amd-node-scraper 0.0.1__py3-none-any.whl

nodescraper/plugins/inband/syslog/syslogdata.py

@@ -0,0 +1,46 @@
+##############################################################
+#
+# 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.connection.inband.inband import TextFileArtifact
+from nodescraper.models import DataModel
+
+
+class SyslogData(DataModel):
+    """Data model for in band syslog logs"""
+
+    syslog_logs: list[TextFileArtifact] = []
+
+    def log_model(self, log_path: str):
+        """Log data model to a file
+
+        Args:
+            log_path (str): log path
+        """
+        for artifact in self.syslog_logs:
+            log_name = os.path.join(log_path, artifact.filename)
+            with open(log_name, "w", encoding="utf-8") as log_file:
+                log_file.write(artifact.contents)

nodescraper/plugins/inband/uptime/__init__.py

@@ -0,0 +1,25 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################

nodescraper/plugins/inband/uptime/uptime_collector.py

@@ -0,0 +1,88 @@
+###############################################################################
+#
+# 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 re
+from typing import Optional
+
+from nodescraper.base import InBandDataCollector
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus, OSFamily
+from nodescraper.models import TaskResult
+
+from .uptimedata import UptimeDataModel
+
+
+class UptimeCollector(InBandDataCollector[UptimeDataModel, None]):
+    """Collect last boot time and uptime from uptime command"""
+
+    DATA_MODEL = UptimeDataModel
+
+    SUPPORTED_OS_FAMILY: set[OSFamily] = {OSFamily.LINUX}
+
+    CMD = "uptime"
+
+    def collect_data(self, args=None) -> tuple[TaskResult, Optional[UptimeDataModel]]:
+        """Collect uptime data from the system.
+
+        Returns:
+            tuple[TaskResult, Optional[UptimeDataModel]]: tuple containing the task result and uptime data model or None if failed.
+        """
+
+        uptime_pattern = re.compile(
+            r"(?P<current_time>\d{2}:\d{2}:\d{2})\s+" r"up\s+(?P<uptime>.+?),\s+\d+\s+users?"
+        )
+
+        res = self._run_sut_cmd(self.CMD)
+
+        if res.exit_code == 0:
+            line = res.stdout.strip()
+            match = uptime_pattern.match(line)
+
+            if match:
+                current_time = match.group("current_time")
+                uptime = match.group("uptime")
+
+        else:
+            self._log_event(
+                category=EventCategory.OS,
+                description="Error running uptime command",
+                data={"command": res.command, "exit_code": res.exit_code},
+                priority=EventPriority.ERROR,
+                console_log=True,
+            )
+            self.result.message = "Failed to run uptime command"
+            self.result.status = ExecutionStatus.EXECUTION_FAILURE
+            return self.result, None
+
+        uptime_data = UptimeDataModel(current_time=current_time, uptime=uptime)
+
+        self._log_event(
+            category=EventCategory.OS,
+            description="Uptime data collected",
+            data=uptime_data.model_dump(),
+            priority=EventPriority.INFO,
+        )
+        self.result.message = f"Uptime: {uptime}"
+        self.result.status = ExecutionStatus.OK
+        return self.result, uptime_data

nodescraper/plugins/inband/uptime/uptime_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 .uptime_collector import UptimeCollector
+from .uptimedata import UptimeDataModel
+
+
+class UptimePlugin(InBandDataPlugin[UptimeDataModel, None, None]):
+    """Plugin for collection of system uptime data"""
+
+    DATA_MODEL = UptimeDataModel
+
+    COLLECTOR = UptimeCollector

nodescraper/plugins/inband/uptime/uptimedata.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 DataModel
+
+
+class UptimeDataModel(DataModel):
+    current_time: str
+    uptime: str

nodescraper/resultcollators/__init__.py

@@ -0,0 +1,25 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################

nodescraper/resultcollators/tablesummary.py

@@ -0,0 +1,159 @@
+###############################################################################
+#
+# 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 textwrap import wrap
+from typing import Optional
+
+from nodescraper.interfaces import PluginResultCollator
+from nodescraper.models import PluginResult, TaskResult
+
+
+class TableSummary(PluginResultCollator):
+    """generate a summary of plugin results in a tabular format which will be logged using the logger instance"""
+
+    def collate_results(
+        self, plugin_results: list[PluginResult], connection_results: list[TaskResult], **kwargs
+    ):
+        """Collate the results into a summary table
+
+        Args:
+            plugin_results (list[PluginResult]): list of plugin results to collate
+            connection_results (list[TaskResult]): list of connection results to collate
+        """
+
+        def gen_str_table(
+            headers: list[str],
+            rows: list[list[Optional[str]]],
+            max_widths: Optional[dict[str, int]] = None,
+        ) -> str:
+            """Wrap cells
+
+            Args:
+                headers (list[str]): table header
+                rows (Optional[list[list[str]]]): table rows
+                max_widths (Optional[dict[str, int]], optional): width per col. Defaults to None.
+
+            Returns:
+                str: wrapped texed
+            """
+
+            max_widths = max_widths or {}
+
+            norm_rows: list[list[str]] = [
+                ["" if c is None else str(c) for c in row] for row in rows
+            ]
+
+            ncols = len(headers)
+
+            raw_widths: list[int] = [len(h) for h in headers]
+            for norm_row in norm_rows:
+                for i, cell in enumerate(norm_row):
+                    for part in cell.splitlines() or [""]:
+                        if len(part) > raw_widths[i]:
+                            raw_widths[i] = len(part)
+
+            target_widths: list[int] = []
+            for i, h in enumerate(headers):
+                cap = max_widths.get(h)
+                if cap is None:
+                    target_widths.append(raw_widths[i])
+                else:
+                    target_widths.append(max(len(h), min(raw_widths[i], cap)))
+
+            wrapped_rows: list[list[list[str]]] = []
+            for norm_row in norm_rows:
+                wrapped_cells: list[list[str]] = []
+                for i, cell in enumerate(norm_row):
+                    cell_lines: list[str] = []
+                    paragraphs = cell.splitlines() or [""]
+                    for para in paragraphs:
+                        chunked = wrap(para, width=target_widths[i]) or [""]
+                        cell_lines.extend(chunked)
+                    wrapped_cells.append(cell_lines)
+                wrapped_rows.append(wrapped_cells)
+
+            col_widths: list[int] = []
+            for i in range(ncols):
+                widest_line = len(headers[i])
+                for wrow in wrapped_rows:
+                    for line in wrow[i]:
+                        if len(line) > widest_line:
+                            widest_line = len(line)
+                col_widths.append(widest_line)
+
+            border = "+" + "+".join("-" * (w + 2) for w in col_widths) + "+"
+
+            def render_physical_row(parts: list[str]) -> str:
+                return "| " + " | ".join(p.ljust(w) for p, w in zip(parts, col_widths)) + " |"
+
+            table_lines: list[str] = [border, render_physical_row(headers), border]
+            for wrow in wrapped_rows:
+                height = max(len(cell_lines) for cell_lines in wrow)
+                for idx in range(height):
+                    parts = [
+                        (wrow[col][idx] if idx < len(wrow[col]) else "") for col in range(ncols)
+                    ]
+                    table_lines.append(render_physical_row(parts))
+            table_lines.append(border)
+            return "\n".join(table_lines)
+
+        tables = ""
+        if connection_results:
+            conn_rows: list[list[Optional[str]]] = []
+            for connection_result in connection_results:
+                conn_rows.append(
+                    [
+                        connection_result.task,
+                        connection_result.status.name,
+                        connection_result.message,
+                    ]
+                )
+
+            table = gen_str_table(
+                ["Connection", "Status", "Message"],
+                conn_rows,
+                max_widths={"Connection": 32, "Status": 16, "Message": 80},
+            )
+            tables += f"\n\n{table}"
+
+        if plugin_results:
+            plug_rows: list[list[Optional[str]]] = []
+            for plugin_result in plugin_results:
+                plug_rows.append(
+                    [
+                        plugin_result.source,
+                        plugin_result.status.name,
+                        plugin_result.message,
+                    ]
+                )
+            table = gen_str_table(
+                ["Plugin", "Status", "Message"],
+                plug_rows,
+                max_widths={"Plugin": 32, "Status": 16, "Message": 80},
+            )
+            tables += f"\n\n{table}"
+
+        if tables:
+            self.logger.info("%s\n", tables)

nodescraper/taskresulthooks/__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 .filesystemloghook import FileSystemLogHook
+
+__all__ = ["FileSystemLogHook"]

nodescraper/taskresulthooks/filesystemloghook.py

@@ -0,0 +1,88 @@
+###############################################################################
+#
+# 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 json
+import os
+from typing import Optional
+
+from nodescraper.connection.inband import BaseFileArtifact
+from nodescraper.interfaces.taskresulthook import TaskResultHook
+from nodescraper.models import DataModel, TaskResult
+from nodescraper.utils import get_unique_filename, pascal_to_snake
+
+
+class FileSystemLogHook(TaskResultHook):
+
+    def __init__(self, log_base_path=None, **kwargs) -> None:
+        if log_base_path is None:
+            log_base_path = os.getcwd()
+
+        self.log_base_path = log_base_path
+
+    def process_result(self, task_result: TaskResult, data: Optional[DataModel] = None, **kwargs):
+        """log task result to the filesystem
+
+        Args:
+            task_result (TaskResult): input task result
+        """
+        log_path = self.log_base_path
+        if task_result.parent:
+            log_path = os.path.join(log_path, pascal_to_snake(task_result.parent))
+        if task_result.task:
+            log_path = os.path.join(log_path, pascal_to_snake(task_result.task))
+
+        os.makedirs(log_path, exist_ok=True)
+
+        with open(os.path.join(log_path, "result.json"), "w", encoding="utf-8") as log_file:
+            log_file.write(task_result.model_dump_json(exclude={"artifacts", "events"}, indent=2))
+
+        artifact_map = {}
+        for artifact in task_result.artifacts:
+            if isinstance(artifact, BaseFileArtifact):
+                log_name = get_unique_filename(log_path, artifact.filename)
+                artifact.log_model(log_path)
+
+            else:
+                name = f"{pascal_to_snake(artifact.__class__.__name__)}s"
+                if name in artifact_map:
+                    artifact_map[name].append(artifact.model_dump(mode="json"))
+                else:
+                    artifact_map[name] = [artifact.model_dump(mode="json")]
+
+        for name, artifacts in artifact_map.items():
+            log_name = get_unique_filename(log_path, f"{name}.json")
+            with open(os.path.join(log_path, log_name), "w", encoding="utf-8") as log_file:
+                json.dump(artifacts, log_file, indent=2)
+
+        if task_result.events:
+            event_log = get_unique_filename(log_path, "events.json")
+            events = [
+                event.model_dump(mode="json", exclude_none=True) for event in task_result.events
+            ]
+            with open(os.path.join(log_path, event_log), "w", encoding="utf-8") as log_file:
+                json.dump(events, log_file, indent=2)
+
+        if data:
+            data.log_model(log_path)