Externalise examples should override inline examples with same name

core/src/main/kotlin/io/specmatic/core/Scenario.kt

@@ -553,10 +553,10 @@ data class Scenario(
         )
     }
 
-    fun useExamples(externalisedJSONExamples: Map<OpenApiSpecification.OperationIdentifier, List<Row>>): Scenario {
-        val matchingTestData: Map<OpenApiSpecification.OperationIdentifier, List<Row>> = matchingRows(externalisedJSONExamples)
+    fun useExamples(rawExternalisedExamples: Map<OpenApiSpecification.OperationIdentifier, List<Row>>): Scenario {
+        val matchingRawExternalisedEamples: Map<OpenApiSpecification.OperationIdentifier, List<Row>> = matchingRows(rawExternalisedExamples)
 
-        val newExamples: List<Examples> = matchingTestData.map { (operationId, rows) ->
+        val externalisedExamples: List<Examples> = matchingRawExternalisedEamples.map { (operationId, rows) ->
             if(rows.isEmpty())
                 return@map emptyList()
 
@@ -567,7 +567,7 @@ data class Scenario(
             listOf(Examples(columns, rowsWithPathData))
         }.flatten()
 
-        return this.copy(examples = this.examples + newExamples)
+        return this.copy(examples = inlineExamplesThatAreNotOverridden(externalisedExamples) + externalisedExamples)
     }
 
     private fun matchingRows(externalisedJSONExamples: Map<OpenApiSpecification.OperationIdentifier, List<Row>>): Map<OpenApiSpecification.OperationIdentifier, List<Row>> {
@@ -615,6 +615,16 @@ data class Scenario(
 
         return Result.fromResults(listOf(requestMatch, responseMatch))
     }
+
+    private fun inlineExamplesThatAreNotOverridden(externalisedExamples: List<Examples>): List<Examples> {
+        val externalisedExampleNames = externalisedExamples.flatMap { it.rows.map { row -> row.name } }.toSet()
+
+        return this.examples.mapNotNull {
+            val rowsThatAreNotOverridden  = it.rows.filter { row -> row.name !in externalisedExampleNames }
+            if(rowsThatAreNotOverridden.isEmpty()) return@mapNotNull null
+            it.copy(rows = rowsThatAreNotOverridden)
+        }
+    }
 }
 
 fun newExpectedServerStateBasedOn(

core/src/test/kotlin/integration_tests/LoadTestsFromExternalisedFiles.kt

@@ -276,8 +276,38 @@ class LoadTestsFromExternalisedFiles {
             }
         })
 
-        assertThat(idsSeen).containsExactlyInAnyOrder("123", "456")
-        assertThat(results.testCount).isEqualTo(2)
+        assertThat(idsSeen).contains("123", "456")
+        assertThat(results.testCount).isEqualTo(3)
+    }
+
+    @Test
+    fun `external example should override the inline example with the same name and should restrict it from running as a test`() {
+        val feature = OpenApiSpecification
+            .fromFile("src/test/resources/openapi/has_overriding_external_examples.yaml")
+            .toFeature()
+            .loadExternalisedExamples()
+
+        val idsSeen = mutableListOf<String>()
+
+        val result = feature.executeTests(object : TestExecutor {
+            override fun execute(request: HttpRequest): HttpResponse {
+                val path = request.path ?: fail("Path expected")
+                idsSeen.add(path.split("/").last())
+
+                return HttpResponse(200, parsedJSONObject("""{"id": 10, "name": "Jack"}""")).also {
+                    println("---")
+                    println(request.toLogString())
+                    println(it.toLogString())
+                    println()
+                }
+            }
+        })
+
+        assertThat(idsSeen).contains("overriding_external_id")
+        assertThat(idsSeen).doesNotContain("overridden_inline_id")
+
+        assertThat(idsSeen).hasSize(2)
+        assertThat(result.testCount).isEqualTo(2)
     }
 
     @Test
@@ -303,8 +333,8 @@ class LoadTestsFromExternalisedFiles {
             }
         })
 
-        assertThat(idsSeen).containsExactlyInAnyOrder("123", "456")
-        assertThat(results.testCount).isEqualTo(2)
+        assertThat(idsSeen).contains("123", "456")
+        assertThat(results.testCount).isEqualTo(3)
     }
 
     @Test
@@ -335,7 +365,7 @@ class LoadTestsFromExternalisedFiles {
             }
         })
 
-        assertThat(results.testCount).isEqualTo(2)
+        assertThat(results.testCount).isEqualTo(3)
     }
 
     @Test
@@ -372,7 +402,7 @@ class LoadTestsFromExternalisedFiles {
 
         println(results.report())
 
-        assertThat(results.testCount).isEqualTo(2)
-        assertThat(results.failureCount).isEqualTo(2)
+        assertThat(results.testCount).isEqualTo(3)
+        assertThat(results.failureCount).isEqualTo(3)
     }
 }

core/src/test/resources/openapi/has_inline_and_external_examples.yaml

@@ -14,11 +14,14 @@ paths:
           required: true
           description: Unique identifier of the person
           schema:
-            type: integer
+            type: string
           examples:
             johnDoe:
               summary: Example ID for John Doe
               value: 123
+            get_person:
+              summary: Example ID for Unknown
+              value: inline_id
       responses:
         '200':
           description: Successful response
@@ -40,3 +43,8 @@ paths:
                   value:
                     id: 123
                     name: John Doe
+                get_person:
+                  summary: Example response for Unknown
+                  value:
+                    id: 1000
+                    name: Unknown

core/src/test/resources/openapi/has_inline_and_external_examples_examples/get_person.json

@@ -0,0 +1,13 @@
+{
+  "http-request": {
+    "method": "GET",
+    "path": "/person/external_id"
+  },
+  "http-response": {
+    "status": 200,
+    "body": {
+      "id": 789,
+      "name": "John External Doe"
+    }
+  }
+}

core/src/test/resources/openapi/has_overriding_external_examples.yaml

@@ -0,0 +1,50 @@
+openapi: 3.0.3
+info:
+  title: Person API
+  description: API for retrieving person details
+  version: 1.0.0
+paths:
+  /person/{id}:
+    get:
+      summary: Get person details by ID
+      description: Retrieves the details of a person based on their unique identifier
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Unique identifier of the person
+          schema:
+            type: string
+          examples:
+            johnDoe:
+              summary: Example ID for John Doe
+              value: 123
+            get_person:
+              summary: Example ID for Unknown
+              value: overridden_inline_id
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                  name:
+                    type: string
+                required:
+                  - id
+                  - name
+              examples:
+                johnDoe:
+                  summary: Example response for John Doe
+                  value:
+                    id: 123
+                    name: John Doe
+                get_person:
+                  summary: Example response for Unknown
+                  value:
+                    id: 1000
+                    name: Unknown

core/src/test/resources/openapi/has_overriding_external_examples_examples/get_person.json

@@ -0,0 +1,13 @@
+{
+  "http-request": {
+    "method": "GET",
+    "path": "/person/overriding_external_id"
+  },
+  "http-response": {
+    "status": 200,
+    "body": {
+      "id": 789,
+      "name": "John External Doe"
+    }
+  }
+}