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.

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

Jump to bottom

Issue #2116. Fix cross-path reference parameter ref resolve #2121

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

Issue #2116. Fix cross-path reference parameter ref resolve #2121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51ac8c2
Issue #2116. Fix cross-path reference parameter ref resolve
ludovicianul Aug 12, 2024
7ad16bc
Issue #2116. Add unit test to check that params ref starting with #/p…
ludovicianul Aug 13, 2024
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
6 changes: 6 additions & 0 deletions ...s/swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/ParameterProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ public List<Parameter> processParameters(List<Parameter> parameters) {
if (parameter.get$ref() != null) {
RefFormat refFormat = computeRefFormat(parameter.get$ref());
final Parameter resolvedParameter = cache.loadRef(parameter.get$ref(), refFormat, Parameter.class);

if (parameter.get$ref().startsWith("#/paths")) {
processedPathLevelParameters.add(parameter);
continue;
}

if (parameter.get$ref().startsWith("#") && parameter.get$ref().indexOf("#/components/parameters") <= -1) {
//TODO: Not possible to add warning during resolve doesn't accept result as an input. Hence commented below line.
//result.warning(location, "The parameter should use Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.");
Expand Down
306 changes: 161 additions & 145 deletions ...agger-parser-v3/src/test/java/io/swagger/v3/parser/processors/ParameterProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.swagger.v3.parser.processors;

import static org.testng.Assert.assertEquals;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Content;
Expand All @@ -13,154 +14,169 @@
import io.swagger.v3.oas.models.parameters.RequestBody;
import io.swagger.v3.parser.ResolverCache;
import io.swagger.v3.parser.models.RefFormat;
import mockit.*;
import org.testng.annotations.Test;


import java.util.Arrays;
import java.util.List;

import static org.testng.Assert.assertEquals;

import mockit.Expectations;
import mockit.FullVerifications;
import mockit.Injectable;
import mockit.Mocked;
import org.testng.annotations.Test;

public class ParameterProcessorTest {


@Injectable
ResolverCache cache;

@Injectable
OpenAPI openAPI;

@Mocked
SchemaProcessor modelProcessor;

@Injectable
boolean openapi31;

@Injectable
HeaderParameter headerParameter;

@Injectable
QueryParameter queryParameter;

@Injectable
CookieParameter cookieParameter;

@Injectable
PathParameter pathParameter;

@Injectable
HeaderParameter resolvedHeaderParam;

@Injectable
Schema bodyParamSchema;

@Test
public void testProcessParameters_TypesThatAreNotRefOrBody() throws Exception {
expectedModelProcessorCreation();
new Expectations() {
{
headerParameter.getSchema();
result = null;
headerParameter.getContent();
result = null;
queryParameter.getSchema();
result = null;
queryParameter.getContent();
result = null;
cookieParameter.getSchema();
result = null;
cookieParameter.getContent();
result = null;
pathParameter.getSchema();
result = null;
pathParameter.getContent();
result = null;
}
};
final List<Parameter> processedParameters = new ParameterProcessor(cache, openAPI, openapi31)
.processParameters(Arrays.asList(headerParameter,
queryParameter,
cookieParameter,
pathParameter));

new FullVerifications() {{
headerParameter.get$ref();
times = 1;
queryParameter.get$ref();
times = 1;
cookieParameter.get$ref();
times = 1;
pathParameter.get$ref();
times = 1;
}};

assertEquals(processedParameters.size(), 4);
assertEquals(processedParameters.get(0), headerParameter);
assertEquals(processedParameters.get(1), queryParameter);
assertEquals(processedParameters.get(2), cookieParameter);
assertEquals(processedParameters.get(3), pathParameter);
}

@Test
public void testProcessParameters_RefToHeader() throws Exception {
expectedModelProcessorCreation();

final String ref = "#/components/parameters/foo";
Parameter refParameter = new Parameter().$ref(ref);

expectLoadingRefFromCache(ref, RefFormat.INTERNAL, resolvedHeaderParam);
new Expectations() {
{
resolvedHeaderParam.getSchema();
result = null;
resolvedHeaderParam.getContent();
result = null;
}
};

final List<Parameter> processedParameters = new ParameterProcessor(cache, openAPI, openapi31).processParameters(Arrays.asList(refParameter));

new FullVerifications(){{}};

assertEquals(processedParameters.size(), 1);
assertEquals(processedParameters.get(0), resolvedHeaderParam);
}

private void expectLoadingRefFromCache(final String ref, final RefFormat refFormat,
final Parameter resolvedParam) {
new Expectations() {{
cache.loadRef(ref, refFormat, Parameter.class);
times = 1;
result = resolvedParam;
}};
}

@Test
public void testProcessParameters_BodyParameter() throws Exception {
final SchemaProcessor[] schemaProcessor1 = {new SchemaProcessor(cache, openAPI, openapi31)};
new Expectations() {{
schemaProcessor1[0] = new SchemaProcessor(cache, openAPI, openapi31);
times = 1;

}};

RequestBody bodyParameter = new RequestBody().content(new Content().addMediaType("*/*",new MediaType().schema(bodyParamSchema)));

new Expectations(){{
schemaProcessor1[0].processSchema(bodyParamSchema); times=1;
}};

new RequestBodyProcessor(cache, openAPI, openapi31).processRequestBody(bodyParameter);

new FullVerifications(){{}};
}

private void expectedModelProcessorCreation() {
new Expectations() {{
new SchemaProcessor(cache, openAPI, openapi31);
times = 1;
}};
}
@Injectable
ResolverCache cache;

@Injectable
OpenAPI openAPI;

@Mocked
SchemaProcessor modelProcessor;

@Injectable
boolean openapi31;

@Injectable
HeaderParameter headerParameter;

@Injectable
QueryParameter queryParameter;

@Injectable
CookieParameter cookieParameter;

@Injectable
PathParameter pathParameter;

@Injectable
HeaderParameter resolvedHeaderParam;

@Injectable
Schema bodyParamSchema;

@Test
public void testProcessParameters_TypesThatAreNotRefOrBody() throws Exception {
expectedModelProcessorCreation();
new Expectations() {
{
headerParameter.getSchema();
result = null;
headerParameter.getContent();
result = null;
queryParameter.getSchema();
result = null;
queryParameter.getContent();
result = null;
cookieParameter.getSchema();
result = null;
cookieParameter.getContent();
result = null;
pathParameter.getSchema();
result = null;
pathParameter.getContent();
result = null;
}
};
final List<Parameter> processedParameters = new ParameterProcessor(cache, openAPI, openapi31)
.processParameters(Arrays.asList(
headerParameter,
queryParameter,
cookieParameter,
pathParameter
));

new FullVerifications() {{
headerParameter.get$ref();
times = 1;
queryParameter.get$ref();
times = 1;
cookieParameter.get$ref();
times = 1;
pathParameter.get$ref();
times = 1;
}};

assertEquals(processedParameters.size(), 4);
assertEquals(processedParameters.get(0), headerParameter);
assertEquals(processedParameters.get(1), queryParameter);
assertEquals(processedParameters.get(2), cookieParameter);
assertEquals(processedParameters.get(3), pathParameter);
}

@Test
public void testProcessParameters_RefToHeader() throws Exception {
expectedModelProcessorCreation();

final String ref = "#/components/parameters/foo";
Parameter refParameter = new Parameter().$ref(ref);

expectLoadingRefFromCache(ref, RefFormat.INTERNAL, resolvedHeaderParam);
new Expectations() {
{
resolvedHeaderParam.getSchema();
result = null;
resolvedHeaderParam.getContent();
result = null;
}
};

final List<Parameter> processedParameters = new ParameterProcessor(cache, openAPI, openapi31).processParameters(Arrays.asList(refParameter));

new FullVerifications() {{
}};

assertEquals(processedParameters.size(), 1);
assertEquals(processedParameters.get(0), resolvedHeaderParam);
}

private void expectLoadingRefFromCache(
final String ref, final RefFormat refFormat,
final Parameter resolvedParam
) {
new Expectations() {{
cache.loadRef(ref, refFormat, Parameter.class);
times = 1;
result = resolvedParam;
}};
}

@Test
public void testProcessParameters_BodyParameter() throws Exception {
final SchemaProcessor[] schemaProcessor1 = {new SchemaProcessor(cache, openAPI, openapi31)};
new Expectations() {{
schemaProcessor1[0] = new SchemaProcessor(cache, openAPI, openapi31);
times = 1;

}};

RequestBody bodyParameter = new RequestBody().content(new Content().addMediaType("*/*", new MediaType().schema(bodyParamSchema)));

new Expectations() {{
schemaProcessor1[0].processSchema(bodyParamSchema);
times = 1;
}};

new RequestBodyProcessor(cache, openAPI, openapi31).processRequestBody(bodyParameter);

new FullVerifications() {{
}};
}

@Test
public void testProcessParameters_PreservePathRef() throws Exception {
ParameterProcessor processor = new ParameterProcessor(cache, openAPI, openapi31);
List<Parameter> parameters =
Arrays.asList(new PathParameter().$ref("#/paths/~1test/get/parameters/0"), new PathParameter().$ref("#/no-paths/~1test/get/parameters/0"));
List<Parameter> processedParameters = processor.processParameters(parameters);

assertEquals(processedParameters.size(), 1);
assertEquals(processedParameters.get(0).get$ref(), "#/paths/~1test/get/parameters/0");
}

private void expectedModelProcessorCreation() {
new Expectations() {{
new SchemaProcessor(cache, openAPI, openapi31);
times = 1;
}};
}
}