PAYARA-3466 Open API 1.1 - Tests #3852

jbee · 2019-03-19T10:10:17Z

This PR adds more tests for the Open API module motivated by the defects reported earlier and found during update to Open API 1.1.

A particular focus area is the JSON rendering. Being annotation guided semi-automatic the output wasn't always intuitive and often incorrect. There were problems both with missing elements and elements that should never have been in the output.

To verify the JSON output from our model against the Open API spec (as outlined here https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md ) I created a model for the spec structure (see NoteType) and a OpenApiValidator that can verify the structure of a Open API document given as JsonNode. As this is no trivial operation in itself the validator itself needed testing to verify its correctness. For that reason I added example JSON snippets from the spec which are expected to pass the verification. So none of the .json files needs serious review.

The likely correct structural Open API document validator is then used to validate documents created for existing and new tests.

A common base class OpenApiApplicationTest was extracted that bootstraps the applications with the extras of the class under test and verifies the structure of created document so that the individual tests only have to focus on verifying the contents of the document.
The same was done with OpenApiBuilderTest as a base for tests using the model fluent API to setup the basis of the document.

A larger change in the annotation processing was needed to handle annotations as if they are inherited from super-classes and interfaces. The util AnnotationInfo takes care of this aggregation for each type.

…ument validation, added more tests

… added test for callbacks, added components references to validator model

…form to guideline

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java

… JSON

… docs

jbee · 2019-03-28T09:23:16Z

...profile/openapi/src/test/java/fish/payara/microprofile/openapi/test/app/TestApplication.java

 @ApplicationPath("/test")
 public class TestApplication extends Application {

-    @Override
-    public Set<Class<?>> getClasses() {


FYI: Now passed to the test setup to be more flexible and isolated per test.

jbee · 2019-03-28T09:35:44Z

jenkins test please

jbee · 2019-03-28T09:43:55Z

jenkins test please

...file/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/media/SchemaImpl.java

...e/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/AnnotationInfo.java

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/visitor/OpenApiWalker.java

…ct them

…otations

…s for #isAnnotationNull

jbee · 2019-04-02T14:17:28Z

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/util/ModelUtils.java

        for (Method m : annotation.annotationType().getDeclaredMethods()) {
            if (m.getParameterCount() == 0) {
                try {
                    Object value = m.invoke(annotation);
-                    if (value != null) {


FYI: Main point was to change the .cast(...) to (Type)value style of cast or instanceof where appropriate. Also values from annotation can never be null or a Collection type so I removed these checks. To be sure this is correct I added tests for this util method.

…of processor to walker

jbee · 2019-04-02T17:33:15Z

jenkins test please

jbee · 2019-04-03T08:41:12Z

...roprofile/openapi/src/main/java/fish/payara/microprofile/openapi/api/visitor/ApiContext.java

+     * @param type any class, not null
+     * @return true, if the give type is a known type in this context, else false
+     */
+    boolean isApplicationType(Class<?> type);


I added this to allow the ApplicationProcessor logic to make this check even though the information on this is within the OpenApiWalker that creates the ApiContext.

jbee · 2019-04-03T08:45:19Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

@@ -457,24 +438,9 @@ private void addParameter(AnnotatedElement element, ApiContext context,
        if (context.getWorkingOperation() != null) {
            context.getWorkingOperation().addParameter(newParameter);
        } else {
-            if (element instanceof Field) {
-                Field field = Field.class.cast(element);
-                ApiContext apiContext;


FYI: Below logic moved to the walker so the walker now is the only one creating the context which is both cleaner and was needed to allow moving inner class processing to the walker what needed to delay generation of resource mapping which also moved to the walker.

jbee · 2019-04-03T08:45:45Z

...napi/src/main/java/fish/payara/microprofile/openapi/impl/processor/ApplicationProcessor.java

-    /**
-     * Generates a map listing the location each resource class is mapped to.
-     */
-    private static Map<String, Set<Class<?>>> generateResourceMapping(Set<Class<?>> classList) {


FYI: Moved to the walker as is.

jbee · 2019-04-03T08:47:14Z

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/visitor/OpenApiWalker.java

    }

    @Override
    public void accept(ApiVisitor visitor) {
        // OpenAPI necessary annotations
-        processAnnotations(OpenAPIDefinition.class, visitor::visitOpenAPI, true);
-        processAnnotations(Schema.class, visitor::visitSchema, true);


FYI: Schema was processed twice which was needed previously but now works when keeping the later processing of Schema annotation.

jbee · 2019-04-03T08:47:58Z

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/visitor/OpenApiWalker.java

+                    || annotationClass == CookieParam.class
+                    || annotationClass == PathParam.class
+                    || annotationClass == QueryParam.class) {
+                    // NB. if fields are annotated as Param all methods have it


FYI: The field => method logic part was moved here from the application processor

jbee · 2019-04-03T08:48:34Z

...ofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/visitor/OpenApiWalker.java

+    /**
+     * Generates a map listing the location each resource class is mapped to.
+     */
+    private static Map<String, Set<Class<?>>> generateResourceMapping(Set<Class<?>> classList) {


FYI: Method moved here from ApplicationProcessor

jbee · 2019-04-03T08:51:09Z

jenkins test please

Pandrex247

Haven't spotted anything, though there was a lot to look through!

jbee · 2019-04-03T16:00:47Z

@Pandrex247 I would have liked to split in multiple PRs but its hard to do that for fixes and confirming tests where most of the fixes only in union lead to meaningful and correct results one can test for. Therefore I felt it was still the best option to keep it all in one PR.

MattGill98 · 2019-04-08T10:07:15Z

🎉 🎉 🎉

jbee added 4 commits March 15, 2019 18:05

PAYARA-3466 basic tests and basis for JSON output testing

3d29846

PAYARA-3466 fixed serialisation of extentions and maps with properties

4076aa9

PAYARA-3466 extracted base class for example app based tests with doc…

cbcd031

…ument validation, added more tests

Merge branch 'master' into PAYARA-3466-open-api-1.1-tests

147dba1

jbee added this to the 5.192 milestone Mar 19, 2019

jbee self-assigned this Mar 19, 2019

OndroMih added the 3:DevInProgress label Mar 19, 2019

jbee added 2 commits March 19, 2019 18:09

PAYARA-3466 fixed annotation processing (empty annotation detection),…

6be803b

… added test for callbacks, added components references to validator model

PAYARA-3466 tested and fixed GH #3724 (filters), changed names to con…

54613c5

…form to guideline

jbee mentioned this pull request Mar 20, 2019

[microprofile] The /openapi does not render the additionalProperties. #3724

Closed

jbee added 2 commits March 20, 2019 18:28

PAYARA-3466 actually useful toString for model

cc8099f

PAYARA-3466 Schema reference test for GH #3832

e8960c3

svendiedrichsen reviewed Mar 20, 2019

View reviewed changes

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java Outdated Show resolved Hide resolved

svendiedrichsen reviewed Mar 20, 2019

View reviewed changes

...rofile/openapi/src/main/java/fish/payara/microprofile/openapi/impl/model/ExtensibleImpl.java Outdated Show resolved Hide resolved

jbee mentioned this pull request Mar 21, 2019

[microprofile] openapi response is wrong #3832

Closed

PAYARA-3466 fixed processing of inner classes, more tests on model =>…

aa05f9f

… JSON

MarkWareham added the PR: DO NOT MERGE Don't merge PR until further notice label Mar 21, 2019

jbee added 13 commits March 21, 2019 15:00

PAYARA-3466 added test for operation, security requirements, external…

25d1a66

… docs

PAYARA-3466 added tests on headers and request bodies

2fe1791

PAYARA-3466 added tests on examples

7abdcec

PAYARA-3466 added tests on links

b32b7db

PAYARA-3466 added tests on the security package

4aeed2d

PAYARA-3466 added tests on the responses package

a8dfed9

PAYARA-3466 started adding tests for the media package

5a3d737

PAYARA-3466 added tests on media package types (except schema)

14cd520

PAYARA-3466 added tests on media package - Schema

8ca4827

PAYARA-3466 added tests for the model tags package

23402d8

PAYARA-3466 made model fields private

e8b6a71

PAYARA-3466 added tests for model references

bb87fa8

PAYARA-3466 added copyright header where missing

a315fda

jbee commented Mar 28, 2019

View reviewed changes

PAYARA-3466 added missing copyright headers

c9c78c8

jbee requested review from MattGill98 and Pandrex247 March 28, 2019 10:20

MattGill98 suggested changes Apr 1, 2019

View reviewed changes

jbee added 4 commits April 2, 2019 10:09

PAYARA-3466 addressed some of Matt's PR comments

f3753b0

PAYARA-3466 warn about non-conformant extension names but don't corre…

eb79617

…ct them

PAYARA-3466 fixed: processing Schema annotation after HTTP method ann…

adb1741

…otations

PAYARA-3466 replaced .cast() with (Type) cast, cleaned and added test…

125f420

…s for #isAnnotationNull

jbee commented Apr 2, 2019

View reviewed changes

PAYARA-3466 fixed toString for collection fields, moved walking part …

2d2c2c8

…of processor to walker

PAYARA-3466 added tests for param annoations on fields

4f1b34f

jbee commented Apr 3, 2019

View reviewed changes

PAYARA-3466 added missing copyright headers

778e786

Pandrex247 approved these changes Apr 3, 2019

View reviewed changes

smillidge requested a review from MattGill98 April 6, 2019 22:54

MattGill98 approved these changes Apr 8, 2019

View reviewed changes

MattGill98 merged commit 373eaff into payara:master Apr 8, 2019

jbee mentioned this pull request Apr 8, 2019

java.lang.NullPointerException Using openapi using @Operation(hidden = true) #3265

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PAYARA-3466 Open API 1.1 - Tests #3852

PAYARA-3466 Open API 1.1 - Tests #3852

jbee commented Mar 19, 2019 •

edited

Loading

jbee Mar 28, 2019

jbee commented Mar 28, 2019

jbee commented Mar 28, 2019

jbee Apr 2, 2019

jbee commented Apr 2, 2019

jbee Apr 3, 2019

jbee Apr 3, 2019

jbee Apr 3, 2019

jbee Apr 3, 2019

jbee Apr 3, 2019

jbee Apr 3, 2019 •

edited

Loading

jbee commented Apr 3, 2019

Pandrex247 left a comment

jbee commented Apr 3, 2019

MattGill98 commented Apr 8, 2019

PAYARA-3466 Open API 1.1 - Tests #3852

PAYARA-3466 Open API 1.1 - Tests #3852

Conversation

jbee commented Mar 19, 2019 • edited Loading

jbee Mar 28, 2019

Choose a reason for hiding this comment

jbee commented Mar 28, 2019

jbee commented Mar 28, 2019

jbee Apr 2, 2019

Choose a reason for hiding this comment

jbee commented Apr 2, 2019

jbee Apr 3, 2019

Choose a reason for hiding this comment

jbee Apr 3, 2019

Choose a reason for hiding this comment

jbee Apr 3, 2019

Choose a reason for hiding this comment

jbee Apr 3, 2019

Choose a reason for hiding this comment

jbee Apr 3, 2019

Choose a reason for hiding this comment

jbee Apr 3, 2019 • edited Loading

Choose a reason for hiding this comment

jbee commented Apr 3, 2019

Pandrex247 left a comment

Choose a reason for hiding this comment

jbee commented Apr 3, 2019

MattGill98 commented Apr 8, 2019

jbee commented Mar 19, 2019 •

edited

Loading

jbee Apr 3, 2019 •

edited

Loading