test(plugins/cgroups/oar): Updates to add 80% test code coverage for CGroups/oar plugin

Author: victoryeagle77

plugins/cgroups/oar/src/config.rs

@@ -1,11 +1,11 @@
-use std::sync::{Arc, Mutex};
-
-use anyhow::Context;
+use anyhow::{Context, Result};
 use rustc_hash::FxHashSet;
+use std::sync::{Arc, Mutex};
+use util_cgroups::Cgroup;
 
 use crate::{
+    OarVersion,
     attr::{JOB_REGEX_OAR2, JOB_REGEX_OAR3, find_jobid_in_attrs},
-    config::OarVersion,
 };
 use util_cgroups_plugins::{cgroup_events::CgroupRemovalCallback, regex::RegexAttributesExtrator};
 
@@ -62,7 +62,7 @@ impl JobTracker {
 }
 
 impl JobCleaner {
-    pub fn with_version(tracker: &JobTracker, version: OarVersion) -> anyhow::Result<Self> {
+    pub fn with_version(tracker: &JobTracker, version: OarVersion) -> Result<Self> {
         let attr_extractor = match version {
             OarVersion::Oar2 => RegexAttributesExtrator::new(JOB_REGEX_OAR2),
             OarVersion::Oar3 => RegexAttributesExtrator::new(JOB_REGEX_OAR3),
@@ -75,7 +75,7 @@ impl JobCleaner {
 }
 
 impl CgroupRemovalCallback for JobCleaner {
-    fn on_cgroups_removed(&mut self, cgroups: Vec<util_cgroups::Cgroup>) -> anyhow::Result<()> {
+    fn on_cgroups_removed(&mut self, cgroups: Vec<Cgroup>) -> Result<()> {
         let mut job_ids = Vec::new();
         for cgroup in cgroups {
             // If the regex matches, the cgroup corresponds to a job, and it should have a job id.
@@ -103,4 +103,23 @@ mod tests {
         // this compiles only if JobTracker is Send and Sync
         f::<JobTracker>();
     }
+
+    #[test]
+    fn test_job_single_handle() {
+        let mut tracker = JobTracker::new();
+        tracker.add(10);
+        tracker.remove(10);
+    }
+
+    #[test]
+    fn test_job_multiple_handle() {
+        let mut tracker = JobTracker::new();
+        tracker.add_multiple(vec![10, 20, 30].into_iter());
+        // Remove nothing
+        tracker.remove_multiple(vec![].into_iter());
+        assert_eq!(tracker.known_jobs_sorted(), vec![10, 20, 30]);
+        // Remove everything
+        tracker.remove_multiple(vec![10, 20, 30].into_iter());
+        assert!(tracker.known_jobs_sorted().is_empty());
+    }
 }

plugins/cgroups/oar/src/job_tracker.rs

@@ -3,6 +3,8 @@ use alumet::plugin::{
     rust::{AlumetPlugin, deserialize_config, serialize_config},
 };
 use anyhow::Context;
+use serde::{Deserialize, Serialize};
+use std::time::Duration;
 
 use crate::{
     attr::OarJobTagger,
@@ -26,15 +28,15 @@ mod transform;
 ///
 /// Supports OAR2 and OAR3, on cgroup v1 or cgroup v2.
 pub struct OarPlugin {
-    config: Option<config::Config>,
+    config: Option<Config>,
     /// Intermediary state for startup.
     starting_state: Option<StartingState>,
     /// The reactor that is running in the background. Dropping it will stop it.
     reactor: Option<CgroupReactor>,
 }
 
 impl OarPlugin {
-    pub fn new(config: config::Config) -> Self {
+    pub fn new(config: Config) -> Self {
         Self {
             config: Some(config),
             reactor: None,
@@ -53,12 +55,12 @@ impl AlumetPlugin for OarPlugin {
     }
 
     fn init(config: ConfigTable) -> anyhow::Result<Box<Self>> {
-        let config: config::Config = deserialize_config(config)?;
+        let config: Config = deserialize_config(config)?;
         Ok(Box::new(Self::new(config)))
     }
 
     fn default_config() -> anyhow::Result<Option<ConfigTable>> {
-        let config = serialize_config(config::Config::default())?;
+        let config = serialize_config(Config::default())?;
         Ok(Some(config))
     }
 
@@ -119,11 +121,65 @@ impl AlumetPlugin for OarPlugin {
     }
 }
 
-mod config;
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Config {
+    pub(crate) oar_version: OarVersion,
+    #[serde(with = "humantime_serde")]
+    pub(crate) poll_interval: Duration,
+    pub(crate) jobs_only: bool,
+    /// If `true`, adds attributes like `job_id` to the measurements produced by other plugins.
+    /// The default value is `false`.
+    ///
+    /// The measurements must have the `cgroup` resource consumer, and **cgroup v2** must be used on the node.
+    #[serde(default)]
+    pub annotate_foreign_measurements: bool,
+}
+
+impl Default for Config {
+    #[cfg_attr(tarpaulin, ignore)]
+    fn default() -> Self {
+        Self {
+            oar_version: OarVersion::Oar3,
+            poll_interval: Duration::from_secs(1),
+            jobs_only: true,
+            annotate_foreign_measurements: false,
+        }
+    }
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "lowercase")]
+pub enum OarVersion {
+    Oar2,
+    Oar3,
+}
 
 struct StartingState {
     metrics: Metrics,
     reactor_config: ReactorConfig,
     source_setup: source::JobSourceSetup,
     job_cleaner: JobCleaner,
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_default_config() {
+        let config_table = OarPlugin::default_config()
+            .expect("default_config() should not fail")
+            .expect("default_config() should return Some");
+
+        let config: Config = deserialize_config(config_table).expect("should deserialize config");
+        let default = Config::default();
+
+        assert_eq!(config.oar_version, default.oar_version);
+        assert_eq!(config.poll_interval, default.poll_interval);
+        assert_eq!(config.jobs_only, default.jobs_only);
+        assert_eq!(
+            config.annotate_foreign_measurements,
+            default.annotate_foreign_measurements
+        );
+    }
+}