addressed reviews

Author: alexandraBara

nodescraper/plugins/inband/dmesg/collector_args.py

@@ -34,4 +34,4 @@ class DmesgCollectorArgs(CollectorArgs):
         CollectorArgs (CollectorArgs): specific dmesg collector args
     """
 
-    collect_logs: bool = False
+    collect_rotated_logs: bool = False

nodescraper/plugins/inband/dmesg/dmesg_collector.py

@@ -27,7 +27,7 @@
 from typing import Optional
 
 from nodescraper.base import InBandDataCollector
-from nodescraper.connection.inband import FileArtifact
+from nodescraper.connection.inband import TextFileArtifact
 from nodescraper.enums import EventCategory, EventPriority, OSFamily
 from nodescraper.models import TaskResult
 
@@ -60,25 +60,23 @@ def _shell_quote(self, s: str) -> str:
         return "'" + s.replace("'", "'\"'\"'") + "'"
 
     def _nice_dmesg_name(self, path: str) -> str:
-        """Map path to filename
-
-        Args:
-            path (str): path of remote file
-
-        Returns:
-            str: filename for local file
-        """
+        """Map path to filename"""
+        prefix = "rotated_"
         base = path.rstrip("/").rsplit("/", 1)[-1]
+
         if base == "dmesg":
-            return "dmesg_log.log"
+            return f"{prefix}dmesg_log.log"
+
         m = re.fullmatch(r"dmesg\.(\d+)\.gz", base)
         if m:
-            return f"dmesg.{m.group(1)}.gz.log"
+            return f"{prefix}dmesg.{m.group(1)}.gz.log"
+
         m = re.fullmatch(r"dmesg\.(\d+)", base)
         if m:
-            return f"dmesg.{m.group(1)}.log"
+            return f"{prefix}dmesg.{m.group(1)}.log"
 
-        return (base[:-3] if base.endswith(".gz") else base) + ".log"
+        middle = base[:-3] if base.endswith(".gz") else base
+        return f"{prefix}{middle}.log"
 
     def _collect_dmesg_rotations(self):
         """Collect dmesg logs"""
@@ -102,7 +100,9 @@ def _collect_dmesg_rotations(self):
                 if res.exit_code == 0 and res.stdout is not None:
                     fname = self._nice_dmesg_name(p)
                     self.logger.info("Collected dmesg log: %s", fname)
-                    self.result.artifacts.append(FileArtifact(filename=fname, contents=res.stdout))
+                    self.result.artifacts.append(
+                        TextFileArtifact(filename=fname, contents=res.stdout)
+                    )
                     collected_logs.append(
                         {"path": p, "as": fname, "bytes": len(res.stdout.encode("utf-8", "ignore"))}
                     )
@@ -116,7 +116,9 @@ def _collect_dmesg_rotations(self):
                 if res.exit_code == 0 and res.stdout is not None:
                     fname = self._nice_dmesg_name(p)
                     self.logger.info("Collected dmesg log: %s", fname)
-                    self.result.artifacts.append(FileArtifact(filename=fname, contents=res.stdout))
+                    self.result.artifacts.append(
+                        TextFileArtifact(filename=fname, contents=res.stdout)
+                    )
                     collected_logs.append(
                         {"path": p, "as": fname, "bytes": len(res.stdout.encode("utf-8", "ignore"))}
                     )
@@ -175,7 +177,7 @@ def collect_data(
             args = DmesgCollectorArgs()
 
         dmesg_content = self._get_dmesg_content()
-        if args.collect_logs:
+        if args.collect_rotated_logs:
             self._collect_dmesg_rotations()
 
         if dmesg_content:

test/unit/plugin/test_dmesg_collector.py

@@ -205,7 +205,12 @@ def run_map(cmd, **kwargs):
     c._collect_dmesg_rotations()
 
     names = {a.filename for a in c.result.artifacts}
-    assert names == {"dmesg_log.log", "dmesg.1.log", "dmesg.2.gz.log", "dmesg.10.gz.log"}
+    assert names == {
+        "rotated_dmesg_log.log",
+        "rotated_dmesg.1.log",
+        "rotated_dmesg.2.gz.log",
+        "rotated_dmesg.10.gz.log",
+    }
 
     descs = [e["description"] for e in c._events]
     assert "Collected dmesg rotated files" in descs