https://github.com/ESAPI/esapi-java-legacy/issues/352

Correcting issue.  Underlying problem of Issue 352 was that the tests
were impacting the same file sets, and were acting under the assumption
that they would execute sequentially in the order they appeared in the
test file.  Introducing more threads caused testLoadPlaintextAndEncrypt
and testLoadEncryptedAndAdd to run concurrently and broke the sequential
dependency consistently to replicate the listed result.

Isolating test behavior by removing the shared static relative filepaths
and using the TemporaryFolder junit rule to manage filesystem resources.
Removing order-dependent validation of K/V 3 and K/V 4 from the
testLoadEncryptedAndAdd implementation.

Author: jeremiahjstacey

src/test/java/org/owasp/esapi/reference/crypto/EncryptedPropertiesUtilsTest.java

@@ -20,11 +20,13 @@
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.FileReader;
+import java.io.IOException;
 import java.util.Properties;
 
-import org.junit.After;
-import org.junit.Before;
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.junit.rules.TestName;
 
 
 /**
@@ -45,32 +47,26 @@ public class EncryptedPropertiesUtilsTest {
 	private static final String KEY4	= "sally sue";
 	private static final String VALUE4	= "betty mae";
 
-	private static final String PLAINTEXT_FILENAME		= "plaintext.properties";
-	private static final String ENCRYPTED_FILENAME_1	= "encrypted.properties";
-	private static final String ENCRYPTED_FILENAME_2	= "encrypted.2.properties";
-
-	/**
-	 * {@inheritDoc}
-	 */
-	@Before public void setUp() throws Exception {
-		//write an initial plaintext properties file
-		Properties props = new Properties();
-		props.setProperty(KEY3, VALUE3);
-		props.setProperty(KEY4, VALUE4);
-
-		props.store(new FileOutputStream(PLAINTEXT_FILENAME), "Plaintext test file created by EncryptedPropertiesUtilsTest");
-	}
-
+	
+	/** Rule to acquire the running test's information at runtime.*/
+	@Rule
+	public TestName testName = new TestName();
+
+	/** File management component for IO targets during test executions.*/
+	@Rule
+	public TemporaryFolder tempFolder = new TemporaryFolder();
+	
+	/** Counter used to track the number of files created for a single test to assist with creating unique file references.*/
+	private int fileIndex = 0;
+	
 	/**
-	 * {@inheritDoc}
+	 * Creates a new properties file reference for the active test which will be cleaned up upon test completion.
+	 * @return File New unique file reference for the active test.
+	 * @throws IOException If a new file could not be generated.
 	 */
-	@After public void tearDown() throws Exception {
-		File[] delFiles = new File[] { new File(PLAINTEXT_FILENAME), new File(ENCRYPTED_FILENAME_1), new File(ENCRYPTED_FILENAME_2) };
-        for ( File f : delFiles ) {
-            f.deleteOnExit();
-        }
+	private final File getTempPropertiesFile() throws IOException {
+	    return tempFolder.newFile(String.format("%s_%2d.properties", testName.getMethodName(), fileIndex++));
 	}
-
 	/**
 	 * Test of creating and storing a new EncryptedProperties from scratch,
 	 * as if calling:
@@ -81,7 +77,8 @@ public class EncryptedPropertiesUtilsTest {
 	 * @throws Exception Any exception that occurs
 	 */
 	@Test public void testCreateNew() throws Exception {
-
+	    File encryptedFile = getTempPropertiesFile();
+	    
 		//create a new properties with no input
 		Properties props = EncryptedPropertiesUtils.loadProperties(null, null);
 
@@ -93,11 +90,11 @@ public class EncryptedPropertiesUtilsTest {
 		assertNull("Expected null but returned: " + prop2, prop2);
 
 		//store the file 
-		EncryptedPropertiesUtils.storeProperties(ENCRYPTED_FILENAME_1, props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
+		EncryptedPropertiesUtils.storeProperties(encryptedFile.getAbsolutePath(), props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
 
 		//try reading in the resulting file
 		ReferenceEncryptedProperties loadedProps = new ReferenceEncryptedProperties();
-		loadedProps.load(new FileReader(ENCRYPTED_FILENAME_1));
+		loadedProps.load(new FileReader(encryptedFile.getAbsolutePath()));
 
 		assertEquals(VALUE1, loadedProps.getProperty(KEY1));
 		assertEquals(VALUE2, loadedProps.getProperty(KEY2));
@@ -113,20 +110,29 @@ public class EncryptedPropertiesUtilsTest {
 	 * @throws Exception Any exception that occurs
 	 */
 	@Test public void testLoadPlaintextAndEncrypt() throws Exception {
-
+	    File encryptedFile = getTempPropertiesFile();
+	    File plainTextFile = getTempPropertiesFile();
+	    
+	  //write an initial plaintext properties file
+        Properties props = new Properties();
+        props.setProperty(KEY3, VALUE3);
+        props.setProperty(KEY4, VALUE4);
+
+        props.store(new FileOutputStream(plainTextFile.getAbsolutePath()), "Plaintext test file created by EncryptedPropertiesUtilsTest");
+	    
 		//load the plaintext properties file
-		Properties props = EncryptedPropertiesUtils.loadProperties(PLAINTEXT_FILENAME, false);
+		props = EncryptedPropertiesUtils.loadProperties(plainTextFile.getAbsolutePath(), false);
 
 		//test some properties using getProperty
 		assertEquals(VALUE3, props.getProperty(KEY3));
 		assertEquals(VALUE4, props.getProperty(KEY4));
 
 		//store the file
-		EncryptedPropertiesUtils.storeProperties(ENCRYPTED_FILENAME_1, props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
+		EncryptedPropertiesUtils.storeProperties(encryptedFile.getAbsolutePath(), props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
 
 		//try reading in the resulting file
 		ReferenceEncryptedProperties loadedProps = new ReferenceEncryptedProperties();
-		loadedProps.load(new FileReader(ENCRYPTED_FILENAME_1));
+		loadedProps.load(new FileReader(encryptedFile.getAbsolutePath()));
 
 		assertEquals(VALUE3, loadedProps.getProperty(KEY3));
 		assertEquals(VALUE4, loadedProps.getProperty(KEY4));
@@ -142,13 +148,10 @@ public class EncryptedPropertiesUtilsTest {
 	 * @throws Exception Any exception that occurs
 	 */
 	@Test public void testLoadEncryptedAndAdd() throws Exception {
-
+	    File encryptedFile = getTempPropertiesFile();
+	    File encryptedFile2 = getTempPropertiesFile();
 		//load the plaintext properties file
-		Properties props = EncryptedPropertiesUtils.loadProperties(ENCRYPTED_FILENAME_1, true);
-
-		//test some properties
-		assertEquals(VALUE3, props.getProperty(KEY3));
-		assertEquals(VALUE4, props.getProperty(KEY4));
+		Properties props = EncryptedPropertiesUtils.loadProperties(encryptedFile.getAbsolutePath(), true);
 
 		//add some new properties
 		EncryptedPropertiesUtils.addProperty(props, KEY1, VALUE1);
@@ -159,17 +162,15 @@ public class EncryptedPropertiesUtilsTest {
 		assertEquals(VALUE2, props.getProperty(KEY2));
 
 		//store the file
-		EncryptedPropertiesUtils.storeProperties(ENCRYPTED_FILENAME_2, props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
+		EncryptedPropertiesUtils.storeProperties(encryptedFile2.getAbsolutePath(), props, "Encrypted Properties File generated by EncryptedPropertiesUtilsTest");
 
 		//try reading in the resulting file
 		ReferenceEncryptedProperties loadedProps = new ReferenceEncryptedProperties();
-		loadedProps.load(new FileReader(ENCRYPTED_FILENAME_2));
+		loadedProps.load(new FileReader(encryptedFile2.getAbsolutePath()));
 
 		//test the values read in
 		assertEquals(VALUE1, loadedProps.getProperty(KEY1));
 		assertEquals(VALUE2, loadedProps.getProperty(KEY2));
-		assertEquals(VALUE3, loadedProps.getProperty(KEY3));
-		assertEquals(VALUE4, loadedProps.getProperty(KEY4));
 	}
 
 }