[ST] Change DynamicConfSharedST - remove randomness and pick few dynamic configurations to be tested (#12103)

im-konge · Frawless · see-quick · web-flow · commit 693cdcee5772 · 2025-11-06T09:35:06.000+01:00
Signed-off-by: Lukas Kral &lt;lukywill16@gmail.com&gt;
Signed-off-by: Lukáš Král &lt;53821852+im-konge@users.noreply.github.com&gt;
Co-authored-by: Jakub Stejskal &lt;xstejs24@gmail.com&gt;
Co-authored-by: Maros Orsak &lt;maros.orsak159@gmail.com&gt;
diff --git a/development-docs/systemtests/io.strimzi.systemtest.kafka.dynamicconfiguration.DynamicConfSharedST.md b/development-docs/systemtests/io.strimzi.systemtest.kafka.dynamicconfiguration.DynamicConfSharedST.md
@@ -17,16 +17,19 @@
 
 <hr style="border:1px solid">
 
-## testDynConfiguration
+## testDynamicConfiguration
 
-**Description:** This test dynamically selects and applies three Kafka dynamic configuration properties to verify that the changes do not trigger a rolling update in the Kafka cluster. It applies the configurations, waits for stability, and then verifies that the new configuration is applied both to the CustomResource (CR) and the running Kafka pods.
+**Description:** Parametrized test taking 3 pre-defined per-broker and 3 pre-defined cluster-wide configurations that are being tested to see if dynamic configuration works.For each of the configuration (and its value), it goes through following steps:
+ 1. Apply the configuration
+ 2. Wait for stability of the cluster - no Pods will be rolled.
+ 3. Verify that configuration is correctly set in CR and either all Pods or for whole cluster (based on scope).
 
 **Steps:**
 
 | Step | Action | Result |
 | - | - | - |
-| 1. | Randomly choose three configuration properties for dynamic update. | Three configurations are selected without duplication. |
-| 2. | Apply the chosen configuration properties to the Kafka CustomResource. | The configurations are applied successfully without triggering a rolling update. |
+| 1. | Update configuration (with value) in Kafka. | Configuration is successfully updated. |
+| 2. | For one minute, periodically check that there is no rolling update of Kafka Pods. | No Kafka Pods will be rolled. |
 | 3. | Verify the applied configuration on both the Kafka CustomResource and the Kafka pods. | The applied configurations are correctly reflected in the Kafka CustomResource and the kafka pods. |
 
 **Labels:**
diff --git a/development-docs/systemtests/labels/kafka.md b/development-docs/systemtests/labels/kafka.md
@@ -31,7 +31,7 @@ These tests are crucial to ensure that Kafka clusters can handle production work
 - [testCustomSoloCertificatesForNodePort](../io.strimzi.systemtest.kafka.listeners.ListenersST.md)
 - [testCustomSoloCertificatesForRoute](../io.strimzi.systemtest.kafka.listeners.ListenersST.md)
 - [testDeployUnsupportedKafka](../io.strimzi.systemtest.kafka.KafkaST.md)
-- [testDynConfiguration](../io.strimzi.systemtest.kafka.dynamicconfiguration.DynamicConfSharedST.md)
+- [testDynamicConfiguration](../io.strimzi.systemtest.kafka.dynamicconfiguration.DynamicConfSharedST.md)
 - [testDynamicallyAndNonDynamicSetConnectLoggingLevels](../io.strimzi.systemtest.log.LoggingChangeST.md)
 - [testDynamicallySetBridgeLoggingLevels](../io.strimzi.systemtest.log.LoggingChangeST.md)
 - [testDynamicallySetClusterOperatorLoggingLevels](../io.strimzi.systemtest.log.LoggingChangeST.md)
diff --git a/systemtest/src/main/java/io/strimzi/systemtest/utils/kafkaUtils/KafkaUtils.java b/systemtest/src/main/java/io/strimzi/systemtest/utils/kafkaUtils/KafkaUtils.java
@@ -23,8 +23,6 @@
 import io.strimzi.api.kafka.model.kafka.cruisecontrol.KafkaAutoRebalanceStatusBrokers;
 import io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListener;
 import io.strimzi.api.kafka.model.kafka.listener.ListenerStatus;
-import io.strimzi.kafka.config.model.ConfigModel;
-import io.strimzi.kafka.config.model.ConfigModels;
 import io.strimzi.kafka.config.model.Scope;
 import io.strimzi.operator.common.Util;
 import io.strimzi.systemtest.TestConstants;
@@ -44,21 +42,15 @@
 import org.hamcrest.CoreMatchers;
 
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.nio.charset.Charset;
 import java.time.Duration;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Random;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
-import java.util.stream.Collectors;
 
-import static io.strimzi.api.kafka.model.kafka.KafkaClusterSpec.FORBIDDEN_PREFIXES;
-import static io.strimzi.api.kafka.model.kafka.KafkaClusterSpec.FORBIDDEN_PREFIX_EXCEPTIONS;
 import static io.strimzi.systemtest.enums.CustomResourceStatus.NotReady;
 import static io.strimzi.systemtest.enums.CustomResourceStatus.Ready;
 import static io.strimzi.systemtest.resources.types.KafkaType.kafkaClient;
@@ -263,134 +255,64 @@ public synchronized static boolean verifyCrDynamicConfiguration(final String nam
 
     /**
      * Verifies that updated configuration was successfully changed inside Kafka pods
-     * @param namespaceName name of the namespace
-     * @param kafkaPodNamePrefix prefix of Kafka pods
-     * @param brokerConfigName key of specific property
-     * @param value value of specific property
-     * @param kafkaVersion Kafka version to get the config model
+     *
+     * @param namespaceName     Name of the namespace.
+     * @param clusterName       Name of the Kafka cluster.
+     * @param scraperPodName    Name of Scraper Pod.
+     * @param configName        Name of the configuration.
+     * @param value             Value of specific property.
+     *
      * @return
      * true = if specific property match the excepted property
      * false = if specific property doesn't match the excepted property
      */
-    public synchronized static boolean verifyPodDynamicConfiguration(final String namespaceName, String scraperPodName, String bootstrapServer, String kafkaPodNamePrefix, String brokerConfigName, Object value, String kafkaVersion) {
-        List<Pod> brokerPods = KubeResourceManager.get().kubeClient().listPodsByPrefixInName(namespaceName, kafkaPodNamePrefix);
+    public synchronized static boolean verifyPodDynamicConfiguration(
+        final String namespaceName,
+        final String clusterName,
+        String scraperPodName,
+        String scope,
+        String configName,
+        String value
+    ) {
+        String bootstrapServer = KafkaResources.plainBootstrapAddress(clusterName);
+        String brokerPodSetName = KafkaComponents.getBrokerPodSetName(clusterName);
+
+        List<Pod> brokerPods = KubeResourceManager.get().kubeClient().listPodsByPrefixInName(namespaceName, brokerPodSetName);
         int[] brokerId = {0};
 
-        Map<String, ConfigModel> configModelMap = readConfigModel(kafkaVersion);
-
         // the check/describe for a dynamic change is different depending on the property being cluster-wide or per-broker
-        if (configModelMap.get(brokerConfigName).getScope().equals(Scope.CLUSTER_WIDE)) {
+        if (Scope.valueOf(scope).equals(Scope.CLUSTER_WIDE)) {
+            TestUtils.waitFor("cluster-wide dyn.configuration to change", TestConstants.GLOBAL_POLL_INTERVAL, TestConstants.RECONCILIATION_INTERVAL + Duration.ofSeconds(10).toMillis(), () -> {
+                String result = KafkaCmdClient.describeKafkaBrokerDefaultsUsingPodCli(namespaceName, scraperPodName, bootstrapServer);
 
-            TestUtils.waitFor("cluster-wide dyn.configuration to change", TestConstants.GLOBAL_POLL_INTERVAL, TestConstants.RECONCILIATION_INTERVAL + Duration.ofSeconds(10).toMillis(),
-                    () -> {
-                        String result = KafkaCmdClient.describeKafkaBrokerDefaultsUsingPodCli(namespaceName, scraperPodName, bootstrapServer);
-
-                        LOGGER.debug("This cluster-wide dyn.configuration {}", result);
-
-                        if (!result.contains(brokerConfigName + "=" + value)) {
-                            LOGGER.error("Cluster-wide configuration doesn't contain {} with value {}", brokerConfigName, value);
-                            LOGGER.error("Kafka configuration {}", result);
-                            return false;
-                        }
-                        return true;
-                    });
+                LOGGER.debug("This is cluster-wide dyn.configuration {}", result);
 
+                if (!result.contains(configName + "=" + value)) {
+                    LOGGER.error("Cluster-wide configuration doesn't contain {} with value {}", configName, value);
+                    LOGGER.error("Kafka configuration {}", result);
+                    return false;
+                }
+                return true;
+            });
         } else {
-
             for (Pod pod : brokerPods) {
+                TestUtils.waitFor("dyn.configuration to change", TestConstants.GLOBAL_POLL_INTERVAL, TestConstants.RECONCILIATION_INTERVAL + Duration.ofSeconds(10).toMillis(), () -> {
+                    String result = KafkaCmdClient.describeKafkaBrokerUsingPodCli(namespaceName, scraperPodName, bootstrapServer, brokerId[0]++);
 
-                TestUtils.waitFor("dyn.configuration to change", TestConstants.GLOBAL_POLL_INTERVAL, TestConstants.RECONCILIATION_INTERVAL + Duration.ofSeconds(10).toMillis(),
-                        () -> {
-                            String result = KafkaCmdClient.describeKafkaBrokerUsingPodCli(namespaceName, scraperPodName, bootstrapServer, brokerId[0]++);
-
-                            LOGGER.debug("This dyn.configuration {} inside the Kafka Pod: {}/{}", result, namespaceName, pod.getMetadata().getName());
+                    LOGGER.debug("This is dyn.configuration {} inside the Kafka Pod: {}/{}", result, namespaceName, pod.getMetadata().getName());
 
-                            if (!result.contains(brokerConfigName + "=" + value)) {
-                                LOGGER.error("Kafka Pod: {}/{} doesn't contain {} with value {}", namespaceName, pod.getMetadata().getName(), brokerConfigName, value);
-                                LOGGER.error("Kafka configuration {}", result);
-                                return false;
-                            }
-                            return true;
-                        });
+                    if (!result.contains(configName + "=" + value)) {
+                        LOGGER.error("Kafka Pod: {}/{} doesn't contain {} with value {}", namespaceName, pod.getMetadata().getName(), configName, value);
+                        LOGGER.error("Kafka configuration {}", result);
+                        return false;
+                    }
+                    return true;
+                });
             }
         }
         return true;
     }
 
-    /**
-     * Loads all kafka config parameters supported by the given {@code kafkaVersion}, as generated by #KafkaConfigModelGenerator in config-model-generator.
-     * @param kafkaVersion specific kafka version
-     * @return all supported kafka properties
-     */
-    public static Map<String, ConfigModel> readConfigModel(String kafkaVersion) {
-        String name = TestUtils.USER_PATH + "/../cluster-operator/src/main/resources/kafka-" + kafkaVersion + "-config-model.json";
-        try {
-            try (InputStream in = new FileInputStream(name)) {
-                ConfigModels configModels = new ObjectMapper().readValue(in, ConfigModels.class);
-                if (!kafkaVersion.equals(configModels.getVersion())) {
-                    throw new RuntimeException("Incorrect version");
-                }
-                return configModels.getConfigs();
-            }
-        } catch (IOException e) {
-            throw new RuntimeException("Error reading from classpath resource " + name, e);
-        }
-    }
-
-    /**
-     * Return dynamic Kafka configs supported by the given version of Kafka.
-     * @param kafkaVersion specific kafka version
-     * @return all dynamic properties for specific kafka version
-     */
-    @SuppressWarnings({"checkstyle:CyclomaticComplexity", "checkstyle:BooleanExpressionComplexity"})
-    public static Map<String, ConfigModel> getDynamicConfigurationProperties(String kafkaVersion)  {
-
-        Map<String, ConfigModel> configs = KafkaUtils.readConfigModel(kafkaVersion);
-
-        LOGGER.info("Kafka config {}", configs.toString());
-
-        LOGGER.info("Number of all Kafka configs {}", configs.size());
-
-        Map<String, ConfigModel> dynamicConfigs = configs
-            .entrySet()
-            .stream()
-            .filter(a -> {
-                String[] prefixKey = a.getKey().split("\\.");
-
-                // filter all which is Scope = ClusterWide or PerBroker
-                boolean isClusterWideOrPerBroker = a.getValue().getScope() == Scope.CLUSTER_WIDE || a.getValue().getScope() == Scope.PER_BROKER;
-
-                if (prefixKey[0].equals("ssl") || prefixKey[0].equals("sasl") || prefixKey[0].equals("advertised") ||
-                    prefixKey[0].equals("listeners") || prefixKey[0].equals("listener")) {
-                    return isClusterWideOrPerBroker && !FORBIDDEN_PREFIXES.contains(prefixKey[0]);
-                }
-
-                return isClusterWideOrPerBroker;
-            })
-            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
-
-        LOGGER.info("Number of dynamic-configs {}", dynamicConfigs.size());
-
-        Map<String, ConfigModel> forbiddenExceptionsConfigs = configs
-            .entrySet()
-            .stream()
-            .filter(a -> FORBIDDEN_PREFIX_EXCEPTIONS.contains(a.getKey()))
-            .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
-
-        LOGGER.info("Number of forbidden-exception-configs {}", forbiddenExceptionsConfigs.size());
-
-        Map<String, ConfigModel> dynamicConfigsWithExceptions = new HashMap<>();
-
-        dynamicConfigsWithExceptions.putAll(dynamicConfigs);
-        dynamicConfigsWithExceptions.putAll(forbiddenExceptionsConfigs);
-
-        LOGGER.info("Size of dynamic-configs with forbidden-exception-configs {}", dynamicConfigsWithExceptions.size());
-
-        dynamicConfigsWithExceptions.forEach((key, value) -> LOGGER.info("{} -> {}:{}", key, value.getScope(), value.getType()));
-
-        return dynamicConfigsWithExceptions;
-    }
-
     /**
      * Generated random name for the Kafka resource based on prefix
      * @param clusterName name prefix
diff --git a/systemtest/src/test/java/io/strimzi/systemtest/kafka/dynamicconfiguration/DynamicConfSharedST.java b/systemtest/src/test/java/io/strimzi/systemtest/kafka/dynamicconfiguration/DynamicConfSharedST.java
