Skip to content

Fix for #620: allOf fails to process load properties with external $ref #621

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

Merged
merged 1 commit into from
Jan 9, 2018
Merged

Fix for #620: allOf fails to process load properties with external $ref #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 29 additions & 21 deletions modules/swagger-parser/src/main/java/io/swagger/parser/processors/ExternalRefProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,31 +92,14 @@ public String processRefToExternalDefinition(String $ref, RefFormat refFormat) {
} else {
processRefToExternalDefinition(file + refModel.get$ref(), RefFormat.RELATIVE);
}
} else if (allOfModel instanceof ModelImpl) {
//Loop through additional properties of allOf and recursively call this method;
processProperties(allOfModel.getProperties(), file);
}
}
}
//Loop the properties and recursively call this method;
Map<String, Property> subProps = model.getProperties();
if (subProps != null) {
for (Map.Entry<String, Property> prop : subProps.entrySet()) {
if (prop.getValue() instanceof RefProperty) {
processRefProperty((RefProperty) prop.getValue(), file);
} else if (prop.getValue() instanceof ArrayProperty) {
ArrayProperty arrayProp = (ArrayProperty) prop.getValue();
if (arrayProp.getItems() instanceof RefProperty) {
processRefProperty((RefProperty) arrayProp.getItems(), file);
}
} else if (prop.getValue() instanceof MapProperty) {
MapProperty mapProp = (MapProperty) prop.getValue();
if (mapProp.getAdditionalProperties() instanceof RefProperty) {
processRefProperty((RefProperty) mapProp.getAdditionalProperties(), file);
} else if (mapProp.getAdditionalProperties() instanceof ArrayProperty &&
((ArrayProperty) mapProp.getAdditionalProperties()).getItems() instanceof RefProperty) {
processRefProperty((RefProperty) ((ArrayProperty) mapProp.getAdditionalProperties()).getItems(), file);
}
}
}
}
processProperties(model.getProperties(), file);
if (model instanceof ModelImpl) {
ModelImpl modelImpl = (ModelImpl) model;
Property additionalProperties = modelImpl.getAdditionalProperties();
Expand Down Expand Up @@ -148,6 +131,31 @@ public String processRefToExternalDefinition(String $ref, RefFormat refFormat) {
return newRef;
}

private void processProperties(final Map<String, Property> subProps, final String file) {
if (subProps == null || 0 == subProps.entrySet().size() ) {
return;
}
for (Map.Entry<String, Property> prop : subProps.entrySet()) {
if (prop.getValue() instanceof RefProperty) {
processRefProperty((RefProperty) prop.getValue(), file);
} else if (prop.getValue() instanceof ArrayProperty) {
ArrayProperty arrayProp = (ArrayProperty) prop.getValue();
if (arrayProp.getItems() instanceof RefProperty) {
processRefProperty((RefProperty) arrayProp.getItems(), file);
}
} else if (prop.getValue() instanceof MapProperty) {
MapProperty mapProp = (MapProperty) prop.getValue();
if (mapProp.getAdditionalProperties() instanceof RefProperty) {
processRefProperty((RefProperty) mapProp.getAdditionalProperties(), file);
} else if (mapProp.getAdditionalProperties() instanceof ArrayProperty &&
((ArrayProperty) mapProp.getAdditionalProperties()).getItems() instanceof RefProperty) {
processRefProperty((RefProperty) ((ArrayProperty) mapProp.getAdditionalProperties()).getItems(),
file);
}
}
}
}

private void processRefProperty(RefProperty subRef, String externalFile) {
if (isAnExternalRefFormat(subRef.getRefFormat())) {
String $ref = constructRef(subRef, externalFile);
Expand Down
4 changes: 2 additions & 2 deletions modules/swagger-parser/src/main/java/io/swagger/parser/util/RefUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public static String readExternalUrlRef(String file, RefFormat refFormat, List<A
return readExternalRef(url, RefFormat.URL, auths, null);
}
} catch (Exception e) {
throw new RuntimeException("Unable to load " + refFormat + " ref: " + file, e);
throw new RuntimeException("Unable to load " + refFormat + " ref: " + file + " path:" + rootPath, e);
}

return result;
Expand Down Expand Up @@ -143,7 +143,7 @@ public static String readExternalRef(String file, RefFormat refFormat, List<Auth

}
} catch (Exception e) {
throw new RuntimeException("Unable to load " + refFormat + " ref: " + file, e);
throw new RuntimeException("Unable to load " + refFormat + " ref: " + file + " path: "+parentDirectory, e);
}

return result;
Expand Down
21 changes: 18 additions & 3 deletions modules/swagger-parser/src/test/java/io/swagger/parser/FileReferenceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
package io.swagger.parser;

import io.swagger.models.*;
import io.swagger.models.properties.ArrayProperty;
import io.swagger.models.properties.Property;
import io.swagger.models.properties.RefProperty;
import io.swagger.parser.util.SwaggerDeserializationResult;
import org.testng.annotations.Test;

import static org.testng.Assert.*;
import java.util.Arrays;
import java.util.Map;


public class FileReferenceTests {
@Test
Expand Down Expand Up @@ -148,9 +152,20 @@ public void testIssue340() {
@Test
public void testIssue304() {
SwaggerDeserializationResult result = new SwaggerParser().readWithInfo("./src/test/resources/nested-file-references/issue-304.json", null, true);
assertNotNull(result.getSwagger());
assertNotNull(result.getSwagger().getDefinitions());
}

Swagger swagger = result.getSwagger();
assertFalse(swagger.getDefinitions().get("BarData") instanceof RefModel);
@Test
public void testAllOfFlatAndNested() {
for (String path : Arrays.asList("./src/test/resources/allOf-properties-ext-ref/models/swagger.json",
"./src/test/resources/allOf-properties-ext-ref/swagger.json")) {
Swagger swagger = new SwaggerParser().read(path);
assertEquals(3, swagger.getDefinitions().size());
ComposedModel composedModel = (ComposedModel)swagger.getDefinitions().get("record");
assertEquals(((RefModel) composedModel.getParent()).getSimpleRef(), "pet");
Map<String, Property> props = composedModel.getChild().getProperties();
assertEquals(((RefProperty) props.get("mother")).getSimpleRef(), "pet");
assertEquals(((RefProperty) ((ArrayProperty) props.get("siblings")).getItems()).getSimpleRef(), "pet");
}
}
}
8 changes: 8 additions & 0 deletions modules/swagger-parser/src/test/resources/allOf-properties-ext-ref/models/pet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"type": "object",
"properties": {
"color": {
"type": "string"
}
}
}
25 changes: 25 additions & 0 deletions modules/swagger-parser/src/test/resources/allOf-properties-ext-ref/models/purebred_pet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"allOf": [
{
"$ref": "./pet.json"
},
{
"type": "object",
"properties": {
"breed": {
"type": "string",
"sample": "Labrador"
},
"mother": {
"$ref": "./pet.json"
},
"siblings": {
"type": "array",
"items": {
"$ref": "./pet.json"
}
}
}
}
]
}
12 changes: 12 additions & 0 deletions modules/swagger-parser/src/test/resources/allOf-properties-ext-ref/models/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"swagger": "2.0",
"info": {
"title": "flat",
"version": "1.0.0"
},
"definitions": {
"record": {
"$ref": "./purebred_pet.json"
}
}
}
12 changes: 12 additions & 0 deletions modules/swagger-parser/src/test/resources/allOf-properties-ext-ref/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"swagger": "2.0",
"info": {
"title": "flat",
"version": "1.0.0"
},
"definitions": {
"record": {
"$ref": "./models/purebred_pet.json"
}
}
}