Merge pull request #1305 from lugaru1234/issue1223

Fixes #1223: ReferenceTest has been migrated

Author: fehguy

modules/swagger-jaxrs/pom.xml

@@ -143,6 +143,12 @@
             <groupId>org.mockito</groupId>
             <artifactId>mockito-all</artifactId>
         </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>${commons-io-version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <properties>
         <coverage.complexity.minimum>0.29</coverage.complexity.minimum>

modules/swagger-jaxrs/src/test/java/io/swagger/ReferenceTest.java

@@ -0,0 +1,43 @@
+package io.swagger;
+
+import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertTrue;
+
+import io.swagger.converter.ModelConverters;
+import io.swagger.jaxrs.Reader;
+import io.swagger.matchers.SerializationMatchers;
+import io.swagger.models.Pet;
+import io.swagger.models.Swagger;
+import io.swagger.models.properties.Property;
+import io.swagger.models.properties.RefProperty;
+import io.swagger.resources.ResourceWithReferences;
+
+import org.apache.commons.io.IOUtils;
+import org.testng.annotations.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Map;
+
+public class ReferenceTest {
+
+    @Test(description = "Scan a model with common reference and reference with ApiModel")
+    public void scanModel() {
+        final Map<String, Property> props = ModelConverters.getInstance().readAll(Pet.class).get("Pet").getProperties();
+        final RefProperty category = (RefProperty) props.get("category");
+        assertEquals(category.getType(), "ref");
+        assertEquals(category.get$ref(), "#/definitions/Category");
+
+        final RefProperty categoryWithApiModel = (RefProperty) props.get("categoryWithApiModel");
+        assertEquals(categoryWithApiModel.getType(), "ref");
+        assertEquals(categoryWithApiModel.get$ref(), "#/definitions/MyCategory");
+    }
+
+    @Test(description = "Scan API with operation and response references")
+    public void scanAPI() throws IOException {
+        final Swagger swagger = new Reader(new Swagger()).read(ResourceWithReferences.class);
+        final InputStream in = getClass().getClassLoader().getResourceAsStream("ResourceWithReferences.json");
+        assertTrue(SerializationMatchers.compareAsJson(swagger, IOUtils.toString(in, StandardCharsets.UTF_8)));
+    }
+}

modules/swagger-jaxrs/src/test/java/io/swagger/matchers/SerializationMatchers.java

@@ -0,0 +1,35 @@
+package io.swagger.matchers;
+
+import io.swagger.util.Json;
+import io.swagger.util.Yaml;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+public class SerializationMatchers {
+    private static final Logger LOGGER = LoggerFactory.getLogger(SerializationMatchers.class);
+
+    public static boolean compareAsYaml(Object objectToSerialize, String yamlStr) {
+        return apply(objectToSerialize, yamlStr, Yaml.mapper());
+    }
+
+    public static boolean compareAsJson(Object objectToSerialize, String jsonStr) {
+        return apply(objectToSerialize, jsonStr, Json.mapper());
+    }
+
+    private static boolean apply(Object objectToSerialize, String str, ObjectMapper mapper) {
+        ObjectNode lhs = mapper.convertValue(objectToSerialize, ObjectNode.class);
+        ObjectNode rhs = null;
+        try {
+            rhs = mapper.readValue(str, ObjectNode.class);
+        } catch (IOException e) {
+            LOGGER.error("Failed to read value", e);
+        }
+        return lhs.equals(rhs);
+    }
+}

modules/swagger-jaxrs/src/test/java/io/swagger/models/Category.java

@@ -0,0 +1,28 @@
+package io.swagger.models;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement(name = "Category")
+public class Category {
+    private long id;
+    private String name;
+
+    @XmlElement(name = "id")
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    @XmlElement(name = "name")
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+}

modules/swagger-jaxrs/src/test/java/io/swagger/models/CategoryWithApiModel.java

@@ -0,0 +1,10 @@
+package io.swagger.models;
+
+import io.swagger.annotations.ApiModel;
+
+import javax.xml.bind.annotation.XmlRootElement;
+
+@ApiModel("MyCategory")
+@XmlRootElement(name = "CategoryWithApiModel")
+public class CategoryWithApiModel {
+}

…s/ModelContainingModelWithReference.java …s/ModelContainingModelWithReference.javamodules/swagger-jaxrs/src/test/scala/models/ModelContainingModelWithReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/ModelContainingModelWithReference.java modules/swagger-jaxrs/src/test/scala/models/ModelContainingModelWithReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/ModelContainingModelWithReference.java

@@ -1,4 +1,4 @@
-package models;
+package io.swagger.models;
 
 import io.swagger.annotations.ApiModelProperty;
 

…est/scala/models/ModelWithReference.java …o/swagger/models/ModelWithReference.javamodules/swagger-jaxrs/src/test/scala/models/ModelWithReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/ModelWithReference.java modules/swagger-jaxrs/src/test/scala/models/ModelWithReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/ModelWithReference.java

@@ -1,4 +1,4 @@
-package models;
+package io.swagger.models;
 
 import io.swagger.annotations.ApiModel;
 import io.swagger.annotations.ApiModelProperty;

modules/swagger-jaxrs/src/test/java/io/swagger/models/Pet.java

@@ -4,7 +4,7 @@
 
 import models.Category;
 import models.CategoryWithApiModel;
-import models.Tag;
+import io.swagger.models.duplicated.Tag;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -20,7 +20,7 @@ public class Pet {
     private CategoryWithApiModel categoryWithApiModel;
     private String name;
     private List<String> photoUrls = new ArrayList<String>();
-    private List<models.Tag> tags = new ArrayList<models.Tag>();
+    private List<Tag> tags = new ArrayList<Tag>();
     private String status;
 
     @XmlElement(name = "id")
@@ -71,7 +71,7 @@ public void setPhotoUrls(List<String> photoUrls) {
 
     @XmlElementWrapper(name = "tags")
     @XmlElement(name = "tag")
-    public List<models.Tag> getTags() {
+    public List<Tag> getTags() {
         return tags;
     }
 

…la/models/SubModelWithSelfReference.java …er/models/SubModelWithSelfReference.javamodules/swagger-jaxrs/src/test/scala/models/SubModelWithSelfReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/SubModelWithSelfReference.java modules/swagger-jaxrs/src/test/scala/models/SubModelWithSelfReference.java renamed to modules/swagger-jaxrs/src/test/java/io/swagger/models/SubModelWithSelfReference.java

@@ -1,4 +1,4 @@
-package models;
+package io.swagger.models;
 
 import io.swagger.annotations.ApiModelProperty;
 

modules/swagger-jaxrs/src/test/java/io/swagger/models/duplicated/Tag.java

@@ -25,4 +25,4 @@ public String getName() {
     public void setName(String name) {
         this.name = name;
     }
-}
+}