refactor: move validate_metrics_value to utilities/monitoring

hmeir · claude · hmeir · commit 6f39d087a88c · 2026-05-25T12:43:37.000+03:00
Signed-off-by: Harel Meir &lt;hmeir@redhat.com&gt;
Co-Authored-By: Claude Sonnet 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/tests/install_upgrade_operators/hco_enablement_golden_image_updates/conftest.py b/tests/install_upgrade_operators/hco_enablement_golden_image_updates/conftest.py
@@ -19,6 +19,7 @@
     COMMON_TEMPLATES_KEY_NAME,
     FEATURE_GATES,
     HCO_OPERATOR,
+    KUBERNETES_ARCH_LABEL,
     SSP_CR_COMMON_TEMPLATES_LIST_KEY_NAME,
 )
 from utilities.ssp import get_ssp_resource
@@ -121,6 +122,11 @@ def common_templates_scope_session(hyperconverged_status_scope_session):
     return hyperconverged_status_scope_session[SSP_CR_COMMON_TEMPLATES_LIST_KEY_NAME]
 
 
+@pytest.fixture(scope="session")
+def worker_architectures(schedulable_nodes):
+    return {node.labels[KUBERNETES_ARCH_LABEL] for node in schedulable_nodes}
+
+
 @pytest.fixture(scope="class")
 def default_common_template_hco_status(hyperconverged_status_templates_scope_class):
     return get_templates_by_type_from_hco_status(
diff --git a/tests/install_upgrade_operators/hco_enablement_golden_image_updates/multiarch/conftest.py b/tests/install_upgrade_operators/hco_enablement_golden_image_updates/multiarch/conftest.py
@@ -56,11 +56,6 @@ def enabled_multiarch_feature_gate(hyperconverged_resource_scope_class):
             yield
 
 
-@pytest.fixture(scope="session")
-def worker_architectures(schedulable_nodes):
-    return {node.labels[KUBERNETES_ARCH_LABEL] for node in schedulable_nodes}
-
-
 @pytest.fixture(scope="class")
 def control_plane_architecture(control_plane_nodes):
     return get_control_plane_architecture(control_plane_nodes=control_plane_nodes)
diff --git a/tests/observability/metrics/conftest.py b/tests/observability/metrics/conftest.py
@@ -36,7 +36,6 @@
     network_packets_received,
     vnic_info_from_vm_or_vmi,
 )
-from tests.observability.utils import validate_metrics_value
 from tests.utils import create_vms, start_stress_on_vm
 from utilities import console
 from utilities.constants import (
@@ -72,7 +71,7 @@
     get_pod_by_name_prefix,
     unique_name,
 )
-from utilities.monitoring import get_metrics_value
+from utilities.monitoring import get_metrics_value, validate_metrics_value
 from utilities.network import assert_ping_successful, get_ip_from_vm_or_virt_handler_pod, ping
 from utilities.ssp import verify_ssp_pod_is_running
 from utilities.storage import (
diff --git a/tests/observability/metrics/test_aaq_metrics.py b/tests/observability/metrics/test_aaq_metrics.py
@@ -4,7 +4,7 @@
     timestamp_to_seconds,
     validate_values_from_kube_application_aware_resourcequota_metric,
 )
-from tests.observability.utils import validate_metrics_value
+from utilities.monitoring import validate_metrics_value
 
 pytestmark = [
     pytest.mark.usefixtures(
diff --git a/tests/observability/metrics/test_general_metrics.py b/tests/observability/metrics/test_general_metrics.py
@@ -7,7 +7,7 @@
 from libs.net.cluster import is_ipv6_single_stack_cluster
 from tests.observability.metrics.constants import KUBEVIRT_VMI_NODE_CPU_AFFINITY
 from tests.observability.metrics.utils import validate_vmi_node_cpu_affinity_with_prometheus
-from tests.observability.utils import validate_metrics_value
+from utilities.monitoring import validate_metrics_value
 from utilities.virt import VirtualMachineForTests, fedora_vm_body, running_vm
 
 KUBEVIRT_VM_TAG = f"{Resource.ApiGroup.KUBEVIRT_IO}/vm"
diff --git a/tests/observability/metrics/test_metrics.py b/tests/observability/metrics/test_metrics.py
@@ -9,10 +9,10 @@
     assert_vm_metric_virt_handler_pod,
     compare_kubevirt_vmi_info_metric_with_vm_info,
 )
-from tests.observability.utils import validate_metrics_value
 from utilities.constants import (
     KUBEVIRT_HCO_HYPERCONVERGED_CR_EXISTS,
 )
+from utilities.monitoring import validate_metrics_value
 
 pytestmark = [pytest.mark.post_upgrade, pytest.mark.sno]
 
diff --git a/tests/observability/metrics/test_migration_metrics.py b/tests/observability/metrics/test_migration_metrics.py
@@ -13,7 +13,7 @@
     timestamp_to_seconds,
     wait_for_non_empty_metrics_value,
 )
-from tests.observability.utils import validate_metrics_value
+from utilities.monitoring import validate_metrics_value
 
 LOGGER = logging.getLogger(__name__)
 
diff --git a/tests/observability/metrics/test_ssp_metrics.py b/tests/observability/metrics/test_ssp_metrics.py
@@ -7,12 +7,12 @@
     validate_metric_value_with_round_down,
     validate_metric_value_within_range,
 )
-from tests.observability.utils import validate_metrics_value
 from utilities.constants import (
     SSP_OPERATOR,
     VIRT_TEMPLATE_VALIDATOR,
 )
 from utilities.hco import ResourceEditorValidateHCOReconcile
+from utilities.monitoring import validate_metrics_value
 from utilities.virt import VirtualMachineForTests
 
 KUBEVIRT_SSP_OPERATOR_UP = "kubevirt_ssp_operator_up"
diff --git a/tests/observability/metrics/test_vms_metrics.py b/tests/observability/metrics/test_vms_metrics.py
@@ -27,7 +27,6 @@
     validate_metric_value_greater_than_initial_value,
     validate_vnic_info,
 )
-from tests.observability.utils import validate_metrics_value
 from utilities.constants import (
     CAPACITY,
     MIGRATION_POLICY_VM_LABEL,
@@ -38,7 +37,7 @@
     USED,
 )
 from utilities.infra import get_node_selector_dict
-from utilities.monitoring import get_metrics_value
+from utilities.monitoring import get_metrics_value, validate_metrics_value
 from utilities.virt import VirtualMachineForTests, fedora_vm_body, running_vm
 
 LOGGER = logging.getLogger(__name__)
diff --git a/tests/observability/upgrade/test_upgrade_observability.py b/tests/observability/upgrade/test_upgrade_observability.py
@@ -1,9 +1,9 @@
 import pytest
 
 from tests.observability.constants import KUBEVIRT_VMI_NUMBER_OF_OUTDATED
-from tests.observability.utils import validate_metrics_value
 from tests.upgrade_params import IUO_UPGRADE_TEST_DEPENDENCY_NODE_ID
 from utilities.constants import DEPENDENCY_SCOPE_SESSION
+from utilities.monitoring import validate_metrics_value
 
 
 @pytest.mark.cnv_upgrade
diff --git a/tests/observability/utils.py b/tests/observability/utils.py
@@ -1,46 +1,13 @@
-import datetime
 import logging
 
 from ocp_utilities.monitoring import Prometheus
-from timeout_sampler import TimeoutExpiredError, TimeoutSampler
 
 from tests.observability.constants import SSP_COMMON_TEMPLATES_MODIFICATION_REVERTED
-from utilities.constants import (
-    TIMEOUT_4MIN,
-    TIMEOUT_15SEC,
-)
-from utilities.monitoring import get_metrics_value
 
 LOGGER = logging.getLogger(__name__)
 ALLOW_ALERTS_ON_HEALTHY_CLUSTER_LIST = [SSP_COMMON_TEMPLATES_MODIFICATION_REVERTED]
 
 
-def validate_metrics_value(
-    prometheus: Prometheus, metric_name: str, expected_value: str, timeout: int = TIMEOUT_4MIN
-) -> None:
-    samples = TimeoutSampler(
-        wait_timeout=timeout,
-        sleep=TIMEOUT_15SEC,
-        func=get_metrics_value,
-        prometheus=prometheus,
-        metrics_name=metric_name,
-    )
-    sample = None
-    comparison_values_log = {}
-    try:
-        for sample in samples:
-            if sample:
-                comparison_values_log[datetime.datetime.now()] = (
-                    f"metric: {metric_name} value is: {sample}, the expected value is {expected_value}"
-                )
-                if sample == expected_value:
-                    LOGGER.info("Metrics value matches the expected value!")
-                    return
-    except TimeoutExpiredError:
-        LOGGER.error(f"Metrics value: {sample}, expected: {expected_value}, comparison log: {comparison_values_log}")
-        raise
-
-
 def verify_no_listed_alerts_on_cluster(prometheus: Prometheus, alerts_list: list[str]) -> None:
     """
     It gets a list of alerts and verifies that none of them are firing on a cluster.
diff --git a/utilities/monitoring.py b/utilities/monitoring.py
@@ -1,7 +1,12 @@
+import datetime
 import logging
+from typing import TYPE_CHECKING
 
 from timeout_sampler import TimeoutExpiredError, TimeoutSampler
 
+if TYPE_CHECKING:
+    from ocp_utilities.monitoring import Prometheus
+
 from utilities.constants import (
     FIRING_STATE,
     KUBEVIRT_HYPERCONVERGED_OPERATOR_HEALTH_STATUS,
@@ -175,6 +180,43 @@ def get_metrics_value(prometheus, metrics_name):
     return 0
 
 
+def validate_metrics_value(
+    prometheus: "Prometheus", metric_name: str, expected_value: str | int, timeout: int = TIMEOUT_5MIN
+) -> None:
+    """Wait until the metric matches the expected value.
+
+    Args:
+        prometheus: Prometheus instance.
+        metric_name: Name of the metric to query.
+        expected_value: Expected value to match. Use str for emitted values (e.g. "0"),
+            int 0 for absent/not-emitted metrics (get_metrics_value returns int 0 when absent).
+        timeout: Maximum wait time in seconds.
+
+    Raises:
+        TimeoutExpiredError: If the metric does not match within timeout.
+    """
+    samples = TimeoutSampler(
+        wait_timeout=timeout,
+        sleep=TIMEOUT_5SEC,
+        func=get_metrics_value,
+        prometheus=prometheus,
+        metrics_name=metric_name,
+    )
+    sample = None
+    comparison_values_log = {}
+    try:
+        for sample in samples:
+            comparison_values_log[datetime.datetime.now()] = (
+                f"metric: {metric_name} value is: {sample}, the expected value is {expected_value}"
+            )
+            if sample == expected_value:
+                LOGGER.info(f"Metrics value matches the expected value: {expected_value}")
+                return
+    except TimeoutExpiredError:
+        LOGGER.error(f"Metrics value: {sample}, expected: {expected_value}, comparison log: {comparison_values_log}")
+        raise
+
+
 def wait_for_gauge_metrics_value(prometheus, query, expected_value, timeout=TIMEOUT_5MIN):
     samples = TimeoutSampler(
         wait_timeout=timeout,

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`timestamp_to_seconds,`
`5`	`5`	`validate_values_from_kube_application_aware_resourcequota_metric,`
`6`	`6`	`)`
`7`		`-from tests.observability.utils import validate_metrics_value`
	`7`	`+from utilities.monitoring import validate_metrics_value`
`8`	`8`
`9`	`9`	`pytestmark = [`
`10`	`10`	`pytest.mark.usefixtures(`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,10 @@`
`9`	`9`	`assert_vm_metric_virt_handler_pod,`
`10`	`10`	`compare_kubevirt_vmi_info_metric_with_vm_info,`
`11`	`11`	`)`
`12`		`-from tests.observability.utils import validate_metrics_value`
`13`	`12`	`from utilities.constants import (`
`14`	`13`	`KUBEVIRT_HCO_HYPERCONVERGED_CR_EXISTS,`
`15`	`14`	`)`
	`15`	`+from utilities.monitoring import validate_metrics_value`
`16`	`16`
`17`	`17`	`pytestmark = [pytest.mark.post_upgrade, pytest.mark.sno]`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`timestamp_to_seconds,`
`14`	`14`	`wait_for_non_empty_metrics_value,`
`15`	`15`	`)`
`16`		`-from tests.observability.utils import validate_metrics_value`
	`16`	`+from utilities.monitoring import validate_metrics_value`
`17`	`17`
`18`	`18`	`LOGGER = logging.getLogger(__name__)`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,12 @@`
`7`	`7`	`validate_metric_value_with_round_down,`
`8`	`8`	`validate_metric_value_within_range,`
`9`	`9`	`)`
`10`		`-from tests.observability.utils import validate_metrics_value`
`11`	`10`	`from utilities.constants import (`
`12`	`11`	`SSP_OPERATOR,`
`13`	`12`	`VIRT_TEMPLATE_VALIDATOR,`
`14`	`13`	`)`
`15`	`14`	`from utilities.hco import ResourceEditorValidateHCOReconcile`
	`15`	`+from utilities.monitoring import validate_metrics_value`
`16`	`16`	`from utilities.virt import VirtualMachineForTests`
`17`	`17`
`18`	`18`	`KUBEVIRT_SSP_OPERATOR_UP = "kubevirt_ssp_operator_up"`