feat(e2e): output logs in expandable group when running in github actions

Author: Alenar

mithril-test-lab/mithril-end-to-end/src/utils/formatting.rs

@@ -0,0 +1,37 @@
+use crate::utils::is_running_in_github_actions;
+
+/// Handle printing a log group title and a separator.
+///
+/// If running in GitHub actions, the logs produced between the creation of the group and its
+/// drop will be wrapped within a `::group::` and `::endgroup::` github action command.
+pub struct LogGroup;
+
+impl LogGroup {
+    pub fn new(name: &str, title: &str) -> Self {
+        let group_title = Self::group_title(name, title);
+        if is_running_in_github_actions() {
+            println!("::group::{group_title}");
+        }
+        Self::print_header(&group_title);
+
+        Self
+    }
+
+    fn group_title(name: &str, title: &str) -> String {
+        format!("{} LOGS - {}:", name.to_uppercase(), title)
+    }
+
+    fn print_header(title: &str) {
+        println!("{:-^100}", "");
+        println!("{title:^30}",);
+        println!("{:-^100}", "");
+    }
+}
+
+impl Drop for LogGroup {
+    fn drop(&mut self) {
+        if is_running_in_github_actions() {
+            println!("::endgroup::");
+        }
+    }
+}

mithril-test-lab/mithril-end-to-end/src/utils/mithril_command.rs

@@ -1,4 +1,4 @@
-use crate::utils::file_utils;
+use crate::utils::{LogGroup, file_utils};
 use anyhow::{Context, anyhow};
 use mithril_common::StdResult;
 use slog_scope::info;
@@ -146,7 +146,10 @@ impl MithrilCommand {
             ));
         }
 
-        self.print_header(name, &format!("LAST {number_of_line} LINES"));
+        let _log_group_guard = LogGroup::new(
+            name.unwrap_or(&self.name),
+            &format!("LAST {number_of_line} LINES"),
+        );
 
         println!(
             "{}",
@@ -172,7 +175,10 @@ impl MithrilCommand {
             ));
         }
 
-        self.print_header(name, &format!("LAST {number_of_error} ERROR(S)"));
+        let _log_group_guard = LogGroup::new(
+            name.unwrap_or(&self.name),
+            &format!("LAST {number_of_error} ERROR(S)"),
+        );
 
         println!(
             "{}",
@@ -183,18 +189,4 @@ impl MithrilCommand {
 
         Ok(())
     }
-
-    fn print_header(&self, name: Option<&str>, title: &str) {
-        let name = match name {
-            Some(n) => n,
-            None => &self.name,
-        };
-
-        println!("{:-^100}", "");
-        println!(
-            "{:^30}",
-            format!("{} LOGS - {}:", name.to_uppercase(), title)
-        );
-        println!("{:-^100}", "");
-    }
 }

mithril-test-lab/mithril-end-to-end/src/utils/mod.rs

@@ -2,6 +2,12 @@ mod mithril_command;
 #[macro_use]
 mod spec_utils;
 mod file_utils;
+mod formatting;
 
+pub use formatting::*;
 pub use mithril_command::MithrilCommand;
 pub use spec_utils::AttemptResult;
+
+pub fn is_running_in_github_actions() -> bool {
+    std::env::var("GITHUB_ACTIONS").is_ok()
+}