Merge pull request #5572 from seadowg/flakey-test

Improve temp file utility to try and prevent flakey tests
getodk · May 9, 2023 · 8dfcf80 · 8dfcf80
2 parents 44a50c0 + dfdd358
commit 8dfcf80
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 13 deletions.
diff --git a/collect_app/src/test/java/org/odk/collect/android/formmanagement/FormMediaDownloaderTest.kt b/collect_app/src/test/java/org/odk/collect/android/formmanagement/FormMediaDownloaderTest.kt
@@ -57,7 +57,7 @@ class FormMediaDownloaderTest {
     }
 
     @Test
-    fun `returns false when there is an existing copy of a media file and an older one and server hash doesn't match existing copy`() {
+    fun `returns false when there is an existing copy of a media file and an older one and media file list hash doesn't match existing copy`() {
         // Save forms
         val formsRepository = InMemFormsRepository()
         val form1 = FormFixtures.form(

diff --git a/shared/src/main/java/org/odk/collect/shared/TempFiles.kt b/shared/src/main/java/org/odk/collect/shared/TempFiles.kt
@@ -7,14 +7,16 @@ object TempFiles {
 
     @JvmStatic
     fun createTempFile(name: String, extension: String): File {
-        val tempFile = File.createTempFile(name, extension)
-        tempFile.deleteOnExit()
-        return tempFile
+        val tmpDir = getTempDir()
+        return File(tmpDir, name + getRandomName(tmpDir) + extension).also {
+            it.createNewFile()
+            it.deleteOnExit()
+        }
     }
 
     @JvmStatic
     fun createTempFile(parent: File, name: String): File {
-        return File(parent, name).also {
+        return File(parent, name + getRandomName(parent)).also {
             it.createNewFile()
             it.deleteOnExit()
         }
@@ -30,30 +32,31 @@ object TempFiles {
 
     @JvmStatic
     fun createTempFile(parent: File): File {
-        val tempFile = File.createTempFile(getRandomString(), ".temp", parent)
-        tempFile.deleteOnExit()
-        return tempFile
+        return File(parent, getRandomName(parent)).also {
+            it.createNewFile()
+            it.deleteOnExit()
+        }
     }
 
     @JvmStatic
     fun getPathInTempDir(name: String, extension: String): String {
-        val tmpDir = System.getProperty("java.io.tmpdir", ".")
+        val tmpDir = getTempDir()
         val file = File(tmpDir, name + extension)
         file.deleteOnExit()
         return file.absolutePath
     }
 
     @JvmStatic
     fun getPathInTempDir(): String {
-        val tmpDir = System.getProperty("java.io.tmpdir", ".")
-        return File(tmpDir, getRandomString()).absolutePath
+        val tmpDir = getTempDir()
+        return File(tmpDir, getRandomName(tmpDir)).absolutePath
     }
 
     @JvmStatic
     @JvmOverloads
     fun createTempDir(parent: File? = null): File {
         val dir = if (parent != null) {
-            File(parent, getRandomString())
+            File(parent, getRandomName(parent))
         } else {
             File(getPathInTempDir())
         }
@@ -62,5 +65,23 @@ object TempFiles {
         return dir
     }
 
-    private fun getRandomString() = RandomString.randomString(16)
+    private fun getTempDir(): File {
+        val tmpDir = File(System.getProperty("java.io.tmpdir", "."), " org.odk.collect.shared.TempFiles")
+        if (!tmpDir.exists()) {
+            tmpDir.mkdir()
+        }
+
+        return tmpDir
+    }
+
+    private fun getRandomName(parent: File): String {
+        val existing = parent.listFiles()
+
+        var candiate = RandomString.randomString(16)
+        while (existing!!.any { it.name.contains(candiate) }) {
+            candiate = RandomString.randomString(16)
+        }
+
+        return candiate
+    }
 }