Merge pull request #1657 from znsio/debug_logs_for_example_load_stubs

Add debug logs for explicit example loading stage in stub
znsio · Mar 6, 2025 · f983f52 · f983f52
2 parents b320d7b + 6ecfed7
commit f983f52
Show file tree

Hide file tree

Showing 7 changed files with 323 additions and 136 deletions.
diff --git a/application/src/main/kotlin/application/StubCommand.kt b/application/src/main/kotlin/application/StubCommand.kt
@@ -36,7 +36,7 @@ class StubCommand : Callable<Unit> {
     @Autowired
     private var specmaticConfig: SpecmaticConfig = SpecmaticConfig()
 
-    @Parameters(arity = "0..*", description = ["Contract file paths"])
+    @Parameters(arity = "0..*", description = ["Contract file paths", "Spec file paths"])
     var contractPaths: List<String> = mutableListOf()
 
     @Option(names = ["--data", "--examples"], description = ["Directories containing JSON examples"], required = false)
@@ -130,8 +130,9 @@ class StubCommand : Callable<Unit> {
         try {
             contractSources = when (contractPaths.isEmpty()) {
                 true -> {
-                    logger.debug("No contractPaths specified. Using configuration file named $configFileName")
                     specmaticConfigPath = File(Configuration.configFilePath).canonicalPath
+
+                    logger.debug("Using the spec paths configured for stubs in the configuration file '$specmaticConfigPath'")
                     specmaticConfig.contractStubPathData()
                 }
                 else -> contractPaths.map {

diff --git a/application/src/main/kotlin/application/StubLoaderEngine.kt b/application/src/main/kotlin/application/StubLoaderEngine.kt
@@ -29,9 +29,7 @@ class StubLoaderEngine {
 
         return when {
             dataDirs.isNotEmpty() -> {
-                loadContractStubsFromFiles(contractPathDataList, dataDirs, specmaticConfig, strictMode).plus(
-                    loadContractStubsFromImplicitPaths(contractPathDataList, specmaticConfig, dataDirs)
-                )
+                loadContractStubsFromFiles(contractPathDataList, dataDirs, specmaticConfig, strictMode, withImplicitStubs = true)
             }
             else -> loadContractStubsFromImplicitPaths(contractPathDataList, specmaticConfig, dataDirs)
         }

diff --git a/core/src/main/kotlin/io/specmatic/conversions/OpenApiSpecification.kt b/core/src/main/kotlin/io/specmatic/conversions/OpenApiSpecification.kt
@@ -402,7 +402,7 @@ class OpenApiSpecification(
         val data: List<Pair<List<ScenarioInfo>, Map<String, List<Pair<HttpRequest, HttpResponse>>>>> =
             openApiPaths().map { (openApiPath, pathItem) ->
                 val scenariosAndExamples = openApiOperations(pathItem).map { (httpMethod, openApiOperation) ->
-                    logger.debug("\n\nProcessing $httpMethod $openApiPath")
+                    logger.debug("${System.lineSeparator()}Processing $httpMethod $openApiPath")
 
                     try {
                         openApiOperation.validateParameters()

diff --git a/core/src/main/kotlin/io/specmatic/core/Feature.kt b/core/src/main/kotlin/io/specmatic/core/Feature.kt
@@ -72,7 +72,7 @@ fun parseContractFileToFeature(
     overlayContent: String = "",
     strictMode: Boolean = false
 ): Feature {
-    logger.debug("Parsing contract file ${file.path}, absolute path ${file.absolutePath}")
+    logger.debug("Parsing spec file ${file.path}, absolute path ${file.canonicalPath}")
     return when (file.extension) {
         in OPENAPI_FILE_EXTENSIONS -> OpenApiSpecification.fromYAML(
             hook.readContract(file.path),

diff --git a/core/src/main/kotlin/io/specmatic/core/utilities/Utilities.kt b/core/src/main/kotlin/io/specmatic/core/utilities/Utilities.kt
@@ -291,8 +291,8 @@ fun contractFilePathsFrom(configFilePath: String, workingDirectory: String, sele
         it.loadContracts(selector, workingDirectory, configFilePath)
     }
 
-    logger.debug("Contract file paths in $configFilePath:")
-    logger.debug(contractPathData.joinToString(System.lineSeparator()) { it.path }.prependIndent("  "))
+    logger.debug("Spec file paths in $configFilePath:")
+    logger.debug(contractPathData.joinToString(System.lineSeparator()) { "- ${it.path}" })
 
     return contractPathData
 }