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

nodescraper/connection/inband/inbandmanager.py

@@ -0,0 +1,151 @@
+###############################################################################
+#
+# 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 __future__ import annotations
+
+from logging import Logger
+from typing import Optional, Union
+
+from nodescraper.enums import (
+    EventCategory,
+    EventPriority,
+    ExecutionStatus,
+    OSFamily,
+    SystemLocation,
+)
+from nodescraper.interfaces.connectionmanager import ConnectionManager
+from nodescraper.interfaces.taskresulthook import TaskResultHook
+from nodescraper.models import SystemInfo, TaskResult
+from nodescraper.utils import get_exception_traceback
+
+from .inband import InBandConnection
+from .inbandlocal import LocalShell
+from .inbandremote import RemoteShell, SSHConnectionError
+from .sshparams import SSHConnectionParams
+
+
+class InBandConnectionManager(ConnectionManager[InBandConnection, SSHConnectionParams]):
+
+    def __init__(
+        self,
+        system_info: SystemInfo,
+        logger: Optional[Logger] = None,
+        max_event_priority_level: Union[EventPriority, str] = EventPriority.CRITICAL,
+        parent: Optional[str] = None,
+        task_result_hooks: Optional[list[TaskResultHook]] = None,
+        connection_args: Optional[SSHConnectionParams] = None,
+        **kwargs,
+    ):
+        super().__init__(
+            system_info,
+            logger,
+            max_event_priority_level,
+            parent,
+            task_result_hooks,
+            connection_args,
+            **kwargs,
+        )
+
+    def _check_os_family(self):
+        """Check the OS family of the system under test (SUT)
+
+        Raises:
+            RuntimeError: If the connection is not initialized
+        """
+        if not self.connection:
+            raise RuntimeError("Connection not initialized")
+
+        self.logger.info("Checking OS family")
+        res = self.connection.run_command("uname -s")
+        if "not recognized as an internal or external command" in res.stdout + res.stderr:
+            self.system_info.os_family = OSFamily.WINDOWS
+        elif res.exit_code == 0:
+            self.system_info.os_family = OSFamily.LINUX
+        else:
+            self._log_event(
+                category=EventCategory.UNKNOWN,
+                description="Unable to determine SUT OS",
+                priority=EventPriority.WARNING,
+            )
+        self.logger.info("OS Family: %s", self.system_info.os_family.name)
+
+    def connect(
+        self,
+    ) -> TaskResult:
+        """Connect to the system under test (SUT) using in-band connection
+
+        Returns:
+            TaskResult: The result of the connection attempt
+        """
+        if self.system_info.location == SystemLocation.LOCAL:
+            self.logger.info("Using local shell")
+            self.connection = LocalShell()
+            self._check_os_family()
+            return self.result
+
+        if not self.connection_args or not isinstance(self.connection_args, SSHConnectionParams):
+            if not self.connection_args:
+                message = "No SSH credentials provided"
+            else:
+                message = "Invalide SSH creddentials provided"
+
+            self._log_event(
+                category=EventCategory.RUNTIME,
+                description=message,
+                priority=EventPriority.CRITICAL,
+                console_log=True,
+            )
+            self.result.status = ExecutionStatus.EXECUTION_FAILURE
+            return self.result
+
+        try:
+            self.logger.info(
+                "Initializing SSH connection to system '%s'", self.connection_args.hostname
+            )
+            self.connection = RemoteShell(self.connection_args)
+            self.connection.connect_ssh()
+            self._check_os_family()
+        except SSHConnectionError as exception:
+            self._log_event(
+                category=EventCategory.SSH,
+                description=f"{str(exception)}",
+                priority=EventPriority.CRITICAL,
+                console_log=True,
+            )
+        except Exception as exception:
+            self._log_event(
+                category=EventCategory.SSH,
+                description=f"Exception during SSH: {str(exception)}",
+                data=get_exception_traceback(exception),
+                priority=EventPriority.CRITICAL,
+                console_log=True,
+            )
+        return self.result
+
+    def disconnect(self):
+        """Disconnect in-band connection"""
+        super().disconnect()
+        if isinstance(self.connection, RemoteShell):
+            self.connection.client.close()

nodescraper/connection/inband/inbandremote.py

@@ -0,0 +1,173 @@
+###############################################################################
+#
+# 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
+import socket
+from typing import Type, Union
+
+import paramiko
+from paramiko.ssh_exception import (
+    AuthenticationException,
+    BadHostKeyException,
+    SSHException,
+)
+
+from .inband import (
+    BaseFileArtifact,
+    CommandArtifact,
+    InBandConnection,
+)
+from .sshparams import SSHConnectionParams
+
+
+class SSHConnectionError(Exception):
+    """A general exception for ssh connection failures"""
+
+
+class RemoteShell(InBandConnection):
+    """Utility class for running shell commands"""
+
+    host_key_policy: Type[paramiko.MissingHostKeyPolicy] = paramiko.RejectPolicy
+
+    def __init__(
+        self,
+        ssh_params: SSHConnectionParams,
+    ) -> None:
+        self.ssh_params = ssh_params
+        self.client = paramiko.SSHClient()
+        self.client.load_system_host_keys()
+        self.client.set_missing_host_key_policy(self.host_key_policy())
+
+    def connect_ssh(self):
+        """Connect to the remote host via SSH"""
+        try:
+            self.client.connect(
+                hostname=str(self.ssh_params.hostname),
+                port=self.ssh_params.port,
+                username=self.ssh_params.username,
+                password=(
+                    self.ssh_params.password.get_secret_value()
+                    if self.ssh_params.password
+                    else None
+                ),
+                key_filename=self.ssh_params.key_filename,
+                pkey=self.ssh_params.pkey,
+                timeout=10,
+                look_for_keys=True,
+                auth_timeout=60,
+                banner_timeout=200,
+            )
+        except socket.timeout:
+            raise SSHConnectionError("SSH Request timeout") from socket.timeout
+        except socket.gaierror as e:
+            raise SSHConnectionError("Hostname could not be resolved") from e
+        except AuthenticationException as e:
+            raise SSHConnectionError("SSH Authentication failed") from e
+        except BadHostKeyException as e:
+            raise SSHConnectionError("Unable to verify server's host key") from e
+        except ConnectionResetError as e:
+            raise SSHConnectionError("Connection reset by peer") from e
+        except SSHException as e:
+            raise SSHConnectionError(f"Unable to establish SSH connection: {str(e)}") from e
+        except EOFError as e:
+            raise SSHConnectionError("EOFError during SSH connection") from e
+        except Exception as e:
+            raise e
+
+    def read_file(
+        self,
+        filename: str,
+        encoding: Union[str, None] = "utf-8",
+        strip: bool = True,
+    ) -> BaseFileArtifact:
+        """Read a remote file into a BaseFileArtifact.
+
+        Args:
+            filename (str): Path to file on remote host
+            encoding Optional[Union[str, None]]: If None, file is read as binary. If str, decode using that encoding. Defaults to "utf-8".
+            strip (bool): Strip whitespace for text files. Ignored for binary.
+
+        Returns:
+            BaseFileArtifact: Object representing file contents
+        """
+        with self.client.open_sftp().open(filename, "rb") as remote_file:
+            raw_contents = remote_file.read()
+        return BaseFileArtifact.from_bytes(
+            filename=os.path.basename(filename),
+            raw_contents=raw_contents,
+            encoding=encoding,
+            strip=strip,
+        )
+
+    def run_command(
+        self,
+        command: str,
+        sudo=False,
+        timeout: int = 30,
+        strip: bool = True,
+    ) -> CommandArtifact:
+        """Run a shell command over ssh
+
+        Args:
+            command (str): command to run
+            sudo (bool, optional): run command with sudo (Linux only). Defaults to False.
+            timeout (int, optional): timeout for command in seconds. Defaults to 300.
+            strip (bool, optional): strip output of command. Defaults to True.
+
+        Returns:
+            CommandArtifact: Command artifact with stdout, stderr, which have been decoded and stripped as well as exit code
+        """
+        write_password = sudo and self.ssh_params.username != "root" and self.ssh_params.password
+        if write_password:
+            command = f"sudo -S -p '' {command}"
+        elif sudo:
+            command = f"sudo {command}"
+
+        try:
+            stdin, stdout, stderr = self.client.exec_command(command, timeout=timeout)
+
+            if write_password:
+                stdin.write(
+                    self.ssh_params.password.get_secret_value()
+                    if self.ssh_params.password
+                    else "" + "\n"
+                )
+                stdin.flush()
+                stdin.channel.shutdown_write()
+
+            stdout_str = stdout.read().decode("utf-8")
+            stderr_str = stderr.read().decode("utf-8")
+            exit_code = stdout.channel.recv_exit_status()
+        except TimeoutError:
+            stderr_str = "Command timed out"
+            stdout_str = ""
+            exit_code = 124
+
+        return CommandArtifact(
+            command=command,
+            stdout=stdout_str.strip() if strip else stdout_str,
+            stderr=stderr_str.strip() if strip else stderr_str,
+            exit_code=exit_code,
+        )

nodescraper/connection/inband/sshparams.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 typing import Annotated, Optional, Union
+
+from paramiko import PKey
+from pydantic import BaseModel, ConfigDict, Field, SecretStr
+from pydantic.networks import IPvAnyAddress
+
+
+class SSHConnectionParams(BaseModel):
+    """Class which holds info for an SSH connection"""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    hostname: Union[IPvAnyAddress, str]
+    username: str
+    password: Optional[SecretStr] = None
+    pkey: Optional[PKey] = None
+    key_filename: Optional[str] = None
+    port: Annotated[int, Field(strict=True, gt=0, le=65535)] = 22

nodescraper/constants.py

@@ -0,0 +1,26 @@
+###############################################################################
+#
+# 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.
+#
+###############################################################################
+DEFAULT_LOGGER = "nodescraper"

nodescraper/enums/__init__.py

@@ -0,0 +1,40 @@
+###############################################################################
+#
+# 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 .eventcategory import EventCategory
+from .eventpriority import EventPriority
+from .executionstatus import ExecutionStatus
+from .osfamily import OSFamily
+from .systeminteraction import SystemInteractionLevel
+from .systemlocation import SystemLocation
+
+__all__ = [
+    "ExecutionStatus",
+    "OSFamily",
+    "SystemInteractionLevel",
+    "SystemLocation",
+    "EventCategory",
+    "EventPriority",
+]

nodescraper/enums/eventcategory.py

@@ -0,0 +1,89 @@
+###############################################################################
+#
+# 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 enum import auto, unique
+
+from nodescraper.utils import AutoNameStrEnum
+
+
+@unique
+class EventCategory(AutoNameStrEnum):
+    """Class defining shared event categories
+    - SSH
+        SSH-related errors, e.g. connection refused, timeout, etc.
+    - RAS
+        Any RAS events including from memory, IO, compute, platform, etc.
+    - IO
+        IO-related SoC or platform IO component, e.g. PCIe, XGMI, HUBs, DF, CXL, USB, USR, NICs
+        Does not include IO errors which are customer-visible via RAS
+    - OS
+        Generic Operating System events.
+        Does not include specific events from OS which point to another category
+    - PLATFORM
+        Generic Platform Errors e.g. topo enumeration
+        Platform-specific errors which do not fall under other categories (e.g. BMC, SMC, UBB)
+        Does not include specific platform events which point to another category
+    - APPLICATION
+        End user application errors/failures/outputs
+    - MEMORY
+        Memory-related SoC or platform component, e.g. HBM, UMC, DRAM, SRAM, DDR, etc.
+        Does not include anything customer-visible via RAS
+    - STORAGE
+        SSD/HDD/storage media hardware events, filesystem events
+    - COMPUTE
+        Events from any of the following AMD IP: GFX, CPU, SDMA, VCN
+    - FW
+        FW Timeouts, internal FW problems, FW version mismatches
+    - SW_DRIVER
+        Generic SW errors/failures with amdgpu (e.g. dmesg error on driver load)
+        Does not include specific events from driver which point to another category
+    - BIOS
+        SBIOS/VBIOS/IFWI Errors
+    - INFRASTRUCTURE
+        Network, IT issues, Downtime
+    - NETWORK
+        Network configuration, interfaces, routing, neighbors, ethtool data
+    - RUNTIME
+        Framework issues, does not include content failures
+    - UNKNOWN
+        This is not a catch-all. It is intended for errors which inherently cannot be categorized due to limitations on how they are collected/analyzed.
+    """
+
+    SSH = auto()
+    RAS = auto()
+    IO = auto()
+    OS = auto()
+    PLATFORM = auto()
+    APPLICATION = auto()
+    MEMORY = auto()
+    STORAGE = auto()
+    COMPUTE = auto()
+    FW = auto()
+    SW_DRIVER = auto()
+    BIOS = auto()
+    INFRASTRUCTURE = auto()
+    NETWORK = auto()
+    RUNTIME = auto()
+    UNKNOWN = auto()

nodescraper/enums/eventpriority.py

@@ -0,0 +1,42 @@
+###############################################################################
+#
+# 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 enum import IntEnum
+from functools import total_ordering
+
+
+@total_ordering
+class EventPriority(IntEnum):
+    """Enum defining event priority levels"""
+
+    INFO = 1
+    WARNING = 2
+    ERROR = 3
+    CRITICAL = 4
+
+    def __lt__(self, other: "EventPriority") -> bool:
+        if self.__class__ is other.__class__:
+            return self.value < other.value
+        return NotImplemented

nodescraper/enums/executionstatus.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 enum
+from functools import total_ordering
+
+
+@total_ordering
+class ExecutionStatus(enum.Enum):
+    """Status of module execution"""
+
+    UNSET = 0
+    NOT_RAN = 10
+    OK = 20
+    WARNING = 30
+    ERROR = 40
+    EXECUTION_FAILURE = 50
+
+    def __lt__(self, other: "ExecutionStatus") -> bool:
+        if self.__class__ is other.__class__:
+            return self.value < other.value
+        return NotImplemented

nodescraper/enums/osfamily.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.
+#
+###############################################################################
+import enum
+
+
+class OSFamily(enum.Enum):
+    """Enum describing operating system of the SUT"""
+
+    WINDOWS = enum.auto()
+    UNKNOWN = enum.auto()
+    LINUX = enum.auto()