forked from payara/Payara
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request payara#5331 from aubi/FISH-1204
FISH-1204 Missing example values in OpenApi components schema definition using nested objects
- Loading branch information
1 parent
e1cec75
commit e0c842c
Showing
7 changed files
with
535 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
...test/java/fish/payara/microprofile/openapi/test/app/application/DependantClassesTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* | ||
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | ||
| * | ||
| * Copyright (c) [2021] Payara Foundation and/or its affiliates. All rights reserved. | ||
| * | ||
| * The contents of this file are subject to the terms of either the GNU | ||
| * General Public License Version 2 only ("GPL") or the Common Development | ||
| * and Distribution License("CDDL") (collectively, the "License"). You | ||
| * may not use this file except in compliance with the License. You can | ||
| * obtain a copy of the License at | ||
| * https://github.com/payara/Payara/blob/master/LICENSE.txt | ||
| * See the License for the specific | ||
| * language governing permissions and limitations under the License. | ||
| * | ||
| * When distributing the software, include this License Header Notice in each | ||
| * file and include the License file at glassfish/legal/LICENSE.txt. | ||
| * | ||
| * GPL Classpath Exception: | ||
| * The Payara Foundation designates this particular file as subject to the "Classpath" | ||
| * exception as provided by the Payara Foundation in the GPL Version 2 section of the License | ||
| * file that accompanied this code. | ||
| * | ||
| * Modifications: | ||
| * If applicable, add the following below the License Header, with the fields | ||
| * enclosed by brackets [] replaced by your own identifying information: | ||
| * "Portions Copyright [year] [name of copyright owner]" | ||
| * | ||
| * Contributor(s): | ||
| * If you wish your version of this file to be governed by only the CDDL or | ||
| * only the GPL Version 2, indicate your decision by adding "[Contributor] | ||
| * elects to include this software in this distribution under the [CDDL or GPL | ||
| * Version 2] license." If you don't indicate a single choice of license, a | ||
| * recipient has the option to distribute your version of this file under | ||
| * either the CDDL, the GPL Version 2 or to extend the choice of license to | ||
| * its licensees as provided above. However, if you add GPL Version 2 code | ||
| * and therefore, elected the GPL Version 2 license, then the option applies | ||
| * only if the new code is made subject to such option by the copyright | ||
| * holder. | ||
| */ | ||
| package fish.payara.microprofile.openapi.test.app.application; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import fish.payara.microprofile.openapi.resource.rule.ApplicationProcessedDocument; | ||
| import fish.payara.microprofile.openapi.test.app.OpenApiApplicationTest; | ||
| import fish.payara.microprofile.openapi.test.app.TestApplication; | ||
| import fish.payara.microprofile.openapi.test.app.application.schema.Schema1Depending; | ||
| import fish.payara.microprofile.openapi.test.app.application.schema.Schema2Simple; | ||
| import fish.payara.microprofile.openapi.test.app.application.schema.Schema2Simple1; | ||
| import static fish.payara.microprofile.openapi.test.util.JsonUtils.path; | ||
| import static fish.payara.microprofile.openapi.test.util.JsonUtils.toJson; | ||
| import java.util.Iterator; | ||
| import javax.ws.rs.POST; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.Produces; | ||
| import javax.ws.rs.core.MediaType; | ||
| import org.eclipse.microprofile.openapi.annotations.media.Content; | ||
| import org.eclipse.microprofile.openapi.annotations.media.Schema; | ||
| import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody; | ||
| import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; | ||
| import org.eclipse.microprofile.openapi.annotations.responses.APIResponses; | ||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertFalse; | ||
| import static org.junit.Assert.assertNotNull; | ||
| import static org.junit.Assert.assertTrue; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Test presence of required attribute in the generated OpenApi. | ||
| */ | ||
| @Path("/serversDependant") | ||
| public class DependantClassesTest extends OpenApiApplicationTest { | ||
|
|
||
| // add multiple classes to be processed, simulate component scan | ||
| @Before | ||
| @Override | ||
| public void createDocument() { | ||
| document = ApplicationProcessedDocument.createDocument(null, getClass(), TestApplication.class, Schema1Depending.class, Schema2Simple.class, Schema2Simple1.class); | ||
| jsonDocument = toJson(document); | ||
| } | ||
|
|
||
| @POST | ||
| @Produces(MediaType.APPLICATION_JSON) | ||
| @APIResponses({ | ||
| @APIResponse(responseCode = "200", description = "Successful, returning ok.")}) | ||
| public Schema1Depending save(@RequestBody(description = "The request body with connected data", required = true, | ||
| content = @Content( | ||
| mediaType = MediaType.APPLICATION_JSON, | ||
| schema = @Schema(implementation = Schema1Depending.class) | ||
| )) Schema1Depending schema1Depending) { | ||
| return new Schema1Depending(); | ||
| } | ||
|
|
||
| /** | ||
| * Test if the additional field description is copied to the dependant | ||
| * schema. E.g. Schema2Simple -> Schema1Depending | ||
| */ | ||
| @Test | ||
| public void dependantSchemaIsFullyPopulated() { | ||
| ObjectNode root = getOpenAPIJson(); | ||
| // verify schema | ||
| JsonNode subpropertyId = path(root, "components.schemas.Schema1Depending.properties.schema2Simple.properties.id"); | ||
| assertEquals("ID", subpropertyId.findValue("description").asText()); | ||
| assertEquals("1", subpropertyId.findValue("example").asText()); | ||
| // verify operation's data | ||
| // FIXME: this test crashes as for some reason, schema2Simple is refereneced, not copied. | ||
| JsonNode operationSubpropertyId = path(root, "paths./test/serversDependant.post.requestBody.content.application/json.schema.properties.schema2Simple.properties.id"); | ||
| assertEquals("ID", operationSubpropertyId.findValue("description").asText()); | ||
| assertEquals("1", operationSubpropertyId.findValue("example").asText()); | ||
| } | ||
|
|
||
| @Test | ||
| public void dependantSchemaHasTwoRequiredFields() { | ||
| // verify, that both attributes in Schema1Depending (implementation and ref) are required | ||
| JsonNode requiredItems = path(getOpenAPIJson(), "components.schemas.Schema1Depending.required"); | ||
| assertNotNull(requiredItems); | ||
| Iterator<JsonNode> requiredElements = requiredItems.elements(); | ||
| // verify one result | ||
| assertTrue(requiredElements.hasNext()); | ||
| // verify the name of the required field | ||
| assertEquals("schema2Simple", requiredElements.next().asText()); | ||
| // one more result | ||
| assertTrue(requiredElements.hasNext()); | ||
| // verify the name of the required field | ||
| assertEquals("schema2SimpleRef", requiredElements.next().asText()); | ||
| // no more than two results | ||
| assertFalse(requiredElements.hasNext()); | ||
| } | ||
| } |
Oops, something went wrong.