updates

Author: alexandraBara

nodescraper/plugins/inband/dmesg/collector_args.py

@@ -0,0 +1,31 @@
+###############################################################################
+#
+# MIT License
+#
+# Copyright (c) 2025 Advanced Micro Devices, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+###############################################################################
+
+from nodescraper.models import CollectorArgs
+
+
+class DmesgCollectorArgs(CollectorArgs):
+    collect_logs: bool = False

nodescraper/plugins/inband/dmesg/dmesg_collector.py

@@ -24,12 +24,14 @@
 #
 ###############################################################################
 import re
+from typing import Optional
 
 from nodescraper.base import InBandDataCollector
 from nodescraper.connection.inband import FileArtifact
 from nodescraper.enums import EventCategory, EventPriority, OSFamily
 from nodescraper.models import TaskResult
 
+from .collector_args import DmesgCollectorArgs
 from .dmesgdata import DmesgData
 
 
@@ -54,7 +56,7 @@ def _nice_dmesg_name(self, path: str) -> str:
         """Map path to filename."""
         base = path.rstrip("/").rsplit("/", 1)[-1]
         if base == "dmesg":
-            return "dmesg.log"
+            return "dmesg_log.log"
         m = re.fullmatch(r"dmesg\.(\d+)\.gz", base)
         if m:
             return f"dmesg.{m.group(1)}.gz.log"
@@ -81,7 +83,7 @@ def _collect_dmesg_rotations(self) -> int:
             qp = self._shell_quote(p)
             if p.endswith(".gz"):
                 cmd = f"gzip -dc {qp} 2>/dev/null || zcat {qp} 2>/dev/null"
-                res = self._run_sut_cmd(cmd, sudo=True)
+                res = self._run_sut_cmd(cmd, sudo=True, log_artifact=False)
                 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)
@@ -95,7 +97,7 @@ def _collect_dmesg_rotations(self) -> int:
                     )
             else:
                 cmd = f"cat {qp}"
-                res = self._run_sut_cmd(cmd, sudo=True)
+                res = self._run_sut_cmd(cmd, sudo=True, log_artifact=False)
                 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)
@@ -125,8 +127,6 @@ def _collect_dmesg_rotations(self) -> int:
                 priority=EventPriority.WARNING,
             )
 
-        return collected_logs
-
     def _get_dmesg_content(self) -> str:
         """run dmesg command on system and return output
 
@@ -148,15 +148,20 @@ def _get_dmesg_content(self) -> str:
 
     def collect_data(
         self,
-        args=None,
+        args: Optional[DmesgCollectorArgs] = None,
     ) -> tuple[TaskResult, DmesgData | None]:
         """Collect dmesg data from the system
 
         Returns:
             tuple[TaskResult, DmesgData | None]: tuple containing the result of the task and the dmesg data if available
         """
+
+        if args is None:
+            args = DmesgCollectorArgs()
+
         dmesg_content = self._get_dmesg_content()
-        _ = self._collect_dmesg_rotations()
+        if args.collect_logs:
+            self._collect_dmesg_rotations()
 
         if dmesg_content:
             dmesg_data = DmesgData(dmesg_content=dmesg_content)

nodescraper/plugins/inband/dmesg/dmesg_plugin.py

@@ -26,16 +26,21 @@
 from nodescraper.base import InBandDataPlugin
 
 from .analyzer_args import DmesgAnalyzerArgs
+from .collector_args import DmesgCollectorArgs
 from .dmesg_analyzer import DmesgAnalyzer
 from .dmesg_collector import DmesgCollector
 from .dmesgdata import DmesgData
 
 
-class DmesgPlugin(InBandDataPlugin[DmesgData, None, DmesgAnalyzerArgs]):
+class DmesgPlugin(InBandDataPlugin[DmesgData, DmesgCollectorArgs, DmesgAnalyzerArgs]):
     """Plugin for collection and analysis of dmesg data"""
 
     DATA_MODEL = DmesgData
 
     COLLECTOR = DmesgCollector
 
     ANALYZER = DmesgAnalyzer
+
+    ANALYZER_ARGS = DmesgAnalyzerArgs
+
+    COLLECTOR_ARGS = DmesgCollectorArgs

test/unit/plugin/test_dmesg_collector.py

@@ -117,7 +117,7 @@ def test_bad_exit_code(conn_mock, system_info):
 
     res, _ = collector.collect_data()
     assert res.status == ExecutionStatus.ERROR
-    assert len(res.events) == 2
+    assert len(res.events) == 1
     assert res.events[0].description == "Error reading dmesg"
 
 
@@ -177,7 +177,7 @@ def test_collect_rotations_good_path(monkeypatch, system_info, conn_mock):
     ls_out = (
         "\n".join(
             [
-                "/var/log/dmesg",
+                "/var/log/dmesg_log",
                 "/var/log/dmesg.1",
                 "/var/log/dmesg.2.gz",
                 "/var/log/dmesg.10.gz",
@@ -192,7 +192,7 @@ def run_map(cmd, **kwargs):
         if cmd.startswith("cat '"):
             if "/var/log/dmesg.1'" in cmd:
                 return DummyRes(command=cmd, stdout="dmesg.1 content\n", exit_code=0)
-            if "/var/log/dmesg'" in cmd:
+            if "/var/log/dmesg_log'" in cmd:
                 return DummyRes(command=cmd, stdout="dmesg content\n", exit_code=0)
         if "gzip -dc" in cmd and "/var/log/dmesg.2.gz" in cmd:
             return DummyRes(command=cmd, stdout="gz2 content\n", exit_code=0)
@@ -202,13 +202,10 @@ def run_map(cmd, **kwargs):
 
     c = get_collector(monkeypatch, run_map, system_info, conn_mock)
 
-    collected = c._collect_dmesg_rotations()
+    c._collect_dmesg_rotations()
 
     names = {a.filename for a in c.result.artifacts}
-    assert names == {"dmesg.log", "dmesg.1.log", "dmesg.2.gz.log", "dmesg.10.gz.log"}
-
-    assert isinstance(collected, list)
-    assert len(collected) == 4
+    assert names == {"dmesg_log.log", "dmesg.1.log", "dmesg.2.gz.log", "dmesg.10.gz.log"}
 
     descs = [e["description"] for e in c._events]
     assert "Collected dmesg rotated files" in descs
@@ -222,9 +219,8 @@ def run_map(cmd, **kwargs):
 
     c = get_collector(monkeypatch, run_map, system_info, conn_mock)
 
-    collected = c._collect_dmesg_rotations()
+    c._collect_dmesg_rotations()
 
-    assert collected == 0
     assert c.result.artifacts == []
 
     events = c._events
@@ -247,10 +243,8 @@ def run_map(cmd, **kwargs):
 
     c = get_collector(monkeypatch, run_map, system_info, conn_mock)
 
-    collected = c._collect_dmesg_rotations()
+    c._collect_dmesg_rotations()
 
-    assert isinstance(collected, list)
-    assert len(collected) == 0
     assert c.result.artifacts == []
 
     fail_events = [
@@ -277,7 +271,3 @@ def run_map(cmd, **kwargs):
 
     assert isinstance(data, DmesgData)
     assert data.dmesg_content == "DMESG OUTPUT\n"
-
-    assert len(c.result.artifacts) == 1
-    assert c.result.artifacts[0].filename == "dmesg.log"
-    assert c.result.message == "Dmesg data collected"