#793 better error message on file not found (#795)

* release_notes, move file loading to function with custom exception * Rename Yaml Loader to more generic File Loader * Made changes requested by prs
Flank · May 20, 2020 · 08b7866 · 08b7866
1 parent 71aac52
commit 08b7866
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 31 deletions.
diff --git a/release_notes.md b/release_notes.md
@@ -2,6 +2,7 @@
 
 - [#784](https://github.com/Flank/flank/pull/784) Add output-style option. ([jan-gogo](https://github.com/jan-gogo)) 
 - [#779](https://github.com/Flank/flank/pull/779) Print retries & display additional info. ([jan-gogo](https://github.com/jan-gogo))
+- [#793](https://github.com/Flank/flank/issues/793) Better error message on file not found. ([adamfilipow92](https://github.com/adamfilipow92)) 
 - 
 - 
 

diff --git a/test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt b/test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt
@@ -25,14 +25,14 @@ import ftl.args.yml.GcloudYml
 import ftl.args.yml.AppTestPair
 import ftl.args.yml.AndroidGcloudYmlParams
 import ftl.args.yml.YamlDeprecated
+import ftl.util.loadFile
 import ftl.cli.firebase.test.android.AndroidRunCommand
 import ftl.config.Device
 import ftl.config.FtlConstants
 import ftl.config.parseRoboDirectives
 import ftl.run.status.asOutputStyle
 import ftl.util.FlankFatalError
 import java.io.Reader
-import java.nio.file.Files
 import java.nio.file.Path
 
 // set default values, init properties, etc.
@@ -197,7 +197,7 @@ AndroidArgs
             mergeYmlMaps(GcloudYml, AndroidGcloudYml, FlankYml, AndroidFlankYml)
         }
 
-        fun load(yamlPath: Path, cli: AndroidRunCommand? = null): AndroidArgs = load(Files.newBufferedReader(yamlPath), cli)
+        fun load(yamlPath: Path, cli: AndroidRunCommand? = null): AndroidArgs = load(loadFile(yamlPath), cli)
 
         @VisibleForTesting
         internal fun load(yamlReader: Reader, cli: AndroidRunCommand? = null): AndroidArgs {

diff --git a/test_runner/src/main/kotlin/ftl/args/IosArgs.kt b/test_runner/src/main/kotlin/ftl/args/IosArgs.kt
@@ -18,6 +18,7 @@ import ftl.args.yml.IosFlankYml
 import ftl.args.yml.IosGcloudYml
 import ftl.args.yml.IosGcloudYmlParams
 import ftl.args.yml.YamlDeprecated
+import ftl.util.loadFile
 import ftl.cli.firebase.test.ios.IosRunCommand
 import ftl.config.Device
 import ftl.config.FtlConstants
@@ -27,7 +28,6 @@ import ftl.run.status.asOutputStyle
 import ftl.util.FlankFatalError
 import ftl.util.FlankTestMethod
 import java.io.Reader
-import java.nio.file.Files
 import java.nio.file.Path
 
 class IosArgs(
@@ -162,7 +162,7 @@ IosArgs
             mergeYmlMaps(GcloudYml, IosGcloudYml, FlankYml, IosFlankYml)
         }
 
-        fun load(yamlPath: Path, cli: IosRunCommand? = null): IosArgs = load(Files.newBufferedReader(yamlPath), cli)
+        fun load(yamlPath: Path, cli: IosRunCommand? = null): IosArgs = load(loadFile(yamlPath), cli)
 
         @VisibleForTesting
         internal fun load(yamlReader: Reader, cli: IosRunCommand? = null): IosArgs {

diff --git a/test_runner/src/main/kotlin/ftl/args/yml/MissingParameterErrorConverter.kt b/test_runner/src/main/kotlin/ftl/args/yml/MissingParameterErrorConverter.kt
@@ -2,13 +2,13 @@ package ftl.args.yml
 
 import com.fasterxml.jackson.databind.JsonNode
 import ftl.args.yml.errors.ConfigurationErrorMessageBuilder
-import ftl.util.FlankConfigurationException
+import ftl.util.FlankFatalError
 
 fun convertConfigurationErrorExceptions(missingParameterError: Exception, yaml: JsonNode): Throwable {
     val errorMessageBuilder = ConfigurationErrorMessageBuilder
     val errorMessage = missingParameterError.message
     return if (errorMessage != null) {
-        FlankConfigurationException(errorMessageBuilder(errorMessage, yaml))
+        FlankFatalError(errorMessageBuilder(errorMessage, yaml))
     } else {
         missingParameterError
     }

diff --git a/test_runner/src/main/kotlin/ftl/args/yml/YamlDeprecated.kt b/test_runner/src/main/kotlin/ftl/args/yml/YamlDeprecated.kt
@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.node.MissingNode
 import com.fasterxml.jackson.databind.node.ObjectNode
 import com.google.common.annotations.VisibleForTesting
 import ftl.args.ArgsHelper.yamlMapper
+import ftl.util.loadFile
 import ftl.util.FlankFatalError
 import java.io.Reader
 import java.nio.file.Files
@@ -125,7 +126,7 @@ object YamlDeprecated {
     fun modify(yamlPath: Path): Boolean {
         if (yamlPath.toFile().exists().not()) throw FlankFatalError("Flank yml doesn't exist at path $yamlPath")
 
-        val (errorDetected, string) = modify(Files.newBufferedReader(yamlPath))
+        val (errorDetected, string) = modify(loadFile(yamlPath))
 
         Files.write(yamlPath, string.toByteArray())
         println("\nUpdated ${yamlPath.fileName} file")

diff --git a/test_runner/src/main/kotlin/ftl/doctor/Doctor.kt b/test_runner/src/main/kotlin/ftl/doctor/Doctor.kt
@@ -3,14 +3,14 @@ package ftl.doctor
 import com.google.common.annotations.VisibleForTesting
 import ftl.args.ArgsHelper
 import ftl.args.IArgsCompanion
+import ftl.util.loadFile
 import java.io.Reader
-import java.nio.file.Files
 import java.nio.file.Path
 
 object Doctor {
     fun validateYaml(args: IArgsCompanion, data: Path): String {
         if (!data.toFile().exists()) return "Skipping yaml validation. No file at path $data"
-        return validateYaml(args, Files.newBufferedReader(data))
+        return validateYaml(args, loadFile(data))
     }
 
     @VisibleForTesting

diff --git a/test_runner/src/main/kotlin/ftl/util/FileLoader.kt b/test_runner/src/main/kotlin/ftl/util/FileLoader.kt
@@ -0,0 +1,12 @@
+package ftl.util
+
+import java.io.Reader
+import java.nio.file.Files
+import java.nio.file.NoSuchFileException
+import java.nio.file.Path
+
+fun loadFile(filePath: Path): Reader = try {
+    Files.newBufferedReader(filePath)
+} catch (fileNotFound: NoSuchFileException) {
+    throw FlankFatalError("File not found: ${fileNotFound.message}")
+}
diff --git a/test_runner/src/main/kotlin/ftl/util/FlankException.kt b/test_runner/src/main/kotlin/ftl/util/FlankException.kt
@@ -60,12 +60,3 @@ class FlankFatalError(message: String) : FlankException(message)
  * @param message [String] message to be printed to [System.err]
  */
 class FlankCommonException(message: String) : FlankException(message)
-
-/**
- *  Exception throws when required parameters is missing
- *
- *  Exit code: 1
- *
- *  @param message [String] message to be printed to [System.err]
- */
-class FlankConfigurationException(message: String) : FlankException(message)
diff --git a/test_runner/src/main/kotlin/ftl/util/Utils.kt b/test_runner/src/main/kotlin/ftl/util/Utils.kt
@@ -151,10 +151,6 @@ fun withGlobalExceptionHandling(block: () -> Int) {
                 }
                 exitProcess(1)
             }
-            is FlankConfigurationException -> {
-                System.err.println(t)
-                exitProcess(1)
-            }
             is FTLError -> {
                 t.matrix.logError("not finished")
                 exitProcess(3)

diff --git a/test_runner/src/test/kotlin/ftl/MainTest.kt b/test_runner/src/test/kotlin/ftl/MainTest.kt
@@ -89,8 +89,8 @@ class MainTest {
     }
 
     @Test
-    fun `should terminate jvm with exit status 1 if yml parsing error occurs`() {
-        systemExit.expectSystemExitWithStatus(1)
+    fun `should terminate jvm with exit status 2 if yml parsing error occurs`() {
+        systemExit.expectSystemExitWithStatus(2)
         Main.main(arrayOf(
             "firebase",
             "test",

diff --git a/test_runner/src/test/kotlin/ftl/args/yml/ErrorParserTest.kt b/test_runner/src/test/kotlin/ftl/args/yml/ErrorParserTest.kt
@@ -4,7 +4,7 @@ import ftl.args.AndroidArgs
 import ftl.args.yml.errors.ConfigurationErrorMessageBuilder
 import ftl.test.util.TestHelper
 import ftl.test.util.TestHelper.getThrowable
-import ftl.util.FlankConfigurationException
+import ftl.util.FlankFatalError
 import org.junit.Assert
 import org.junit.Test
 
@@ -41,8 +41,8 @@ At line: 23, column: 3
         Assert.assertEquals(expected, buildErrorMessage(instantionError))
     }
 
-    @Test(expected = FlankConfigurationException::class)
-    fun `should throw FlankConfigException without device version`() {
+    @Test(expected = FlankFatalError::class)
+    fun `should throw FlankFatalError without device version`() {
         AndroidArgs.load(yamlWithoutDeviceVersion)
     }
 
@@ -78,13 +78,13 @@ Error node: {
         Assert.assertEquals(exceptedMessage, actualMessage)
     }
 
-    @Test(expected = FlankConfigurationException::class)
-    fun `should throw FlankConfigException without model name`() {
+    @Test(expected = FlankFatalError::class)
+    fun `should throw FlankFatalError without model name`() {
         AndroidArgs.load(yamlNoModelName)
     }
 
-    @Test(expected = FlankConfigurationException::class)
-    fun `should throw FlankConfigException without model node`() {
+    @Test(expected = FlankFatalError::class)
+    fun `should throw FlankFatalError without model node`() {
         AndroidArgs.load(yamlNoModelNode)
     }
 }
diff --git a/test_runner/src/test/kotlin/ftl/args/yml/FileLoaderTest.kt b/test_runner/src/test/kotlin/ftl/args/yml/FileLoaderTest.kt
@@ -0,0 +1,29 @@
+package ftl.args.yml
+
+import ftl.util.loadFile
+import ftl.test.util.TestHelper.getThrowable
+import ftl.util.FlankFatalError
+import org.junit.Assert
+import org.junit.Test
+import java.nio.file.Paths
+import java.util.UUID
+
+class FileLoaderTest {
+    @Test(expected = FlankFatalError::class)
+    fun `should throws FlankFatalError when file not found`() {
+        val filePath = Paths.get("${UUID.randomUUID()}.yml")
+        loadFile(filePath)
+    }
+
+    @Test
+    fun `should throws FlankFatalError with specific message when file not found`() {
+        val filePath = Paths.get("${UUID.randomUUID()}.yml")
+        val thrownException = getThrowable { loadFile(filePath) }
+
+        val expectedExceptionMessage = "File not found: $filePath"
+        Assert.assertEquals(expectedExceptionMessage, thrownException.message)
+
+        val expectedExceptionType = FlankFatalError::class
+        Assert.assertEquals(expectedExceptionType, thrownException::class)
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     - [#784](https://github.com/Flank/flank/pull/784) Add output-style option. ([jan-gogo](https://github.com/jan-gogo))
     - [#779](https://github.com/Flank/flank/pull/779) Print retries & display additional info. ([jan-gogo](https://github.com/jan-gogo))
+    - [#793](https://github.com/Flank/flank/issues/793) Better error message on file not found. ([adamfilipow92](https://github.com/adamfilipow92))
     -
     -
@@ Expand Down @@