Adding custom properties to OpenApiSpecInputProvider (#54)

* Adding custom properties to OpenApiSpecInputProvider

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

* Minor changes for comments

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

Author: ricardozanini

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

@@ -1,35 +1,29 @@
 package io.quarkiverse.openapi.generator.deployment;
 
 import java.nio.file.Path;
-import java.util.Collections;
 import java.util.Map;
 
-import io.quarkus.runtime.annotations.ConfigGroup;
 import io.quarkus.runtime.annotations.ConfigItem;
+import io.quarkus.runtime.annotations.ConfigPhase;
 import io.quarkus.runtime.annotations.ConfigRoot;
 
 // This configuration is read in codegen phase (before build time), the annotation is for document purposes and avoiding quarkus warns
-@ConfigGroup
-@ConfigRoot(prefix = SpecConfig.BUILD_TIME_CONFIG_PREFIX)
+@ConfigRoot(name = SpecConfig.BUILD_TIME_CONFIG_PREFIX, phase = ConfigPhase.BUILD_TIME)
 public class SpecConfig {
 
-    public static final String BUILD_TIME_CONFIG_PREFIX = "quarkus.openapi-generator.codegen";
+    static final String BUILD_TIME_CONFIG_PREFIX = "openapi-generator.codegen";
     public static final String API_PKG_SUFFIX = ".api";
     public static final String MODEL_PKG_SUFFIX = ".model";
     // package visibility for unit tests
-    static final String BUILD_TIME_SPEC_PREFIX_FORMAT = BUILD_TIME_CONFIG_PREFIX + ".spec.\"%s\"";
+    static final String BUILD_TIME_SPEC_PREFIX_FORMAT = "quarkus." + BUILD_TIME_CONFIG_PREFIX + ".spec.\"%s\"";
     private static final String BASE_PACKAGE_PROP_FORMAT = "%s.base-package";
     private static final String SKIP_FORM_MODEL_PROP_FORMAT = "%s.skip-form-model";
 
     /**
      * OpenAPI Spec details for codegen configuration.
      */
     @ConfigItem(name = "spec")
-    Map<String, SpecItemConfig> specItem;
-
-    public Map<String, SpecItemConfig> getSpecItem() {
-        return Collections.unmodifiableMap(specItem);
-    }
+    public Map<String, SpecItemConfig> specItem;
 
     public static String resolveApiPackage(final String basePackage) {
         return String.format("%s%s", basePackage, API_PKG_SUFFIX);
@@ -39,7 +33,7 @@ public static String resolveModelPackage(final String basePackage) {
         return String.format("%s%s", basePackage, MODEL_PKG_SUFFIX);
     }
 
-    public static String getResolvedBasePackageProperty(final Path openApiFilePath) {
+    public static String getResolvedBasePackagePropertyName(final Path openApiFilePath) {
         return String.format(BASE_PACKAGE_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
     }
 

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

@@ -1,14 +1,29 @@
 package io.quarkiverse.openapi.generator.deployment;
 
-// Configuration class for documentation purposes
+import java.util.Optional;
+
+import io.quarkus.runtime.annotations.ConfigGroup;
 import io.quarkus.runtime.annotations.ConfigItem;
 
+/*
+ * Model for the configuration of this extension.
+ * It's used for documentation purposes only.
+ * The configuration is consumed in the codegen phase, before build time.
+ * Not meant to be used outside this scope.
+ */
+@ConfigGroup
 public class SpecItemConfig {
 
     /**
      * Base package for where the generated code for the given OpenAPI specification will be added.
      */
-    @ConfigItem
-    String basePackage;
+    @ConfigItem(name = "base-package")
+    public String basePackage;
+
+    /**
+     * Whether to skip the generation of models for form parameters
+     */
+    @ConfigItem(name = "skip-form-model")
+    public Optional<Boolean> skipFormModel;
 
 }

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

@@ -1,13 +1,15 @@
 package io.quarkiverse.openapi.generator.deployment.codegen;
 
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getResolvedBasePackageProperty;
+import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getResolvedBasePackagePropertyName;
 import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getSkipFormModelPropertyName;
 
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.stream.Stream;
 
+import org.eclipse.microprofile.config.Config;
+
 import io.quarkiverse.openapi.generator.deployment.circuitbreaker.CircuitBreakerConfigurationParser;
 import io.quarkiverse.openapi.generator.deployment.wrapper.OpenApiClientGeneratorWrapper;
 import io.quarkus.bootstrap.prebuild.CodeGenException;
@@ -43,7 +45,7 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
                         .map(Path::toString)
                         .filter(s -> s.endsWith(this.inputExtension()))
                         .map(Path::of).forEach(openApiFilePath -> {
-                            this.generate(context, openApiFilePath, outDir);
+                            this.generate(context.config(), openApiFilePath, outDir);
                         });
             } catch (IOException e) {
                 throw new CodeGenException("Failed to generate java files from OpenApi files in " + openApiDir.toAbsolutePath(),
@@ -54,20 +56,18 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         return false;
     }
 
-    protected void generate(CodeGenContext context, final Path openApiFilePath, final Path outDir) {
+    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 = getResolvedBasePackageProperty(openApiFilePath);
+        final String basePackage = getResolvedBasePackagePropertyName(openApiFilePath);
 
         final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
                 openApiFilePath.normalize(), outDir)
-                        .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(context.config(), basePackage))
+                        .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(config, basePackage))
                         .withCircuitBreakerConfiguration(CircuitBreakerConfigurationParser.parse(
-                                context.config()));
-        context.config()
-                .getOptionalValue(basePackage, String.class)
+                                config));
+        config.getOptionalValue(basePackage, String.class)
                 .ifPresent(generator::withBasePackage);
-        context.config()
-                .getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)
+        config.getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)
                 .ifPresent(generator::withSkipFormModelConfig);
 
         generator.generate();

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

@@ -7,16 +7,19 @@
 import java.nio.channels.ReadableByteChannel;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.ServiceLoader;
 import java.util.stream.Collectors;
 
 import org.eclipse.microprofile.config.Config;
+import org.eclipse.microprofile.config.spi.ConfigSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import io.quarkus.bootstrap.prebuild.CodeGenException;
 import io.quarkus.deployment.CodeGenContext;
+import io.smallrye.config.SmallRyeConfigBuilder;
 
 public class OpenApiGeneratorStreamCodeGen extends OpenApiGeneratorCodeGenBase {
 
@@ -55,6 +58,7 @@ public String inputDirectory() {
     @Override
     public boolean trigger(CodeGenContext context) throws CodeGenException {
         final Path outDir = context.outDir();
+
         boolean generated = false;
 
         for (final OpenApiSpecInputProvider provider : this.providers) {
@@ -68,7 +72,7 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
                         FileOutputStream output = new FileOutputStream(openApiFilePath.toString())) {
                     output.getChannel().transferFrom(channel, 0, Integer.MAX_VALUE);
                     LOGGER.debug("Saved OpenAPI spec input model in {}", openApiFilePath);
-                    this.generate(context, openApiFilePath, outDir);
+                    this.generate(this.mergeConfig(context, inputModel), openApiFilePath, outDir);
                     generated = true;
                 } catch (IOException e) {
                     throw new UncheckedIOException("Failed to save InputStream from provider " + provider + " into location ",
@@ -79,6 +83,14 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         return generated;
     }
 
+    private Config mergeConfig(CodeGenContext context, SpecInputModel inputModel) {
+        final List<ConfigSource> sources = new ArrayList<>();
+        context.config().getConfigSources().forEach(sources::add);
+        return new SmallRyeConfigBuilder()
+                .withSources(inputModel.getConfigSource())
+                .withSources(sources).build();
+    }
+
     @Override
     public boolean shouldRun(Path sourceDir, Config config) {
         this.loadServices();

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

@@ -3,12 +3,21 @@
 import static java.util.Objects.requireNonNull;
 
 import java.io.InputStream;
+import java.nio.file.Path;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 
+import org.eclipse.microprofile.config.spi.ConfigSource;
+
+import io.quarkiverse.openapi.generator.deployment.SpecConfig;
+import io.smallrye.config.PropertiesConfigSource;
+
 public class SpecInputModel {
 
     private final InputStream inputStream;
     private final String filename;
+    private final Map<String, String> codegenProperties = new HashMap<>();
 
     public SpecInputModel(final String filename, final InputStream inputStream) {
         requireNonNull(inputStream, "InputStream can't be null");
@@ -17,6 +26,16 @@ public SpecInputModel(final String filename, final InputStream inputStream) {
         this.filename = filename;
     }
 
+    /**
+     * @param filename the name of the file for reference
+     * @param inputStream the content of the spec file
+     * @param basePackageName the name of the package where the files will be generated
+     */
+    public SpecInputModel(final String filename, final InputStream inputStream, final String basePackageName) {
+        this(filename, inputStream);
+        this.codegenProperties.put(SpecConfig.getResolvedBasePackagePropertyName(Path.of(filename)), basePackageName);
+    }
+
     public String getFileName() {
         return filename;
     }
@@ -25,6 +44,10 @@ public InputStream getInputStream() {
         return inputStream;
     }
 
+    public ConfigSource getConfigSource() {
+        return new PropertiesConfigSource(this.codegenProperties, "properties", 0);
+    }
+
     @Override
     public String toString() {
         return "SpecInputModel{" +

integration-tests/generation-input/src/main/java/io/quarkiverse/openapi/generator/codegen/ClassPathPetstoreOpenApiSpecInputProvider.java

@@ -1,6 +1,6 @@
 package io.quarkiverse.openapi.generator.codegen;
 
-import java.util.Collections;
+import java.util.ArrayList;
 import java.util.List;
 
 import io.quarkiverse.openapi.generator.deployment.codegen.OpenApiSpecInputProvider;
@@ -16,8 +16,11 @@ public class ClassPathPetstoreOpenApiSpecInputProvider implements OpenApiSpecInp
 
     @Override
     public List<SpecInputModel> read(CodeGenContext context) {
-        return Collections.singletonList(
-                new SpecInputModel("petstore.json", this.getClass().getResourceAsStream("/specs/petstore.json")));
+        final List<SpecInputModel> inputModels = new ArrayList<>();
+        inputModels.add(new SpecInputModel("petstore.json", this.getClass().getResourceAsStream("/specs/petstore.json")));
+        inputModels.add(new SpecInputModel("subtraction.yaml", this.getClass().getResourceAsStream("/specs/subtraction.yaml"),
+                "org.math"));
+        return inputModels;
     }
 
 }

integration-tests/generation-input/src/main/resources/specs/subtraction.yaml

@@ -0,0 +1,31 @@
+---
+openapi: 3.0.3
+info:
+  title: Generated API
+  version: "1.0"
+paths:
+  /:
+    post:
+      operationId: doOperation
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SubtractionOperation'
+      responses:
+        "200":
+          description: OK
+components:
+  schemas:
+    SubtractionOperation:
+      type: object
+      properties:
+        difference:
+          format: float
+          type: number
+        leftElement:
+          format: float
+          type: number
+        rightElement:
+          format: float
+          type: number

integration-tests/generation-tests/src/main/resources/application.properties

@@ -1,3 +1,6 @@
+quarkus.openapi-generator.codegen.spec."petstore.json".base-package=org.acme.petstore
+# This one is passed through the Classpath source provider. Uncomment to overwrite it
+#quarkus.openapi-generator.codegen.spec."subtraction.yaml".base-package=org.acme.subtraction
 quarkus.oidc-client.client-enabled=false
 # ${keycloak.url} is provided by test-utils
 # petstore_auth is the name of the security scheme from the openapi spec file (petstore.json)

integration-tests/generation-tests/src/test/java/io/quarkiverse/openapi/generator/it/PetStoreTest.java

@@ -6,10 +6,10 @@
 
 import javax.inject.Inject;
 
+import org.acme.petstore.api.PetApi;
+import org.acme.petstore.model.Pet;
 import org.eclipse.microprofile.rest.client.inject.RestClient;
 import org.junit.jupiter.api.Test;
-import org.openapi.quarkus.api.PetApi;
-import org.openapi.quarkus.model.Pet;
 
 import com.github.tomakehurst.wiremock.WireMockServer;
 

integration-tests/generation-tests/src/test/java/io/quarkiverse/openapi/generator/it/WiremockPetStore.java

@@ -29,7 +29,7 @@ public Map<String, String> start() {
                                         "\"name\": \"Bidu\"," +
                                         "\"status\": \"AVAILABLE\"" +
                                         "}")));
-        return Collections.singletonMap("org.openapi.quarkus.api.PetApi/mp-rest/url", wireMockServer.baseUrl());
+        return Collections.singletonMap("org.acme.petstore.api.PetApi/mp-rest/url", wireMockServer.baseUrl());
     }
 
     @Override