Fix #40 - Add verbose codegen configuration and instructions for maven runs (#61)

ricardozanini · web-flow · commit aa866003478d · 2022-05-06T10:19:23.000-03:00
Signed-off-by: Ricardo Zanini &lt;zanini@redhat.com&gt;
diff --git a/README.md b/README.md
@@ -101,6 +101,16 @@ public class PetResource {
 
 See the [integration-tests](integration-tests) module for more information of how to use this extension. Please be advised that the extension is on experimental, early development stage.
 
+## Logging
+
+Since the most part of this extension work is in the `generate-code` execution phase of the Quarkus Maven's plugin, the log configuration must be set in the Maven context. When building your project, add `-Dorg.slf4j.simpleLogger.log.org.openapitools=off` to the `mvn` command to reduce the internal generator noise. For example:
+
+```shell
+ mvn clean install -Dorg.slf4j.simpleLogger.log.org.openapitools=off
+```
+
+For more information, see the [Maven Logging Configuration](https://maven.apache.org/maven-logging.html) guide.
+
 ## Authentication Support
 
 If your OpenAPI specification file has `securitySchemes` [definitions](https://spec.openapis.org/oas/v3.1.0#security-scheme-object), the inner generator
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/CodegenConfig.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/CodegenConfig.java
@@ -9,14 +9,16 @@
 import io.smallrye.config.common.utils.StringUtil;
 
 // This configuration is read in codegen phase (before build time), the annotation is for document purposes and avoiding quarkus warns
-@ConfigRoot(name = SpecConfig.BUILD_TIME_CONFIG_PREFIX, phase = ConfigPhase.BUILD_TIME)
-public class SpecConfig {
+@ConfigRoot(name = CodegenConfig.CODEGEN_TIME_CONFIG_PREFIX, phase = ConfigPhase.BUILD_TIME)
+public class CodegenConfig {
+
+    static final String CODEGEN_TIME_CONFIG_PREFIX = "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";
+    public static final String VERBOSE_PROPERTY_NAME = "quarkus." + CODEGEN_TIME_CONFIG_PREFIX + ".verbose";
     // package visibility for unit tests
-    static final String BUILD_TIME_SPEC_PREFIX_FORMAT = "quarkus." + BUILD_TIME_CONFIG_PREFIX + ".spec.%s";
+    static final String BUILD_TIME_SPEC_PREFIX_FORMAT = "quarkus." + CODEGEN_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";
 
@@ -26,6 +28,12 @@ public class SpecConfig {
     @ConfigItem(name = "spec")
     public Map<String, SpecItemConfig> specItem;
 
+    /**
+     * Whether to log the internal generator codegen process in the default output or not.
+     */
+    @ConfigItem(name = "verbose", defaultValue = "false")
+    public boolean verbose;
+
     public static String resolveApiPackage(final String basePackage) {
         return String.format("%s%s", basePackage, API_PKG_SUFFIX);
     }
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/ModelCodegenConfigParser.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/ModelCodegenConfigParser.java
@@ -1,6 +1,6 @@
 package io.quarkiverse.openapi.generator.deployment.codegen;
 
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveModelPackage;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveModelPackage;
 
 import java.util.HashMap;
 import java.util.List;
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java
@@ -1,11 +1,13 @@
 package io.quarkiverse.openapi.generator.deployment.codegen;
 
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getResolvedBasePackagePropertyName;
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getSkipFormModelPropertyName;
+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.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;
@@ -59,9 +61,11 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
     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);
         final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
-                openApiFilePath.normalize(), outDir)
+                openApiFilePath.normalize(),
+                outDir,
+                verbose.orElse(false))
                         .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(config, basePackage))
                         .withCircuitBreakerConfiguration(CircuitBreakerConfigurationParser.parse(
                                 config));
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/SpecInputModel.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/SpecInputModel.java
@@ -10,7 +10,7 @@
 
 import org.eclipse.microprofile.config.spi.ConfigSource;
 
-import io.quarkiverse.openapi.generator.deployment.SpecConfig;
+import io.quarkiverse.openapi.generator.deployment.CodegenConfig;
 import io.smallrye.config.PropertiesConfigSource;
 
 public class SpecInputModel {
@@ -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(SpecConfig.getResolvedBasePackagePropertyName(Path.of(filename)), basePackageName);
+        this.codegenProperties.put(CodegenConfig.getResolvedBasePackagePropertyName(Path.of(filename)), basePackageName);
     }
 
     public String getFileName() {
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java
@@ -1,8 +1,8 @@
 package io.quarkiverse.openapi.generator.deployment.wrapper;
 
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.getSanitizedFileName;
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveApiPackage;
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveModelPackage;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSanitizedFileName;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveApiPackage;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveModelPackage;
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
 
@@ -25,7 +25,7 @@
  */
 public class OpenApiClientGeneratorWrapper {
 
-    private static final String VERBOSE = "verbose";
+    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";
 
@@ -36,7 +36,7 @@ public class OpenApiClientGeneratorWrapper {
     private String apiPackage = "";
     private String modelPackage = "";
 
-    public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputDir) {
+    public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputDir, final boolean verbose) {
         // do not generate docs nor tests
         GlobalSettings.setProperty(CodegenConstants.API_DOCS, FALSE.toString());
         GlobalSettings.setProperty(CodegenConstants.API_TESTS, FALSE.toString());
@@ -47,8 +47,8 @@ public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputD
         GlobalSettings.setProperty(CodegenConstants.MODELS, "");
         GlobalSettings.setProperty(CodegenConstants.SUPPORTING_FILES, "");
         // logging
-        GlobalSettings.setProperty(VERBOSE, FALSE.toString());
-        GlobalSettings.setProperty(ONCE_LOGGER, TRUE.toString());
+        GlobalSettings.setProperty(VERBOSE, String.valueOf(verbose));
+        GlobalSettings.setProperty(ONCE_LOGGER, verbose ? FALSE.toString() : TRUE.toString());
 
         this.configurator = new QuarkusCodegenConfigurator();
         this.configurator.setInputSpec(specFilePath.toString());
diff --git a/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/QuarkusJavaClientCodegen.java b/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/QuarkusJavaClientCodegen.java
@@ -3,6 +3,7 @@
 import java.io.File;
 
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.JavaClientCodegen;
 import org.openapitools.codegen.utils.ProcessUtils;
 import org.openapitools.codegen.utils.URLPathUtils;
@@ -77,4 +78,12 @@ public void preprocessOpenAPI(OpenAPI openAPI) {
         // add the default server url to the context
         additionalProperties.put(DEFAULT_SERVER_URL, URLPathUtils.getServerURL(this.openAPI, serverVariableOverrides()));
     }
+
+    @Override
+    public void postProcess() {
+        final boolean verbose = Boolean.parseBoolean(GlobalSettings.getProperty(OpenApiClientGeneratorWrapper.VERBOSE));
+        if (verbose) {
+            super.postProcess();
+        }
+    }
 }
diff --git a/deployment/src/main/resources/application.properties b/deployment/src/main/resources/application.properties
@@ -0,0 +1 @@
+quarkus.log.category."org.openapitools".level=OFF
diff --git a/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/CodegenConfigTest.java b/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/CodegenConfigTest.java
@@ -1,24 +1,24 @@
 package io.quarkiverse.openapi.generator.deployment;
 
-import static io.quarkiverse.openapi.generator.deployment.SpecConfig.BUILD_TIME_SPEC_PREFIX_FORMAT;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.BUILD_TIME_SPEC_PREFIX_FORMAT;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.nio.file.Path;
 
 import org.junit.jupiter.api.Test;
 
-class SpecConfigTest {
+class CodegenConfigTest {
 
     @Test
     void verifySpaceEncoding() {
-        final String resolvedPrefix = SpecConfig
+        final String resolvedPrefix = CodegenConfig
                 .getBuildTimeSpecPropertyPrefix(Path.of("/home/myuser/luke/my test openapi.json"));
         assertEquals(resolvedPrefix, String.format(BUILD_TIME_SPEC_PREFIX_FORMAT, "my_test_openapi_json"));
     }
 
     @Test
     void withSingleFileName() {
-        final String resolvedPrefix = SpecConfig.getBuildTimeSpecPropertyPrefix(Path.of("my test openapi.json"));
+        final String resolvedPrefix = CodegenConfig.getBuildTimeSpecPropertyPrefix(Path.of("my test openapi.json"));
         assertEquals(resolvedPrefix, String.format(BUILD_TIME_SPEC_PREFIX_FORMAT, "my_test_openapi_json"));
     }
 
diff --git a/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java b/deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java
@@ -221,7 +221,7 @@ private OpenApiClientGeneratorWrapper createGeneratorWrapper(String specFileName
                 .of(requireNonNull(this.getClass().getResource(String.format("/openapi/%s", specFileName))).toURI());
         final Path targetPath = Paths.get(getTargetDir(), "openapi-gen");
 
-        return new OpenApiClientGeneratorWrapper(openApiSpec, targetPath);
+        return new OpenApiClientGeneratorWrapper(openApiSpec, targetPath, false);
     }
 
     private String getTargetDir() throws URISyntaxException {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+quarkus.log.category."org.openapitools".level=OFF`
Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,7 @@ private OpenApiClientGeneratorWrapper createGeneratorWrapper(String specFileName`
`221`	`221`	`.of(requireNonNull(this.getClass().getResource(String.format("/openapi/%s", specFileName))).toURI());`
`222`	`222`	`final Path targetPath = Paths.get(getTargetDir(), "openapi-gen");`
`223`	`223`
`224`		`- return new OpenApiClientGeneratorWrapper(openApiSpec, targetPath);`
	`224`	`+ return new OpenApiClientGeneratorWrapper(openApiSpec, targetPath, false);`
`225`	`225`	`}`
`226`	`226`
`227`	`227`	`private String getTargetDir() throws URISyntaxException {`