[System Tests] added test clients image env variable (kroxylicious#2223)

* added test clients image base env variable

Signed-off-by: Francisco Vila <fvila@redhat.com>

* add arch constant

Signed-off-by: Francisco Vila <fvila@redhat.com>

* remove archs

Signed-off-by: Francisco Vila <fvila@redhat.com>

* updated dev guide

Signed-off-by: Francisco Vila <fvila@redhat.com>

* rename variable to TEST_CLIENTS_IMAGE

Signed-off-by: Francisco Vila <fvila@redhat.com>

* fix default kafka version

Signed-off-by: Francisco Vila <fvila@redhat.com>

---------

Signed-off-by: Francisco Vila <fvila@redhat.com>

Author: franvila

DEV_GUIDE.md

@@ -345,6 +345,7 @@ has been applied ineffectively.
 the container engine. Default value: `$HOME/.docker/config.json`
 * `SKIP_STRIMZI_INSTALL`: skip strimzi installation. Default value: `false`
 * `KAFKA_CLIENT`: client used to produce/consume messages. Default value: `strimzi_test_client`. Currently supported values: `strimzi_test_client`, `kaf`, `kcat`
+* `TEST_CLIENTS_IMAGE`: strimzi test client image to be used when running the tests. It is useful when running regression tests. Default value: `quay.io/strimzi-test-clients/test-clients:latest-kafka-${kafka.version}`
 * `AWS_USE_CLOUD`: set to `true` in case AWS Cloud is used for Record Encryption System Tests. LocalStack will be used by default. Default value: `false`
 * `AWS_REGION`: region of the AWS Cloud account to be used for KMS management. Default value: `us-east-2`
 * `AWS_ACCESS_KEY_ID`: key id of the aws account with admin permissions to be used for KMS management. Mandatory when `AWS_USE_CLOUD` is `true`. Default value: `test`

kroxylicious-systemtests/src/main/java/io/kroxylicious/systemtests/Constants.java

@@ -114,7 +114,6 @@ private Constants() {
     /**
      * Test clients image url
      */
-    public static final String TEST_CLIENTS_IMAGE = "quay.io/strimzi-test-clients/test-clients:latest-kafka-" + Environment.KAFKA_VERSION;
     public static final String KCAT_CLIENT_IMAGE = "quay.io/kroxylicious/kcat:1.7.1";
     public static final String KAF_CLIENT_IMAGE = "quay.io/kroxylicious/kaf:v0.2.7";
 

kroxylicious-systemtests/src/main/java/io/kroxylicious/systemtests/Environment.java

@@ -51,6 +51,7 @@ private Environment() {
     private static final String AWS_KROXYLICIOUS_ACCESS_KEY_ID_ENV = "AWS_KROXYLICIOUS_ACCESS_KEY_ID";
     private static final String AWS_KROXYLICIOUS_SECRET_ACCESS_KEY_ENV = "AWS_KROXYLICIOUS_SECRET_ACCESS_KEY";
     private static final String AWS_REGION_ENV = "AWS_REGION";
+    private static final String TEST_CLIENTS_IMAGE_ENV = "TEST_CLIENTS_IMAGE";
 
     /**
      * The kafka version default value
@@ -101,6 +102,7 @@ private Environment() {
     public static final String AWS_KROXYLICIOUS_ACCESS_KEY_ID_DEFAULT = AWS_ACCESS_KEY_ID_DEFAULT;
     private static final String AWS_KROXYLICIOUS_SECRET_ACCESS_KEY_DEFAULT = AWS_SECRET_ACCESS_KEY_DEFAULT;
     public static final String AWS_REGION_DEFAULT = "us-east-2";
+    private static final String TEST_CLIENTS_IMAGE_DEFAULT = "quay.io/strimzi-test-clients/test-clients:latest-kafka-" + KAFKA_VERSION_DEFAULT;
 
     public static final String KAFKA_VERSION = ENVIRONMENT_VARIABLES.getOrDefault(KAFKA_VERSION_ENV, KAFKA_VERSION_DEFAULT);
     public static final String KROXYLICIOUS_OPERATOR_VERSION = ENVIRONMENT_VARIABLES.getOrDefault(KROXYLICIOUS_OPERATOR_VERSION_ENV, KROXYLICIOUS_VERSION_DEFAULT);
@@ -141,6 +143,8 @@ private Environment() {
     public static final String KROXYLICIOUS_OPERATOR_REGISTRY = ENVIRONMENT_VARIABLES.getOrDefault(KROXYLICIOUS_OPERATOR_REGISTRY_ENV,
             KROXYLICIOUS_OPERATOR_REGISTRY_DEFAULT);
 
+    public static final String TEST_CLIENTS_IMAGE = ENVIRONMENT_VARIABLES.getOrDefault(TEST_CLIENTS_IMAGE_ENV, TEST_CLIENTS_IMAGE_DEFAULT);
+
     private static String readMetadataProperty(String property) {
         var p = new Properties();
         var metadataProps = "/metadata.properties";

kroxylicious-systemtests/src/main/java/io/kroxylicious/systemtests/templates/testclients/TestClientsJobTemplates.java

@@ -15,6 +15,7 @@
 import io.fabric8.kubernetes.api.model.batch.v1.JobBuilder;
 
 import io.kroxylicious.systemtests.Constants;
+import io.kroxylicious.systemtests.Environment;
 import io.kroxylicious.systemtests.templates.ContainerTemplates;
 
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -75,7 +76,7 @@ public static JobBuilder defaultAdminClientJob(String jobName, List<String> args
                 .editSpec()
                 .editTemplate()
                 .editSpec()
-                .withContainers(ContainerTemplates.baseImageBuilder("admin", Constants.TEST_CLIENTS_IMAGE)
+                .withContainers(ContainerTemplates.baseImageBuilder("admin", Environment.TEST_CLIENTS_IMAGE)
                         .withCommand("admin-client")
                         .withArgs(args)
                         .build())
@@ -99,7 +100,7 @@ public static JobBuilder defaultTestClientProducerJob(String jobName, String boo
                                                           @Nullable String messageKey) {
         return newJobForContainer(jobName,
                 "test-client-producer",
-                Constants.TEST_CLIENTS_IMAGE,
+                Environment.TEST_CLIENTS_IMAGE,
                 testClientsProducerEnvVars(bootstrap, topicName, numOfMessages, message, messageKey));
     }
 
@@ -128,7 +129,7 @@ private static JobBuilder newJobForContainer(String jobName, String containerNam
     public static JobBuilder defaultTestClientConsumerJob(String jobName, String bootstrap, String topicName, int numOfMessages) {
         return newJobForContainer(jobName,
                 "test-client-consumer",
-                Constants.TEST_CLIENTS_IMAGE,
+                Environment.TEST_CLIENTS_IMAGE,
                 testClientsConsumerEnvVars(bootstrap, topicName, numOfMessages));
     }