Implement custom cluster metadata decorator with support of global cluster_size parametrization (#8464)

Author: ivandasch

modules/ducktests/tests/checks/utils/check_cluster.py

@@ -0,0 +1,106 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Checks custom cluster metadata decorator.
+"""
+
+from unittest.mock import Mock
+
+import pytest
+from ducktape.cluster.cluster_spec import ClusterSpec, LINUX
+from ducktape.mark.mark_expander import MarkedFunctionExpander
+
+from ignitetest.utils._mark import cluster, ParametrizableClusterMetadata, CLUSTER_SIZE_KEYWORD, CLUSTER_SPEC_KEYWORD
+
+
+def expand_function(*, func, sess_ctx):
+    """
+    Inject parameters into function and generate context list.
+    """
+    assert hasattr(func, "marks")
+    assert next(filter(lambda x: isinstance(x, ParametrizableClusterMetadata), func.marks), None)
+
+    return MarkedFunctionExpander(session_context=sess_ctx, function=func).expand()
+
+
+def mock_session_ctx(*, cluster_size=None):
+    """
+    Create mock of session context.
+    """
+    sess_ctx = Mock()
+    sess_ctx.globals = {"cluster_size": cluster_size} if cluster_size is not None else {}
+
+    return sess_ctx
+
+
+# pylint: disable=no-self-use
+class CheckClusterParametrization:
+    """
+    Checks custom @cluster parametrization.
+    """
+    def check_num_nodes(self):
+        """"
+        Check num_nodes.
+        """
+        @cluster(num_nodes=10)
+        def function():
+            return 0
+
+        test_context_list = expand_function(func=function, sess_ctx=mock_session_ctx())
+        assert len(test_context_list) == 1
+        assert test_context_list[0].cluster_use_metadata[CLUSTER_SIZE_KEYWORD] == 10
+
+        test_context_list = expand_function(func=function,
+                                            sess_ctx=mock_session_ctx(cluster_size="100"))
+        assert len(test_context_list) == 1
+        assert test_context_list[0].cluster_use_metadata[CLUSTER_SIZE_KEYWORD] == 100
+
+    def check_cluster_spec(self):
+        """"
+        Check cluster_spec.
+        """
+        @cluster(cluster_spec=ClusterSpec.simple_linux(10))
+        def function():
+            return 0
+
+        test_context_list = expand_function(func=function, sess_ctx=mock_session_ctx())
+        assert len(test_context_list) == 1
+        inserted_spec = test_context_list[0].cluster_use_metadata[CLUSTER_SPEC_KEYWORD]
+
+        assert inserted_spec.size() == 10
+        for node in inserted_spec.nodes:
+            assert node.operating_system == LINUX
+
+        test_context_list = expand_function(func=function,
+                                            sess_ctx=mock_session_ctx(cluster_size="100"))
+        assert len(test_context_list) == 1
+        inserted_spec = test_context_list[0].cluster_use_metadata[CLUSTER_SPEC_KEYWORD]
+
+        assert inserted_spec.size() == 100
+        for node in inserted_spec.nodes:
+            assert node.operating_system == LINUX
+
+    def check_invalid_global_param(self):
+        """Check handle of invalid params."""
+        @cluster(num_nodes=10)
+        def function():
+            return 0
+
+        invalid_vals = ["abc", "-10", "1.5", "0", 1.6, -7, 0]
+
+        for val in invalid_vals:
+            with pytest.raises(Exception):
+                expand_function(func=function, sess_ctx=mock_session_ctx(cluster_size=val))

…ktests/tests/checks/utils/check_marks.py …tests/checks/utils/check_parametrized.pymodules/ducktests/tests/checks/utils/check_marks.py renamed to modules/ducktests/tests/checks/utils/check_parametrized.py modules/ducktests/tests/checks/utils/check_marks.py renamed to modules/ducktests/tests/checks/utils/check_parametrized.py

@@ -17,13 +17,11 @@
 Module contains node rebalance tests.
 """
 
-from ducktape.mark.resource import cluster
-
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import ignite_versions
+from ignitetest.utils import ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, IgniteVersion, LATEST
 

modules/ducktests/tests/ignitetest/tests/add_node_rebalance_test.py

@@ -19,15 +19,14 @@
 from enum import IntEnum
 
 from ducktape.mark import matrix
-from ducktape.mark.resource import cluster
 from jinja2 import Template
 
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.utils.control_utility import ControlUtility
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration, IgniteClientConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import ignite_versions, version_if
+from ignitetest.utils import ignite_versions, version_if, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, IgniteVersion, LATEST_2_8
 

modules/ducktests/tests/ignitetest/tests/cellular_affinity_test.py

@@ -19,14 +19,13 @@
 import time
 
 from ducktape.mark import parametrize
-from ducktape.mark.resource import cluster
 
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.utils.control_utility import ControlUtility
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration
 from ignitetest.services.utils.ignite_configuration.cache import CacheConfiguration
-from ignitetest.utils import ignite_versions
+from ignitetest.utils import ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, V_2_8_1, IgniteVersion
 
@@ -49,8 +48,8 @@ class ClientTest(IgniteTest):
     JAVA_CLIENT_CLASS_NAME = "org.apache.ignite.internal.ducktest.tests.client_test.IgniteCachePutClient"
 
     # pylint: disable=R0913
-    @ignite_versions(str(V_2_8_1), str(DEV_BRANCH))
     @cluster(num_nodes=7)
+    @ignite_versions(str(V_2_8_1), str(DEV_BRANCH))
     @parametrize(num_nodes=7, static_clients=2, temp_client=3, iteration_count=3, client_work_time=30)
     def test_ignite_start_stop_nodes(self, ignite_version, num_nodes, static_clients, temp_client, iteration_count,
                                      client_work_time):
@@ -62,8 +61,8 @@ def test_ignite_start_stop_nodes(self, ignite_version, num_nodes, static_clients
                                temp_client, iteration_count, client_work_time)
 
     # pylint: disable=R0913
-    @ignite_versions(str(V_2_8_1), str(DEV_BRANCH))
     @cluster(num_nodes=7)
+    @ignite_versions(str(V_2_8_1), str(DEV_BRANCH))
     @parametrize(num_nodes=7, static_clients=2, temp_client=3, iteration_count=3, client_work_time=30)
     def test_ignite_kill_start_nodes(self, ignite_version, num_nodes, static_clients, temp_client, iteration_count,
                                      client_work_time):

modules/ducktests/tests/ignitetest/tests/client_test.py

@@ -17,15 +17,14 @@
 This module contains manipulating baseline test through control utility.
 """
 
-from ducktape.mark.resource import cluster
 from ducktape.utils.util import wait_until
 
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.utils.control_utility import ControlUtility, ControlUtilityError
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration, DataStorageConfiguration
 from ignitetest.services.utils.ignite_configuration.data_storage import DataRegionConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import version_if, ignite_versions
+from ignitetest.utils import version_if, ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, LATEST_2_8, IgniteVersion, V_2_8_0
 

modules/ducktests/tests/ignitetest/tests/control_utility/baseline_test.py

@@ -17,17 +17,16 @@
 """
 This module contains transactions manipulation test through control utility.
 """
-import random
 
-from ducktape.mark.resource import cluster
+import random
 
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.utils.control_utility import ControlUtility
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration
 from ignitetest.services.utils.ignite_configuration.cache import CacheConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import ignite_versions
+from ignitetest.utils import ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, LATEST_2_8, IgniteVersion
 

modules/ducktests/tests/ignitetest/tests/control_utility/tx_test.py

@@ -25,7 +25,6 @@
 from typing import NamedTuple
 
 from ducktape.mark import matrix
-from ducktape.mark.resource import cluster
 
 from ignitetest.services.ignite import IgniteAwareService, IgniteService, get_event_time, node_failed_event_pattern
 from ignitetest.services.ignite_app import IgniteApplicationService
@@ -35,7 +34,7 @@
     TcpDiscoverySpi
 from ignitetest.services.utils.time_utils import epoch_mills
 from ignitetest.services.zk.zookeeper import ZookeeperService, ZookeeperSettings
-from ignitetest.utils import ignite_versions, version_if
+from ignitetest.utils import ignite_versions, version_if, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, LATEST_2_8, V_2_8_0, IgniteVersion
 

modules/ducktests/tests/ignitetest/tests/discovery_test.py

@@ -20,15 +20,14 @@
 import time
 
 from ducktape.mark import matrix
-from ducktape.mark.resource import cluster
 
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.utils.control_utility import ControlUtility
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration
 from ignitetest.services.utils.ignite_configuration.cache import CacheConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import ignite_versions
+from ignitetest.utils import ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, LATEST_2_7, V_2_8_0, IgniteVersion
 
@@ -61,7 +60,8 @@ def test(self, ignite_version, long_txs):
 
         config = IgniteConfiguration(version=IgniteVersion(ignite_version), caches=caches, cluster_state="INACTIVE")
 
-        ignites = IgniteService(self.test_context, config, num_nodes=self.NUM_NODES)
+        num_nodes = len(self.test_context.cluster) - 2
+        ignites = IgniteService(self.test_context, config, num_nodes=num_nodes)
 
         ignites.start()
 
@@ -71,7 +71,7 @@ def test(self, ignite_version, long_txs):
         ControlUtility(ignites, self.test_context).activate()
 
         client_config = config._replace(client_mode=True,
-                                        discovery_spi=from_ignite_cluster(ignites, slice(0, self.NUM_NODES - 1)))
+                                        discovery_spi=from_ignite_cluster(ignites, slice(0, num_nodes - 1)))
 
         long_tx_streamer = IgniteApplicationService(
             self.test_context,
@@ -93,7 +93,7 @@ def test(self, ignite_version, long_txs):
 
         single_key_tx_streamer.start()
 
-        ignites.stop_node(ignites.nodes[self.NUM_NODES - 1])
+        ignites.stop_node(ignites.nodes[num_nodes - 1])
 
         if long_txs:
             long_tx_streamer.await_event("Node left topology", 60, from_the_beginning=True)
@@ -109,5 +109,6 @@ def test(self, ignite_version, long_txs):
         data["Worst latency (ms)"] = single_key_tx_streamer.extract_result("WORST_LATENCY")
         data["Streamed txs"] = single_key_tx_streamer.extract_result("STREAMED")
         data["Measure duration (ms)"] = single_key_tx_streamer.extract_result("MEASURE_DURATION")
+        data["Server nodes"] = num_nodes
 
         return data

modules/ducktests/tests/ignitetest/tests/pme_free_switch_test.py

@@ -17,14 +17,12 @@
 This module contains smoke tests that checks that ducktape works as expected
 """
 
-from ducktape.mark.resource import cluster
-
 from ignitetest.services.ignite import IgniteService
 from ignitetest.services.ignite_app import IgniteApplicationService
 from ignitetest.services.ignite_execution_exception import IgniteExecutionException
 from ignitetest.services.utils.ignite_configuration import IgniteConfiguration, IgniteClientConfiguration
 from ignitetest.services.utils.ignite_configuration.discovery import from_ignite_cluster
-from ignitetest.utils import ignite_versions
+from ignitetest.utils import ignite_versions, cluster
 from ignitetest.utils.ignite_test import IgniteTest
 from ignitetest.utils.version import DEV_BRANCH, IgniteVersion