Skip to content

Fix ExampleGenerator #3438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vfpfafrf wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Fix ExampleGenerator #3438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2f399e
fix code-style according to java7
Jul 20, 2016
9a27cba
fix incorrect float, double example generation
Jul 20, 2016
4141aa5
fix incorrect generic object example generation
Jul 20, 2016
0651a20
composed model example generation
Jul 21, 2016
e585094
missing tests
Jul 21, 2016
0c3b3b9
rollback method modifiers
Jul 22, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 34 additions & 37 deletions modules/swagger-codegen/src/main/java/io/swagger/codegen/examples/ExampleGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,14 @@
package io.swagger.codegen.examples;

import io.swagger.models.ComposedModel;
import io.swagger.models.Model;
import io.swagger.models.ModelImpl;
import io.swagger.models.properties.ArrayProperty;
import io.swagger.models.properties.BooleanProperty;
import io.swagger.models.properties.DateProperty;
import io.swagger.models.properties.DateTimeProperty;
import io.swagger.models.properties.DecimalProperty;
import io.swagger.models.properties.DoubleProperty;
import io.swagger.models.properties.FileProperty;
import io.swagger.models.properties.FloatProperty;
import io.swagger.models.properties.IntegerProperty;
import io.swagger.models.properties.LongProperty;
import io.swagger.models.properties.MapProperty;
import io.swagger.models.properties.ObjectProperty;
import io.swagger.models.properties.Property;
import io.swagger.models.properties.RefProperty;
import io.swagger.models.properties.StringProperty;
import io.swagger.models.properties.UUIDProperty;
import io.swagger.models.RefModel;
import io.swagger.models.properties.*;
import io.swagger.util.Json;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.*;

public class ExampleGenerator {
protected Map<String, Model> examples;
Expand All @@ -37,15 +18,15 @@ public ExampleGenerator(Map<String, Model> examples) {
}

public List<Map<String, String>> generate(Map<String, Object> examples, List<String> mediaTypes, Property property) {
List<Map<String, String>> output = new ArrayList<Map<String, String>>();
Set<String> processedModels = new HashSet<String>();
List<Map<String, String>> output = new ArrayList<>();
Set<String> processedModels = new HashSet<>();
if (examples == null) {
if (mediaTypes == null) {
// assume application/json for this
mediaTypes = Arrays.asList("application/json"); // FIXME: a parameter should not be assigned. Also declare the methods parameters as 'final'.
}
for (String mediaType : mediaTypes) {
Map<String, String> kv = new HashMap<String, String>();
Map<String, String> kv = new HashMap<>();
kv.put("contentType", mediaType);
if (property != null && mediaType.startsWith("application/json")) {
String example = Json.pretty(resolvePropertyToExample(mediaType, property, processedModels));
Expand All @@ -64,14 +45,14 @@ public List<Map<String, String>> generate(Map<String, Object> examples, List<Str
}
} else {
for (Map.Entry<String, Object> entry : examples.entrySet()) {
final Map<String, String> kv = new HashMap<String, String>();
final Map<String, String> kv = new HashMap<>();
kv.put("contentType", entry.getKey());
kv.put("example", Json.pretty(entry.getValue()));
output.add(kv);
}
}
if (output.size() == 0) {
Map<String, String> kv = new HashMap<String, String>();
Map<String, String> kv = new HashMap<>();
kv.put("output", "none");
output.add(kv);
}
Expand All @@ -96,20 +77,20 @@ protected Object resolvePropertyToExample(String mediaType, Property property, S
return "2000-01-23T04:56:07.000+00:00";
} else if (property instanceof DateTimeProperty) {
return "2000-01-23T04:56:07.000+00:00";
} else if (property instanceof DecimalProperty) {
return new BigDecimal(1.3579);
} else if (property instanceof DoubleProperty) {
return new Double(3.149);
return 3.149;
} else if (property instanceof FileProperty) {
return ""; // TODO
} else if (property instanceof FloatProperty) {
return new Float(1.23);
return 1.23f;
} else if (property instanceof IntegerProperty) {
return new Integer(123);
return 123;
} else if (property instanceof LongProperty) {
return new Long(123456789);
return 123456789L;
} else if (property instanceof DecimalProperty) {
return new BigDecimal(1.3579);
} else if (property instanceof MapProperty) {
Map<String, Object> mp = new HashMap<String, Object>();
Map<String, Object> mp = new HashMap<>();
if (property.getName() != null) {
mp.put(property.getName(),
resolvePropertyToExample(mediaType, ((MapProperty) property).getAdditionalProperties(), processedModels));
Expand All @@ -119,7 +100,7 @@ protected Object resolvePropertyToExample(String mediaType, Property property, S
}
return mp;
} else if (property instanceof ObjectProperty) {
return "{}";
return Collections.EMPTY_MAP;
} else if (property instanceof RefProperty) {
String simpleName = ((RefProperty) property).getSimpleRef();
Model model = examples.get(simpleName);
Expand All @@ -140,7 +121,7 @@ public Object resolveModelToExample(String name, String mediaType, Model model,
if (model instanceof ModelImpl) {
processedModels.add(name);
ModelImpl impl = (ModelImpl) model;
Map<String, Object> values = new HashMap<String, Object>();
Map<String, Object> values = new HashMap<>();

if (impl.getProperties() != null) {
for (String propertyName : impl.getProperties().keySet()) {
Expand All @@ -149,6 +130,22 @@ public Object resolveModelToExample(String name, String mediaType, Model model,
}
}
return values;
} else if (model instanceof ComposedModel) {
Map<String, Object> values = new HashMap<>();
ComposedModel composedModel = (ComposedModel) model;
if (composedModel.getInterfaces() != null) {
for (RefModel refModel : composedModel.getInterfaces()) {
String simpleRef = refModel.getSimpleRef();
Model ifModel = examples.get(simpleRef);
if (ifModel != null){
Object example = resolveModelToExample(simpleRef, mediaType, ifModel, processedModels);
if (example instanceof Map){
values.putAll((Map) example);
}
}
}
}
return values;
}
return "";
}
Expand Down
89 changes: 75 additions & 14 deletions modules/swagger-codegen/src/test/java/io/swagger/codegen/ExampleGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,25 @@
package io.swagger.codegen;

import io.swagger.codegen.examples.ExampleGenerator;
import io.swagger.models.Model;
import io.swagger.models.ModelImpl;
import io.swagger.models.Xml;
import io.swagger.models.properties.ArrayProperty;
import io.swagger.models.properties.RefProperty;
import io.swagger.models.properties.StringProperty;

import com.fasterxml.jackson.core.type.TypeReference;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Sets;
import io.swagger.codegen.examples.ExampleGenerator;
import io.swagger.models.*;
import io.swagger.models.properties.*;
import io.swagger.util.Json;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.*;

@SuppressWarnings("static-method")
public class ExampleGeneratorTest {

private static final String JSON = "application/json";
private static final String XML = "application/xml";

@Test(description = "check handling of recursive models")
public void recursiveModelsTest() {
final String JSON = "application/json";
final String XML = "application/xml";
final String nodeType = "Node";
final RefProperty ref = new RefProperty(nodeType);
final Model node = new ModelImpl().name(nodeType).property("name", new StringProperty())
Expand Down Expand Up @@ -70,4 +65,70 @@ public void recursiveModelsTest() {
Assert.assertEqualsNoOrder(types.toArray(new String[types.size()]),
expectedTypes.toArray(new String[expectedTypes.size()]));
}

@Test(description = "check primitive types generation")
public void testPrimitiveTypes() throws Exception {
final String nodeType = "Node";
RefProperty ref = new RefProperty(nodeType);
Model node = new ModelImpl().name(nodeType)
.property("parent", ref)
.property("str", new StringProperty())
.property("bool", new BooleanProperty())
.property("dbl", new DoubleProperty())
.property("float", new FloatProperty())
.property("int", new IntegerProperty())
.property("long", new LongProperty())
.property("obj", new ObjectProperty());

ExampleGenerator generator = new ExampleGenerator(ImmutableMap.of(nodeType, node));
List<Map<String, String>> generate = generator.generate(null, Collections.singletonList(JSON), ref);
String example = generate.get(0).get("example");

Map<String, Object> result = Json.mapper().readValue(example, new TypeReference<Map<String, Object>>() {});
Assert.assertEquals(result.get("str"), "aeiou");
Assert.assertEquals(result.get("bool"), Boolean.TRUE);
Assert.assertEquals(result.get("dbl"), 3.149);
Assert.assertEquals(result.get("float"), 1.23);
Assert.assertEquals(result.get("int"), 123);
Assert.assertEquals(result.get("long"), 123456789);
Assert.assertTrue(result.get("obj") instanceof Map);
Assert.assertEquals(((Map)result.get("obj")).size(), 0);
}

@Test(description = "check composed model generation")
public void testComposedModel() throws Exception {
final String nodeType = "Node";
RefProperty ref = new RefProperty(nodeType);
RefProperty parent = new RefProperty("parent");
Model modelOne = new ModelImpl().name("ModelOne")
.property("parent", parent)
.property("str", new StringProperty())
.property("bool", new BooleanProperty())
.property("dbl", new DoubleProperty());

Model modelTwo = new ModelImpl().name("ModelTwo")
.property("parent", parent)
.property("float", new FloatProperty())
.property("int", new IntegerProperty())
.property("long", new LongProperty())
.property("obj", new ObjectProperty());

Model model = new ComposedModel()
.interfaces(Arrays.asList(new RefModel("ModelOne"), new RefModel("ModelTwo")))
.parent(new RefModel(nodeType));

ExampleGenerator generator = new ExampleGenerator(ImmutableMap.of("ModelOne", modelOne, "ModelTwo", modelTwo, nodeType, model));
List<Map<String, String>> generate = generator.generate(null, Collections.singletonList(JSON), ref);
String example = generate.get(0).get("example");

Map<String, Object> result = Json.mapper().readValue(example, new TypeReference<Map<String, Object>>() {});
Assert.assertEquals(result.get("str"), "aeiou");
Assert.assertEquals(result.get("bool"), Boolean.TRUE);
Assert.assertEquals(result.get("dbl"), 3.149);
Assert.assertEquals(result.get("float"), 1.23);
Assert.assertEquals(result.get("int"), 123);
Assert.assertEquals(result.get("long"), 123456789);
Assert.assertTrue(result.get("obj") instanceof Map);
Assert.assertEquals(((Map)result.get("obj")).size(), 0);
}
}