This is an automated email from the ASF dual-hosted git repository.
maoling pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/zookeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 16187c4 ZOOKEEPER-4319: Refactored AtomicFileWritingIdiomTest to use
TempDir annotation
16187c4 is described below
commit 16187c48a1d9b339866b81e69c522021b031c4c3
Author: Elvys Soares <[email protected]>
AuthorDate: Sun Jun 27 15:44:14 2021 +0800
ZOOKEEPER-4319: Refactored AtomicFileWritingIdiomTest to use TempDir
annotation
This is a test refactoring. No original assertion was changed nor the
original code presented any failing steps.
**Problem:**
Tests that manipulate external file resources need to guarantee resource
integrity and availability. Test suite design and maintainability may suffer
from the addition of assurance steps to guarantee parallel execution scenarios
and resource leakage from failed previous executions.
**Solution:**
The use of tempdir annotation assures a temporary directory being created
and cleaned up for every test method execution, thus simplifying test
maintenance steps.
Author: Elvys Soares <[email protected]>
Reviewers: maoling <[email protected]>
Closes #1702 from eas5/test_improvement
---
.../common/AtomicFileWritingIdiomTest.java | 44 +++++++---------------
1 file changed, 13 insertions(+), 31 deletions(-)
diff --git
a/zookeeper-server/src/test/java/org/apache/zookeeper/common/AtomicFileWritingIdiomTest.java
b/zookeeper-server/src/test/java/org/apache/zookeeper/common/AtomicFileWritingIdiomTest.java
index d3e833b..3126f00 100644
---
a/zookeeper-server/src/test/java/org/apache/zookeeper/common/AtomicFileWritingIdiomTest.java
+++
b/zookeeper-server/src/test/java/org/apache/zookeeper/common/AtomicFileWritingIdiomTest.java
@@ -32,21 +32,13 @@ import java.nio.charset.StandardCharsets;
import org.apache.zookeeper.ZKTestCase;
import
org.apache.zookeeper.common.AtomicFileWritingIdiom.OutputStreamStatement;
import org.apache.zookeeper.common.AtomicFileWritingIdiom.WriterStatement;
-import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
public class AtomicFileWritingIdiomTest extends ZKTestCase {
- private static File tmpdir;
-
- @BeforeAll
- public static void createTmpDir() {
- tmpdir = new File("build/test/tmp");
- tmpdir.mkdirs();
- }
-
@Test
- public void testOutputStreamSuccess() throws IOException {
+ public void testOutputStreamSuccess(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -61,11 +53,10 @@ public class AtomicFileWritingIdiomTest extends ZKTestCase {
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
- target.delete();
}
@Test
- public void testWriterSuccess() throws IOException {
+ public void testWriterSuccess(@TempDir File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -80,11 +71,10 @@ public class AtomicFileWritingIdiomTest extends ZKTestCase {
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
- target.delete();
}
@Test
- public void testOutputStreamFailure() throws IOException {
+ public void testOutputStreamFailure(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -107,11 +97,10 @@ public class AtomicFileWritingIdiomTest extends ZKTestCase
{
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
@Test
- public void testWriterFailure() throws IOException {
+ public void testWriterFailure(@TempDir File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -134,11 +123,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
@Test
- public void testOutputStreamFailureIOException() throws IOException {
+ public void testOutputStreamFailureIOException(@TempDir File tmpdir)
throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -161,11 +149,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
@Test
- public void testWriterFailureIOException() throws IOException {
+ public void testWriterFailureIOException(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -188,11 +175,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
@Test
- public void testOutputStreamFailureError() throws IOException {
+ public void testOutputStreamFailureError(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -215,11 +201,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
@Test
- public void testWriterFailureError() throws IOException {
+ public void testWriterFailureError(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
@@ -242,13 +227,12 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
- target.delete();
}
// ************** target file does not exist
@Test
- public void testOutputStreamSuccessNE() throws IOException {
+ public void testOutputStreamSuccessNE(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
@@ -262,11 +246,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
});
// content changed
assertEquals("after", getContent(target));
- target.delete();
}
@Test
- public void testWriterSuccessNE() throws IOException {
+ public void testWriterSuccessNE(@TempDir File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
@@ -281,11 +264,10 @@ public class AtomicFileWritingIdiomTest extends
ZKTestCase {
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
- target.delete();
}
@Test
- public void testOutputStreamFailureNE() throws IOException {
+ public void testOutputStreamFailureNE(@TempDir File tmpdir) throws
IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
@@ -311,7 +293,7 @@ public class AtomicFileWritingIdiomTest extends ZKTestCase {
}
@Test
- public void testWriterFailureNE() throws IOException {
+ public void testWriterFailureNE(@TempDir File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
