Make TestHTTPEndpoint at class level affect all URL fields in test classes

[gian1200]

Description

When working with @TestHTTPEndpoint, @TestHTTPResource and URL field type; one must annotate the field with both.

It is also possible to annotate the @QuarkusTest class with @TestHTTPEndpoint to make Rest Assured pick the the correct path and prefix it.

The issue happens when having multiple paths inside a single "Resource class". It feels a little redundant. Something like:

@QuarkusTest
class XXXResourceTest {

	@TestHTTPEndpoint(XXXResource.class)
	@TestHTTPResource("path1")
	URL endpoint1;

	@TestHTTPEndpoint(XXXResource.class)
	@TestHTTPResource("path2")
	URL endpoint2;

	@TestHTTPEndpoint(XXXResource.class)
	@TestHTTPResource("path3")
	URL endpoint3;

	// Tests...
}

Implementation ideas

It'd be nice to be able to do something like this and get the same result:

@QuarkusTest
@TestHTTPEndpoint(XXXResource.class)
class XXXResourceTest {

	@TestHTTPResource("path1")
	URL endpoint1;

	@TestHTTPResource("path2")
	URL endpoint2;

	@TestHTTPResource("path3")
	URL endpoint3;

	// Tests...
}

[geoand]

Seems reasonable. Would you like to contribute this feature?

[gian1200]

Sure, although I do not know where to do the change or what to do. Any similar commit/PR I can take a look at?

[geoand]

All changes would likely be in

quarkus/test-framework/common/src/main/java/io/quarkus/test/common/http/TestHTTPResourceManager.java

Line 52 in 5f9b3d3

public static void inject(Object testCase, List<Function<Class<?>, String>> endpointProviders) {

I haven't tried it, but likely all you need to do is also query the test class for the TestHTTPEndpoint annotation and update the path accordingly.

[MaikKingma]

While you are implementing this feature, the annotation on class level @TestHTTPEndpoint looses its effect on nested test classes:

import org.junit.jupiter.api.*;
import io.quarkus.test.common.http.TestHTTPEndpoint;

@TestHTTPEndpoint(SomeRestAPI.class)
class A {
    
     @Nested
     class B {

          @Test
          void someTest() {
                // some test logic for an endpoint. Always returns 404 as TestHTTPEndpoint annotation fails to work for nested class
          }
     }
}

what currently fixes this is:

import org.junit.jupiter.api.*;
import io.quarkus.test.common.http.TestHTTPEndpoint;

class A {
    
     @Nested
     @TestHTTPEndpoint(SomeRestAPI.class)
     class B {

          @Test
          void someTest() {
                // some test logic for an endpoint. Now works as the nested test class is annotated
          }
     }
}

[gian1200]

Not sure what's the reasoning (or use case) behind nested test classes is (never use them before). What would happen when both classes are annotated with @TestHTTPEndpoint: override, error, or something else?

For the moment, I just rebase my branch and will create a new Draft PR to see if it now passes all tests.

[gian1200]

what currently fixes this is:

Does class A or B have another annotation? I'm trying to add nested classes to my branch, but Class B is never called, only Class A (which is annotated with @QuarkusTest)

Just to be sure, you are referring to something like this, right?:

testRootEndpoint inheriting the path from "TestResource.class", while testPathEndpoint's path is "TestResource.class path + ABC"

@QuarkusTest
@TestHTTPEndpoint(TestResource.class)
class TestHTTPResourceNestedTestCase {

    @Nested
    class NestedTestCase {

        URL testRootEndpoint;

        @TestHTTPResource("ABC")
        URL testPathEndpoint;

        @Test
        public void should...() {
            given()
                    .when().get(testRootEndpoint).then()
                    .body(is("..."));
        }

        @Test
        public void should...() {
            given()
                    .when().get(testPathEndpoint).then()
                    .body(is("..."));
        }

    }

}

[gian1200]

I tried implemented it, but found some issues (due to my lack of knowledge on Quarkus core). I'm unable to get the reference to NestedTestCase object from TestHTTPResourceNestedTestCase object.
Maybe it can be done if test-framework\junit5\src\main\java\io\quarkus\test\junit\QuarkusTestExtension.java is also modified.

To avoid delaying the original issue, I moved the @Nested work to a separate branch. Feel free to check and continue it https://github.com/gian1200/quarkus/tree/feature/testhttpendpoint-nested-classes