Adding report generator from the must-gather logs collected

Signed-off-by: Shivam Durgbuns <sdurgbun@redhat.com>

Author: shivamdurgbuns

.secrets.baseline

@@ -559,15 +559,15 @@
         "hashed_secret": "72cb70dbbafe97e5ea13ad88acd65d08389439b0",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 331,
+        "line_number": 330,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "de19c40310ad831a71524cd279e6f5f0577fb09a",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 377,
+        "line_number": 376,
         "type": "Secret Keyword",
         "verified_result": null
       }

ocs_ci/deployment/deployment.py

@@ -144,6 +144,9 @@
     is_acm_cluster,
     is_recovery_cluster,
 )
+from ocs_ci.ocs.must_gather.report_generator_hook import (
+    trigger_reports_after_collect_ocs_logs,
+)
 from ocs_ci.utility.deployment import (
     create_external_secret,
     get_and_apply_idms_from_catalog,
@@ -560,6 +563,13 @@ def do_deploy_ocs(self):
                 if config.REPORTING["collect_logs_on_success_run"]:
                     try:
                         collect_ocs_logs("deployment", ocp=False, status_failure=False)
+                        trigger_reports_after_collect_ocs_logs(
+                            dir_name="deployment",
+                            status_failure=False,
+                            cluster_configs=(
+                                config.clusters if config.multicluster else [config]
+                            ),
+                        )
                     except Exception as e:
                         logger.error(
                             f"Failed to collect OCS logs: {e}, but ignoring it as deployment is successful"
@@ -585,6 +595,13 @@ def do_deploy_ocs(self):
                         ocp=False,
                         timeout=defaults.MUST_GATHER_TIMEOUT,
                     )
+                    trigger_reports_after_collect_ocs_logs(
+                        dir_name="deployment",
+                        status_failure=True,
+                        cluster_configs=(
+                            config.clusters if config.multicluster else [config]
+                        ),
+                    )
                 except Exception as e:
                     logger.error(f"Failed to collect OCS logs: {e}")
             raise

ocs_ci/framework/conf/default_config.yaml

@@ -156,6 +156,8 @@ REPORTING:
   max_mg_fail_attempts: 3
   tarball_mg_logs: true
   delete_packed_mg_logs: true
+  # If True, run scripts/python/must_gather_report_generator/main.py after OCS must-gather is collected
+  generate_must_gather_report: false
 
 # This is the default information about environment.
 ENV_DATA:

ocs_ci/framework/pytest_customization/ocscilib.py

@@ -37,6 +37,9 @@
 from ocs_ci.ocs.cluster import check_clusters
 from ocs_ci.ocs.resources.ocs import get_version_info
 from ocs_ci.ocs import utils
+from ocs_ci.ocs.must_gather.report_generator_hook import (
+    trigger_reports_after_collect_ocs_logs,
+)
 from ocs_ci.utility.utils import (
     dump_config_to_file,
     get_ceph_version,
@@ -999,6 +1002,13 @@ def pytest_runtest_makereport(item, call):
                     timeout=timeout,
                     since_time=since_time_str,
                 )
+                # Must-gather (OCS) is complete when collect_ocs_logs returns
+                if ocs_logs_collection:
+                    trigger_reports_after_collect_ocs_logs(
+                        dir_name=test_case_name,
+                        status_failure=True,
+                        cluster_configs=ocsci_config.clusters,
+                    )
         except Exception:
             log.exception("Failed to collect OCS logs")
 

ocs_ci/ocs/must_gather/report_generator_hook.py

@@ -0,0 +1,80 @@
+import os
+import re
+import subprocess
+from pathlib import Path
+
+from ocs_ci.framework import config
+
+
+def _repo_root():
+    # ocs_ci/ocs/must_gather/report_generator_hook.py -> parents[4] is repo root
+    return Path(__file__).resolve().parents[4]
+
+
+def run_report_generator(mg_dir_path: str, report_dir: str, *, prefix: str) -> None:
+    """
+    Run scripts/python/must_gather_report_generator/main.py after must-gather is complete.
+    The report generator script itself is responsible for handling tarballs,
+    symlinks, etc. This hook only triggers the script after log collection.
+    """
+    if not config.REPORTING.get("generate_must_gather_report", False):
+        return
+
+    mg_dir_path = os.path.abspath(mg_dir_path)
+    tarball_path = f"{mg_dir_path}.tar.gz"
+    if not (os.path.isdir(mg_dir_path) or os.path.isfile(tarball_path)):
+        return
+
+    os.makedirs(report_dir, exist_ok=True)
+
+    script_path = _repo_root() / "scripts/python/must_gather_report_generator/main.py"
+    if not script_path.is_file():
+        return
+
+    safe_prefix = re.sub(r"[^A-Za-z0-9_.-]+", "_", prefix)
+    text_out = os.path.join(report_dir, f"{safe_prefix}_mg_analysis.txt")
+    xml_out = os.path.join(report_dir, f"{safe_prefix}_mg_analysis.xml")
+
+    cmd = [
+        "python",
+        str(script_path),
+        mg_dir_path,
+        "--output-file",
+        text_out,
+        "--xml-output",
+        xml_out,
+    ]
+    subprocess.run(cmd, check=False)
+
+
+def trigger_reports_after_collect_ocs_logs(
+    *,
+    dir_name: str,
+    status_failure: bool,
+    cluster_configs,
+) -> None:
+    """
+    Trigger report generation for the OCS must-gather directory per cluster.
+    Should be called only AFTER collect_ocs_logs() returns.
+    """
+    if not config.REPORTING.get("generate_must_gather_report", False):
+        return
+
+    for cluster in cluster_configs:
+        if status_failure:
+            base = os.path.join(
+                os.path.expanduser(cluster.RUN["log_dir"]),
+                f"failed_testcase_ocs_logs_{cluster.RUN['run_id']}",
+                f"{dir_name}_ocs_logs",
+                f"{cluster.ENV_DATA['cluster_name']}",
+            )
+        else:
+            base = os.path.join(
+                os.path.expanduser(cluster.RUN["log_dir"]),
+                f"{dir_name}_{cluster.RUN['run_id']}",
+                f"{cluster.ENV_DATA['cluster_name']}",
+            )
+
+        mg_dir = os.path.join(base, "ocs_must_gather")
+        report_dir = os.path.join(base, "must_gather_report")
+        run_report_generator(mg_dir, report_dir, prefix=dir_name)