Small OpenAPI and Swagger UI enhancements #19148

phillip-kruger · 2021-08-01T04:52:19Z

This PR contains some small enhancements to the OpenAPI and Swagger UI extensions:

Auto add the Security Requirement for REST Endpoints that has RolesAllowed
Set a more appropriate default title and version
Set the correct default oauth2RedirectUrl in swagger-ui
Allow multiple static OpenAPI model documents
Upgrade to SmallRye OpenAPI 2.1.9 (see https://github.com/smallrye/smallrye-open-api/releases/tag/2.1.9)

Fix #18614
Fix #19113
Fix #19131

It might be easier to review per commit.

quarkus-bot · 2021-08-01T08:48:08Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `07b1d7d`

Status	Name	Step	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 11	`Build`	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 11 Windows	`Build`	Test failures	Logs	Raw logs
✖	JVM Tests - JDK 16	`Build`	Test failures	Logs	Raw logs
✖	Native Tests - Main	`Build`	Test failures	Logs	Raw logs
✖	Native Tests - Misc4	`Build`	Test failures	Logs	Raw logs

Full information is available in the Build summary check run.

Test Failures

⚙️ JVM Tests - JDK 11 #

📦 extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment

✖ io.quarkus.resteasy.reactive.server.test.simple.SimpleQuarkusRestTestCase.testWriter line 177 - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Response body doesn't match expectation.
Expected: "OK"
  Actual: An Internal Server Error with stack trace:
java.lang.NullPointerException
	at org.jboss.resteasy.reactive.server.injection.ContextProducers.getTarget(ContextProducers.java:108)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers.resourceInfo(ContextProducers.java:90)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.create(ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.zig:163)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.create(ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.zig:194)
	at io.quarkus.arc.impl.RequestContext.getIfActive(RequestContext.java:68)
	at io.quarkus.arc.impl.ClientP...

📦 integration-tests/main

✖ io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON line 46 - More details - Source on GitHub

org.opentest4j.AssertionFailedError: expected: <Generated API> but was: <main-integration-test API>
	at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:55)
	at org.junit.jupiter.api.AssertionUtils.failNotEqual(AssertionUtils.java:62)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:177)
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1124)
	at io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON(OpenApiTestCase.java:46)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at io.quarkus.test.junit.QuarkusTestExtension.runExtensionMethod(QuarkusTestExtension.java...

⚙️ JVM Tests - JDK 11 Windows #

📦 integration-tests/main

✖ io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON line 46 - More details - Source on GitHub

org.opentest4j.AssertionFailedError: expected: <Generated API> but was: <main-integration-test API>
	at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:55)
	at org.junit.jupiter.api.AssertionUtils.failNotEqual(AssertionUtils.java:62)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:177)
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1124)
	at io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON(OpenApiTestCase.java:46)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at io.quarkus.test.junit.QuarkusTestExtension.runExtensionMethod(QuarkusTestExtension.java...

⚙️ JVM Tests - JDK 16 #

📦 integration-tests/main

✖ io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON line 46 - More details - Source on GitHub

org.opentest4j.AssertionFailedError: expected: <Generated API> but was: <main-integration-test API>
	at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:55)
	at org.junit.jupiter.api.AssertionUtils.failNotEqual(AssertionUtils.java:62)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:177)
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1124)
	at io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON(OpenApiTestCase.java:46)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:78)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:567)
	at io.quarkus.test.junit.QuarkusTestExtension.runExtensionMethod(QuarkusTestExtension.java...

⚙️ Native Tests - Main #

📦 integration-tests/main

✖ io.quarkus.it.main.OpenApiITCase.testOpenAPIJSON - More details - Source on GitHub

org.opentest4j.AssertionFailedError: expected: <Generated API> but was: <main-integration-test API>
	at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:55)
	at org.junit.jupiter.api.AssertionUtils.failNotEqual(AssertionUtils.java:62)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:182)
	at org.junit.jupiter.api.AssertEquals.assertEquals(AssertEquals.java:177)
	at org.junit.jupiter.api.Assertions.assertEquals(Assertions.java:1124)
	at io.quarkus.it.main.OpenApiTestCase.testOpenAPIJSON(OpenApiTestCase.java:46)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:688)
...

⚙️ Native Tests - Misc4 #

📦 integration-tests/gradle

✖ io.quarkus.gradle.nativeimage.CustomNativeTestSourceSetIT.runNativeTests line 18 - More details - Source on GitHub

org.opentest4j.AssertionFailedError: 

expected: "SUCCESS"
 but was: null
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at io.quarkus.gradle.nativeimage.CustomNativeTestSourceSetIT.runNativeTests(CustomNativeTestSourceSetIT.java:18)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:688)
	at org.junit.jupiter.engine....

gsmet · 2021-08-01T12:00:27Z

@geoand the failure in io.quarkus.resteasy.reactive.server.test.simple.SimpleQuarkusRestTestCase.testWriter looks a bit suspicious.

phillip-kruger · 2021-08-01T12:13:56Z

@gsmet @geoand yes, I need to fix those, the default name is now the app name and not Generated API anymore. The tests needs to be updated. I did not run the integration tests locally so I missed that. I'll update soon

quarkus-bot · 2021-08-01T22:08:15Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `6671894`

Status	Name	Step	Test failures	Logs	Raw logs
✖	MicroProfile TCKs Tests	`Verify`	Test failures	Logs	Raw logs

Full information is available in the Build summary check run.

Test Failures

⚙️ MicroProfile TCKs Tests #

📦 tcks/resteasy-reactive/target/testsuite/tests

✖ com.sun.ts.tests.jaxrs.platform.container.completioncallback.JAXRSClient0164.argumentIsNullWhenRegistredClassTest line 208 - More details - Source on GitHub

com.sun.ts.tests.jaxrs.common.JAXRSCommonClient$Fault: Unexpected response content No name has been set yet expecting NULL
	at com.sun.ts.tests.jaxrs.platform.container.completioncallback.JAXRSClient0164.assertString(JAXRSClient0164.java:457)
	at com.sun.ts.tests.jaxrs.platform.container.completioncallback.JAXRSClient0164.argumentIsNullWhenRegistredClassTest(JAXRSClient0164.java:208)

...yment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java

...eployment/src/main/java/io/quarkus/smallrye/openapi/deployment/SmallRyeOpenApiProcessor.java

.../swagger-ui/deployment/src/test/java/io/quarkus/swaggerui/deployment/SwaggerOptionsTest.java

...yment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java

geoand · 2021-08-02T06:49:26Z

Good stuff!

I only added a few minor comments. Also, can we the last commit be squashed into whatever commit introduced the broken tests?
That way we won't have intermediate state that doesn't build properly

phillip-kruger · 2021-08-02T06:56:30Z

@geoand - thanks for the review, I'll make the changes as requested soon

Signed-off-by:Phillip Kruger <[email protected]> OpenAPI auto add Security Requirement to endpoints with RolesAllowed Signed-off-by:Phillip Kruger <[email protected]>

…sion Signed-off-by:Phillip Kruger <[email protected]> Fix OpenAPI integration tests Signed-off-by:Phillip Kruger <[email protected]>

Signed-off-by: Phillip Kruger <[email protected]>

Signed-off-by:Phillip Kruger <[email protected]> OpenAPI Allow multiple static files Signed-off-by:Phillip Kruger <[email protected]>

Signed-off-by:Phillip Kruger <[email protected]>

quarkus-bot · 2021-08-02T13:54:48Z

This workflow status is outdated as a new workflow run has been triggered.

Failing Jobs - Building `779dd5a`

Status	Name	Step	Test failures	Logs	Raw logs
✔️	JVM Tests - JDK 11
✖	JVM Tests - JDK 11 Windows	`Build`	Test failures	Logs	Raw logs
✔️	JVM Tests - JDK 16

Full information is available in the Build summary check run.

Test Failures

⚙️ JVM Tests - JDK 11 Windows #

📦 extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment

✖ io.quarkus.resteasy.reactive.server.test.simple.SimpleQuarkusRestTestCase.testException line 170 - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Response body doesn't match expectation.
Expected: "OK"
  Actual: An Internal Server Error with stack trace:
java.lang.NullPointerException
	at org.jboss.resteasy.reactive.server.injection.ContextProducers.getTarget(ContextProducers.java:108)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers.resourceInfo(ContextProducers.java:90)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.create(ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.zig:163)
	at org.jboss.resteasy.reactive.server.injection.ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.create(ContextProducers_ProducerMethod_resourceInfo_be7f5503a87442251cde9fbc1d406fb350a529f0_Bean.zig:194)
	at io.quarkus.arc.impl.RequestContext.getIfActive(RequestContext.java:68)
	at io.quarkus.arc.impl.ClientP...

✖ io.quarkus.resteasy.reactive.server.test.simple.SimpleQuarkusRestTestCase.testPrimitiveBody line 317 - More details - Source on GitHub

java.lang.AssertionError: 
1 expectation failed.
Expected status code <200> but was <500>.

	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
	at java.base/jdk.internal.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45)
	at java.base/java.lang.reflect.Constructor.newInstance(Constructor.java:490)
	at org.codehaus.groovy.reflection.CachedConstructor.invoke(CachedConstructor.java:72)
	at org.codehaus.groovy.reflection.CachedConstructor.doConstructorInvoke(CachedConstructor.java:59)
	at org.codehaus.groovy.runtime.callsite.ConstructorSite$ConstructorSiteNoUnwrap.callConstructor(ConstructorSite.java:84)
	at org.codehaus.groovy.runtime.callsite.AbstractCallSite.callConstructor(AbstractCallSite.java:277)
	at io.restassured.internal.ResponseSpecificationImpl$HamcrestAssertionClosure.valid...

phillip-kruger · 2021-08-02T14:00:37Z

@geoand @gsmet I am not sure if that failure is related, I do not think so. Can you check ?

geoand · 2021-08-02T14:01:33Z

I don't think they are, but best restart the tests to be sure

phillip-kruger · 2021-08-02T14:04:09Z

Is it possible to only restart for JVM Tests - JDK 11 Windows ?

geoand · 2021-08-02T14:09:33Z

Unfortunately that's not possible

quarkus-bot · 2021-08-02T18:36:36Z

Failing Jobs - Building `779dd5a`

Status	Name	Step	Test failures	Logs	Raw logs
✔️	JVM Tests - JDK 11
✖	JVM Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
✔️	JVM Tests - JDK 16

phillip-kruger · 2021-08-02T18:43:13Z

@geoand - any advice ?

geoand · 2021-08-02T18:45:16Z

What is failing?

phillip-kruger · 2021-08-02T18:49:25Z

Not sure, seems likes it is timing out.

geoand · 2021-08-02T18:50:57Z

If it's not in a RESTEasy Reactive or OpenAPI related module, I wouldn't worry about it... The Windows build is pretty flaky...

phillip-kruger · 2021-08-02T19:06:03Z

Should we just merge then ?

geoand · 2021-08-02T19:06:43Z

Yup, go ahead

phillip-kruger · 2021-08-02T19:07:44Z

Thanks :)

This is due to this change: quarkusio/quarkus/pull/19148

phillip-kruger requested a review from geoand August 1, 2021 04:52

quarkus-bot bot added area/dependencies Pull requests that update a dependency file area/openapi area/smallrye area/swagger-ui labels Aug 1, 2021

geoand reviewed Aug 2, 2021

View reviewed changes

...yment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java Outdated Show resolved Hide resolved

geoand reviewed Aug 2, 2021

View reviewed changes

...eployment/src/main/java/io/quarkus/smallrye/openapi/deployment/SmallRyeOpenApiProcessor.java Show resolved Hide resolved

geoand reviewed Aug 2, 2021

View reviewed changes

.../swagger-ui/deployment/src/test/java/io/quarkus/swaggerui/deployment/SwaggerOptionsTest.java Show resolved Hide resolved

geoand reviewed Aug 2, 2021

View reviewed changes

...yment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java Outdated Show resolved Hide resolved

phillip-kruger added 5 commits August 2, 2021 11:32

OpenAPI auto add Security Requirement to endpoints with RolesAllowed

0f9314b

Signed-off-by:Phillip Kruger <[email protected]> OpenAPI auto add Security Requirement to endpoints with RolesAllowed Signed-off-by:Phillip Kruger <[email protected]>

OpenAPI set application name and version as the default title and ver…

8fe04d7

…sion Signed-off-by:Phillip Kruger <[email protected]> Fix OpenAPI integration tests Signed-off-by:Phillip Kruger <[email protected]>

Swagger UI set the correct default oauth2RedirectUrl

f9409ff

Signed-off-by: Phillip Kruger <[email protected]>

OpenAPI Allow multiple static files

4896e83

Signed-off-by:Phillip Kruger <[email protected]> OpenAPI Allow multiple static files Signed-off-by:Phillip Kruger <[email protected]>

Update SmallRye OpenAPI to 2.1.9

779dd5a

Signed-off-by:Phillip Kruger <[email protected]>

phillip-kruger requested a review from geoand August 2, 2021 09:39

geoand approved these changes Aug 2, 2021

View reviewed changes

phillip-kruger added the triage/waiting-for-ci Ready to merge when CI successfully finishes label Aug 2, 2021

phillip-kruger merged commit 95bcc1e into quarkusio:main Aug 2, 2021

quarkus-bot bot added this to the 2.2 - main milestone Aug 2, 2021

quarkus-bot bot removed the triage/waiting-for-ci Ready to merge when CI successfully finishes label Aug 2, 2021

Sgitario added a commit to Sgitario/quarkus-test-suite that referenced this pull request Aug 3, 2021

Fix OpenApiIT due to quarkusio/quarkus/pull/19148

4dbc180

Sgitario added a commit to quarkus-qe/quarkus-test-suite that referenced this pull request Aug 3, 2021

Fix OpenApiIT due to quarkusio/quarkus/pull/19148

8c19279

Sgitario added a commit to Sgitario/beefy-scenarios that referenced this pull request Aug 4, 2021

Fix 013 failure by updating openapi assert

abe2424

This is due to this change: quarkusio/quarkus/pull/19148

Sgitario mentioned this pull request Aug 4, 2021

Fix 013 failure by updating openapi assert quarkus-qe/beefy-scenarios#243

Closed

phillip-kruger deleted the swagger-ui-enhancements branch August 4, 2021 11:47

rsvoboda added a commit to rsvoboda/beefy-scenarios that referenced this pull request Aug 5, 2021

Fix OpenApi tests due to quarkusio/quarkus/pull/19148

2d62177

rsvoboda mentioned this pull request Aug 5, 2021

Fix OpenApi tests due to quarkusio/quarkus/pull/19148 quarkus-qe/beefy-scenarios#244

Merged

rsvoboda added a commit to rsvoboda/beefy-scenarios that referenced this pull request Aug 5, 2021

Fix OpenApi tests due to quarkusio/quarkus/pull/19148

076b2c4

Sgitario pushed a commit to quarkus-qe/beefy-scenarios that referenced this pull request Aug 5, 2021

Fix OpenApi tests due to quarkusio/quarkus/pull/19148

e46ae46

Small OpenAPI and Swagger UI enhancements #19148

Small OpenAPI and Swagger UI enhancements #19148

Conversation

phillip-kruger commented Aug 1, 2021

quarkus-bot bot commented Aug 1, 2021 • edited Loading

Failing Jobs - Building 07b1d7d

Test Failures

⚙️ JVM Tests - JDK 11 #

📦 extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment

📦 integration-tests/main

⚙️ JVM Tests - JDK 11 Windows #

📦 integration-tests/main

⚙️ JVM Tests - JDK 16 #

📦 integration-tests/main

⚙️ Native Tests - Main #

📦 integration-tests/main

⚙️ Native Tests - Misc4 #

📦 integration-tests/gradle

gsmet commented Aug 1, 2021

phillip-kruger commented Aug 1, 2021

quarkus-bot bot commented Aug 1, 2021 • edited Loading

Failing Jobs - Building 6671894

Test Failures

⚙️ MicroProfile TCKs Tests #

📦 tcks/resteasy-reactive/target/testsuite/tests

geoand commented Aug 2, 2021

phillip-kruger commented Aug 2, 2021

quarkus-bot bot commented Aug 2, 2021 • edited Loading

Failing Jobs - Building 779dd5a

Test Failures

⚙️ JVM Tests - JDK 11 Windows #

📦 extensions/resteasy-reactive/quarkus-resteasy-reactive/deployment

phillip-kruger commented Aug 2, 2021

geoand commented Aug 2, 2021

phillip-kruger commented Aug 2, 2021

geoand commented Aug 2, 2021

quarkus-bot bot commented Aug 2, 2021

Failing Jobs - Building 779dd5a

phillip-kruger commented Aug 2, 2021

geoand commented Aug 2, 2021

phillip-kruger commented Aug 2, 2021

geoand commented Aug 2, 2021

phillip-kruger commented Aug 2, 2021

geoand commented Aug 2, 2021

phillip-kruger commented Aug 2, 2021

quarkus-bot bot commented Aug 1, 2021 •

edited

Loading

Failing Jobs - Building `07b1d7d`

quarkus-bot bot commented Aug 1, 2021 •

edited

Loading

Failing Jobs - Building `6671894`

quarkus-bot bot commented Aug 2, 2021 •

edited

Loading

Failing Jobs - Building `779dd5a`

Failing Jobs - Building `779dd5a`