tmt: Introduce skip_for_ostree

So we don't spawn VMs for tests like "composefs-gc" just to do nothing
and exit

Signed-off-by: Pragyan Poudyal <pragyanpoudyal41999@gmail.com>

Author: Johan-Liebert1

crates/xtask/src/tmt.rs

@@ -28,6 +28,10 @@ const FIELD_ADJUST: &str = "adjust";
 const FIELD_FIXME_SKIP_IF_COMPOSEFS: &str = "fixme_skip_if_composefs";
 const FIELD_FIXME_SKIP_IF_UKI: &str = "fixme_skip_if_uki";
 
+/// For tests that should only run for composefs systems
+/// Ex. composefs-gc
+const FIELD_SKIP_IF_OSTREE: &str = "skip_if_ostree";
+
 // bcvk options
 const BCVK_OPT_BIND_STORAGE_RO: &str = "--bind-storage-ro";
 const ENV_BOOTC_UPGRADE_IMAGE: &str = "BOOTC_upgrade_image";
@@ -210,10 +214,11 @@ fn verify_ssh_connectivity(sh: &Shell, port: u16, key_path: &Utf8Path) -> Result
     )
 }
 
-#[derive(Debug)]
+#[derive(Debug, Default)]
 struct PlanMetadata {
     try_bind_storage: bool,
     skip_if_composefs: bool,
+    skip_if_ostree: bool,
     skip_if_uki: bool,
 }
 
@@ -255,8 +260,7 @@ fn parse_plan_metadata(
                     .and_modify(|m| m.try_bind_storage = b)
                     .or_insert(PlanMetadata {
                         try_bind_storage: b,
-                        skip_if_uki: false,
-                        skip_if_composefs: false,
+                        ..Default::default()
                     });
             }
         }
@@ -271,8 +275,7 @@ fn parse_plan_metadata(
                     .and_modify(|m| m.skip_if_composefs = b)
                     .or_insert(PlanMetadata {
                         skip_if_composefs: b,
-                        skip_if_uki: false,
-                        try_bind_storage: false,
+                        ..Default::default()
                     });
             }
         }
@@ -287,8 +290,22 @@ fn parse_plan_metadata(
                     .and_modify(|m| m.skip_if_uki = b)
                     .or_insert(PlanMetadata {
                         skip_if_uki: b,
-                        skip_if_composefs: false,
-                        try_bind_storage: false,
+                        ..Default::default()
+                    });
+            }
+        }
+
+        if let Some(skip_if_ostree) = plan_data.get(&serde_yaml::Value::String(format!(
+            "extra-{}",
+            FIELD_SKIP_IF_OSTREE
+        ))) {
+            if let Some(b) = skip_if_ostree.as_bool() {
+                plan_metadata
+                    .entry(plan_name.to_string())
+                    .and_modify(|m| m.skip_if_ostree = b)
+                    .or_insert(PlanMetadata {
+                        skip_if_ostree: b,
+                        ..Default::default()
                     });
             }
         }
@@ -602,6 +619,14 @@ pub(crate) fn run_tmt(sh: &Shell, args: &RunTmtArgs) -> Result<()> {
                 .map(|(_, v)| v.skip_if_composefs)
                 .unwrap_or(false)
         });
+    } else {
+        plans.retain(|plan| {
+            !plan_metadata
+                .iter()
+                .find(|(key, _)| plan.ends_with(key.as_str()))
+                .map(|(_, v)| v.skip_if_ostree)
+                .unwrap_or(false)
+        });
     }
 
     if matches!(args.boot_type, crate::BootType::Uki) {
@@ -1068,6 +1093,8 @@ struct TestDef {
     try_bind_storage: bool,
     /// Whether to skip this test for composefs backend
     skip_if_composefs: bool,
+    /// Whether to skip this test for ostree backend
+    skip_if_ostree: bool,
     /// Whether to skip this test for images with UKI
     skip_if_uki: bool,
     /// TMT fmf attributes to pass through (summary, duration, adjust, etc.)
@@ -1239,6 +1266,13 @@ fn generate_integration() -> Result<(String, String)> {
             .and_then(|v| v.as_bool())
             .unwrap_or(false);
 
+        let skip_if_ostree = metadata
+            .extra
+            .as_mapping()
+            .and_then(|m| m.get(&serde_yaml::Value::String(FIELD_SKIP_IF_OSTREE.to_string())))
+            .and_then(|v| v.as_bool())
+            .unwrap_or(false);
+
         let skip_if_uki = metadata
             .extra
             .as_mapping()
@@ -1256,6 +1290,7 @@ fn generate_integration() -> Result<(String, String)> {
             test_command,
             try_bind_storage,
             skip_if_composefs,
+            skip_if_ostree,
             skip_if_uki,
             tmt: metadata.tmt,
         });
@@ -1379,6 +1414,13 @@ fn generate_integration() -> Result<(String, String)> {
             );
         }
 
+        if test.skip_if_ostree {
+            plan_value.insert(
+                serde_yaml::Value::String(format!("extra-{}", FIELD_SKIP_IF_OSTREE)),
+                serde_yaml::Value::Bool(true),
+            );
+        }
+
         if test.skip_if_uki {
             plan_value.insert(
                 serde_yaml::Value::String(format!("extra-{}", FIELD_FIXME_SKIP_IF_UKI)),

tmt/plans/integration.fmf

@@ -196,6 +196,8 @@ execute:
     how: fmf
     test:
       - /tmt/tests/tests/test-35-composefs-gc
+  extra-skip_if_ostree: true
+  extra-fixme_skip_if_uki: true
 
 /plan-35-upgrade-preflight-disk-check:
   summary: Verify pre-flight disk space check rejects images with inflated layer sizes
@@ -254,6 +256,7 @@ execute:
     how: fmf
     test:
       - /tmt/tests/tests/test-41-composefs-gc-uki
+  extra-skip_if_ostree: true
 
 /plan-42-loader-entries-source:
   summary: Test bootc loader-entries set-options-for-source
@@ -269,4 +272,5 @@ execute:
     how: fmf
     test:
       - /tmt/tests/tests/test-43-switch-same-digest
+  extra-skip_if_ostree: true
 # END GENERATED PLANS

tmt/tests/booted/test-composefs-gc-uki.nu

@@ -2,6 +2,8 @@
 # tmt:
 #   summary: Test composefs garbage collection for UKI
 #   duration: 30m
+# extra:
+#   skip_if_ostree: true
 
 use std assert
 use tap.nu

tmt/tests/booted/test-composefs-gc.nu

@@ -2,6 +2,9 @@
 # tmt:
 #   summary: Test composefs garbage collection with same and different kernel+initrd
 #   duration: 30m
+# extra:
+#   skip_if_ostree: true
+#   fixme_skip_if_uki: true
 
 use std assert
 use tap.nu

tmt/tests/booted/test-switch-same-digest.nu

@@ -2,6 +2,8 @@
 # tmt:
 #   summary: Error on bootc switch to image with identical fs-verity digest
 #   duration: 10m
+# extra:
+#   skip_if_ostree: true
 #
 # Verify that `bootc switch` errors out when the target image produces the
 # same composefs fs-verity digest as an existing deployment.  The simplest