Merge pull request #13 from openapi-processor/build-matrix

windows fixes

Author: hauner

.github/workflows/ci.yaml

@@ -10,7 +10,11 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+#    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
 
     steps:
     - uses: actions/checkout@v1
@@ -19,7 +23,7 @@ jobs:
       with:
         java-version: 11.0.2
     - name: build
-      run: ./gradlew build --stacktrace
+      run: ./gradlew build --refresh-dependencies --stacktrace
     - name: archive artifacts
       uses: actions/upload-artifact@v1
       if: success()

build.gradle

@@ -112,7 +112,7 @@ dependencies {
     }
 
     testImplementation "io.openapiprocessor:openapi-processor-api:$processorApiVersion"
-    testImplementation ('io.openapiprocessor:openapi-processor-test:1.0.0') {
+    testImplementation ('io.openapiprocessor:openapi-processor-test:1.0.1') {
         exclude group: 'com.google.guava'
     }
 

src/main/groovy/com/github/hauner/openapi/core/misc/URL.groovy

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2020 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi.core.misc
+
+import java.nio.file.Paths
+
+/**
+ * helper to convert a source url/path to an URL.
+ *
+ * @author Martin Hauner
+ */
+class URL {
+
+    /**
+     * convert source to a valid URL.
+     *
+     * if the source is an url string it converts it to an URL
+     * if the source is not an URL it assumes a local path and prefixes it with file://(//) to
+     * create a valid URL.
+     *
+     * @param source source path or url
+     * @return an URL to the given source
+     */
+    static java.net.URL toURL (String source) {
+        try {
+            return new java.net.URL (source)
+        } catch (Exception ignore) {
+            // catch
+        }
+
+        try {
+            Paths.get (source)
+                .normalize ()
+                .toUri ()
+                .toURL ()
+        } catch (Exception e) {
+            throw e
+        }
+    }
+
+}

src/main/groovy/com/github/hauner/openapi/core/parser/openapi4j/Parser.groovy

@@ -22,6 +22,8 @@ import org.openapi4j.parser.OpenApi3Parser
 import org.openapi4j.parser.model.v3.OpenApi3
 import org.openapi4j.parser.validation.v3.OpenApi3Validator
 
+import static com.github.hauner.openapi.core.misc.URL.toURL
+
 /**
  * openapi4j parser.
  *
@@ -30,12 +32,8 @@ import org.openapi4j.parser.validation.v3.OpenApi3Validator
 class Parser {
 
     ParserOpenApi parse (String apiPath) {
-        if (!hasScheme (apiPath)) {
-            apiPath = "file:${apiPath}"
-        }
-
         OpenApi3 api = new OpenApi3Parser ()
-            .parse (new URL (apiPath), true)
+            .parse (toURL (apiPath), true)
 
         ValidationResults results = OpenApi3Validator
             .instance ()
@@ -44,8 +42,4 @@ class Parser {
         new OpenApi (api, results)
     }
 
-    static boolean hasScheme (String path) {
-        path.indexOf (":") > -1
-    }
-
 }

src/main/groovy/com/github/hauner/openapi/core/parser/swagger/Parser.groovy

@@ -21,6 +21,8 @@ import io.swagger.v3.parser.OpenAPIV3Parser
 import io.swagger.v3.parser.core.models.ParseOptions
 import io.swagger.v3.parser.core.models.SwaggerParseResult
 
+import static com.github.hauner.openapi.core.misc.URL.toURL
+
 /**
  * swagger parser.
  *
@@ -42,26 +44,21 @@ class Parser {
     }
 
     private static String preparePath (String path) {
-        // the swagger parser works with http(s) & file protocols only.
+        // the swagger parser only works with http(s) & file protocols.
+
         // If it is something different (or nothing) it tries to find the given path as-is on the
         // file system. If that fails it tries to load the path as resource.
 
         if (isResource (path)) {
-            // strip resource: (only used by tests) to load it from resources
-            path.substring (SCHEME_RESOURCE.size ())
-        } else if (hasScheme (path)) {
-            "file:${path}"
-        } else {
-            path
+            // strip resource: (only used by tests) to load test files from the resources
+            return path.substring (SCHEME_RESOURCE.size ())
         }
+
+        toURL (path).toString ()
     }
 
     static boolean isResource (String path) {
         path.startsWith (SCHEME_RESOURCE)
     }
 
-    static boolean hasScheme (String path) {
-        path.indexOf (":") > -1
-    }
-
 }

src/main/groovy/com/github/hauner/openapi/core/writer/java/ApiWriter.groovy

@@ -28,6 +28,8 @@ import groovy.util.logging.Slf4j
 import java.nio.file.Files
 import java.nio.file.Path
 
+import static com.github.hauner.openapi.core.misc.URL.toURL
+
 /**
  * Root writer for the generated api files.
  *
@@ -127,9 +129,9 @@ class ApiWriter {
     }
 
     private void createTargetFolders () {
-        def rootPkg = options.packageName.replace ('.', File.separator)
-        def apiPkg = [rootPkg, 'api'].join (File.separator)
-        def modelPkg = [rootPkg, 'model'].join (File.separator)
+        def rootPkg = options.packageName.replace ('.', '/')
+        def apiPkg = [rootPkg, 'api'].join ('/')
+        def modelPkg = [rootPkg, 'model'].join ('/')
         log.debug ('creating target folders: {}', rootPkg)
 
         apiFolder = createTargetPackage (apiPkg)
@@ -141,17 +143,11 @@ class ApiWriter {
 
     private Path createTargetPackage (String apiPkg) {
         String root = options.targetDir
-        if (!hasScheme (root)) {
-            root = "file://${root}"
-        }
+        String pkg = [root, apiPkg].join ('/')
 
-        def target = Path.of (new URL ([root, apiPkg].join ('/')).toURI ())
+        def target = Path.of (toURL(pkg).toURI ())
         Files.createDirectories (target)
         target
     }
 
-    private boolean hasScheme (String source) {
-        source.indexOf ("://") > -1
-    }
-
 }

src/test/groovy/io/openapiprocessor/core/misc/PathSpec.groovy

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2020 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.openapiprocessor.core.misc
+
+import spock.lang.IgnoreIf
+import spock.lang.Requires
+import spock.lang.Specification
+import spock.lang.Unroll
+
+
+import static com.github.hauner.openapi.core.misc.URL.toURL
+
+class PathSpec extends Specification {
+
+    @Unroll
+    @Requires({ os.windows })
+    void "convert source to url on windows" () {
+        def resultUrl = toURL (source)
+
+        expect:
+        resultUrl.toString () == url
+
+        where:
+        source                                                     | url
+        "file:////C:/somewhere/openapi-processor-samples/samples"  | "file:////C:/somewhere/openapi-processor-samples/samples"
+        "C:\\somewhere\\openapi-processor-samples\\samples"        | "file:/C:/somewhere/openapi-processor-samples/samples"
+    }
+
+    @Unroll
+    @IgnoreIf({ os.windows })
+    void "convert source to url on unix (#source)" () {
+        def resultUrl = toURL (source)
+
+        expect:
+        resultUrl.toString () == url
+
+        where:
+        source                                                 | url
+        "file:///somewhere/openapi-processor-samples/samples"  | "file:/somewhere/openapi-processor-samples/samples"
+        "https:///somewhere/openapi-processor-samples/samples" | "https:/somewhere/openapi-processor-samples/samples"
+        "/somewhere/openapi-processor-samples/samples"         | "file:/somewhere/openapi-processor-samples/samples"
+    }
+
+}