Testing strimzi with keycloak and oauth

[MariaIRubio]

I see that under https://github.com/strimzi/strimzi-kafka-oauth/blob/main/testsuite/keycloak-auth-tests there is an example to test,
but I dont find this dependency in maven availabe.

       <dependency>
            <groupId>io.strimzi.oauth.testsuite</groupId>
            <artifactId>common</artifactId>
        </dependency>

From Strimzi I find test-container, test, but not testsuite

Thank you very much in advance!

[scholzj]

I guess you would need to elaborate on what exactly do you want to test. Strimzi tests it on several levels:

• In the OAuth repository:
  • The test suite there is run as part of the CI and I'm not sure what would be the value of publishing it anywhere. I think you anyway cannot use it in your Java unit test as it is dependent on various Docker compose files etc. These are not examples how to test it, these are the actual tests. But you can of course checkout the GitHub repo and run it. I guess in theory you could do something similar with test containers ... but does it really improve things? Do you have test containers for everything? I don't think so.
• In Strimzi system tests where it tests the actual operators and operands against Keycloak in a real Kubernetes environment.

[scholzj]

Every application in the company I work has to be tested.

Yeah, of course. the point I was trying to make that you should likely try to test it with as close setup to what you will have in production as possible. And not sure how easy that would be to achieve with test containers here as lot of it is also up to the Kafka Broker etc.

[MariaIRubio]

And you, with your expertise, would you try to test with testcontainers, or "just" unit test? I say just because testing seems for me more complicated that actually developing.
Thanks in advance, like always, for your time and your patience!
I also have to say, that once you make the right configurations, strimzi rocks! It makes definitely everything way more easier with keycloak integration. Quite great!

[scholzj]

For the OAuth, I would probably try to test it in some system test environment with some actual setup using Strimzi etc. I would probably not go for test containers with that.

[MariaIRubio]

Thank you so much!

[see-quick]

My bits to this topic:

1. The Strimzi test container is useful when testing at the integration level, as it avoids the overhead of setting up the entire system (e.g., Keycloak, Strimzi, etc.). It is particularly beneficial for achieving a faster feedback loop or testing multiple configurations, which would otherwise be time-consuming at the system level.
2. However, if you need to properly validate that your application works with OAuth, a system test would be more appropriate. That said, system tests come with their challenges, such as increased complexity and longer execution times. For example, comparing integration testing with; (a.) Strimzi test container with OAuth (a few seconds) (b.) System test with the same environment (a few minutes)

Tip

Also if your application is used within Kubernetes I would highly recommend testing it on the system level instead of "just" using test containers.