Merge pull request #1140 from znsio/log_error_when_invalid_contract_path

Log error when invalid contract paths are selected by user
znsio · Jul 11, 2024 · 1c0931b · 1c0931b
2 parents c8edaa9 + fdf667a
commit 1c0931b
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 13 deletions.
diff --git a/core/src/main/kotlin/in/specmatic/core/utilities/Utilities.kt b/core/src/main/kotlin/in/specmatic/core/utilities/Utilities.kt
@@ -343,6 +343,15 @@ fun examplesDirFor(openApiFilePath: String, alternateSuffix: String): File {
         getExamplesDir(openApiFilePath, alternateSuffix)
 }
 
+fun checkIfContractPathsAreValid(contractPaths: List<String>) {
+    val validContractPaths = contractPaths.filter { path ->
+        File(path).extension in CONTRACT_EXTENSIONS
+    }
+    if (validContractPaths.isEmpty()) {
+        throw ContractException("No valid specification file found at given paths : ${contractPaths.joinToString(", ")}")
+    }
+}
+
 private fun getExamplesDir(openApiFilePath: String, suffix: String): File =
     File(openApiFilePath).canonicalFile.let {
         it.parentFile.resolve("${it.parent}/${it.nameWithoutExtension}$suffix")

diff --git a/core/src/main/kotlin/in/specmatic/stub/api.kt b/core/src/main/kotlin/in/specmatic/stub/api.kt
@@ -6,10 +6,7 @@ import `in`.specmatic.core.git.SystemGit
 import `in`.specmatic.core.log.StringLog
 import `in`.specmatic.core.log.consoleLog
 import `in`.specmatic.core.log.logger
-import `in`.specmatic.core.utilities.ContractPathData
-import `in`.specmatic.core.utilities.contractStubPaths
-import `in`.specmatic.core.utilities.examplesDirFor
-import `in`.specmatic.core.utilities.exitIfDoesNotExist
+import `in`.specmatic.core.utilities.*
 import `in`.specmatic.core.value.StringValue
 import `in`.specmatic.mock.NoMatchingScenario
 import `in`.specmatic.mock.ScenarioStub
@@ -70,6 +67,8 @@ fun createStubFromContracts(
     host: String = "localhost",
     port: Int = 9000
 ): ContractStub {
+    checkIfContractPathsAreValid(contractPaths)
+
     return createStubFromContracts(
         contractPaths,
         dataDirPaths,
@@ -81,6 +80,8 @@ fun createStubFromContracts(
 
 // Used by stub client code
 fun createStubFromContracts(contractPaths: List<String>, host: String = "localhost", port: Int = 9000): ContractStub {
+    checkIfContractPathsAreValid(contractPaths)
+
     return createStubFromContracts(
         contractPaths,
         host,

diff --git a/core/src/test/kotlin/utilities/UtilitiesTest.kt b/core/src/test/kotlin/utilities/UtilitiesTest.kt
@@ -8,6 +8,7 @@ import `in`.specmatic.core.git.GitCommand
 import `in`.specmatic.core.git.SystemGit
 import `in`.specmatic.core.git.checkout
 import `in`.specmatic.core.git.clone
+import `in`.specmatic.core.pattern.ContractException
 import `in`.specmatic.core.pattern.parsedJSON
 import `in`.specmatic.core.pattern.parsedJSONObject
 import `in`.specmatic.core.utilities.*
@@ -22,10 +23,7 @@ import io.ktor.server.response.*
 import io.ktor.server.routing.*
 import io.mockk.*
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.AfterAll
-import org.junit.jupiter.api.AfterEach
-import org.junit.jupiter.api.Nested
-import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.*
 import java.io.File
 import java.net.ServerSocket
 
@@ -535,6 +533,29 @@ internal class UtilitiesTest {
         }
     }
 
+    @Nested
+    inner class CheckIfContractPathsAreValidTests {
+        @Test
+        fun `should not throw an exception if the contract paths are valid`() {
+            val contractPaths = listOf("first.yaml", "second.yml", "third.json")
+
+            assertDoesNotThrow {
+                checkIfContractPathsAreValid(contractPaths)
+            }
+        }
+
+        @Test
+        fun `should throw an exception if none of the contract paths is valid`() {
+            val contractPaths = listOf("first.random", "second.random", "third.random")
+
+            val e = assertThrows<ContractException> {
+                checkIfContractPathsAreValid(contractPaths)
+            }
+
+            assertThat(e.errorMessage == "No valid specification file found at given paths: first.random, second.random, third.random")
+        }
+    }
+
     private fun deleteGitIgnoreFile(){
         File(".gitignore").delete()
     }

diff --git a/junit5-support/src/main/kotlin/in/specmatic/test/SpecmaticJUnitSupport.kt b/junit5-support/src/main/kotlin/in/specmatic/test/SpecmaticJUnitSupport.kt
@@ -186,7 +186,9 @@ open class SpecmaticJUnitSupport {
         if(!mbs.isRegistered(name))
             mbs.registerMBean(statistics, name)
 
-        val contractPaths = System.getProperty(CONTRACT_PATHS)
+        val contractPaths = System.getProperty(CONTRACT_PATHS)?.split(",").orEmpty()
+        checkIfContractPathsAreValid(contractPaths)
+
         val givenWorkingDirectory = System.getProperty(WORKING_DIRECTORY)
         val filterName: String? = System.getProperty(FILTER_NAME_PROPERTY) ?: System.getenv(FILTER_NAME_ENVIRONMENT_VARIABLE)
         val filterNotName: String? = System.getProperty(FILTER_NOT_NAME_PROPERTY) ?: System.getenv(FILTER_NOT_NAME_ENVIRONMENT_VARIABLE)
@@ -206,10 +208,8 @@ open class SpecmaticJUnitSupport {
         }
         val testScenarios = try {
             val (testScenarios, allEndpoints) = when {
-                contractPaths != null -> {
-                    val testScenariosAndEndpointsPairList = contractPaths.split(",").filter {
-                        File(it).extension in CONTRACT_EXTENSIONS
-                    }.map {
+                (contractPaths != null) -> {
+                    val testScenariosAndEndpointsPairList = contractPaths.map {
                         loadTestScenarios(
                             it,
                             suggestionsPath,