Skip to content
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.

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

fix for issue-1865 - dereferencing files with dots #1877

Merged
merged 1 commit into from
Feb 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;

Expand Down Expand Up @@ -47,10 +48,13 @@ public static String computeDefinitionName(String ref) {
plausibleName = filePathElements[filePathElements.length - 1];

final String[] split = plausibleName.split("\\.");
// Fix for issue-1621
plausibleName = split[0];
for (int i = 1; i < split.length - 1; i++) {
plausibleName += "." + split[i];
// Fix for issue-1621 and issue-1865
//validate number of dots
if(split.length > 2) {
//Remove dot so ref can be interpreted as internal and relative in Swagger-Core schema class 'set$ref'
plausibleName = String.join("", Arrays.copyOf(split, split.length - 1));
}else{
plausibleName = split[0];
}
}

Expand Down Expand Up @@ -225,4 +229,4 @@ private static String readAll(Path path) throws IOException {
return IOUtils.toString(inputStream, UTF_8);
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,36 @@ public class OpenAPIV3ParserTest {
protected int serverPort = getDynamicPort();
protected WireMockServer wireMockServer;

@Test
public void testIssue1621() {
final ParseOptions parseOptions = new ParseOptions();
parseOptions.setResolve(true);
parseOptions.setResolveFully(true);
parseOptions.setResolveCombinators(false);
SwaggerParseResult parseResult = new OpenAPIV3Parser().readLocation("issue-1621/example.openapi.yaml", null, parseOptions);
assertEquals(0, parseResult.getMessages().size());
OpenAPI api = parseResult.getOpenAPI();
assertEquals( api.getPaths()
.get("/example")
.getPost()
.getRequestBody()
.getContent()
.get("application/json")
.getSchema()
.getTitle(),"POST Example");
}

@Test
public void testIssue1865() throws Exception {
ParseOptions options = new ParseOptions();
options.setResolve(true);
SwaggerParseResult result = new OpenAPIV3Parser().readLocation("src/test/resources/issue-1865/openapi30.yaml", null, options);

Assert.assertNotNull(result);
Assert.assertNotNull(result.getOpenAPI());
Assert.assertEquals(result.getOpenAPI().getComponents().getSchemas().get("Foo").get$ref(), "#/components/schemas/foomodel");
}

@Test
public void testIssue1777() {
OpenAPIV3Parser openApiParser = new OpenAPIV3Parser();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#broken-ref/apis/foo.yaml
openapi: 3.0.0
info:
title: swagger parser bug, worked until 2.0.28 but not since 2.0.29
version: '1.0'

paths:

'/foo':
post:
summary: create foo
description: Create a new foo.
responses:
'200':
description: a Foo
content:
application/json:
schema:
$ref: '#/components/schemas/Foo'

components:
schemas:
Foo:
$ref: ../models/foo.model.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# broken-ref/examples/foo.example.yaml
value:
foo: bar
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#broken-ref/models/foo.model.yaml
title: Foo
type: object
properties:
foo:
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# broken-ref/openapi30.yaml
openapi: 3.0.3
info:
title: ref chain
version: '1'

paths:
/foo:
$ref: ./apis/foo.yaml#/paths/~1foo
Original file line number Diff line number Diff line change
Expand Up @@ -65,26 +65,6 @@ public void testIssue1143(){
assertNotNull(result.getOpenAPI().getComponents().getSchemas().get("identificacion_usuario_aplicacion"));
}

@Test
public void testIssue1621() {
final ParseOptions parseOptions = new ParseOptions();
parseOptions.setResolve(true);
parseOptions.setResolveFully(true);
parseOptions.setResolveCombinators(false);
OpenAPIParser openAPIParser = new OpenAPIParser();
SwaggerParseResult swaggerParseResult = openAPIParser.readLocation("issue-1621/example.openapi.yaml", null, parseOptions);
assertEquals(0, swaggerParseResult.getMessages().size());
OpenAPI api = swaggerParseResult.getOpenAPI();
assertEquals("POST Example", api.getPaths()
.get("/example")
.getPost()
.getRequestBody()
.getContent()
.get("application/json")
.getSchema()
.getTitle());
}

@Test
public void testIssue749() {
ParseOptions options = new ParseOptions();
Expand Down