Changes cxf Client URL only in Test

[arolfes]

Hi,

I wanna use wiremockserver with dynamic port to simulate different responses and validate the incomig requests .

Therefore I need to change the port where the injected Cxf Client sends the request.

Is it possible?
If yes, can you give me a hint how to change the port at test runtime? Probably inside BeforeAll method ?

[shumonsharif]

Hi @arolfes You can modify the URL dynamically at runtime using something like:

    @CXFClient
    CalculatorSoap calculatorSoap;

    @BeforeEach
    void setup() {
        ((BindingProvider)calculatorSoap).getRequestContext()
                      .put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:9999/calculator.asmx");
    }

[famod]

How do you start the wiremock server? @QuarkusTestResource should just work here, see https://quarkus.io/guides/getting-started-testing#quarkus-test-resource

[arolfes]

Hello @shumonsharif ,

thank you for the solution. its working fine. I didn't know that it is still possible to use the old fashion way to change the URL for an endpoint. but when I saw your solution I remembered it from previous cxf projects :-) thx a lot.

Hello @famod ,
yes you are right I followed the tutorial for qarkus-test-resource.

Late Night Update: Following the tutorial correctly I don't need to change the URL with extra code. Thank you for making it clear.

so my code looks like this:

Consumer with injected client

@ApplicationScoped
class MyConsumer(
    @CXFClient("soapService")
    val soapClient: SoapServicePortType
) {
// some functions...
}

ConsumerTest

class MyConsumerTest {

    @InjectWireMock
    lateinit var wireMockServer: WireMockServer

    @Inject
    lateinit var  consumer: MyConsumer

    @BeforeEach
    fun beforeEach() {
        wireMockServer.resetAll()
    }
// some test functions

Wiremock Resource

class WireMockResource : QuarkusTestResourceLifecycleManager {

    val wireMockServer =
        WireMockServer(WireMockConfiguration.wireMockConfig().dynamicPort().httpsPort(0))

    override fun start(): MutableMap<String, String> {
        wireMockServer.start()

        return mutableMapOf("quarkus.cxf.client.soapService.client-endpoint-url" to "http://localhost:${wireMockServer.port()}/${MyConsumer.SERVICE_ENDPOINT}")
    }

    override fun stop() {
        wireMockServer.stop()
    }

    override fun inject(testInjector: TestInjector) {
        testInjector.injectIntoFields(
            wireMockServer,
            AnnotatedAndMatchesType(InjectWireMock::class.java, WireMockServer::class.java)
        )
    }
}

@Target(AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER)
@Retention
annotation class InjectWireMock

[arolfes]

And by the way

your extension is easy to use. Good Job.

[arolfes]

Hi @shumonsharif , @famod

I marked @famod reply as answer because for my test purpose it's the better solution.
The solution from @shumonsharif works also. I tested it first :-) .
But I believe using the QuarkusTestResourceLifecycleManager is more the quarkus way.

[shumonsharif]

Perfect, I also learned something new here ... thanks @arolfes and @famod ! QuarkusTestResourceLifecycleManager is fairly new to me as well, and definitely looks like the right way to go. FWIW, I think the docs for QuarkusTestResourceLifecycleManager could use a slight improvement ... it's not obvious (at least it wasn't to me from the docs) that the property values can be overridden in the start method.

[famod]

it's not obvious (at least it wasn't to me from the docs) that the property values can be overridden in the start method

PRs are welcome! 😄

One thing to keep in mind with @QuarkusTestResource is that it's "global". QuarkusTestResource.restrictToAnnotatedClass can be used to isolate it, but then there will be a Quarkus restart which can be problematic if you have many tests.
But there will at least be automatic test class ordering in Quarkus 2.6 to mitigate the problem, see quarkusio/quarkus#21748 and quarkusio/quarkus#21610.