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

nodescraper/__init__.py

@@ -0,0 +1,32 @@
+###############################################################################
+#
+# 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 importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("node-scraper")
+except PackageNotFoundError:
+    __version__ = "unknown"

nodescraper/base/__init__.py

@@ -0,0 +1,34 @@
+###############################################################################
+#
+# 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 .inbandcollectortask import InBandDataCollector
+from .inbanddataplugin import InBandDataPlugin
+from .regexanalyzer import RegexAnalyzer
+
+__all__ = [
+    "InBandDataCollector",
+    "InBandDataPlugin",
+    "RegexAnalyzer",
+]

nodescraper/base/inbandcollectortask.py

@@ -0,0 +1,118 @@
+###############################################################################
+#
+# 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 logging
+from typing import Generic, Optional, Union
+
+from nodescraper.connection.inband import InBandConnection
+from nodescraper.connection.inband.inband import BaseFileArtifact, CommandArtifact
+from nodescraper.enums import EventPriority, OSFamily, SystemInteractionLevel
+from nodescraper.generictypes import TCollectArg, TDataModel
+from nodescraper.interfaces import DataCollector, TaskResultHook
+from nodescraper.interfaces.task import SystemCompatibilityError
+from nodescraper.models import SystemInfo
+
+
+class InBandDataCollector(
+    DataCollector[InBandConnection, TDataModel, TCollectArg],
+    Generic[TDataModel, TCollectArg],
+):
+    """Parent class for all data collectors that collect in band data"""
+
+    SUPPORTED_OS_FAMILY: set[OSFamily] = {OSFamily.WINDOWS, OSFamily.LINUX}
+
+    def __init__(
+        self,
+        system_info: SystemInfo,
+        connection: InBandConnection,
+        logger: Optional[logging.Logger] = None,
+        system_interaction_level: SystemInteractionLevel = SystemInteractionLevel.INTERACTIVE,
+        max_event_priority_level: Union[EventPriority, str] = EventPriority.CRITICAL,
+        parent: Optional[str] = None,
+        task_result_hooks: Optional[list[TaskResultHook]] = None,
+        **kwargs,
+    ):
+        super().__init__(
+            system_info=system_info,
+            system_interaction_level=system_interaction_level,
+            max_event_priority_level=max_event_priority_level,
+            logger=logger,
+            connection=connection,
+            parent=parent,
+            task_result_hooks=task_result_hooks,
+        )
+        if self.system_info.os_family not in self.SUPPORTED_OS_FAMILY:
+            raise SystemCompatibilityError(
+                f"{self.system_info.os_family.name} OS family is not supported"
+            )
+
+    def _run_sut_cmd(
+        self,
+        command: str,
+        sudo: bool = False,
+        timeout: int = 300,
+        strip: bool = True,
+        log_artifact: bool = True,
+    ) -> CommandArtifact:
+        """
+        Run a command on the SUT and return the result.
+
+        Args:
+            command (str): command to run on the SUT.
+            sudo (bool, optional): whether to run the command with sudo. Defaults to False.
+            timeout (int, optional): command timeout in seconds. Defaults to 300.
+            strip (bool, optional): whether output should be stripped. Defaults to True.
+            log_artifact (bool, optional): whether we should log the command result. Defaults to True.
+
+        Returns:
+            CommandArtifact: The result of the command execution, which includes stdout, stderr, and exit code.
+        """
+        command_res = self.connection.run_command(
+            command=command, sudo=sudo, timeout=timeout, strip=strip
+        )
+        if log_artifact:
+            self.result.artifacts.append(command_res)
+
+        return command_res
+
+    def _read_sut_file(
+        self, filename: str, encoding="utf-8", strip: bool = True, log_artifact=True
+    ) -> BaseFileArtifact:
+        """
+        Read a file from the SUT and return its content.
+
+        Args:
+            filename (str): path to the file on the SUT.
+            encoding (str, optional): encoding to use when reading the file. Defaults to "utf-8".
+            strip (bool, optional): whether the file contents should be stripped. Defaults to True.
+            log_artifact (bool, optional): whether we should log the contents of the file. Defaults to True.
+
+        Returns:
+            BaseFileArtifact: The content of the file read from the SUT, which includes the file name and content
+        """
+        file_res = self.connection.read_file(filename=filename, encoding=encoding, strip=strip)
+        if log_artifact:
+            self.result.artifacts.append(file_res)
+        return file_res

nodescraper/base/inbanddataplugin.py

@@ -0,0 +1,39 @@
+###############################################################################
+#
+# 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 typing import Generic
+
+from nodescraper.connection.inband import InBandConnectionManager, SSHConnectionParams
+from nodescraper.generictypes import TAnalyzeArg, TCollectArg, TDataModel
+from nodescraper.interfaces import DataPlugin
+
+
+class InBandDataPlugin(
+    DataPlugin[InBandConnectionManager, SSHConnectionParams, TDataModel, TCollectArg, TAnalyzeArg],
+    Generic[TDataModel, TCollectArg, TAnalyzeArg],
+):
+    """Base class for in band plugins"""
+
+    CONNECTION_TYPE = InBandConnectionManager

nodescraper/base/regexanalyzer.py

@@ -0,0 +1,120 @@
+###############################################################################
+#
+# 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 Union
+
+from pydantic import BaseModel
+
+from nodescraper.enums import EventCategory, EventPriority
+from nodescraper.generictypes import TAnalyzeArg, TDataModel
+from nodescraper.interfaces.dataanalyzertask import DataAnalyzer
+from nodescraper.models.event import Event
+
+
+class ErrorRegex(BaseModel):
+    regex: re.Pattern
+    message: str
+    event_category: Union[str, EventCategory] = EventCategory.UNKNOWN
+    event_priority: EventPriority = EventPriority.ERROR
+
+
+class RegexEvent(Event):
+    @property
+    def count(self) -> int:
+        return int(self.data.get("count", 0))
+
+    @count.setter
+    def count(self, val: int):
+        self.data["count"] = val
+
+
+class RegexAnalyzer(DataAnalyzer[TDataModel, TAnalyzeArg]):
+    """Parent class for all regex based data analyzers."""
+
+    def _build_regex_event(
+        self, regex_obj: ErrorRegex, match: Union[str, list[str]], source: str
+    ) -> RegexEvent:
+        """Build a RegexEvent object from a regex match and source.
+
+        Args:
+            regex_obj (ErrorRegex): regex object containing the regex pattern, message, category, and priorit
+            match (
+        Union[str, list[str]]): matched content from the regex
+                    source (str): descriptor for the content where the match was found
+
+        Returns:
+            RegexEvent: an instance of RegexEvent containing the match details
+        """
+        return RegexEvent(
+            description=regex_obj.message,
+            category=regex_obj.event_category,
+            priority=regex_obj.event_priority,
+            data={
+                "match_content": match,
+                "source": source,
+                "count": 1,
+                "task_name": self.__class__.__name__,
+                "task_type": self.TASK_TYPE,
+            },
+        )
+
+    def check_all_regexes(
+        self, content: str, source: str, error_regex: list[ErrorRegex], group=True
+    ) -> list[RegexEvent]:
+        """Iterate over all ERROR_REGEX and check content for any matches
+
+        Args:
+            content (str): content to match regex on
+            source (str): descriptor for content
+            error_regex (list[ErrorRegex]): list of regex objects to match
+            group (bool, optional): flag to control whether matches should be grouped together. Defaults to True.
+
+        Returns:
+            list[RegexEvent]: list of regex event objects
+        """
+
+        regex_map: dict[str, RegexEvent] = {}
+        regex_event_list: list[RegexEvent] = []
+
+        for error_regex_obj in error_regex:
+            for match in error_regex_obj.regex.findall(content):
+                if isinstance(match, str) and "\n" in match:
+                    match = match.strip().split("\n")
+
+                # filter out empty string
+                if isinstance(match, tuple) or isinstance(match, list):
+                    match = [match_val for match_val in match if match_val]
+                    if len(match) == 1:
+                        match = match[0]
+
+                if group and str(match) in regex_map:
+                    regex_map[str(match)].count += 1
+                elif group:
+                    regex_map[str(match)] = self._build_regex_event(error_regex_obj, match, source)
+                else:
+                    regex_event_list.append(self._build_regex_event(error_regex_obj, match, source))
+
+        return list(regex_map.values()) if group else regex_event_list

nodescraper/cli/__init__.py

@@ -0,0 +1,29 @@
+###############################################################################
+#
+# 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 .cli import main as cli_entry
+
+__all__ = ["cli_entry"]