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.

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

Jump to bottom

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has `anyOf` or `oneOf` #18856

Draft

Philzen wants to merge 2 commits into OpenAPITools:master from Philzen:bugfix/18829-AbstractOpenApiSchema-missing-on-default-java-generator-library

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

-Original file line number
+Diff line change
@@ Expand Up / @@ -33,6 +33,7 @@ @@
     import org.openapitools.codegen.model.OperationMap;
     import org.openapitools.codegen.model.OperationsMap;
     import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
+    import org.openapitools.codegen.utils.ModelUtils;
     import org.openapitools.codegen.utils.ProcessUtils;
     import org.slf4j.Logger;
     import org.slf4j.LoggerFactory;
@@ Expand Down Expand Up / @@ -595,9 +596,6 @@ public void processOpts() { @@
                 supportingFiles.add(new SupportingFile("ProgressRequestBody.mustache", invokerFolder, "ProgressRequestBody.java"));
                 supportingFiles.add(new SupportingFile("ProgressResponseBody.mustache", invokerFolder, "ProgressResponseBody.java"));
                 supportingFiles.add(new SupportingFile("GzipRequestInterceptor.mustache", invokerFolder, "GzipRequestInterceptor.java"));
-                if (OKHTTP_GSON.equals(getLibrary())) {
-                    supportingFiles.add(new SupportingFile("AbstractOpenApiSchema.mustache", modelsFolder, "AbstractOpenApiSchema.java"));
-                }
                 // NOTE: below moved to postProcessOperationsWithModels
                 //supportingFiles.add(new SupportingFile("auth/OAuthOkHttpClient.mustache", authFolder, "OAuthOkHttpClient.java"));
@@ Expand Down Expand Up / @@ -626,7 +624,6 @@ public void processOpts() { @@
                 if (ProcessUtils.hasHttpSignatureMethods(openAPI)) {
                     supportingFiles.add(new SupportingFile("auth/HttpSignatureAuth.mustache", authFolder, "HttpSignatureAuth.java"));
                 }
-                supportingFiles.add(new SupportingFile("AbstractOpenApiSchema.mustache", modelsFolder, "AbstractOpenApiSchema.java"));
                 forceSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
                 // Composed schemas can have the 'additionalProperties' keyword, as specified in JSON schema.
@@ Expand All / @@ -643,7 +640,6 @@ public void processOpts() { @@
                 if (ProcessUtils.hasHttpSignatureMethods(openAPI)) {
                     supportingFiles.add(new SupportingFile("auth/HttpSignatureAuth.mustache", authFolder, "HttpSignatureAuth.java"));
                 }
-                supportingFiles.add(new SupportingFile("AbstractOpenApiSchema.mustache", modelsFolder, "AbstractOpenApiSchema.java"));
                 forceSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
                 // Composed schemas can have the 'additionalProperties' keyword, as specified in JSON schema.
@@ Expand All / @@ -656,7 +652,6 @@ public void processOpts() { @@
             } else if (NATIVE.equals(getLibrary())) {
                 supportingFiles.add(new SupportingFile("ApiResponse.mustache", invokerFolder, "ApiResponse.java"));
                 supportingFiles.add(new SupportingFile("JSON.mustache", invokerFolder, "JSON.java"));
-                supportingFiles.add(new SupportingFile("AbstractOpenApiSchema.mustache", modelsFolder, "AbstractOpenApiSchema.java"));
                 forceSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
             } else if (RESTEASY.equals(getLibrary())) {
                 supportingFiles.add(new SupportingFile("JSON.mustache", invokerFolder, "JSON.java"));
@@ Expand All / @@ -678,7 +673,6 @@ public void processOpts() { @@
                 supportingFiles.remove(new SupportingFile("manifest.mustache", projectFolder, "AndroidManifest.xml"));
             } else if (GOOGLE_API_CLIENT.equals(getLibrary())) {
                 forceSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
             } else if (REST_ASSURED.equals(getLibrary())) {
                 if (getSerializationLibrary() == null) {
                     LOGGER.info("No serializationLibrary configured, using '{}' as fallback", SERIALIZATION_LIBRARY_GSON);
@@ Expand Down Expand Up / @@ -802,6 +796,13 @@ public void processOpts() { @@
                     supportingFiles.add(new SupportingFile("auth/ApiErrorDecoder.mustache", authFolder, "ApiErrorDecoder.java"));
                 }
             }
+            if (additionalProperties.getOrDefault(CodegenConstants.GENERATE_MODELS, false).equals(true)
+                && List.of(JERSEY2, JERSEY3, NATIVE, OKHTTP_GSON).contains(getLibrary())
+                && (ProcessUtils.hasAnyOfSchemas(openAPI) || ProcessUtils.hasOneOfSchemas(openAPI))
+            ) {
+                supportingFiles.add(new SupportingFile("AbstractOpenApiSchema.mustache", modelsFolder, "AbstractOpenApiSchema.java"));
+            }
         }
         @Override
@@ Expand Down @@

modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ProcessUtils.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -99,6 +99,14 @@ @@
             return false;
         }
+        public static boolean hasAnyOfSchemas(OpenAPI openAPI) {
+            return openAPI.getComponents().getSchemas().values().stream().anyMatch(ModelUtils::hasAnyOf);
+        }
+        public static boolean hasOneOfSchemas(OpenAPI openAPI) {
+            return openAPI.getComponents().getSchemas().values().stream().anyMatch(ModelUtils::hasOneOf);
+        }
         /**
          * Returns a list of OAS Codegen security objects
          *
@@ Expand Down @@

.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -468,7 +468,7 @@ @@
             validateJavaSourceFiles(files);
             assertThat(output.resolve("src/main/java/zz/yyyy/model/xxxx/SomeObj.java")).content()
                 .contains("public class SomeObj", "Boolean isActive()");
             assertThat(files).hasSize(43).map(File::toPath).contains(
                 output.resolve(".gitignore"),
                 output.resolve(".openapi-generator-ignore"),
                 output.resolve(".openapi-generator/FILES"),
@@ Expand Down Expand Up / @@ -591,7 +591,7 @@ @@
             List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
             assertThat(files).hasSize(35);
             validateJavaSourceFiles(files);
             assertThat(output.resolve("src/main/java/xyz/abcdef/api/PingApi.java")).content().contains(
@@ Expand Down Expand Up / @@ -1156,7 +1156,7 @@ @@
                 .content().contains("class RealCommand {");
             assertThat(output.resolve("src/main/java/org/openapitools/client/model/Command.java"))
                 .content().contains("class Command {");
             assertThat(files).hasSize(49).contains(
                 output.resolve("src/main/java/org/openapitools/client/model/RealCommand.java").toFile(),
                 output.resolve("src/main/java/org/openapitools/client/model/Command.java").toFile()
             );
@@ Expand Down Expand Up / @@ -1366,7 +1366,7 @@ @@
             List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
             validateJavaSourceFiles(files);
             assertThat(files).hasSize(35);
             TestUtils.assertFileContains(output.resolve("src/main/java/xyz/abcdef/ApiClient.java"),
                 "public static String urlEncode(String s) { return URLEncoder.encode(s,"
                     + " UTF_8).replaceAll(\"\\\\+\", \"%20\"); }"
@@ Expand All / @@ -1388,7 +1388,7 @@ @@
             List<File> files = new DefaultGenerator().opts(configurator.toClientOptInput()).generate();
             validateJavaSourceFiles(files);
             assertThat(files).hasSize(38);
             assertThat(output.resolve("src/main/java/xyz/abcdef/api/DefaultApi.java")).content()
                 .contains(
                     "localVarQueryParams.addAll(ApiClient.parameterToPairs(\"since\", queryObject.getSince()));",
@@ Expand Down Expand Up / @@ -2667,6 +2667,48 @@ @@
                 );
         }
+        @DataProvider
+        public static Object[][] librariesWhoseModelsExtendAbstractOpenApiSchema() {
+            return new Object[][]{{"okhttp-gson"}, {"jersey2"}, {"jersey3"}, {"native"}};
+        }
+        /**
+         * Regression test for <a href="https://github.com/OpenAPITools/openapi-generator/issues/18829">#18829</a>
+         */
+        @Test(dataProvider = "librariesWhoseModelsExtendAbstractOpenApiSchema")
+        void doesIncludeAbstractOpenApiSchema_whenOnlyModelsAreGenerated(String library) {
+            final CodegenConfigurator configurator = new CodegenConfigurator()
+                .setGeneratorName("java")
+                .setLibrary(library)
+                .setInputSpec("src/test/resources/3_1/java/petstore.yaml");
+            var generator = new DefaultGenerator(true);
+            generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
+            var files = generator.opts(configurator.toClientOptInput()).generate();
+            assertThat(files).extracting(File::getName).contains("AbstractOpenApiSchema.java");
+        }
+        /**
+         * Regression test for <a href="https://github.com/OpenAPITools/openapi-generator/issues/16257">#16257</a>
+         */
+        @Test(dataProvider = "librariesWhoseModelsExtendAbstractOpenApiSchema")
+        void doesNotIncludeAbstractOpenApiSchema_whenModelsAreNotGenerated(String library) {
+            final CodegenConfigurator configurator = new CodegenConfigurator()
+                .setGeneratorName("java")
+                .setLibrary(library)
+                .setInputSpec("src/test/resources/3_1/java/petstore.yaml");
+            var generator = new DefaultGenerator(true);
+            generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "false");
+            generator.setGeneratorPropertyDefault(CodegenConstants.APIS, "true");
+            generator.setGeneratorPropertyDefault(CodegenConstants.SUPPORTING_FILES, "true");
+            var files = generator.opts(configurator.toClientOptInput()).generate();
+            assertThat(files).extracting(File::getName)
+                .doesNotContain("AbstractOpenApiSchema.java");
+        }
         static private Path newTempFolder() {
             try {
                 var tempDir = Files.createTempDirectory("test");
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has `anyOf` or `oneOf` #18856

Diff view

Diff view

There are no files selected for viewing

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has anyOf or oneOf #18856

Are you sure you want to change the base?

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has anyOf or oneOf #18856

Diff view

Diff view

There are no files selected for viewing

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

GitHub Actions / JUnit Test results

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has `anyOf` or `oneOf` #18856

[JAVA] [jersey2] [jersey3] [okhttp] [native] Fix models-only build broken when schema has `anyOf` or `oneOf` #18856