#50 Asyncapi support external files (#52)

* #50 Add support to reference external files

* #50 Update pom version

* #50 Fix objects creation in the contracts

* #50 Reuse variable

* #50 Support for external files and fix tests

* #50 Update pom version

* #50 Fix codacy errors and refactor tests

* #50 Fix codacy issues

* #50 Fix array of objects

* #50 Fix codacy issue

* #50 Check that there are no references and properties at the same level and refactor code

* #50 Fix variables to be final

Author: jmejutovazquez

README.md

@@ -35,7 +35,7 @@ After you have these installed, you need to add the Spring Cloud Contract Maven
     <dependency>
       <groupId>net.coru</groupId>
       <artifactId>scc-multiapi-converter</artifactId>
-      <version>2.4.1</version>
+      <version>2.6.0</version>
       <scope>compile</scope>
     </dependency>
   </dependencies>

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>net.coru</groupId>
   <artifactId>scc-multiapi-converter</artifactId>
-  <version>2.5.0</version>
+  <version>2.6.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/asyncapi/AsyncApiContractConverter.java

@@ -52,6 +52,8 @@ public final class BasicTypeConstants {
 
   public static final String PROPERTIES = "properties";
 
+  public static final String SCHEMA = "schema";
+
   public static final String SCHEMAS = "schemas";
 
   public static final String FORMAT = "format";
@@ -62,6 +64,8 @@ public final class BasicTypeConstants {
 
   public static final String TYPE = "type";
 
+  public static final String PAYLOAD = "payload";
+
   public static final RegexProperty STRING_REGEX = RegexPatterns.alphaNumeric();
 
   public static final RegexProperty INT_REGEX = RegexPatterns.positiveInt();

src/main/java/net/coru/multiapi/converter/utils/BasicTypeConstants.java

@@ -37,10 +37,7 @@ void fileIsAcceptedTrue() {
   @Test
   @DisplayName("AsyncApi: Check if a contract is returned")
   void convertFromTest() {
-    Collection<Contract> contracts;
-    File file = new File(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
-    contracts = multiApiContractConverter.convertFrom(file);
-    List<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
 
     assertThat(contractList).hasSize(2);
 
@@ -60,9 +57,7 @@ void convertFromTest() {
   @Test
   @DisplayName("AsyncApi: Check if Input is being processed okay")
   void testInput() {
-    File file = new File(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
     Map<String, Object> order = asyncApiContractConverterTestFixtures.createOrder();
 
     Contract publishContract = contractList.get(0);
@@ -79,9 +74,7 @@ void testInput() {
   @Test
   @DisplayName("AsyncApi: Check if OutputMessage is being processed okay")
   void testOutputMessage() {
-    File file = new File(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.EVENT_API_FILE);
     Map<String, Object> order = asyncApiContractConverterTestFixtures.createOrder();
 
     Contract publishContract = contractList.get(0);
@@ -105,9 +98,7 @@ void testOutputMessage() {
   @Test
   @DisplayName("AsyncApi: Check if the enum logic is being processed okay")
   void testEnums() {
-    File file = new File(asyncApiContractConverterTestFixtures.TEST_ENUMS_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_ENUMS_FILE);
 
     for (int i = 0; i < contractList.size(); i++) {
       Contract contract = contractList.get(i);
@@ -128,9 +119,7 @@ void testEnums() {
   @Test
   @DisplayName("AsyncApi: Check if complex objects are being processed okay")
   void testComplexObjects() {
-    File file = new File(asyncApiContractConverterTestFixtures.TEST_COMPLEX_OBJECTS_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_COMPLEX_OBJECTS_FILE);
 
     for (int i = 0; i < contractList.size(); i++) {
       Contract contract = contractList.get(i);
@@ -150,17 +139,15 @@ void testComplexObjects() {
       } else {
         assertThat(nameValue).containsEntry(asyncApiContractConverterTestFixtures.COMPANY_NAME, asyncApiContractConverterTestFixtures.CORUNET);
         assertThat(nameValue).containsEntry(asyncApiContractConverterTestFixtures.REFERENCE_NAME, 3324);
-        assertThat(addressValue).containsEntry(asyncApiContractConverterTestFixtures.STREET, "Calle Sor Joaquina");
+        assertThat(addressValue).containsEntry(asyncApiContractConverterTestFixtures.STREET, asyncApiContractConverterTestFixtures.STREET_VALUE);
       }
     }
   }
 
   @Test
   @DisplayName("AsyncApi: Check if arrays are being processed okay")
   void testArrays() {
-    File file = new File(asyncApiContractConverterTestFixtures.TEST_ARRAYS_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_ARRAYS_FILE);
 
     for (int i = 0; i < contractList.size(); i++) {
       Contract contract = contractList.get(i);
@@ -189,9 +176,7 @@ void testArrays() {
   @Test
   @DisplayName("AsyncApi: Check if arrays with reference to an object are being processed okay")
   void testArraysWithRef() {
-    File file = new File(asyncApiContractConverterTestFixtures.TEST_ARRAYS_REF_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_ARRAYS_REF_FILE);
 
     for (int i = 0; i < contractList.size(); i++) {
       Contract contract = contractList.get(i);
@@ -215,9 +200,7 @@ void testArraysWithRef() {
   @Test
   @DisplayName("AsyncApi: Check if basic types are being processed okay")
   void testBasicTypes() {
-    File file = new File(asyncApiContractConverterTestFixtures.TEST_BASIC_TYPES_FILE);
-    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
-    ArrayList<Contract> contractList = new ArrayList<>(contracts);
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_BASIC_TYPES_FILE);
 
     for (int i = 0; i < contractList.size(); i++) {
       Contract contract = contractList.get(i);
@@ -244,7 +227,62 @@ void testBasicTypes() {
         assertThat(orderValue).containsEntry(asyncApiContractConverterTestFixtures.BOOLEAN_TYPE, true);
       }
     }
+  }
+
+  @Test
+  @DisplayName("AsyncApi: Check if references to external files work correctly")
+  void testExternalFiles() {
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_EXTERNAL_FILE);
+
+    for (int i = 0; i < contractList.size(); i++) {
+      Contract contract = contractList.get(i);
+
+      Map<String, Object> bodyValue = (Map<String, Object>) contract.getOutputMessage().getBody().getClientValue();
+      assertThat(bodyValue.get(asyncApiContractConverterTestFixtures.ORDER)).isNotNull();
+      Map<String, Object> orderValue = (Map<String, Object>) bodyValue.get(asyncApiContractConverterTestFixtures.ORDER);
+      List<Integer> amount = (ArrayList<Integer>) orderValue.get(asyncApiContractConverterTestFixtures.AMOUNT);
+
+      if (i == 0) {
+        assertThat(orderValue.get(asyncApiContractConverterTestFixtures.COMPANY_NAME)).isNotNull().isInstanceOf(String.class);
+        assertThat(orderValue.get(asyncApiContractConverterTestFixtures.IS_SENT)).isNotNull().isInstanceOf(Boolean.class);
+        assertThat(amount).isNotNull().isInstanceOf(ArrayList.class);
+      } else {
+        assertThat(orderValue).containsEntry(asyncApiContractConverterTestFixtures.COMPANY_NAME, asyncApiContractConverterTestFixtures.CORUNET);
+        assertThat(orderValue).containsEntry(asyncApiContractConverterTestFixtures.IS_SENT, true);
+        assertThat(amount).isEqualTo(asyncApiContractConverterTestFixtures.INT_ARRAY_VALUES);
+      }
+    }
+  }
+
+  @Test
+  @DisplayName("AsyncApi: Check if references to external files work correctly with multiple schemas")
+  void testExternalFilesWithMultipleSchemas() {
+    List<Contract> contractList = getContracts(asyncApiContractConverterTestFixtures.TEST_EXTERNAL_FILE_MULTIPLE_SCHEMAS);
+
+    for (int i = 0; i < contractList.size(); i++) {
+      Contract contract = contractList.get(i);
 
+      Map<String, Object> bodyValue = (Map<String, Object>) contract.getOutputMessage().getBody().getClientValue();
+      assertThat(bodyValue.get(asyncApiContractConverterTestFixtures.ORDERS)).isNotNull();
+      Map<String, Object> ordersValue = (Map<String, Object>) bodyValue.get(asyncApiContractConverterTestFixtures.ORDERS);
+      assertThat(ordersValue.get(asyncApiContractConverterTestFixtures.ORDER_LINE)).isNotNull();
+      Map<String, Object> orderLineValue = (Map<String, Object>) ordersValue.get(asyncApiContractConverterTestFixtures.ORDER_LINE);
+      assertThat(orderLineValue.get(asyncApiContractConverterTestFixtures.ORDER)).isNotNull();
+      Map<String, Object> orderValue = (Map<String, Object>) orderLineValue.get(asyncApiContractConverterTestFixtures.ORDER);
+
+      if (i == 0) {
+        assertThat(orderValue.get(asyncApiContractConverterTestFixtures.COMPANY_NAME)).isNotNull().isInstanceOf(String.class);
+      } else {
+        assertThat(orderValue).containsEntry(asyncApiContractConverterTestFixtures.COMPANY_NAME, asyncApiContractConverterTestFixtures.CORUNET);
+      }
+    }
+  }
+
+  private List<Contract> getContracts(String filePath) {
+    File file = new File(filePath);
+    Collection<Contract> contracts = multiApiContractConverter.convertFrom(file);
+    List<Contract> contractList = new ArrayList<>(contracts);
+    return contractList;
   }
 
 }

src/test/java/net/coru/multiapi/converter/asyncapi/AsyncApiContractConverterTest.java

@@ -24,6 +24,10 @@ public class AsyncApiContractConverterTestFixtures {
 
   public final String TEST_ENUMS_FILE = "src/test/resources/asyncapi/testEnums.yml";
 
+  public final String TEST_EXTERNAL_FILE = "src/test/resources/asyncapi/testExternalFiles.yml";
+
+  public final String TEST_EXTERNAL_FILE_MULTIPLE_SCHEMAS = "src/test/resources/asyncapi/testExternalFilesWithMultipleSchemas.yml";
+
   public final String PUBLISH_NAME = "publishOperation";
 
   public final String TRIGGERED_BY = "publishOperation()";
@@ -42,6 +46,10 @@ public class AsyncApiContractConverterTestFixtures {
 
   public final String ORDER = "order";
 
+  public final String ORDERS = "orders";
+
+  public final String ORDER_LINE = "orderLine";
+
   public final String EMPLOYEES = "employees";
 
   public final String INT_ARRAY = "intArray";
@@ -60,6 +68,8 @@ public class AsyncApiContractConverterTestFixtures {
 
   public final String STREET = "street";
 
+  public final String STREET_VALUE = "Calle Sor Joaquina";
+
   public final String AMOUNT = "amount";
 
   public final String INTEGER_TYPE = "integerType";
@@ -76,6 +86,8 @@ public class AsyncApiContractConverterTestFixtures {
 
   public final String BOOLEAN_TYPE = "booleanType";
 
+  public final String IS_SENT = "isSent";
+
   public final List<Integer> INT_ARRAY_VALUES = List.of(1, 2, 3);
 
   public final List<Double> DOUBLE_ARRAY_VALUES = List.of(1.25, 2.5, 3.75);

src/test/java/net/coru/multiapi/converter/asyncapi/AsyncApiContractConverterTestFixtures.java

@@ -42,25 +42,21 @@ components:
   messages:
     OrderCreated:
       payload:
-        $ref: '#/components/schemas/OrderCreated'
+        $ref: '#/components/schemas/OrderCreatedSchema'
     CreateOrder:
       payload:
-        $ref: '#/components/schemas/CreateOrder'
+        $ref: '#/components/schemas/CreateOrderSchema'
   schemas:
-    CreateOrder:
+    CreateOrderSchema:
       type: object
       properties:
         order:
-          type: object
-          properties:
-            $ref: '#/components/schemas/Order'
-    OrderCreated:
+          $ref: '#/components/schemas/Order'
+    OrderCreatedSchema:
       type: object
       properties:
         order:
-          type: object
-          properties:
-            $ref: '#/components/schemas/Order'
+          $ref: '#/components/schemas/Order'
     Order:
       type: object
       properties:

src/test/resources/asyncapi/event-api.yml

@@ -0,0 +1,7 @@
+components:
+  schemas:
+    Orders:
+      type: object
+      properties:
+        orderLine:
+          $ref: './externalfiles/thirdSchema.yml#/components/schemas/OrderLine'

src/test/resources/asyncapi/externalfiles/firstSchema.yml

@@ -0,0 +1,17 @@
+components:
+  schemas:
+    Order:
+      type: object
+      properties:
+        companyName:
+          type: string
+          example: Corunet
+        isSent:
+          type: boolean
+          example: true
+        amount:
+          type: array
+          items:
+            type: integer
+            format: int32
+            example: [ 1, 2, 3 ]

src/test/resources/asyncapi/externalfiles/secondSchema.yml

@@ -0,0 +1,14 @@
+components:
+  schemas:
+    OrderLine:
+      type: object
+      properties:
+        order:
+          $ref: '#/components/schemas/Order'
+
+    Order:
+      type: object
+      properties:
+        companyName:
+          type: string
+          example: Corunet