fix: accept swagger/openapi in yaml format (#1202)

* Accept swagger/openapi in yml

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Fix bean instantiation

Signed-off-by: Carson Cook <carson.cook@ibm.com>

* Suppress sonar warning for generic

Signed-off-by: Carson Cook <carson.cook@ibm.com>

Author: CarsonCook

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/TransformApiDocService.java

@@ -9,11 +9,11 @@
  */
 package org.zowe.apiml.apicatalog.swagger;
 
-import org.zowe.apiml.apicatalog.services.cached.model.ApiDocInfo;
-import org.zowe.apiml.apicatalog.swagger.api.AbstractApiDocService;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Service;
+import org.zowe.apiml.apicatalog.services.cached.model.ApiDocInfo;
+import org.zowe.apiml.apicatalog.swagger.api.AbstractApiDocService;
 
 import javax.validation.UnexpectedTypeException;
 import java.util.function.Function;
@@ -25,7 +25,7 @@
 @Service
 @RequiredArgsConstructor
 public class TransformApiDocService {
-    private final Function<String, AbstractApiDocService> beanApiDocFactory;
+    private final Function<String, AbstractApiDocService<?, ?>> beanApiDocFactory;
 
     /**
      * Does transformation API documentation
@@ -38,7 +38,7 @@ public class TransformApiDocService {
      */
     public String transformApiDoc(String serviceId, ApiDocInfo apiDocInfo) {
         //maybe null check of apidocinfo
-        AbstractApiDocService abstractApiDocService = beanApiDocFactory.apply(apiDocInfo.getApiDocContent());
+        AbstractApiDocService<?, ?> abstractApiDocService = beanApiDocFactory.apply(apiDocInfo.getApiDocContent());
         if (abstractApiDocService == null) {
             throw new UnexpectedTypeException("Response is not a Swagger or OpenAPI type object.");
         }

api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/api/ApiTransformationConfig.java

@@ -9,16 +9,17 @@
  */
 package org.zowe.apiml.apicatalog.swagger.api;
 
-import org.zowe.apiml.product.gateway.GatewayClient;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Scope;
+import org.zowe.apiml.product.gateway.GatewayClient;
 
 import javax.validation.UnexpectedTypeException;
 import java.io.IOException;
@@ -27,20 +28,20 @@
 @Configuration
 @Slf4j
 @RequiredArgsConstructor
+@SuppressWarnings("squid:S1452")
 public class ApiTransformationConfig {
 
     private final GatewayClient gatewayClient;
 
     @Bean
-    public Function<String, AbstractApiDocService> beanApiDocFactory() {
+    public Function<String, AbstractApiDocService<?, ?>> beanApiDocFactory() {
         return this::abstractApiDocService;
     }
 
-
     @Bean
     @Scope(value = "prototype")
-    public AbstractApiDocService abstractApiDocService(String content) {
-        ObjectMapper mapper = new ObjectMapper();
+    public AbstractApiDocService<?, ?> abstractApiDocService(String content) {
+        ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
         mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
         try {
             ObjectNode objectNode = mapper.readValue(content, ObjectNode.class);

api-catalog-services/src/test/java/org/zowe/apiml/apicatalog/swagger/TransformApiDocServiceTest.java

@@ -9,13 +9,13 @@
  */
 package org.zowe.apiml.apicatalog.swagger;
 
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.zowe.apiml.apicatalog.services.cached.model.ApiDocInfo;
 import org.zowe.apiml.apicatalog.swagger.api.AbstractApiDocService;
 import org.zowe.apiml.apicatalog.swagger.api.ApiDocV2Service;
 import org.zowe.apiml.apicatalog.swagger.api.ApiDocV3Service;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.Assertions;
 
 import javax.validation.UnexpectedTypeException;
 import java.util.function.Function;
@@ -26,7 +26,7 @@ class TransformApiDocServiceTest {
 
     private final String SERVICE_ID = "SERVICE_1";
 
-    private Function<String, AbstractApiDocService> beanApiDocFactory;
+    private Function<String, AbstractApiDocService<?, ?>> beanApiDocFactory;
     private TransformApiDocService transformApiDocService;
 
     @BeforeEach

api-catalog-services/src/test/java/org/zowe/apiml/apicatalog/swagger/api/ApiTransformationConfigTest.java

@@ -15,47 +15,55 @@
 import javax.validation.UnexpectedTypeException;
 import java.util.function.Function;
 
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.assertNull;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.*;
 
 class ApiTransformationConfigTest {
-    private AbstractApiDocService abstractApiDocService;
+    private AbstractApiDocService<?, ?> abstractApiDocService;
 
-    private ApiTransformationConfig apiTransformationConfig = new ApiTransformationConfig(null);
-    private Function<String, AbstractApiDocService> beanApiDocFactory =  apiTransformationConfig.beanApiDocFactory();
+    private final ApiTransformationConfig apiTransformationConfig = new ApiTransformationConfig(null);
+    private final Function<String, AbstractApiDocService<?, ?>> beanApiDocFactory = apiTransformationConfig.beanApiDocFactory();
 
     @BeforeEach
     void setUp() {
         abstractApiDocService = null;
     }
 
     @Test
-    void testApiDocFactory_whenSwagerDocIsPresent() {
+    void givenSwaggerJson_whenGetApiDocService_thenReturnApiDocV2Service() {
         abstractApiDocService = beanApiDocFactory.apply("{\"swagger\": \"2.0\"}");
         assertTrue(abstractApiDocService instanceof ApiDocV2Service, "AbstractApiDocService is not ApiDocV2Service");
     }
 
     @Test
-    void testApiDocFactory_whenOpenApiDocIsPresent() {
+    void givenOpenApiJson_whenGetApiDocService_thenReturnApiDocV3Service() {
         abstractApiDocService = beanApiDocFactory.apply("{\"openapi\": \"3.0\"}");
         assertTrue(abstractApiDocService instanceof ApiDocV3Service, "AbstractApiDocService is not ApiDocV3Service");
     }
 
     @Test
-    void testApiDocFactory_whenApDocIsNotOpenApiNorSwagger() {
+    void givenSwaggerYml_whenGetApiDocService_thenReturnApiDocV2Service() {
+        abstractApiDocService = beanApiDocFactory.apply("swagger: 2.0");
+        assertTrue(abstractApiDocService instanceof ApiDocV2Service, "AbstractApiDocService is not ApiDocV2Service");
+    }
+
+    @Test
+    void givenOpenApiYml_whenGetApiDocService_thenReturnApiDocV3Service() {
+        abstractApiDocService = beanApiDocFactory.apply("openapi: 3.0");
+        assertTrue(abstractApiDocService instanceof ApiDocV3Service, "AbstractApiDocService is not ApiDocV3Service");
+    }
+
+    @Test
+    void givenApiDocNotInOpenApiNorSwagger_whenGetApiDocService_thenReturnNull() {
         abstractApiDocService = beanApiDocFactory.apply("{\"superapi\": \"3.0\"}");
         assertNull(abstractApiDocService, "abstractApiDocService is not null");
     }
 
     @Test
-    void testApiDocFactory_whenApDocVersionIsNotAsExpectedFormat() {
+    void givenApDocVersionIsNotAsExpectedFormat_whenGetApiDocService_thenThrowException() {
         Exception exception = assertThrows(UnexpectedTypeException.class, () -> {
             abstractApiDocService = beanApiDocFactory.apply("FAILED FORMAT");
         });
         assertNull(abstractApiDocService);
         assertEquals("Response is not a Swagger or OpenAPI type object.", exception.getMessage());
     }
-
 }