Implementing the isUseAdviceWith seems to have no effect

[joshdreagan]

Bug description

Overriding the isUseAdviceWith() method and returning true (per the docs linked below) does not prevent the Camel Context from starting before the advice is applied.

https://camel.apache.org/manual/advice-with.html#_enabling_advice_during_testing

[jamesnetherton]

See notes about AdviceWith here:

https://camel.apache.org/camel-quarkus/next/user-guide/testing.html#_using_advicewith

[joshdreagan]

Thank you for the link @jamesnetherton. I had read that doc as well, but I didn't see any caveat about the isUseAdviceWith method not working.

[jamesnetherton]

Which Camel Quarkus version are you using? It may be related to #6807 which was fixed back in Camel Quarkus 3.17.0.

[joshdreagan]

I'm using 3.15.x. Just regular Java though. No Kotlin.

[jamesnetherton]

If you can provide a test case or a project that replicates the problem, it'd help to find the root cause.

[jamesnetherton]

This simple advice test works for me across multiple versions:

@QuarkusTest
public class AdviceTest extends CamelQuarkusTestSupport {
    @Override
    public boolean isUseAdviceWith() {
        return true;
    }

    @BeforeEach
    public void beforeEach() throws Exception {
        AdviceWith.adviceWith(this.context, "advisedRoute", route -> {
            route.replaceFromWith("direct:replaced");
        });
        startRouteDefinitions();
    }

    @Override
    protected RoutesBuilder createRouteBuilder() throws Exception {
        return new RouteBuilder() {
            @Override
            public void configure() throws Exception {
                from("direct:start").routeId("advisedRoute")
                        .transform().simple("Hello ${body}")
                        .to("mock:result");

                from("direct:other")
                        .log("Hi");
            }
        };
    }

    @Test
    void testAdvisedRoute() throws Exception {
        MockEndpoint mockEndpoint = getMockEndpoint("mock:result");
        mockEndpoint.expectedBodiesReceived("Hello World");

        template.sendBody("direct:replaced", "World");
        template.sendBody("direct:other", "Hello World");

        mockEndpoint.assertIsSatisfied();
    }
}

[joshdreagan]

Given that the simple test uses a "direct" endpoint as its start, it's probably misbehaving and you just don't notice. In my case, I'm starting with a Kafka consumer. So I can see the consumer attempt to start and fail to connect for a few seconds before the advice kicks in and augments the route. I'll remove customer details and upload an example.

[joshdreagan]

Ok. Here's an example. Just unzip and run a mvn test. You should see that the Kafka consumer starts and fails to connect for a few seconds before the context is paused and the routes adviced.

advice-test.zip

[jamesnetherton]

Thanks for the example.

You're right, the framework starts the CamelContext, and the advice is applied afterwards. So you see in the logs messages like:

[org.apa.cam.com.kaf.KafkaConsumer] (Camel (camel-1) thread #2 - ShutdownTask) Stopping Kafka consumer on topic: topic.foo

The routes are being advised though, else the test would not pass.

I don't have a workaround or simple fix. We'd probably need to rework some of the core bootstrapping logic to allow the CamelContext to be started manually and perhaps allow the context to be stopped / started between tests. Currently it's not possible #3692.

[joshdreagan]

To work around, I took all the logic out of the Kafka consumer route and set it's autoStartup with a property.

from("kafka:{{kafka.source.topic}}?brokers={{kafka.brokers}}&groupId={{kafka.source.groupId}}")
  .routeId("kafka-source").autoStartup("{{kafka.source.autoStart:true}}")
  .to("direct:route")
;

And I set my Kafka producer endpoints to have the lazyStartProducer=true option.

Then I put an "application.properties" in my "src/test/resources" folder with a value of kafka.source.autoStart=false. That way, when my JUnit test starts up, the Kafka client will not attempt to connect. Then I can advice my routes and produce messages directly to the "direct:route" for my test cases because that's where my actual logic starts.

Kind of clunky, but it works. ¯\_(ツ)_/¯

[bridgerdier]

Right now, the isUseAdviceWith method in CamelQuarkusTestSupport has a somewhat cryptic Javadoc (including a link to a page that returns 404) and an unexplained deprecation annotation:

    /**
     * Override when using <a href="http://camel.apache.org/advicewith.html">advice with</a> and return <code>true</code>.
     * <p/>
     * <b>Important:</b> You must execute method {@link #startRouteDefinitions()}} manually from the unit test
     * after you are done doing all the advice with.
     *
     * @return <code>true</code> to apply advice to existing route(s). <code>false</code> to disable advice.
     */
    @Override
    @Deprecated(since = "3.15.0")
    public boolean isUseAdviceWith() {
        return false;
    }

There should be an explicit notice that overriding this method has no effect and that, as per #7291, there are no plans to provide a working mechanism.