Merge pull request #58 from SmartBear/swagger-compliance-assertion-improvements

Swagger compliance assertion improvements

Author: Ole Lensmar

pom.xml

@@ -8,7 +8,7 @@
 
     <groupId>com.smartbear.soapui.plugins</groupId>
     <artifactId>soapui-swagger-plugin</artifactId>
-    <version>2.5.2</version>
+    <version>2.5.3-SNAPSHOT</version>
 
     <name>Swagger Plugin</name>
     <description>Provides Swagger 1.X/2.0 import/export functionality for REST APIs</description>
@@ -53,7 +53,7 @@
     <properties>
         <jackson-version>2.8.4</jackson-version>
         <swagger-version>1.5.12</swagger-version>
-        <swagger-parser.version>1.0.25</swagger-parser.version>
+        <swagger-parser.version>1.0.26</swagger-parser.version>
         <swagger-inflector.version>1.0.11</swagger-inflector.version>
         <readyapi-version>1.9.0</readyapi-version>
     </properties>

src/main/groovy/com/smartbear/swagger/SwaggerComplianceAssertion.java

@@ -40,6 +40,8 @@
 import com.eviware.x.form.XFormDialogBuilder;
 import com.eviware.x.form.XFormFactory;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.xml.XmlMapper;
 import com.github.fge.jsonschema.core.exceptions.ProcessingException;
 import com.github.fge.jsonschema.core.load.configuration.LoadingConfiguration;
 import com.github.fge.jsonschema.main.JsonSchema;
@@ -192,7 +194,7 @@ private boolean validateMessage(HttpMessageExchange messageExchange, SubmitConte
                     Operation operation = findOperation(swagger.getPath(swaggerPath), method);
                     if (operation != null) {
                         validateOperation(swagger, operation, String.valueOf(messageExchange.getResponseStatusCode()),
-                            messageExchange.getResponseContent()
+                            messageExchange.getResponseContent(), messageExchange.getResponseContentType()
                         );
 
                         return true;
@@ -228,31 +230,31 @@ private Operation findOperation(Path path, RestRequestInterface.HttpMethod metho
         return null;
     }
 
-    void validateOperation(Swagger swagger, Operation operation, String responseCode, String contentAsString) throws AssertionException {
+    void validateOperation(Swagger swagger, Operation operation, String responseCode, String contentAsString, String contentType) throws AssertionException {
 
         Response responseSchema = operation.getResponses().get(responseCode);
         if (responseSchema == null) {
             responseSchema = operation.getResponses().get("default");
         }
 
         if (responseSchema != null) {
-            validateResponse(contentAsString, swagger, responseSchema);
+            validateResponse(contentAsString, contentType, swagger, responseSchema);
         } else if (strictMode) {
             throw new AssertionException(new AssertionError(
                 "Missing response definition for " + responseCode + " response in operation " + operation.getOperationId()));
         }
     }
 
-    void validateResponse(String contentAsString, Swagger swagger, Response responseSchema) throws AssertionException {
+    void validateResponse(String contentAsString, String contentType, Swagger swagger, Response responseSchema) throws AssertionException {
         if (responseSchema.getSchema() != null) {
             Property schema = responseSchema.getSchema();
             if (schema instanceof RefProperty) {
                 Model model = swagger.getDefinitions().get(((RefProperty) schema).getSimpleRef());
                 if (model != null) {
-                    validatePayload(contentAsString, null);
+                    validatePayload(contentAsString, null, contentType );
                 }
             } else {
-                validatePayload(contentAsString, Json.pretty(schema));
+                validatePayload(contentAsString, Json.pretty(schema), contentType);
             }
         }
     }
@@ -309,7 +311,7 @@ private Swagger parseFileContent() throws AssertionException {
         }
     }
 
-    public void validatePayload(String payload, String schema) throws AssertionException {
+    public void validatePayload(String payload, String schema, String contentType) throws AssertionException {
         try {
             JsonSchema jsonSchema;
 
@@ -328,7 +330,16 @@ public void validatePayload(String payload, String schema) throws AssertionExcep
                 jsonSchema = getSwaggerSchema();
             }
 
-            JsonNode contentObject = Json.mapper().readTree(payload);
+            JsonNode contentObject;
+
+            if (contentType.equalsIgnoreCase("application/json")) {
+                contentObject = Json.mapper().readTree(payload);
+            } else if (contentType.equalsIgnoreCase("application/xml")) {
+                final XmlMapper xmlMapper = new XmlMapper();
+                contentObject = xmlMapper.readTree(payload);
+            } else {
+                throw new AssertionException(new AssertionError("Swagger Compliance testing failed. Invalid content type: " + contentType));
+            }
 
             ValidationSupport.validateMessage(jsonSchema, contentObject);
         } catch (AssertionException e) {

src/test/java/com/smartbear/swagger/TestComplianceAssertion.java

@@ -54,10 +54,15 @@ public void testComplianceAssertion() throws Exception {
         SwaggerComplianceAssertion assertion = new SwaggerComplianceAssertion(config, testStep);
         Swagger swagger = assertion.getSwagger(new WsdlSubmitContext(project));
 
-        assertion.validateOperation(swagger, swagger.getPath("/pet/findByTags").getGet(), "200", "[{\"id\":1500,\"category\":{\"id\":0,\"name\":\"\"},\"name\":\"butch\",\"photoUrls\":[\"\"],\"tags\":[{\"id\":0,\"name\":\"\"}],\"status\":\"available\"}]");
+        assertion.validateOperation(swagger, swagger.getPath("/pet/findByTags").getGet(), "200",
+            "[{\"id\":1500,\"category\":{\"id\":0,\"name\":\"\"},\"name\":\"butch\",\"photoUrls\":[\"\"],\"tags\":[{\"id\":0,\"name\":\"\"}],\"status\":\"available\"}]",
+            "application/json");
 
         try {
-            assertion.validateOperation(swagger, swagger.getPath("/pet/findByTags").getGet(), "200", "[{\"id\":1500,\"category\":{\"id\":0,\"name\":\"\"},\"name\":\"butch\",\"photoUrdls\":[\"\"],\"tags\":[{\"id\":0,\"name\":\"\"}],\"status\":\"available\"}]");
+            assertion.validateOperation(swagger, swagger.getPath("/pet/findByTags").getGet(), "200",
+                "[{\"id\":1500,\"category\":{\"id\":0,\"name\":\"\"},\"name\":\"butch\",\"photoUrdls\":[\"\"],\"tags\":[{\"id\":0,\"name\":\"\"}],\"status\":\"available\"}]",
+                "application/json");
+
             assertTrue("Validation should have failed", false);
         } catch (Exception e) {
         }