Skip to content

fix(kotlin-spring): use Jackson 3 annotation package in model imports #23406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yonatankarp wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(kotlin-spring): use Jackson 3 annotation package in model imports #23406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/kotlin-spring/homeController.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import org.springframework.context.annotation.Bean
import org.springframework.stereotype.Controller
import org.springframework.web.bind.annotation.RequestMapping
{{#sourceDocumentationProvider}}
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper
import {{jacksonPackage}}.dataformat.yaml.YAMLMapper
import org.springframework.beans.factory.annotation.Value
import org.springframework.core.io.Resource
import org.springframework.util.StreamUtils
Expand Down
7 changes: 4 additions & 3 deletions ...rator/src/main/resources/kotlin-spring/libraries/spring-boot/buildGradle-sb4-Kts.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,10 @@ dependencies {

implementation("com.google.code.findbugs:jsr305:3.0.2")
{{#useJackson3}}
implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
implementation("tools.jackson.dataformat:jackson-dataformat-xml")
implementation("tools.jackson.module:jackson-module-kotlin")
val jackson3Version = "3.1.0"
implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jackson3Version")
implementation("tools.jackson.dataformat:jackson-dataformat-xml:$jackson3Version")
implementation("tools.jackson.module:jackson-module-kotlin:$jackson3Version")
{{/useJackson3}}
{{^useJackson3}}
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")
Expand Down
25 changes: 22 additions & 3 deletions ...openapi-generator/src/main/resources/kotlin-spring/libraries/spring-boot/pom-sb4.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
<swagger-ui.version>5.17.14</swagger-ui.version>{{/springDocDocumentationProvider}}{{/useSwaggerUI}}{{^springDocDocumentationProvider}}{{#swagger1AnnotationLibrary}}
<swagger-annotations.version>1.6.6</swagger-annotations.version>{{/swagger1AnnotationLibrary}}{{#swagger2AnnotationLibrary}}
<swagger-annotations.version>2.2.28</swagger-annotations.version>{{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>{{#useJackson3}}
<jackson3.version>3.1.0</jackson3.version>{{/useJackson3}}
<jakarta-annotation.version>3.0.0</jakarta-annotation.version>
<kotlin-test-junit5.version>2.2.0</kotlin-test-junit5.version>

Expand Down Expand Up @@ -158,22 +159,40 @@
<artifactId>jsr305</artifactId>
<version>${findbugs-jsr305.version}</version>
</dependency>
{{#useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>{{^useJackson3}}
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
<version>${jackson3.version}</version>
</dependency>
{{/useJackson3}}{{^useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
</dependency>{{/useJackson3}}
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
</dependency>
{{/useJackson3}}
{{#useBeanValidation}}
<!-- Bean Validation API support -->
<dependency>
Expand Down
7 changes: 4 additions & 3 deletions ...ator/src/main/resources/kotlin-spring/libraries/spring-cloud/buildGradle-sb4-Kts.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ dependencies {

implementation("com.google.code.findbugs:jsr305:3.0.2")
{{#useJackson3}}
implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
implementation("tools.jackson.dataformat:jackson-dataformat-xml")
implementation("tools.jackson.module:jackson-module-kotlin")
val jackson3Version = "3.1.0"
implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jackson3Version")
implementation("tools.jackson.dataformat:jackson-dataformat-xml:$jackson3Version")
implementation("tools.jackson.module:jackson-module-kotlin:$jackson3Version")
{{/useJackson3}}
{{^useJackson3}}
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")
Expand Down
25 changes: 22 additions & 3 deletions ...penapi-generator/src/main/resources/kotlin-spring/libraries/spring-cloud/pom-sb4.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
</swagger-annotations.version>{{/swagger1AnnotationLibrary}}{{#swagger2AnnotationLibrary}}
<swagger-annotations.version>2.2.28
</swagger-annotations.version>{{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>{{#useJackson3}}
<jackson3.version>3.1.0</jackson3.version>{{/useJackson3}}
<jakarta-annotation.version>3.0.0</jakarta-annotation.version>
<kotlin-test-junit5.version>2.2.0</kotlin-test-junit5.version>

Expand Down Expand Up @@ -183,22 +184,40 @@
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
{{/hasAuthMethods}}
{{#useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>{{^useJackson3}}
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
<version>${jackson3.version}</version>
</dependency>
{{/useJackson3}}{{^useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
</dependency>{{/useJackson3}}
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
</dependency>
{{/useJackson3}}
{{#useBeanValidation}}
<!-- Bean Validation API support -->
<dependency>
Expand Down
7 changes: 4 additions & 3 deletions ...es/kotlin-spring/libraries/spring-declarative-http-interface/buildGradle-sb4-Kts.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ dependencies {

implementation("com.google.code.findbugs:jsr305:3.0.2")
{{#useJackson3}}
implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
implementation("tools.jackson.dataformat:jackson-dataformat-xml")
implementation("tools.jackson.module:jackson-module-kotlin")
val jackson3Version = "3.1.0"
implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jackson3Version")
implementation("tools.jackson.dataformat:jackson-dataformat-xml:$jackson3Version")
implementation("tools.jackson.module:jackson-module-kotlin:$jackson3Version")
{{/useJackson3}}
{{^useJackson3}}
implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml")
Expand Down
25 changes: 22 additions & 3 deletions ...main/resources/kotlin-spring/libraries/spring-declarative-http-interface/pom-sb4.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
</swagger-annotations.version>{{/swagger1AnnotationLibrary}}{{#swagger2AnnotationLibrary}}
<swagger-annotations.version>2.2.28
</swagger-annotations.version>{{/swagger2AnnotationLibrary}}{{/springDocDocumentationProvider}}
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>{{#useJackson3}}
<jackson3.version>3.1.0</jackson3.version>{{/useJackson3}}
<jakarta-annotation.version>3.0.0</jakarta-annotation.version>
<kotlin-test-junit5.version>2.2.0</kotlin-test-junit5.version>

Expand Down Expand Up @@ -179,22 +180,40 @@
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
{{/hasAuthMethods}}
{{#useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>{{^useJackson3}}
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
<version>${jackson3.version}</version>
</dependency>
{{/useJackson3}}{{^useJackson3}}
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
</dependency>{{/useJackson3}}
</dependency>
<dependency>
<groupId>{{jacksonPackage}}.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
</dependency>
{{/useJackson3}}
{{#useBeanValidation}}
<!-- Bean Validation API support -->
<dependency>
Expand Down
36 changes: 36 additions & 0 deletions ...r/src/test/java/org/openapitools/codegen/kotlin/spring/KotlinSpringServerCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4825,6 +4825,42 @@ public void shouldGenerateSpringBoot4PomWithJackson3Deps() throws IOException {
assertFileNotContains(pomPath, "com.fasterxml.jackson.module");
}

@Test
public void shouldGenerateJackson3BuildDepsWithVersions() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();
String outputPath = output.getAbsolutePath().replace('\\', '/');

final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/petstore.yaml");
final KotlinSpringServerCodegen codegen = new KotlinSpringServerCodegen();
codegen.setOpenAPI(openAPI);
codegen.setOutputDir(output.getAbsolutePath());

codegen.additionalProperties().put(KotlinSpringServerCodegen.USE_SPRING_BOOT4, "true");
codegen.additionalProperties().put(AbstractKotlinCodegen.USE_JACKSON_3, "true");
codegen.additionalProperties().put(DOCUMENTATION_PROVIDER, DocumentationProvider.NONE.toCliOptValue());
codegen.additionalProperties().put(ANNOTATION_LIBRARY, AnnotationLibrary.NONE.toCliOptValue());

ClientOptInput input = new ClientOptInput();
input.openAPI(openAPI);
input.config(codegen);

DefaultGenerator generator = new DefaultGenerator();
generator.setGenerateMetadata(false);
generator.opts(input).generate();

// Gradle build file must have Jackson 3 deps with explicit versions
Path gradlePath = Paths.get(outputPath + "/build.gradle.kts");
assertFileContains(gradlePath, "tools.jackson.dataformat:jackson-dataformat-yaml:");
assertFileContains(gradlePath, "tools.jackson.module:jackson-module-kotlin:");
// Should NOT include non-existent tools.jackson.core:jackson-annotations
assertFileNotContains(gradlePath, "tools.jackson.core:jackson-annotations");

// Annotations stay in com.fasterxml.jackson.annotation even with Jackson 3
Path petModelPath = Paths.get(outputPath + "/src/main/kotlin/org/openapitools/model/Pet.kt");
assertFileContains(petModelPath, "com.fasterxml.jackson.annotation.JsonProperty");
}

@Test
public void shouldDefaultToJackson3WhenSpringBoot4Enabled() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
Expand Down
7 changes: 4 additions & 3 deletions samples/server/petstore/kotlin-springboot-4/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@ dependencies {
implementation("org.springframework.boot:spring-boot-starter-webmvc")

implementation("com.google.code.findbugs:jsr305:3.0.2")
implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
implementation("tools.jackson.dataformat:jackson-dataformat-xml")
implementation("tools.jackson.module:jackson-module-kotlin")
val jackson3Version = "3.1.0"
implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jackson3Version")
implementation("tools.jackson.dataformat:jackson-dataformat-xml:$jackson3Version")
implementation("tools.jackson.module:jackson-module-kotlin:$jackson3Version")
implementation("org.springframework.data:spring-data-commons")
implementation("jakarta.validation:jakarta.validation-api")
implementation("jakarta.annotation:jakarta.annotation-api:3.0.0")
Expand Down
4 changes: 4 additions & 0 deletions samples/server/petstore/kotlin-springboot-4/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
<version>1.0.0</version>
<properties>
<findbugs-jsr305.version>3.0.2</findbugs-jsr305.version>
<jackson3.version>3.1.0</jackson3.version>
<jakarta-annotation.version>3.0.0</jakarta-annotation.version>
<kotlin-test-junit5.version>2.2.0</kotlin-test-junit5.version>

Expand Down Expand Up @@ -101,14 +102,17 @@
<dependency>
<groupId>tools.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>tools.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
<version>${jackson3.version}</version>
</dependency>
<dependency>
<groupId>tools.jackson.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
<version>${jackson3.version}</version>
</dependency>
<!-- Bean Validation API support -->
<dependency>
Expand Down
Loading