Merge pull request #12 from quarkiverse/issue-7

Fix #7 - Correct handling paths on Windows machines

Author: ricardozanini

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

@@ -2,7 +2,7 @@
 
 import static io.quarkiverse.openapi.generator.deployment.OpenApiGeneratorConfiguration.CONFIG_PREFIX;
 
-import java.nio.file.Paths;
+import java.nio.file.Path;
 
 import io.quarkus.runtime.annotations.ConfigGroup;
 import io.quarkus.runtime.annotations.ConfigItem;
@@ -11,6 +11,7 @@
 public class SpecConfig {
     public static final String API_PKG_SUFFIX = ".api";
     public static final String MODEL_PKG_SUFFIX = ".model";
+    static final String BASE_PACKAGE_PROP_FORMAT = CONFIG_PREFIX + ".spec.\"%s\".base-package";
 
     /**
      * Defines the base package name for the generated classes.
@@ -26,8 +27,9 @@ public String getModelPackage() {
         return String.format("%s%s", basePackage, MODEL_PKG_SUFFIX);
     }
 
-    public static String getResolvedBasePackageProperty(final String openApiFilePath) {
-        final String fileName = Paths.get(openApiFilePath).getFileName().toString();
-        return CONFIG_PREFIX + ".spec.\"" + fileName + "\"" + ".base-package";
+    public static String getResolvedBasePackageProperty(final Path openApiFilePath) {
+        final String uriFilePath = openApiFilePath.toUri().toString();
+        final String fileName = uriFilePath.substring(uriFilePath.lastIndexOf("/") + 1);
+        return String.format(BASE_PACKAGE_PROP_FORMAT, fileName);
     }
 }

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

@@ -42,12 +42,11 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
                         .filter(Files::isRegularFile)
                         .map(Path::toString)
                         .filter(s -> s.endsWith(this.inputExtension()))
-                        .map(this::encodeURISpaces)
-                        .forEach(openApiFilePath -> {
+                        .map(Path::of).forEach(openApiFilePath -> {
                             final String basePackage = getRequiredIndexedProperty(
                                     getResolvedBasePackageProperty(openApiFilePath), context);
                             final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
-                                    "file:" + openApiFilePath, outDir.toString())
+                                    openApiFilePath.normalize(), outDir)
                                             .withApiPackage(basePackage + API_PKG_SUFFIX)
                                             .withModelPackage(basePackage + MODEL_PKG_SUFFIX);
                             generator.generate();
@@ -61,13 +60,6 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         return false;
     }
 
-    private String encodeURISpaces(String path) {
-        // the underlying swagger parser library handles the path as a URI, and in previous versions (the one used by the openapi-generator)
-        // it has a bug, not handling these paths correctly. That's why we manually encode the paths here, so the file can be accessible and validated against
-        // these libraries
-        return path.replaceAll(" ", "%20");
-    }
-
     private String getRequiredIndexedProperty(final String propertyKey, final CodeGenContext context) {
         // this is how we get a required property. The configSource will handle the exception for us.
         return context.config().getValue(propertyKey, String.class);

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

@@ -4,6 +4,7 @@
 import static java.lang.Boolean.TRUE;
 
 import java.io.File;
+import java.nio.file.Path;
 import java.util.List;
 
 import org.openapitools.codegen.CodegenConstants;
@@ -25,7 +26,7 @@ public class OpenApiClientGeneratorWrapper {
     private final QuarkusCodegenConfigurator configurator;
     private final DefaultGenerator generator;
 
-    public OpenApiClientGeneratorWrapper(final String specFilePath, final String outputDir) {
+    public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputDir) {
         // do not generate docs nor tests
         GlobalSettings.setProperty(CodegenConstants.API_DOCS, FALSE.toString());
         GlobalSettings.setProperty(CodegenConstants.API_TESTS, FALSE.toString());
@@ -41,8 +42,8 @@ public OpenApiClientGeneratorWrapper(final String specFilePath, final String out
         GlobalSettings.setProperty(ONCE_LOGGER, TRUE.toString());
 
         this.configurator = new QuarkusCodegenConfigurator();
-        this.configurator.setInputSpec(specFilePath);
-        this.configurator.setOutputDir(outputDir);
+        this.configurator.setInputSpec(specFilePath.toString());
+        this.configurator.setOutputDir(outputDir.toString());
         this.generator = new DefaultGenerator();
     }
 

deployment/src/test/java/io/quarkiverse/openapi/generator/deployment/SpecConfigTest.java

@@ -0,0 +1,26 @@
+package io.quarkiverse.openapi.generator.deployment;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.nio.file.Path;
+
+import org.junit.jupiter.api.Test;
+
+class SpecConfigTest {
+
+    @Test
+    void verifySpaceEncoding() {
+        final String resolvedBasePackageProperty = SpecConfig
+                .getResolvedBasePackageProperty(Path.of("/home/myuser/luke/my test openapi.json"));
+        assertEquals(resolvedBasePackageProperty,
+                String.format(SpecConfig.BASE_PACKAGE_PROP_FORMAT, "my%20test%20openapi.json"));
+    }
+
+    @Test
+    void withSingleFileName() {
+        final String resolvedBasePackageProperty = SpecConfig.getResolvedBasePackageProperty(Path.of("my test openapi.json"));
+        assertEquals(resolvedBasePackageProperty,
+                String.format(SpecConfig.BASE_PACKAGE_PROP_FORMAT, "my%20test%20openapi.json"));
+    }
+
+}

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

@@ -1,27 +1,31 @@
 package io.quarkiverse.openapi.generator.deployment.wrapper;
 
+import static java.util.Objects.requireNonNull;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import java.io.File;
 import java.net.URISyntaxException;
+import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.List;
-import java.util.Objects;
 
 import org.junit.jupiter.api.Test;
 
 public class OpenApiClientGeneratorWrapperTest {
 
     @Test
     void generatePetStore() throws URISyntaxException {
-        final String petstoreOpenApi = Objects.requireNonNull(this.getClass().getResource("/openapi/petstore-openapi.json"))
-                .getPath();
-        final String targetPath = Paths.get(Objects.requireNonNull(getClass().getResource("/")).toURI()).getParent().toString()
-                + "/openapi-gen";
+        final Path petstoreOpenApi = Path
+                .of(requireNonNull(this.getClass().getResource("/openapi/petstore-openapi.json")).toURI());
+        final Path targetPath = Paths.get(getTargetDir(), "openapi-gen");
         final OpenApiClientGeneratorWrapper generatorWrapper = new OpenApiClientGeneratorWrapper(petstoreOpenApi, targetPath);
         final List<File> generatedFiles = generatorWrapper.generate();
         assertNotNull(generatedFiles);
         assertFalse(generatedFiles.isEmpty());
     }
+
+    private String getTargetDir() throws URISyntaxException {
+        return Paths.get(requireNonNull(getClass().getResource("/")).toURI()).getParent().toString();
+    }
 }

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

@@ -1,3 +1,4 @@
 quarkus.openapi-generator.spec."petstore.json".base-package=org.acme.openapi
 # since the file name has a space, we use the URI representation of this space here to not break the properties file
+# see the RFC3986 for more info https://datatracker.ietf.org/doc/html/rfc3986
 quarkus.openapi-generator.spec."open%20weather.yaml".base-package=org.acme.openapi.weather