[bugfix][kotlin-wiremock] fix problems with range responses

.github/workflows/samples-kotlin-wiremock.yaml

@@ -3,11 +3,11 @@ name: Samples Kotlin WireMock
 on:
   push:
     branches:
-      - samples/server/petstore/kotlin-wiremock/**
+      - samples/server/petstore/kotlin-wiremock*/**
       - samples/server/echo_api/kotlin-wiremock/**
   pull_request:
     paths:
-      - samples/server/petstore/kotlin-wiremock/**
+      - samples/server/petstore/kotlin-wiremock*/**
       - samples/server/echo_api/kotlin-wiremock/**
 
 jobs:
@@ -19,6 +19,7 @@ jobs:
       matrix:
         sample:
           - samples/server/petstore/kotlin-wiremock
+          - samples/server/petstore/kotlin-wiremock-responses
           - samples/server/echo_api/kotlin-wiremock
     steps:
       - uses: actions/checkout@v4

bin/configs/kotlin-wiremock-responses.yaml

@@ -0,0 +1,4 @@
+generatorName: kotlin-wiremock
+outputDir: samples/server/petstore/kotlin-wiremock-responses
+inputSpec: modules/openapi-generator/src/test/resources/3_0/kotlin/issue7193-responses.yaml
+templateDir: modules/openapi-generator/src/main/resources/kotlin-wiremock

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinWiremockServerCodegen.java

@@ -1,9 +1,7 @@
 package org.openapitools.codegen.languages;
 
-import org.openapitools.codegen.CodegenConstants;
-import org.openapitools.codegen.CodegenProperty;
-import org.openapitools.codegen.CodegenType;
-import org.openapitools.codegen.SupportingFile;
+import io.swagger.v3.oas.models.responses.ApiResponse;
+import org.openapitools.codegen.*;
 import org.openapitools.codegen.meta.GeneratorMetadata;
 import org.openapitools.codegen.meta.Stability;
 import org.openapitools.codegen.meta.features.GlobalFeature;
@@ -16,13 +14,16 @@
 import java.io.File;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 public class KotlinWiremockServerCodegen extends AbstractKotlinCodegen {
 
     protected static final String VENDOR_EXTENSION_BASE_NAME_LITERAL = "x-base-name-literal";
 
+    protected static final String VENDOR_EXTENSION_IS_RANGE_RESPONSE_CODE = "x-is-range-code";
+
     @Override
     public CodegenType getTag() {
         return CodegenType.SERVER;
@@ -126,6 +127,15 @@ public ModelsMap postProcessModels(ModelsMap objs) {
         return objects;
     }
 
+    @Override
+    public CodegenResponse fromResponse(String responseCode, ApiResponse response) {
+        var r = super.fromResponse(responseCode, response);
+
+        var isRange = List.of("1xx", "2xx", "3xx", "4xx", "5xx").contains(responseCode.toLowerCase(Locale.ROOT));
+        r.vendorExtensions.put(VENDOR_EXTENSION_IS_RANGE_RESPONSE_CODE, isRange);
+        return r;
+    }
+
     @Override
     public void postProcess() {
         System.out.println("################################################################################");

modules/openapi-generator/src/main/resources/kotlin-wiremock/api-stub-builder.mustache

@@ -21,39 +21,68 @@ import {{modelPackage}}.*
 class {{operationIdCamelCase}}StubBuilder internal constructor(private val objectMapper: ObjectMapper, private val stub: MappingBuilder) {
     {{#responses}}
     {{^wildcard}}
+    {{^vendorExtensions.x-is-range-code}}
 
     /**
      * Let the stub for {{operationId}} respond with HTTP status code {{code}}.
      *
-     {{#returnType}}
+     {{#dataType}}
      * @param body response body for the [MappingBuilder].
-     {{/returnType}}
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     {{/dataType}}
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith{{code}}(
-        {{#returnType}}
+        {{#dataType}}
         body: {{{.}}},
-        {{/returnType}}
+        {{/dataType}}
         configurer: ResponseDefinitionBuilder.() -> ResponseDefinitionBuilder = { this },
     ): MappingBuilder =
         stub.willReturn(aResponse()
             .withStatus({{code}})
-            {{#returnType}}
+            {{#dataType}}
             .withHeader("Content-Type", "application/json")
             .withBody(objectMapper.writeValueAsString(body))
-            {{/returnType}}
+            {{/dataType}}
             .configurer()
         )
+    {{/vendorExtensions.x-is-range-code}}
     {{/wildcard}}
+    {{#vendorExtensions.x-is-range-code}}
+
+        /**
+        * Let the stub for {{operationId}} respond with HTTP status code [code].
+        *
+        * @param code the response code.
+        {{#dataType}}
+        * @param body response body for the [MappingBuilder].
+        {{/dataType}}
+        * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
+        * @return a [MappingBuilder] to be registered with a WireMock instance.
+        */
+        fun respondWith{{code}}(
+            code: Int,
+            {{#dataType}}
+            body: {{{.}}},
+            {{/dataType}}
+            configurer: ResponseDefinitionBuilder.() -> ResponseDefinitionBuilder = { this },
+        ): MappingBuilder =
+        stub.willReturn(aResponse()
+            .withStatus(code)
+            {{#dataType}}
+            .withHeader("Content-Type", "application/json")
+            .withBody(objectMapper.writeValueAsString(body))
+            {{/dataType}}
+            .configurer()
+        )
+    {{/vendorExtensions.x-is-range-code}}
     {{/responses}}
 
     /**
      * Let the stub for {{operationId}} respond with HTTP status code [code].
      *
-     {{#returnType}}
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
-     {{/returnType}}
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */

modules/openapi-generator/src/test/resources/3_0/kotlin/issue7193-responses.yaml

@@ -0,0 +1,51 @@
+openapi: 3.0.0
+info:
+  description: >-
+    This spec is mainly for testing Petstore server and contains fake endpoints,
+    models. Please do not use this for any other purpose. Special characters: "
+    \
+  version: 1.0.0
+  title: OpenAPI Petstore
+  license:
+    name: Apache-2.0
+    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
+paths:
+  /foo:
+    get:
+      responses:
+        default:
+          description: response
+          content:
+            application/json:
+              schema:
+                type: number
+        4XX:
+          description: client error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Foo'
+        404:
+          description: not found
+          content:
+            application/json:
+              schema:
+                type: string
+        400:
+          description: bad request
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Foo'
+components:
+  schemas:
+    Foo:
+      type: object
+      properties:
+        bar:
+          $ref: '#/components/schemas/Bar'
+    Bar:
+      type: string
+      default: bar

samples/server/echo_api/kotlin-wiremock/src/main/kotlin/org/openapitools/apis/AuthApiStubBuilders.kt

@@ -22,7 +22,7 @@ class TestAuthHttpBasicStubBuilder internal constructor(private val objectMapper
      * Let the stub for testAuthHttpBasic respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -39,6 +39,7 @@ class TestAuthHttpBasicStubBuilder internal constructor(private val objectMapper
     /**
      * Let the stub for testAuthHttpBasic respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -69,7 +70,7 @@ class TestAuthHttpBearerStubBuilder internal constructor(private val objectMappe
      * Let the stub for testAuthHttpBearer respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -86,6 +87,7 @@ class TestAuthHttpBearerStubBuilder internal constructor(private val objectMappe
     /**
      * Let the stub for testAuthHttpBearer respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.

samples/server/echo_api/kotlin-wiremock/src/main/kotlin/org/openapitools/apis/BodyApiStubBuilders.kt

@@ -22,7 +22,7 @@ class TestBinaryGifStubBuilder internal constructor(private val objectMapper: Ob
      * Let the stub for testBinaryGif respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -39,6 +39,7 @@ class TestBinaryGifStubBuilder internal constructor(private val objectMapper: Ob
     /**
      * Let the stub for testBinaryGif respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -69,7 +70,7 @@ class TestBodyApplicationOctetstreamBinaryStubBuilder internal constructor(priva
      * Let the stub for testBodyApplicationOctetstreamBinary respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -86,6 +87,7 @@ class TestBodyApplicationOctetstreamBinaryStubBuilder internal constructor(priva
     /**
      * Let the stub for testBodyApplicationOctetstreamBinary respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -116,7 +118,7 @@ class TestBodyMultipartFormdataArrayOfBinaryStubBuilder internal constructor(pri
      * Let the stub for testBodyMultipartFormdataArrayOfBinary respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -133,6 +135,7 @@ class TestBodyMultipartFormdataArrayOfBinaryStubBuilder internal constructor(pri
     /**
      * Let the stub for testBodyMultipartFormdataArrayOfBinary respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -163,7 +166,7 @@ class TestBodyMultipartFormdataSingleBinaryStubBuilder internal constructor(priv
      * Let the stub for testBodyMultipartFormdataSingleBinary respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -180,6 +183,7 @@ class TestBodyMultipartFormdataSingleBinaryStubBuilder internal constructor(priv
     /**
      * Let the stub for testBodyMultipartFormdataSingleBinary respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -210,7 +214,7 @@ class TestEchoBodyFreeFormObjectResponseStringStubBuilder internal constructor(p
      * Let the stub for testEchoBodyFreeFormObjectResponseString respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -227,6 +231,7 @@ class TestEchoBodyFreeFormObjectResponseStringStubBuilder internal constructor(p
     /**
      * Let the stub for testEchoBodyFreeFormObjectResponseString respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -257,7 +262,7 @@ class TestEchoBodyPetStubBuilder internal constructor(private val objectMapper:
      * Let the stub for testEchoBodyPet respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -274,6 +279,7 @@ class TestEchoBodyPetStubBuilder internal constructor(private val objectMapper:
     /**
      * Let the stub for testEchoBodyPet respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -304,7 +310,7 @@ class TestEchoBodyPetResponseStringStubBuilder internal constructor(private val
      * Let the stub for testEchoBodyPetResponseString respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -321,6 +327,7 @@ class TestEchoBodyPetResponseStringStubBuilder internal constructor(private val
     /**
      * Let the stub for testEchoBodyPetResponseString respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
@@ -351,7 +358,7 @@ class TestEchoBodyTagResponseStringStubBuilder internal constructor(private val
      * Let the stub for testEchoBodyTagResponseString respond with HTTP status code 200.
      *
      * @param body response body for the [MappingBuilder].
-     * @param configurer fonfigurer for the [MappingBuilder], allowing for arbitrary changes.
+     * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.
      */
     fun respondWith200(
@@ -368,6 +375,7 @@ class TestEchoBodyTagResponseStringStubBuilder internal constructor(private val
     /**
      * Let the stub for testEchoBodyTagResponseString respond with HTTP status code [code].
      *
+     * @param code the response code.
      * @param body response body for the [MappingBuilder].
      * @param configurer configurer for the [MappingBuilder], allowing for arbitrary changes.
      * @return a [MappingBuilder] to be registered with a WireMock instance.