update suite_report

Author: james-bruten-mo

suite_report_git/suite_data.py

@@ -16,8 +16,11 @@
 import shutil
 import yaml
 import re
-from bdiff.git_bdiff import GitBDiff, GitInfo
-from typing import Optional, List, Dict
+try:
+    from bdiff.git_bdiff import GitBDiff, GitInfo
+except ImportError:
+    from git_bdiff import GitBDiff, GitInfo
+from typing import Union, Optional, List, Dict
 from pathlib import Path
 from collections import defaultdict
 
@@ -85,21 +88,24 @@ def clone_sources(self):
         """
         Clone the sources defined in the dependencies file, to allow reading of files
         and creation of diffs.
-        If the source is not a github url, then copy it using scp
+        If the source is not a github url, then copy it using rsync
         """
 
         for dependency, data in self.dependencies.items():
             loc = self.temp_directory / dependency
             if data["source"].endswith(".git"):
                 commands = [
-                    f"git clone {data["source"]} {loc}",
-                    f"git -C {loc} checkout {data["ref"]}",
+                    f"git clone {data['source']} {loc}",
+                    f"git -C {loc} checkout {data['ref']}",
                 ]
                 for command in commands:
                     self.run_command(command)
             else:
-                command = f"scp -r -o StrictHostKeyChecking=no {data["source"]} {loc}"
-                self.run_command(command)
+                source = data["source"]
+                if not source.endswith("/"):
+                    source = source + "/"
+                command = f'rsync -e "ssh -o StrictHostKeyChecking=no" -avl {source} {loc}'
+                self.run_command(command, shell=True)
 
     def determine_primary_source(self) -> str:
         """
@@ -259,7 +265,7 @@ def query_suite_database(
         return data
 
     def run_command(
-        self, command: str, shell: bool = False, rval: bool = False
+        self, command: Union[str, List[str]], shell: bool = False, rval: bool = False
     ) -> Optional[subprocess.CompletedProcess]:
         """
         Run a subprocess command and return the result object
@@ -268,7 +274,7 @@ def run_command(
         Outputs:
             - result object from subprocess.run
         """
-        if not shell:
+        if not shell and type(command) != list:
             command = command.split()
         result = subprocess.run(
             command,

suite_report_git/suite_report_git.py

@@ -46,6 +46,7 @@ class SuiteReport(SuiteData):
 
     # str's for collapsed sections in markdown
     open_collapsed = "<details>"
+    open_collapsed_show = "<details open>"
     close_collapsed = "</details>"
 
     def __init__(self, suite_path: Path):
@@ -108,9 +109,9 @@ def create_task_tables(self, parsed_tasks: Dict[str, List[str]]):
         """
 
         # Ensure pink failures and then normal failures appear at the top
-        sort_order = {"pink failure": 0, "failed": 1}
+        sort_order = {"pink failure": 0, "failed": 1, "submit-failed": 2}
         order = list(parsed_tasks.keys())
-        order.sort(key=lambda val: sort_order.get(val, 2))
+        order.sort(key=lambda val: sort_order.get(val, len(sort_order)))
 
         # Create summary table
         self.trac_log.extend(create_markdown_row("State", "Count", header=True))
@@ -130,7 +131,11 @@ def create_task_tables(self, parsed_tasks: Dict[str, List[str]]):
                 continue
             if state == "pink failure":
                 state = self.pink_text
-            self.trac_log.append(self.open_collapsed)
+            if "fail" in state:
+                # Have the collapsed section expanded by default
+                self.trac_log.append(self.open_collapsed_show)
+            else:
+                self.trac_log.append(self.open_collapsed)
             self.trac_log.append(f"<summary>{state} tasks</summary>")
             self.trac_log.append("")
             self.trac_log.extend(create_markdown_row("Task", "State", header=True))
@@ -229,7 +234,8 @@ def parse_args():
         "defaults to finding the suite directory from Cylc Env variables.",
     )
 
-    return parser.parse_args()
+    args, _ = parser.parse_known_args()
+    return args
 
 
 def main():