Merge pull request #38 from amd/alex_journal_log

New plugin: journal logs

Author: alexandraBara

nodescraper/connection/inband/inbandlocal.py

@@ -56,6 +56,7 @@ def run_command(
             command,
             encoding="utf-8",
             shell=True,
+            errors="replace",
             timeout=timeout,
             capture_output=True,
             check=False,

nodescraper/plugins/inband/journal/__init__.py

@@ -0,0 +1,28 @@
+###############################################################################
+#
+# 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 .journal_plugin import JournalPlugin
+
+__all__ = ["JournalPlugin"]

nodescraper/plugins/inband/journal/journal_collector.py

@@ -0,0 +1,77 @@
+###############################################################################
+#
+# 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.base import InBandDataCollector
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus, OSFamily
+from nodescraper.models import TaskResult
+
+from .journaldata import JournalData
+
+
+class JournalCollector(InBandDataCollector[JournalData, None]):
+    """Read journal log via journalctl."""
+
+    SUPPORTED_OS_FAMILY = {OSFamily.LINUX}
+    DATA_MODEL = JournalData
+
+    def _read_with_journalctl(self):
+        """Read journal logs using journalctl
+
+        Returns:
+            str|None: system journal read
+        """
+        cmd = "journalctl --no-pager --system --output=short-iso"
+        res = self._run_sut_cmd(cmd, sudo=True, log_artifact=False, strip=False)
+
+        if res.exit_code != 0:
+            self._log_event(
+                category=EventCategory.OS,
+                description="Error reading journalctl",
+                data={"command": res.command, "exit_code": res.exit_code},
+                priority=EventPriority.ERROR,
+                console_log=True,
+            )
+            self.result.message = "Could not read journalctl data"
+            self.result.status = ExecutionStatus.ERROR
+            return None
+
+        return res.stdout
+
+    def collect_data(self, args=None) -> tuple[TaskResult, JournalData | None]:
+        """Collect journal logs
+
+        Args:
+            args (_type_, optional): Collection args. Defaults to None.
+
+        Returns:
+            tuple[TaskResult, JournalData | None]: Tuple of results and data model or none.
+        """
+        journal_log = self._read_with_journalctl()
+        if journal_log:
+            data = JournalData(journal_log=journal_log)
+            self.result.message = self.result.message or "Journal data collected"
+            return self.result, data
+        return self.result, None

nodescraper/plugins/inband/journal/journal_plugin.py

@@ -0,0 +1,37 @@
+###############################################################################
+#
+# 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.base import InBandDataPlugin
+
+from .journal_collector import JournalCollector
+from .journaldata import JournalData
+
+
+class JournalPlugin(InBandDataPlugin[JournalData, None, None]):
+    """Plugin for collection of journal data"""
+
+    DATA_MODEL = JournalData
+
+    COLLECTOR = JournalCollector

nodescraper/plugins/inband/journal/journaldata.py

@@ -0,0 +1,44 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################
+import os
+
+from nodescraper.models import DataModel
+
+
+class JournalData(DataModel):
+    """Data model for journal logs"""
+
+    journal_log: str
+
+    def log_model(self, log_path: str):
+        """Log data model to a file
+
+        Args:
+            log_path (str): log path
+        """
+        log_name = os.path.join(log_path, "journal.log")
+        with open(log_name, "w", encoding="utf-8") as log_filename:
+            log_filename.write(self.journal_log)

test/unit/plugin/test_journal_collector.py

@@ -0,0 +1,71 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################
+import types
+
+from nodescraper.enums.systeminteraction import SystemInteractionLevel
+from nodescraper.plugins.inband.journal.journal_collector import JournalCollector
+from nodescraper.plugins.inband.journal.journaldata import JournalData
+
+
+class DummyRes:
+    def __init__(self, command="", stdout="", exit_code=0, stderr=""):
+        self.command = command
+        self.stdout = stdout
+        self.exit_code = exit_code
+        self.stderr = stderr
+
+
+def get_collector(monkeypatch, run_map, system_info, conn_mock):
+    c = JournalCollector(
+        system_info=system_info,
+        system_interaction_level=SystemInteractionLevel.INTERACTIVE,
+        connection=conn_mock,
+    )
+    c.result = types.SimpleNamespace(artifacts=[], message=None)
+    c._events = []
+
+    def _log_event(**kw):
+        c._events.append(kw)
+
+    def _run_sut_cmd(cmd, *args, **kwargs):
+        return run_map(cmd, *args, **kwargs)
+
+    monkeypatch.setattr(c, "_log_event", _log_event, raising=True)
+    monkeypatch.setattr(c, "_run_sut_cmd", _run_sut_cmd, raising=True)
+
+    return c
+
+
+def test_collect_data_integration(monkeypatch, system_info, conn_mock):
+    def run_map(cmd, **kwargs):
+        return DummyRes(command=cmd, stdout='{"MESSAGE":"hello"}\n', exit_code=0)
+
+    c = get_collector(monkeypatch, run_map, system_info, conn_mock)
+
+    result, data = c.collect_data()
+    assert isinstance(data, JournalData)
+
+    assert data.journal_log == '{"MESSAGE":"hello"}\n'