Fix #62 - add filename if using default basePackage (#63)

Signed-off-by: Ricardo Zanini <[email protected]>

Author: ricardozanini

README.md

@@ -55,6 +55,8 @@ To fine tune the configuration for each spec file, add the following entry to yo
 quarkus.openapi-generator.codegen.spec.petstore_json.base-package=org.acme.openapi
 ```
 
+If a base package name is not provided, it will be used the default `org.openapi.quarkus.<filename>`. For example, `org.openapi.quarkus.petstore_json`.
+
 Note that the file name is used to configure the specific information for each spec. We follow the [Environment Variables Mapping Rules](https://github.com/eclipse/microprofile-config/blob/master/spec/src/main/asciidoc/configsources.asciidoc#environment-variables-mapping-rules) from Microprofile Configuration to sanitize the OpenAPI spec filename. Any non-alphabetic characters are replaced by an underscore `_`.
 
 Run `mvn compile` to generate your classes in `target/generated-sources/open-api-json` path:

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/CodegenConfig.java

@@ -42,7 +42,7 @@ public static String resolveModelPackage(final String basePackage) {
         return String.format("%s%s", basePackage, MODEL_PKG_SUFFIX);
     }
 
-    public static String getResolvedBasePackagePropertyName(final Path openApiFilePath) {
+    public static String getBasePackagePropertyName(final Path openApiFilePath) {
         return String.format(BASE_PACKAGE_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
     }
 

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java

@@ -1,13 +1,13 @@
 package io.quarkiverse.openapi.generator.deployment.codegen;
 
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.VERBOSE_PROPERTY_NAME;
-import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getResolvedBasePackagePropertyName;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getBasePackagePropertyName;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSanitizedFileName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSkipFormModelPropertyName;
 
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Optional;
 import java.util.stream.Stream;
 
 import org.eclipse.microprofile.config.Config;
@@ -30,6 +30,8 @@ public abstract class OpenApiGeneratorCodeGenBase implements CodeGenProvider {
     static final String YML = ".yml";
     static final String JSON = ".json";
 
+    private static final String DEFAULT_PACKAGE = "org.openapi.quarkus";
+
     @Override
     public String inputDirectory() {
         return "openapi";
@@ -58,22 +60,27 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         return false;
     }
 
-    protected void generate(Config config, final Path openApiFilePath, final Path outDir) {
-        // TODO: do not generate if the output dir has generated files and the openapi file has the same checksum of the previous run
-        final String basePackage = getResolvedBasePackagePropertyName(openApiFilePath);
-        final Optional<Boolean> verbose = config.getOptionalValue(VERBOSE_PROPERTY_NAME, Boolean.class);
+    // TODO: do not generate if the output dir has generated files and the openapi file has the same checksum of the previous run
+    protected void generate(final Config config, final Path openApiFilePath, final Path outDir) {
+        final String basePackage = getBasePackage(config, openApiFilePath);
+        final Boolean verbose = config.getOptionalValue(VERBOSE_PROPERTY_NAME, Boolean.class).orElse(false);
+
         final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
                 openApiFilePath.normalize(),
                 outDir,
-                verbose.orElse(false))
-                        .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(config, basePackage))
-                        .withCircuitBreakerConfiguration(CircuitBreakerConfigurationParser.parse(
+                verbose)
+                        .withModelCodeGenConfig(ModelCodegenConfigParser.parse(config, basePackage))
+                        .withCircuitBreakerConfig(CircuitBreakerConfigurationParser.parse(
                                 config));
-        config.getOptionalValue(basePackage, String.class)
-                .ifPresent(generator::withBasePackage);
         config.getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)
                 .ifPresent(generator::withSkipFormModelConfig);
 
-        generator.generate();
+        generator.generate(basePackage);
+    }
+
+    private String getBasePackage(final Config config, final Path openApiFilePath) {
+        return config
+                .getOptionalValue(getBasePackagePropertyName(openApiFilePath), String.class)
+                .orElse(String.format("%s.%s", DEFAULT_PACKAGE, getSanitizedFileName(openApiFilePath)));
     }
 }

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/SpecInputModel.java

@@ -33,7 +33,7 @@ public SpecInputModel(final String filename, final InputStream inputStream) {
      */
     public SpecInputModel(final String filename, final InputStream inputStream, final String basePackageName) {
         this(filename, inputStream);
-        this.codegenProperties.put(CodegenConfig.getResolvedBasePackagePropertyName(Path.of(filename)), basePackageName);
+        this.codegenProperties.put(CodegenConfig.getBasePackagePropertyName(Path.of(filename)), basePackageName);
     }
 
     public String getFileName() {

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java

@@ -5,6 +5,7 @@
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveModelPackage;
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
+import static java.util.Objects.requireNonNull;
 
 import java.io.File;
 import java.nio.file.Path;
@@ -27,12 +28,11 @@ public class OpenApiClientGeneratorWrapper {
 
     public static final String VERBOSE = "verbose";
     private static final String ONCE_LOGGER = "org.openapitools.codegen.utils.oncelogger.enabled";
-    private static final String DEFAULT_PACKAGE = "org.openapi.quarkus";
 
     private final QuarkusCodegenConfigurator configurator;
     private final DefaultGenerator generator;
 
-    private String basePackage = DEFAULT_PACKAGE;
+    private String basePackage = "";
     private String apiPackage = "";
     private String modelPackage = "";
 
@@ -68,25 +68,20 @@ public OpenApiClientGeneratorWrapper withModelPackage(final String pkg) {
         return this;
     }
 
-    public OpenApiClientGeneratorWrapper withBasePackage(final String pkg) {
-        this.basePackage = pkg;
-        return this;
-    }
-
     /**
      * Adds the circuit breaker configuration to the generator.
      *
      * @param config a map of class names and their methods that should be configured with circuit breaker
      * @return this wrapper
      */
-    public OpenApiClientGeneratorWrapper withCircuitBreakerConfiguration(final Map<String, List<String>> config) {
+    public OpenApiClientGeneratorWrapper withCircuitBreakerConfig(final Map<String, List<String>> config) {
         if (config != null) {
             configurator.addAdditionalProperty("circuit-breaker", config);
         }
         return this;
     }
 
-    public OpenApiClientGeneratorWrapper withModelCodeGenConfiguration(final Map<String, Object> config) {
+    public OpenApiClientGeneratorWrapper withModelCodeGenConfig(final Map<String, Object> config) {
         if (config != null) {
             configurator.addAdditionalProperty("model-codegen", config);
         }
@@ -104,14 +99,16 @@ public OpenApiClientGeneratorWrapper withSkipFormModelConfig(final String skipFo
         return this;
     }
 
-    public List<File> generate() {
+    public List<File> generate(final String basePackage) {
+        this.basePackage = basePackage;
         this.consolidatePackageNames();
         return generator.opts(configurator.toClientOptInput()).generate();
     }
 
     private void consolidatePackageNames() {
+        requireNonNull(basePackage);
         if (basePackage.isEmpty()) {
-            basePackage = DEFAULT_PACKAGE;
+            throw new IllegalArgumentException("basePackage must be a non-empty String");
         }
         if (apiPackage.isEmpty()) {
             this.apiPackage = resolveApiPackage(basePackage);

deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java

@@ -34,28 +34,27 @@ public class OpenApiClientGeneratorWrapperTest {
 
     @Test
     void verifyCommonGenerated() throws URISyntaxException {
-        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi.json").generate();
+        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi.json").generate("org.petstore");
         assertNotNull(generatedFiles);
         assertFalse(generatedFiles.isEmpty());
     }
 
     @Test
     void verifyAuthBasicGenerated() throws URISyntaxException {
-        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi-httpbasic.json").generate();
+        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi-httpbasic.json").generate("org.petstore");
         assertTrue(generatedFiles.stream().anyMatch(f -> f.getName().equals("CompositeAuthenticationProvider.java")));
     }
 
     @Test
     void verifyAuthBearerGenerated() throws URISyntaxException {
-        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi-bearer.json").generate();
+        final List<File> generatedFiles = createGeneratorWrapper("petstore-openapi-bearer.json").generate("org.petstore");
         assertTrue(generatedFiles.stream().anyMatch(f -> f.getName().equals("CompositeAuthenticationProvider.java")));
     }
 
     @Test
     void verifyEnumGeneration() throws URISyntaxException, FileNotFoundException {
         final List<File> generatedFiles = createGeneratorWrapper("issue-28.yaml")
-                .withBasePackage("org.issue28")
-                .generate();
+                .generate("org.issue28");
         final Optional<File> enumFile = generatedFiles.stream()
                 .filter(f -> f.getName().endsWith("ConnectorNamespaceState.java")).findFirst();
         assertThat(enumFile).isPresent();
@@ -73,9 +72,8 @@ void verifyDeprecatedFields() throws URISyntaxException, FileNotFoundException {
         final Map<String, Object> codegenConfig = ModelCodegenConfigParser
                 .parse(MockConfigUtils.getTestConfig("/codegen/application.properties"), "org.issue38");
         final List<File> generatedFiles = this.createGeneratorWrapper("issue-38.yaml")
-                .withBasePackage("org.issue38")
-                .withModelCodeGenConfiguration(codegenConfig)
-                .generate();
+                .withModelCodeGenConfig(codegenConfig)
+                .generate("org.issue38");
 
         // we have two attributes that will be generated with the same name, one of them is deprecated
         final Optional<File> metaV1Condition = generatedFiles.stream()
@@ -158,7 +156,7 @@ void checkAnnotations() throws URISyntaxException, FileNotFoundException {
     void verifyMultipartFormAnnotationIsGeneratedForParameter() throws URISyntaxException, FileNotFoundException {
         List<File> generatedFiles = createGeneratorWrapper("multipart-openapi.yml")
                 .withSkipFormModelConfig("false")
-                .generate();
+                .generate("org.acme");
         assertThat(generatedFiles).isNotEmpty();
 
         Optional<File> file = generatedFiles.stream()
@@ -186,7 +184,7 @@ void verifyMultipartFormAnnotationIsGeneratedForParameter() throws URISyntaxExce
     void verifyMultipartPojoGeneratedAndFieldsHaveAnnotations() throws URISyntaxException, FileNotFoundException {
         List<File> generatedFiles = createGeneratorWrapper("multipart-openapi.yml")
                 .withSkipFormModelConfig("false")
-                .generate();
+                .generate("org.acme");
         assertFalse(generatedFiles.isEmpty());
 
         Optional<File> file = generatedFiles.stream()
@@ -210,10 +208,10 @@ void verifyMultipartPojoGeneratedAndFieldsHaveAnnotations() throws URISyntaxExce
 
     private List<File> generateRestClientFiles() throws URISyntaxException {
         OpenApiClientGeneratorWrapper generatorWrapper = createGeneratorWrapper("simple-openapi.json")
-                .withCircuitBreakerConfiguration(Map.of(
+                .withCircuitBreakerConfig(Map.of(
                         "org.openapitools.client.api.DefaultApi", List.of("opThatDoesNotExist", "byeGet")));
 
-        return generatorWrapper.generate();
+        return generatorWrapper.generate("org.openapitools.client");
     }
 
     private OpenApiClientGeneratorWrapper createGeneratorWrapper(String specFileName) throws URISyntaxException {

integration-tests/example-project/src/main/resources/application.properties

@@ -8,7 +8,6 @@ quarkus.openapi-generator.codegen.spec.open_weather_yaml.base-package=org.acme.o
 # Authentication properties
 org.acme.openapi.weather.security.auth.app_id/api-key=12345
 
-quarkus.openapi-generator.codegen.spec.simple_openapi_json.base-package=org.acme.openapi.simple
 
 org.acme.openapi.simple.api.DefaultApi/byeGet/CircuitBreaker/enabled=true
 org.acme.openapi.simple.api.DefaultApi/byeGet/CircuitBreaker/failOn = java.lang.IllegalArgumentException,java.lang.NullPointerException

integration-tests/example-project/src/test/java/io/quarkiverse/openapi/generator/it/SimpleOpenApiTest.java

@@ -21,8 +21,8 @@ class SimpleOpenApiTest {
 
     @Test
     void circuitBreaker() throws IOException {
-        Path generatedRestClient = Paths.get("target", "generated-sources", "open-api-json", "org", "acme",
-                "openapi", "simple", "api", "DefaultApi.java");
+        Path generatedRestClient = Paths.get("target", "generated-sources", "open-api-json", "org", "openapi",
+                "quarkus", "simple_openapi_json", "api", "DefaultApi.java");
 
         assertThat(generatedRestClient)
                 .exists()