#49 Added Support for External Files (#51)

* #49 Added Support for External Files

* Fixed AnyOfGeneration

* Small fix for readability

Author: Rivarsal

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>net.coru</groupId>
   <artifactId>scc-multiapi-converter</artifactId>
-  <version>2.4.1</version>
+  <version>2.5.0</version>
   <name>SCC-MultiApi-Converter</name>
   <description>Generates Spring Cloud Contracts based on an OpenApi and AsyncApi document</description>
   <url>https://github.com/corunet/scc-multiapi-converter</url>

src/main/java/net/coru/multiapi/converter/MultiApiContractConverter.java

@@ -48,23 +48,23 @@ public Collection<Contract> convertFrom(final File file) {
 
     Collection<Contract> contracts = null;
     JsonNode node;
-    try {
-      node = BasicTypeConstants.OBJECT_MAPPER.readTree(file);
-      if (node != null && node.size() > 0) {
-        if (Objects.nonNull(node.get(BasicTypeConstants.ASYNCAPI))) {
-          contracts = ASYNC_API_CONTRACT_CONVERTER.convertFrom(file);
-        } else if (Objects.nonNull(node.get(BasicTypeConstants.OPENAPI))) {
-          contracts = OPEN_API_CONTRACT_CONVERTER.convertFrom(file);
+    if (isAccepted(file)) {
+      try {
+        node = BasicTypeConstants.OBJECT_MAPPER.readTree(file);
+        if (node != null && node.size() > 0) {
+          if (Objects.nonNull(node.get(BasicTypeConstants.ASYNCAPI))) {
+            contracts = ASYNC_API_CONTRACT_CONVERTER.convertFrom(file);
+          } else if (Objects.nonNull(node.get(BasicTypeConstants.OPENAPI))) {
+            contracts = OPEN_API_CONTRACT_CONVERTER.convertFrom(file);
+          }
+        } else {
+          throw new MultiApiContractConverterException("Yaml file is not correct");
         }
-      } else {
-        throw new MultiApiContractConverterException("Yaml file is not correct");
+      } catch (IOException e) {
+        throw new MultiApiContractConverterException(e);
       }
-    } catch (IOException e) {
-      throw new MultiApiContractConverterException(e);
     }
-
     return contracts;
-
   }
 
   @Override

src/main/java/net/coru/multiapi/converter/openapi/OpenApiContractConverter.java

@@ -28,7 +28,9 @@
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.responses.ApiResponse;
+import io.swagger.v3.parser.core.models.ParseOptions;
 import io.swagger.v3.parser.core.models.SwaggerParseResult;
+import io.swagger.v3.parser.exception.ReadContentException;
 import lombok.extern.slf4j.Slf4j;
 import net.coru.multiapi.converter.exception.MultiApiContractConverterException;
 import net.coru.multiapi.converter.utils.BasicTypeConstants;
@@ -204,8 +206,18 @@ private void processBodyAndMatchers(final Map<String, Object> bodyMap, Schema sc
             processComposedSchema(openAPI, bodyMatchers, bodyMap, subComposedSchema);
           } else if (Objects.nonNull(property.getValue().get$ref())) {
             String subRef = OpenApiContractConverterUtils.mapRefName(property.getValue());
-            HashMap<String, Schema> subProperties = (HashMap<String, Schema>) openAPI.getComponents().getSchemas().get(subRef).getProperties();
-            bodyMap.put(property.getKey(), processComplexBodyAndMatchers(property.getKey(), subProperties, openAPI, bodyMatchers));
+            Schema<?> subSchema = openAPI.getComponents().getSchemas().get(subRef);
+            if(Objects.nonNull(subSchema.getProperties())){
+              Map<String, Schema> subProperties = subSchema.getProperties();
+              bodyMap.put(property.getKey(), processComplexBodyAndMatchers(property.getKey(), subProperties, openAPI, bodyMatchers));
+            } else {
+              final Schema<?> arraySchema = ((ArraySchema) subSchema).getItems();
+              if(arraySchema instanceof ComposedSchema){
+                processComposedSchema(openAPI, bodyMatchers, bodyMap, (ComposedSchema) arraySchema);
+              } else{
+                writeBodyMatcher(bodyMap, openAPI, bodyMatchers, ref, arraySchema, arraySchema.getType());
+              }
+            }
           } else {
             final String refType;
             if (Objects.nonNull(property.getValue().getEnum())) {
@@ -527,10 +539,12 @@ private void processEnum(Map<String, Object> bodyMap, BodyMatchers bodyMatchers,
 
   private OpenAPI getOpenApi(File file) throws MultiApiContractConverterException {
     OpenAPI openAPI;
+    ParseOptions options = new ParseOptions();
+    options.setResolve(true);
     try {
-      SwaggerParseResult result = new OpenAPIParser().readLocation(file.getPath(), null, null);
+      SwaggerParseResult result = new OpenAPIParser().readLocation(file.getPath(), null, options);
       openAPI = result.getOpenAPI();
-    } catch (Exception e) {
+    } catch (ReadContentException e) {
       throw new MultiApiContractConverterException("Code generation failed when parser the .yaml file ");
     }
     if (openAPI == null) {

src/test/java/net/coru/multiapi/converter/openapi/OpenApiContractConverterTest.java

@@ -343,4 +343,20 @@ void testRefsInsideArrays() {
         .isInstanceOf(HashMap.class);
   }
 
+  @Test
+  @DisplayName("OpenApi: Check that Refs inside arrays are being processed okay")
+  void testExternalRefs() {
+    final File file = new File(openApiContractConverterTestFixtures.OPENAPI_TEST_EXTERNAL_REF);
+    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
+    List<Contract> contractList = new ArrayList<>(contracts);
+    Contract contract = contractList.get(0);
+    Response response = contract.getResponse();
+    final Map<String, Object> bodyServerValueMap = (Map<String, Object>) response.getBody().getServerValue();
+    assertThat(bodyServerValueMap)
+        .isNotNull()
+        .hasSize(5)
+        .containsKeys(openApiContractConverterTestFixtures.OPENAPI_TEXT_EXTERNAL_REF_KEYS);
+    assertThat(contract).isNotNull();
+  }
+
 }

src/test/java/net/coru/multiapi/converter/openapi/OpenApiContractConverterTestFixtures.java

@@ -4,6 +4,8 @@
 
 public class OpenApiContractConverterTestFixtures {
 
+  public final String[] OPENAPI_TEXT_EXTERNAL_REF_KEYS = {"schemaRegistryName", "topic", "kafkaName", "schemaName", "repetitions"};
+
   public final String PRICE = "price";
 
   public final String SIMILAR_GAMES = "SimilarGames";
@@ -42,6 +44,7 @@ public class OpenApiContractConverterTestFixtures {
 
   public final String OPENAPI_TEST_REQUEST_HEADERS_YML = "src/test/resources/openapi/testRequestHeaders.yml";
 
+  public final String OPENAPI_TEST_EXTERNAL_REF = "src/test/resources/openapi/testExternalRef.yml";
   public final String APPLICATION_JSON = "application/json";
 
   public final String OPENAPI_TEST_REQUEST_QUERY_PARAMETERS_YML = "src/test/resources/openapi/testRequestQueryParameters.yml";

src/test/resources/openapi/test-config/components.yml

@@ -0,0 +1,15 @@
+components:
+  schema:
+    generator:
+      type: object
+      properties:
+        schemaName:
+          type: string
+        schemaRegistryName:
+          type: string
+        kafkaName:
+          type: string
+        topic:
+          type: string
+        repetitions:
+          type: int32

src/test/resources/openapi/testExternalRef.yml

@@ -0,0 +1,18 @@
+openapi: 3.0.2
+info:
+  title: Schema Registry Mangement
+  version: "1.0"
+servers:
+- url: https://localhost/v1
+paths:
+  /schema_generator:
+    post:
+      tags:
+      - generator
+      responses:
+        200:
+          description: Test File for SCC MultiApi Plugin.
+          content:
+            application/json:
+              schema:
+                $ref: "test-config/components.yml#/components/schema/generator"