Skip to content

Add test case for InlineModelResolver: arbitrary request body #1784

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
ackintosh merged 14 commits into from
Dec 31, 2018
Merged

Add test case for InlineModelResolver: arbitrary request body #1784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0c9763d
Uncomment a valid test case
ackintosh Dec 31, 2018
eb262de
Add test case : inline request body with title
ackintosh Dec 31, 2018
963b84e
Delete legacy test case
ackintosh Dec 31, 2018
453a1d5
Delete unused import
ackintosh Dec 31, 2018
fa870d4
Delete legacy test case which is already implemented by other test
ackintosh Dec 31, 2018
70e009a
Delete legacy test case which is covered by other test
ackintosh Dec 31, 2018
c9de772
Add test case : arbitraryObjectBodyParam
ackintosh Dec 31, 2018
b2d12c7
Delete legacy test case : testArbitraryObjectBodyParam
ackintosh Dec 31, 2018
dd60b56
Add test case : arbitraryObjectRequestBodyProperty
ackintosh Dec 31, 2018
fa6b183
Delete legacy test case : testArbitraryObjectBodyParamInline
ackintosh Dec 31, 2018
ecef4fb
Add test case : arbitraryRequestBodyArray
ackintosh Dec 31, 2018
30ee5c6
Delete legacy test case : testArbitraryObjectBodyParamWithArray
ackintosh Dec 31, 2018
2756a61
Add test case : arbitraryRequestBodyArrayProperty
ackintosh Dec 31, 2018
bd314d2
Delete legacy test case
ackintosh Dec 31, 2018
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
236 changes: 59 additions & 177 deletions ...les/openapi-generator/src/test/java/org/openapitools/codegen/InlineModelResolverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@
import io.swagger.v3.oas.models.responses.ApiResponse;
import io.swagger.v3.oas.models.responses.ApiResponses;
import io.swagger.v3.parser.core.models.ParseOptions;
import org.apache.commons.lang3.StringUtils;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.util.HashMap;
Expand Down Expand Up @@ -285,7 +283,6 @@ public void resolveInlineRequestBodyWhenNoComponents() {
assertNotNull(openAPI.getComponents().getRequestBodies());
}

/*
@Test
public void resolveInlineArraySchemaWithTitle() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
Expand Down Expand Up @@ -335,36 +332,14 @@ public void resolveInlineRequestBodyWithRequired() {
assertTrue(requestBodyReference.getRequired());
}

/*
@Test
public void resolveInlineBodyParameterWithTitle() throws Exception {
OpenAPI openapi = new OpenAPI();

ObjectSchema addressModelItem = new ObjectSchema();
String addressModelName = "DetailedAddress";
addressModelItem.setTitle(addressModelName);
openapi.path("/hello", new Path()
.get(new Operation()
.parameter(new BodyParameter()
.name("body")
.schema(addressModelItem
.addProperties("address", new ObjectSchema()
.addProperties("street", new StringSchema()))
.addProperties("name", new StringSchema())))));

new InlineModelResolver().flatten(openapi);

Operation operation = openapi.getPaths().get("/hello").getGet();
BodyParameter bp = (BodyParameter)operation.getParameters().get(0);
assertTrue(bp.getSchema() instanceof RefModel);

Model body = openapi.getComponents().getSchemas().get(addressModelName);
assertTrue(body instanceof ObjectSchema);
public void resolveInlineRequestBodyWithTitle() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
new InlineModelResolver().flatten(openAPI);

ObjectSchema impl = (ObjectSchema) body;
assertNotNull(impl.getProperties().get("address"));
RequestBody requestBodyReference = openAPI.getPaths().get("/resolve_inline_request_body_with_title").getPost().getRequestBody();
assertEquals("#/components/requestBodies/resolve_inline_request_body_with_title", requestBodyReference.get$ref());
}
*/

@Test
public void nonModelRequestBody() {
Expand Down Expand Up @@ -488,177 +463,84 @@ public void resolveInlineObjectResponseWithAdditionalProperties() {
assertTrue(additionalProperties.getProperties().get("resolve_inline_object_response_with_additional_properties") instanceof StringSchema);
}

/*
@Test
public void testArrayResponse() {
OpenAPI openapi = new OpenAPI();

ArrayProperty schema = new ArrayProperty();
schema.setItems(new ObjectSchema()
.addProperties("name", new StringSchema()));

openapi.path("/foo/baz", new Path()
.get(new Operation()
.response(200, new Response()
.vendorExtension("x-foo", "bar")
.description("it works!")
.schema(schema))));
new InlineModelResolver().flatten(openapi);

Response response = openapi.getPaths().get("/foo/baz").getGet().getResponses().get("200");
assertTrue(response.getSchema() instanceof ArrayProperty);

ArrayProperty am = (ArrayProperty) response.getSchema();
Property items = am.getItems();
assertTrue(items instanceof Schema);
Schema rp = (Schema) items;
assertEquals(rp.getType(), "ref");
assertEquals(rp.get$ref(), "#/definitions/inline_response_200");
assertEquals(rp.getSimpleRef(), "inline_response_200");

Model inline = openapi.getComponents().getSchemas().get("inline_response_200");
assertTrue(inline instanceof ObjectSchema);
ObjectSchema impl = (ObjectSchema) inline;
assertNotNull(impl.getProperties().get("name"));
assertTrue(impl.getProperties().get("name") instanceof StringSchema);
}

@Test
public void testBasicInput() {
OpenAPI openapi = new OpenAPI();

ObjectSchema user = new ObjectSchema()
.addProperties("name", new StringSchema());

openapi.path("/foo/baz", new Path()
.post(new Operation()
.parameter(new BodyParameter()
.name("myBody")
.schema(new RefModel("User")))));

openapi.getComponents().addSchemas("User", user);

new InlineModelResolver().flatten(openapi);

Json.prettyPrint(openapi);
}

@Test
public void testArbitraryObjectBodyParam() {
OpenAPI openapi = new OpenAPI();

openapi.path("/hello", new Path()
.get(new Operation()
.parameter(new BodyParameter()
.name("body")
.schema(new ObjectSchema()))));
public void arbitraryObjectRequestBody() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
new InlineModelResolver().flatten(openAPI);

new InlineModelResolver().flatten(openapi);
MediaType mediaType = openAPI
.getPaths()
.get("/arbitrary_object_request_body")
.getPost()
.getRequestBody()
.getContent()
.get("application/json");

Operation operation = openapi.getPaths().get("/hello").getGet();
BodyParameter bp = (BodyParameter)operation.getParameters().get(0);
assertTrue(bp.getSchema() instanceof ObjectSchema);
ObjectSchema m = (ObjectSchema) bp.getSchema();
assertNull(m.getType());
assertTrue(mediaType.getSchema() instanceof ObjectSchema);
}

@Test
public void testArbitraryObjectBodyParamInline() {
OpenAPI openapi = new OpenAPI();

openapi.path("/hello", new Path()
.get(new Operation()
.parameter(new BodyParameter()
.name("body")
.schema(new ObjectSchema()
.addProperties("arbitrary", new ObjectSchema())))));

new InlineModelResolver().flatten(openapi);
public void arbitraryObjectRequestBodyProperty() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
new InlineModelResolver().flatten(openAPI);

Operation operation = openapi.getPaths().get("/hello").getGet();
BodyParameter bp = (BodyParameter)operation.getParameters().get(0);
assertTrue(bp.getSchema() instanceof RefModel);
MediaType mediaType = openAPI
.getPaths()
.get("/arbitrary_object_request_body_property")
.getPost()
.getRequestBody()
.getContent()
.get("application/json");

Model body = openapi.getComponents().getSchemas().get("body");
assertTrue(body instanceof ObjectSchema);
assertTrue(mediaType.getSchema() instanceof ObjectSchema);

ObjectSchema impl = (ObjectSchema) body;
Property p = impl.getProperties().get("arbitrary");
assertNotNull(p);
assertTrue(p instanceof ObjectSchema);
ObjectSchema requestBodySchema = (ObjectSchema) mediaType.getSchema();
assertTrue(requestBodySchema.getProperties().get("arbitrary_object_request_body_property") instanceof ObjectSchema);
}

@Test
public void testArbitraryObjectBodyParamWithArray() {
OpenAPI openapi = new OpenAPI();

openapi.path("/hello", new Path()
.get(new Operation()
.parameter(new BodyParameter()
.name("body")
.schema(new ArraySchema()
.items(new ObjectSchema())))));

new InlineModelResolver().flatten(openapi);

Parameter param = openapi.getPaths().get("/hello").getGet().getParameters().get(0);
assertTrue(param instanceof BodyParameter);

BodyParameter bp = (BodyParameter) param;
Model schema = bp.getSchema();
public void arbitraryRequestBodyArray() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
new InlineModelResolver().flatten(openAPI);

assertTrue(schema instanceof ArraySchema);
MediaType mediaType = openAPI
.getPaths()
.get("/arbitrary_request_body_array")
.getPost()
.getRequestBody()
.getContent()
.get("application/json");

ArraySchema am = (ArraySchema) schema;
Property inner = am.getItems();
assertTrue(inner instanceof ObjectSchema);
assertTrue(mediaType.getSchema() instanceof ArraySchema);

ObjectSchema op = (ObjectSchema) inner;
assertNotNull(op);
assertNull(op.getProperties());
ArraySchema requestBodySchema = (ArraySchema) mediaType.getSchema();
assertTrue(requestBodySchema.getItems() instanceof ObjectSchema);
assertNull(requestBodySchema.getItems().getProperties());
}

@Test
public void testArbitraryObjectBodyParamArrayInline() {
OpenAPI openapi = new OpenAPI();

openapi.path("/hello", new Path()
.get(new Operation()
.parameter(new BodyParameter()
.name("body")
.schema(new ArraySchema()
.items(new ObjectSchema()
.addProperties("arbitrary", new ObjectSchema()))))));

new InlineModelResolver().flatten(openapi);

Parameter param = openapi.getPaths().get("/hello").getGet().getParameters().get(0);
assertTrue(param instanceof BodyParameter);

BodyParameter bp = (BodyParameter) param;
Model schema = bp.getSchema();

assertTrue(schema instanceof ArraySchema);
public void arbitraryRequestBodyArrayProperty() {
OpenAPI openAPI = new OpenAPIParser().readLocation("src/test/resources/3_0/inline_model_resolver.yaml", null, new ParseOptions()).getOpenAPI();
new InlineModelResolver().flatten(openAPI);

ArraySchema am = (ArraySchema) schema;
Property inner = am.getItems();
assertTrue(inner instanceof Schema);
MediaType mediaType = openAPI
.getPaths()
.get("/arbitrary_request_body_array_property")
.getPost()
.getRequestBody()
.getContent()
.get("application/json");

Schema rp = (Schema) inner;
assertTrue(mediaType.getSchema() instanceof ArraySchema);

assertEquals(rp.getType(), "ref");
assertEquals(rp.get$ref(), "#/definitions/body");
assertEquals(rp.getSimpleRef(), "body");
ArraySchema requestBodySchema = (ArraySchema) mediaType.getSchema();
assertNotNull(requestBodySchema.getItems().get$ref());

Model inline = openapi.getComponents().getSchemas().get("body");
assertNotNull(inline);
assertTrue(inline instanceof ObjectSchema);
ObjectSchema impl = (ObjectSchema) inline;
Property p = impl.getProperties().get("arbitrary");
assertNotNull(p);
assertTrue(p instanceof ObjectSchema);
Schema referencedSchema = ModelUtils.getReferencedSchema(openAPI, requestBodySchema.getItems());
assertTrue(referencedSchema.getProperties().get("arbitrary_request_body_array_property") instanceof ObjectSchema);
}

/*
@Test
public void testArbitraryObjectResponse() {
OpenAPI openapi = new OpenAPI();
Expand Down
69 changes: 69 additions & 0 deletions modules/openapi-generator/src/test/resources/3_0/inline_model_resolver.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,21 @@ paths:
responses:
'200':
description: OK
/resolve_inline_request_body_with_title:
post:
requestBody:
content:
application/json:
schema:
title: resolve_inline_request_body_with_title
type: object
properties:
name:
type: string
operationId: resolveInlineRequestBodyWithRequired
responses:
'200':
description: OK
/non_model_request_body:
post:
requestBody:
Expand Down Expand Up @@ -136,6 +151,60 @@ paths:
properties:
resolve_inline_object_response_with_additional_properties:
type: string
/arbitrary_object_request_body:
post:
requestBody:
content:
application/json:
schema:
type: object
operationId: arbitraryObjectRequestBody
responses:
'200':
description: OK
/arbitrary_object_request_body_property:
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
arbitrary_object_request_body_property:
type: object
operationId: arbitraryObjectRequestBodyProperty
responses:
'200':
description: OK
/arbitrary_request_body_array:
post:
requestBody:
content:
application/json:
schema:
type: item
items:
type: object
operationId: arbitraryRequestBodyArray
responses:
'200':
description: OK
/arbitrary_request_body_array_property:
post:
requestBody:
content:
application/json:
schema:
type: item
items:
type: object
properties:
arbitrary_request_body_array_property:
type: object
operationId: arbitraryRequestBodyArrayProperty
responses:
'200':
description: OK
components:
schemas:
Users:
Expand Down