feat(#1156): generate Java models alongside citrus classes

citrusframework · Oct 21, 2024 · 9922960 · 9922960
1 parent c5005e6
commit 9922960
Show file tree

Hide file tree

Showing 49 changed files with 2,203 additions and 611 deletions.
diff --git a/test-api-generator/citrus-test-api-generator-core/pom.xml b/test-api-generator/citrus-test-api-generator-core/pom.xml
@@ -17,6 +17,10 @@
     <name>Citrus :: Test API Generator :: Core</name>
     <description>Generates a Citrus Test-API for OpenAPI and WSDL specifications.</description>
 
+    <properties>
+        <openapi-java-folder>${project.build.directory}/openapi-java-resources</openapi-java-folder>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>org.citrusframework</groupId>
@@ -118,6 +122,64 @@
                 </executions>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-dependency-plugin</artifactId>
+                <version>3.7.1</version>
+                <configuration>
+                    <artifactItems>
+                        <artifactItem>
+                            <groupId>org.openapitools</groupId>
+                            <artifactId>openapi-generator</artifactId>
+                            <version>${org.openapitools.version}</version>
+                            <includes>Java/*Annotation*.mustache,Java/*Model*.mustache,Java/model*.mustache,Java/pojo*.mustache</includes>
+                        </artifactItem>
+                    </artifactItems>
+                    <outputDirectory>
+                        ${openapi-java-folder}
+                    </outputDirectory>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>unpack-java-templates</id>
+                        <phase>generate-resources</phase>
+                        <goals>
+                            <goal>unpack</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-resources-plugin</artifactId>
+            <version>3.3.1</version>
+                <executions>
+                    <execution>
+                        <id>prepare-java-templates</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.outputDirectory}/java-citrus</outputDirectory>
+                            <resources>
+                                <resource>
+                                    <directory>
+                                        ${openapi-java-folder}/Java
+                                    </directory>
+                                    <includes>
+                                        <include>
+                                            *.mustache
+                                        </include>
+                                    </includes>
+                                </resource>
+                            </resources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.openapitools</groupId>
                 <artifactId>openapi-generator-maven-plugin</artifactId>

diff --git a/...generator-core/src/main/java/org/citrusframework/openapi/generator/JavaCitrusCodegen.java b/...generator-core/src/main/java/org/citrusframework/openapi/generator/JavaCitrusCodegen.java
@@ -85,6 +85,7 @@ public JavaCitrusCodegen() {
 
         // set default
         additionalProperties.put(API_TYPE, API_TYPE_REST);
+        additionalProperties.put("useJakartaEe", true);
 
         // add additional reserved words used in CitrusAbstractTestRequest and its base class to prevent name collisions
         Set<String> reservedWordsTemp = reservedWords();
@@ -119,8 +120,7 @@ public JavaCitrusCodegen() {
             newString(API_ENDPOINT,
             "Which http client should be used (default " + httpClient + ")."));
         cliOptions.add(
-            newString(
-                API_TYPE,
+            newString(API_TYPE,
                 "Specifies the type of API to be generated specify SOAP to generate a SOAP API. By default a REST API will be generated"
             )
         );
@@ -135,10 +135,8 @@ public JavaCitrusCodegen() {
             newString(OPENAPI_SCHEMA,
             "Which OpenAPI schema should be used (default " + openapiSchema + ")."));
         cliOptions.add(
-            newString(
-                PREFIX,
-                "Add a prefix before the name of the files. First character should be upper case (default "
-                    + apiPrefix + ")."
+            newString(PREFIX,
+                "Add a prefix before the name of the files. First character should be upper case (default " + apiPrefix + ")."
             )
         );
         cliOptions.add(newString(PREFIX, "The api prefix (default " + apiPrefix + ")."));

diff --git a/...-api-generator/citrus-test-api-generator-core/src/main/resources/java-citrus/api.mustache b/...-api-generator/citrus-test-api-generator-core/src/main/resources/java-citrus/api.mustache
@@ -1,28 +1,7 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{package}};
 
-import jakarta.annotation.Generated;
 import org.citrusframework.testapi.GeneratedApi;
 import org.citrusframework.testapi.GeneratedApiRequest;
 import jakarta.servlet.http.Cookie;
@@ -52,7 +31,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
 
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public class {{classname}} implements GeneratedApi
 {
 

diff --git a/...generator/citrus-test-api-generator-core/src/main/resources/java-citrus/api_soap.mustache b/...generator/citrus-test-api-generator-core/src/main/resources/java-citrus/api_soap.mustache
@@ -1,28 +1,7 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{package}};
 
-import jakarta.annotation.Generated;
 import java.io.IOException;
 import java.util.HashMap;
 import java.util.Map;
@@ -45,7 +24,7 @@ import org.springframework.util.CollectionUtils;
 
 import {{invokerPackage}}.citrus.{{prefix}}AbstractTestRequest;
 
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public class {{classname}} implements GeneratedApi
 {
     public static final {{classname}} INSTANCE = new {{classname}}();

diff --git a/...citrus-test-api-generator-core/src/main/resources/java-citrus/bean_configuration.mustache b/...citrus-test-api-generator-core/src/main/resources/java-citrus/bean_configuration.mustache
@@ -1,24 +1,4 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{invokerPackage}}.spring;
 
@@ -29,13 +9,12 @@ import static org.springframework.beans.factory.config.BeanDefinition.SCOPE_PROT
 import {{package}}.{{classname}};
 {{/apis}}
 {{/apiInfo}}
-import javax.annotation.processing.Generated;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Scope;
 
 @Configuration
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public class {{prefix}}BeanConfiguration {
 {{#apiInfo}}
     {{#apis}}

diff --git a/...us-test-api-generator-core/src/main/resources/java-citrus/bean_definition_parser.mustache b/...us-test-api-generator-core/src/main/resources/java-citrus/bean_definition_parser.mustache
@@ -1,24 +1,4 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{invokerPackage}}.citrus;
 
@@ -28,8 +8,6 @@ import java.util.Map;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import javax.annotation.processing.Generated;
-
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
@@ -42,7 +20,7 @@ import org.w3c.dom.Attr;
 import org.w3c.dom.Element;
 import org.w3c.dom.NamedNodeMap;
 
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public class {{prefix}}BeanDefinitionParser implements BeanDefinitionParser {
 
     private static final String COOKIE = "cookie";

diff --git a/...erator/citrus-test-api-generator-core/src/main/resources/java-citrus/licenseInfo.mustache b/...erator/citrus-test-api-generator-core/src/main/resources/java-citrus/licenseInfo.mustache
@@ -0,0 +1,15 @@
+/*
+* Copyright the original author or authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
diff --git a/...pi-generator/citrus-test-api-generator-core/src/main/resources/java-citrus/model.mustache b/...pi-generator/citrus-test-api-generator-core/src/main/resources/java-citrus/model.mustache
diff --git a/...enerator/citrus-test-api-generator-core/src/main/resources/java-citrus/model_doc.mustache b/...enerator/citrus-test-api-generator-core/src/main/resources/java-citrus/model_doc.mustache
diff --git a/.../citrus-test-api-generator-core/src/main/resources/java-citrus/namespace_handler.mustache b/.../citrus-test-api-generator-core/src/main/resources/java-citrus/namespace_handler.mustache
@@ -1,24 +1,4 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{invokerPackage}}.citrus.extension;
 
@@ -29,11 +9,9 @@ import {{package}}.{{classname}};
 {{/apiInfo}}
 import {{invokerPackage}}.citrus.{{prefix}}BeanDefinitionParser;
 
-import javax.annotation.processing.Generated;
-
 import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
 
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public class {{prefix}}NamespaceHandler extends NamespaceHandlerSupport {
 
     @Override

diff --git a/...enerator/citrus-test-api-generator-core/src/main/resources/java-citrus/test_base.mustache b/...enerator/citrus-test-api-generator-core/src/main/resources/java-citrus/test_base.mustache
@@ -1,30 +1,9 @@
-/*
- * Copyright the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * ==================================================
- * GENERATED CLASS, ALL CHANGES WILL BE LOST
- * ==================================================
- */
+{{>licenseInfo}}
 
 package {{invokerPackage}}.citrus;
 
 import static org.springframework.util.CollectionUtils.isEmpty;
 
-import jakarta.annotation.Generated;
 import jakarta.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
@@ -51,7 +30,7 @@ import org.slf4j.MarkerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 
-@Generated(value = "org.citrusframework.openapi.generator.JavaCitrusCodegen")
+{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
 public abstract class {{prefix}}AbstractTestRequest extends AbstractTestAction {
 
     protected final Marker coverageMarker = MarkerFactory.getMarker("{{#lambda.uppercase}}{{prefix}}{{/lambda.uppercase}}-API-COVERAGE");