fix(nvml,core/test): code review fixes

- moves points_by_metric_and_consumer to nvml test module
- points_by_metric_and_consumer now returns a sorted vector of (attribute name, attribute value). The order of this vector depends on the arguments of the function
- adds tests for cmp_by_key_list utilitary function and for points_by_metric_and_consumer
- fixes clock speed conversion from MHz to Hz
- fixes some comments & documentation

Author: Fyspeed

Cargo.lock

@@ -711,40 +711,9 @@ impl<'a> SourceCheckOutputContext<'a> {
         self.metrics
     }
 
-    /// Maps measurements to an `IndexMap`.
-    ///
-    /// If multiple measurements have the same name but different attribute values,
-    /// you should include the name of the attribute in `attribute_key_list` so that each
-    /// measurement maps to a distinct key/value pair in the `IndexMap`.
-    ///
-    /// ### Notes
-    /// * The order of elements in the resulting `Vec<AttributeValue>` is not guaranteed.
-    /// * Requesting keys that do not exist in the attributes has no impact on the results.
-    ///
-    /// ### Usage Examples
-    ///
-    /// ```text
-    /// Input:
-    /// [
-    ///     {"clock_speed", "ResourceConsumer", {clock_type = Memory, domain = GPU}},
-    ///     {"clock_speed", "ResourceConsumer", {clock_type = SM}}
-    /// ]
-    ///
-    /// Case 1: attribute_key_list = []
-    /// Output keys -> [("clock_speed", "ResourceConsumer", [])]
-    ///
-    /// Case 2: attribute_key_list = ["clock_type"]
-    /// Output keys -> [
-    ///     ("clock_speed", "ResourceConsumer", [Memory]),
-    ///     ("clock_speed", "ResourceConsumer", [SM])
-    /// ]
-    ///
-    /// Case 3: attribute_key_list = ["domain"]
-    /// Output keys -> [
-    ///     ("clock_speed", "ResourceConsumer", [GPU]),
-    ///     ("clock_speed", "ResourceConsumer", [])
-    /// ]
-    /// ```
+    /// ## Deprecated
+    /// Former utility function for tests for the NVML plugin.
+    /// Moved to plugins/nvidia-nvml/src/lib.rs
     pub fn points_by_metric_and_consumer(
         &'a self,
         attribute_key_list: &[&str],
@@ -816,155 +785,3 @@ impl<'a> OutputCheckInputContext<'a> {
         self.metrics.deref()
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use crate::{
-        measurement::{self, Timestamp, WrappedMeasurementValue},
-        units::{Unit, UnitPrefix::Plain},
-    };
-
-    use super::*;
-
-    fn setup_mock_data<'a>() -> (MeasurementBuffer, MetricRegistry) {
-        let mut measurements = MeasurementBuffer::new();
-        let mut metrics = MetricRegistry::new();
-
-        let now = Timestamp::now();
-
-        let metric = Metric {
-            name: "clock_speed".to_string(),
-            description: "".to_string(),
-            unit: PrefixedUnit {
-                base_unit: Unit::Hertz,
-                prefix: Plain,
-            },
-            value_type: measurement::WrappedMeasurementType::U64,
-        };
-
-        let id = metrics
-            .register(metric, DuplicateCriteria::Different, DuplicateReaction::Error)
-            .unwrap();
-
-        let point1: MeasurementPoint = MeasurementPoint::new_untyped(
-            now,
-            id,
-            Resource::LocalMachine,
-            ResourceConsumer::LocalMachine,
-            WrappedMeasurementValue::U64(123),
-        )
-        .with_attr("clock_type", "Memory")
-        .with_attr("domain", "GPU");
-
-        let point2: MeasurementPoint = MeasurementPoint::new_untyped(
-            now,
-            id,
-            Resource::LocalMachine,
-            ResourceConsumer::LocalMachine,
-            WrappedMeasurementValue::U64(456),
-        )
-        .with_attr("clock_type", "SM");
-
-        measurements.push(point1);
-        measurements.push(point2);
-
-        (measurements, metrics)
-    }
-
-    #[test]
-    fn test_attribute_key_list_empty() {
-        let (measurement, metrics) = setup_mock_data();
-        let source = SourceCheckOutputContext {
-            measurements: &measurement,
-            metrics: &metrics,
-        };
-        let attribute_key_list: &[&str] = &[];
-
-        let result = source.points_by_metric_and_consumer(attribute_key_list);
-
-        // If attribute_key_list is empty,
-        // the duplicate key collisions collapse into a single key with an empty vec![]
-        assert_eq!(result.len(), 1);
-
-        let expected_key = ("clock_speed", ResourceConsumer::LocalMachine, vec![]);
-        assert!(result.contains_key(&expected_key));
-    }
-
-    #[test]
-    fn test_attribute_key_list_with_clock_type() {
-        let (measurement, metrics) = setup_mock_data();
-        let source = SourceCheckOutputContext {
-            measurements: &measurement,
-            metrics: &metrics,
-        };
-        let attribute_key_list = &["clock_type"];
-
-        let result = source.points_by_metric_and_consumer(attribute_key_list);
-
-        // Should produce 2 distinct entries because both have the requested attribute,
-        // mapping to their full list of attribute values.
-        assert_eq!(result.len(), 2);
-
-        let key1 = (
-            "clock_speed",
-            ResourceConsumer::LocalMachine,
-            vec![AttributeValue::from("Memory"), AttributeValue::from("GPU")],
-        );
-        let key2 = (
-            "clock_speed",
-            ResourceConsumer::LocalMachine,
-            vec![AttributeValue::from("SM")],
-        );
-
-        assert!(result.contains_key(&key1));
-        assert!(result.contains_key(&key2));
-    }
-
-    #[test]
-    fn test_attribute_key_list_with_domain() {
-        let (measurement, metrics) = setup_mock_data();
-        let source = SourceCheckOutputContext {
-            measurements: &measurement,
-            metrics: &metrics,
-        };
-        let attribute_key_list = &["domain"];
-
-        let result = source.points_by_metric_and_consumer(attribute_key_list);
-
-        // Measurement 1 contains "domain" -> returns all its attributes [Memory, GPU]
-        // Measurement 2 does NOT contain "domain" -> returns []
-        assert_eq!(result.len(), 2);
-
-        let key_with_domain = (
-            "clock_speed",
-            ResourceConsumer::LocalMachine,
-            vec![AttributeValue::from("Memory"), AttributeValue::from("GPU")],
-        );
-        let key_without_domain = ("clock_speed", ResourceConsumer::LocalMachine, vec![]);
-
-        assert!(result.contains_key(&key_with_domain));
-        assert!(result.contains_key(&key_without_domain));
-    }
-
-    #[test]
-    fn test_multiple_requested_keys_returns_all_attributes() {
-        let (measurement, metrics) = setup_mock_data();
-        let source = SourceCheckOutputContext {
-            measurements: &measurement,
-            metrics: &metrics,
-        };
-        let attribute_key_list = &["clock_type", "non_existent_key"];
-
-        let result = source.points_by_metric_and_consumer(attribute_key_list);
-
-        let expected_key = (
-            "clock_speed",
-            ResourceConsumer::LocalMachine,
-            vec![AttributeValue::from("Memory"), AttributeValue::from("GPU")],
-        );
-
-        // Even though "non_existent_key" wasn't found, "clock_type" matched,
-        // so ALL attributes are exported to the key.
-        assert!(result.contains_key(&expected_key));
-    }
-}

core/alumet/src/test/runtime.rs

@@ -8,6 +8,7 @@ repository.workspace = true
 alumet.workspace = true
 anyhow.workspace = true
 humantime-serde.workspace = true
+indexmap = "2.14.0"
 log.workspace = true
 nvml-wrapper = { version = "0.12.0", features = ["legacy-functions"] }
 nvml-wrapper-sys = { version = "0.9.0" }

plugins/nvidia-nvml/Cargo.toml

@@ -47,7 +47,7 @@ The kind of the memory is the type of the allocated memory space reserved by the
 
 #### Clock_type
 
-The speed of the clock may vary depending on the domain. These are the available domains:
+The speed of the clock may vary depending on the type. These are the available types:
 
 |Value|Description|
 |-----|-----------|