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

nodescraper/plugins/inband/package/package_collector.py

@@ -0,0 +1,273 @@
+###############################################################################
+#
+# 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 Callable, Optional
+
+from pydantic import ValidationError
+
+from nodescraper.base import InBandDataCollector
+from nodescraper.connection.inband import CommandArtifact
+from nodescraper.enums import EventCategory, EventPriority, ExecutionStatus, OSFamily
+from nodescraper.models import TaskResult
+from nodescraper.utils import get_exception_details
+
+from .analyzer_args import PackageAnalyzerArgs
+from .packagedata import PackageDataModel
+
+
+class PackageCollector(InBandDataCollector[PackageDataModel, PackageAnalyzerArgs]):
+    """Collecting Package information from the system"""
+
+    DATA_MODEL = PackageDataModel
+    CMD_WINDOWS = "wmic product get name,version"
+    CMD_RELEASE = "cat /etc/*release"
+    CMD_DPKG = "dpkg-query -W"
+    CMD_DNF = "dnf list --installed"
+    CMD_PACMAN = "pacman -Q"
+
+    def _detect_package_manager(self) -> Optional[Callable]:
+        """Detect the package manager based on the OS release information.
+
+        Returns:
+            Optional[Callable]: A callable function that dumps the packages for the detected package manager,
+            or None if the package manager is not supported.
+        """
+        package_manger_map: dict[str, Callable] = {
+            "debian": self._debian_package_dump,
+            "redhat": self._dump_fedora_centos_rhel_packages,
+            "rhel": self._dump_fedora_centos_rhel_packages,
+            "fedora": self._dump_fedora_centos_rhel_packages,
+            "centos": self._dump_fedora_centos_rhel_packages,
+            "arch": self._dump_arch_packages,
+        }
+        res = self._run_sut_cmd(self.CMD_RELEASE)
+        # search for the package manager key in the release file
+        for os, package_manager in package_manger_map.items():
+            package_search = re.findall(os, res.stdout, flags=re.IGNORECASE)
+            if package_search:
+                return package_manager
+        return None
+
+    def _windows_package_dump(self) -> dict[str, str]:
+        """Dump installed packages on Windows using wmic
+
+        Returns:
+            dict[str, str]: A dictionary with package names as keys and their versions as values.
+        """
+        MIN_SPLIT_LENGTH = 2
+        res = self._run_sut_cmd(self.CMD_WINDOWS)
+        packages = {}
+        if res.exit_code != 0:
+            self._handle_command_failure(res)
+            return {}
+        lines = res.stdout.splitlines()
+
+        for line in lines[1:]:
+            columns = line.split()
+            if len(columns) <= MIN_SPLIT_LENGTH:
+                continue
+            # spaces are allowed in names, so we need to join them
+            name = (" ").join(columns[:-1])
+            version = columns[-1]
+            packages[name] = version
+
+        return packages
+
+    def _debian_package_dump(self) -> dict[str, str]:
+        """Dump installed packages on Debian-based systems using dpkg-query
+
+        Returns:
+            dict[str, str]: A dictionary with package names as keys and their versions as values.
+        """
+        MIN_SPLIT_LENGTH = 2
+        MAX_SPLIT_LENGTH = 3
+        res = self._run_sut_cmd(self.CMD_DPKG)
+        packages = {}
+        if res.exit_code != 0:
+            self._handle_command_failure(res)
+            return {}
+
+        lines = res.stdout.splitlines()
+        for line in lines:
+            columns = line.split()
+            if len(columns) < MIN_SPLIT_LENGTH or len(columns) > MAX_SPLIT_LENGTH:
+                continue
+            if columns[0] == "Installed" or columns[1] == "Packages":
+                continue
+            packages[columns[0]] = columns[1]
+        return packages
+
+    def _dump_fedora_centos_rhel_packages(self) -> dict[str, str]:
+        """Dump installed packages on Fedora, CentOS, or RHEL using dnf
+
+        Returns:
+            dict[str, str]: A dictionary with package names as keys and their versions as values.
+        """
+        MIN_SPLIT_LENGTH = 2
+        MAX_SPLIT_LENGTH = 3
+        res = self._run_sut_cmd(self.CMD_DNF)
+        packages = {}
+        if res.exit_code != 0:
+            self._handle_command_failure(res)
+            return {}
+        lines = res.stdout.splitlines()
+        for line in lines:
+            columns = line.split()
+            if len(columns) < MIN_SPLIT_LENGTH or len(columns) > MAX_SPLIT_LENGTH:
+                continue
+            if "Installed" in columns[0] or "Packages" in columns[1]:
+                continue
+            packages[columns[0]] = columns[1]
+        return packages
+
+    def _dump_arch_packages(self) -> dict[str, str]:
+        """Dump installed packages on Arch Linux using pacman
+
+        Returns:
+            dict[str, str]: A dictionary with package names as keys and their versions as values.
+        """
+        EXPECTED_SPLIT_LENGTH = 2
+        res: CommandArtifact = self._run_sut_cmd(self.CMD_PACMAN)
+        packages = {}
+        if res.exit_code != 0:
+            self._handle_command_failure(res)
+            return {}
+        lines = res.stdout.splitlines()
+        for line in lines:
+            columns = line.split()
+            if len(columns) != EXPECTED_SPLIT_LENGTH:
+                continue
+            packages[columns[0]] = columns[1]
+        return packages
+
+    def _handle_command_failure(self, command_artifact: CommandArtifact):
+        """Handle command failure by logging the error and updating the result.
+        This method logs the error details and updates the result with a failure status.
+
+        Args:
+            command_artifact (CommandArtifact): The command artifact containing the command output and error details.
+        """
+        self._log_event(
+            category=EventCategory.OS,
+            description=f"Error running command: {command_artifact.command}",
+            priority=EventPriority.WARNING,
+            data={
+                "stderr": command_artifact.stderr,
+                "exit_code": command_artifact.exit_code,
+            },
+        )
+        self.result.message = "Failed to run Package Manager command"
+        self.result.status = ExecutionStatus.EXECUTION_FAILURE
+
+    def _filter_rocm_packages(self, packages: dict[str, str], rocm_pattern: str) -> dict[str, str]:
+        """Filter ROCm-related packages from a package dictionary.
+
+        This method searches package names for ROCm-related patterns and returns
+        only the matching packages.
+
+        Args:
+            packages (dict[str, str]): Dictionary with package names as keys and versions as values.
+            rocm_pattern (str): Regex pattern to match ROCm-related package names.
+
+        Returns:
+            dict[str, str]: Filtered dictionary containing only ROCm-related packages.
+        """
+        rocm_packages = {}
+        pattern = re.compile(rocm_pattern, re.IGNORECASE)
+        for package_name, version in packages.items():
+            if pattern.search(package_name):
+                rocm_packages[package_name] = version
+        return rocm_packages
+
+    def collect_data(
+        self, args: Optional[PackageAnalyzerArgs] = None
+    ) -> tuple[TaskResult, Optional[PackageDataModel]]:
+        """Collect package information from the system.
+
+        Args:
+            args (Optional[PackageAnalyzerArgs]): Optional arguments containing ROCm regex pattern.
+
+        Returns:
+            tuple[TaskResult, Optional[PackageDataModel]]: tuple containing the task result and a PackageDataModel instance
+            with the collected package information, or None if there was an error.
+        """
+        packages = {}
+        # Windows
+        if self.system_info.os_family == OSFamily.WINDOWS:
+            packages = self._windows_package_dump()
+        # Linux
+        elif self.system_info.os_family == OSFamily.LINUX:
+            package_manager = self._detect_package_manager()
+            if package_manager:
+                packages = package_manager()
+            else:
+                self.result.message = "Unsupported package manager"
+                self.result.status = ExecutionStatus.NOT_RAN
+                return self.result, None
+        else:
+            self.result.message = "Unsupported OS"
+            self.result.status = ExecutionStatus.NOT_RAN
+            return self.result, None
+
+        # Filter and log ROCm packages if on Linux and rocm_regex is provided
+        if self.system_info.os_family == OSFamily.LINUX and packages:
+            # Get ROCm pattern from args if provided
+            rocm_pattern = args.rocm_regex if args else None
+            if rocm_pattern:
+                self.logger.info("Using rocm_pattern: %s", rocm_pattern)
+                rocm_packages = self._filter_rocm_packages(packages, rocm_pattern)
+                if rocm_packages:
+                    self.result.message = (
+                        f"Found {len(rocm_packages)} ROCm-related packages installed"
+                    )
+                    self.result.status = ExecutionStatus.OK
+                    self._log_event(
+                        category=EventCategory.OS,
+                        description=f"Found {len(rocm_packages)} ROCm-related packages installed",
+                        priority=EventPriority.INFO,
+                        data={"rocm_packages": sorted(rocm_packages.keys())},
+                    )
+            else:
+                self.logger.info("No rocm_regex provided, skipping ROCm package filtering")
+
+        # Extract rocm_regex and enable_rocm_regex from args if provided
+        rocm_regex = args.rocm_regex if (args and args.rocm_regex) else ""
+        enable_rocm_regex = getattr(args, "enable_rocm_regex", False) if args else False
+
+        try:
+            package_model = PackageDataModel(
+                version_info=packages, rocm_regex=rocm_regex, enable_rocm_regex=enable_rocm_regex
+            )
+        except ValidationError as val_err:
+            self._log_event(
+                category=EventCategory.RUNTIME,
+                description="Error validating package data",
+                priority=EventPriority.WARNING,
+                data=get_exception_details(val_err),
+            )
+            package_model = None
+
+        return self.result, package_model

nodescraper/plugins/inband/package/package_plugin.py

@@ -0,0 +1,43 @@
+###############################################################################
+#
+# 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 .analyzer_args import PackageAnalyzerArgs
+from .package_analyzer import PackageAnalyzer
+from .package_collector import PackageCollector
+from .packagedata import PackageDataModel
+
+
+class PackagePlugin(InBandDataPlugin[PackageDataModel, None, PackageAnalyzerArgs]):
+    """Plugin for collection and analysis of package version data"""
+
+    DATA_MODEL = PackageDataModel
+
+    COLLECTOR = PackageCollector
+
+    ANALYZER = PackageAnalyzer
+
+    ANALYZER_ARGS = PackageAnalyzerArgs

nodescraper/plugins/inband/package/packagedata.py

@@ -0,0 +1,41 @@
+###############################################################################
+#
+# 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 PackageDataModel(DataModel):
+    """Pacakge data contains the package data for the system
+
+    Attributes:
+        version_info (dict[str, str]): The version information for the package
+            Key is the package name and value is the version of the package
+        rocm_regex (str): Regular expression pattern for ROCm package filtering
+        enable_rocm_regex (bool): Whether to use custom ROCm regex from collection_args
+    """
+
+    version_info: dict[str, str]
+    rocm_regex: str = ""
+    enable_rocm_regex: bool = False

nodescraper/plugins/inband/pcie/__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 .analyzer_args import PcieAnalyzerArgs
+from .pcie_plugin import PciePlugin
+
+__all__ = ["PciePlugin", "PcieAnalyzerArgs"]

nodescraper/plugins/inband/pcie/analyzer_args.py

@@ -0,0 +1,63 @@
+###############################################################################
+#
+# 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 Dict, Optional, Union
+
+from nodescraper.models import AnalyzerArgs
+
+
+class PcieAnalyzerArgs(AnalyzerArgs):
+    """Arguments for PCIe analyzer
+
+    Attributes:
+        exp_speed: Expected PCIe speed (generation 1-5)
+        exp_width: Expected PCIe width (1-16 lanes)
+        exp_sriov_count: Expected SR-IOV VF count
+        exp_gpu_count_override: Override expected GPU count
+        exp_max_payload_size: Expected max payload size (int for all devices, dict for specific device IDs)
+        exp_max_rd_req_size: Expected max read request size (int for all devices, dict for specific device IDs)
+        exp_ten_bit_tag_req_en: Expected 10-bit tag request enable (int for all devices, dict for specific device IDs)
+    """
+
+    exp_speed: int = 5
+    exp_width: int = 16
+    exp_sriov_count: int = 0
+    exp_gpu_count_override: Optional[int] = None
+    exp_max_payload_size: Optional[Union[Dict[int, int], int]] = None
+    exp_max_rd_req_size: Optional[Union[Dict[int, int], int]] = None
+    exp_ten_bit_tag_req_en: Optional[Union[Dict[int, int], int]] = None
+
+
+def normalize_to_dict(
+    value: Optional[Union[Dict[int, int], int]], vendorid_ep: int
+) -> Dict[int, int]:
+    """Normalize int or dict values to dict format using vendorid_ep as key for int values"""
+    if value is None:
+        return {}
+    if isinstance(value, int):
+        return {vendorid_ep: value}
+    if isinstance(value, dict):
+        return value
+    return {}