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

nodescraper/interfaces/task.py

@@ -0,0 +1,164 @@
+###############################################################################
+#
+# 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 abc
+import copy
+import datetime
+import logging
+from typing import Any, Optional, Union
+
+from nodescraper.constants import DEFAULT_LOGGER
+from nodescraper.enums import EventCategory, EventPriority
+from nodescraper.models import Event, SystemInfo, TaskResult
+
+from .taskresulthook import TaskResultHook
+
+
+class SystemCompatibilityError(Exception):
+    """Exception raised when system has invalid attributes for the task"""
+
+    pass
+
+
+class Task(abc.ABC):
+    """Parent class for all tasks"""
+
+    TASK_TYPE: str
+
+    def __init__(
+        self,
+        system_info: SystemInfo,
+        logger: Optional[logging.Logger] = None,
+        max_event_priority_level: Union[EventPriority, str] = EventPriority.CRITICAL,
+        parent: Optional[str] = None,
+        task_result_hooks: Optional[list[TaskResultHook]] = None,
+        **kwargs: dict[str, Any],
+    ):
+        if logger is None:
+            logger = logging.getLogger(DEFAULT_LOGGER)
+        self.system_info = system_info
+        self.logger = logger
+        self.max_event_priority_level = max_event_priority_level
+        self.parent = parent
+        if not task_result_hooks:
+            task_result_hooks = []
+        self.task_result_hooks = task_result_hooks
+        self.result: TaskResult = self._init_result()
+
+    @property
+    def max_event_priority_level(self) -> EventPriority:
+        """maximum priority level for events generated by task
+
+        Returns:
+            EventPriority: max priority level enum
+        """
+        return self._max_event_priority_level
+
+    @max_event_priority_level.setter
+    def max_event_priority_level(self, input_value: Union[str, EventPriority]):
+        if isinstance(input_value, str):
+            value: EventPriority = getattr(EventPriority, input_value)
+        elif isinstance(input_value, int):
+            value = EventPriority(input_value)
+        elif isinstance(input_value, EventPriority):
+            value: EventPriority = input_value  # type:ignore
+        else:
+            raise ValueError(f"Invalid type for max_event_priority_level: {type(input_value)}")
+
+        self._max_event_priority_level = value
+
+    def __init_subclass__(cls, **kwargs) -> None:
+        super().__init_subclass__(**kwargs)
+        if cls.TASK_TYPE is None:
+            raise TypeError(f"No value provided for TASK_TYPE in task class {cls.__name__}")
+
+    def _build_event(
+        self,
+        category: Union[EventCategory, str],
+        description: str,
+        priority: EventPriority,
+        data: Optional[dict] = None,
+        timestamp: Optional[datetime.datetime] = None,
+    ) -> Event:
+
+        if data is None:
+            data = {"task_name": self.__class__.__name__, "task_type": self.TASK_TYPE}
+
+        else:
+            # Copy to avoid mutating the caller's dict
+            data = copy.copy(data)
+            data["task_name"] = self.__class__.__name__
+            data["task_type"] = self.TASK_TYPE
+
+        if self.parent:
+            data["parent"] = self.parent
+
+        if self.system_info.metadata:
+            data["system_metadata"] = copy.copy(self.system_info.metadata)
+
+        if priority > self.max_event_priority_level:
+            priority = self.max_event_priority_level
+
+        event = Event(
+            category=category,
+            description=description,
+            priority=priority,
+            data=data,
+        )
+
+        if timestamp:
+            event.timestamp = timestamp
+
+        return event
+
+    def _log_event(
+        self,
+        category: Union[EventCategory, str],
+        description: str,
+        priority: EventPriority,
+        data: Optional[dict] = None,
+        timestamp: Optional[datetime.datetime] = None,
+        console_log: bool = False,
+    ):
+        event = self._build_event(
+            category=category,
+            description=description,
+            priority=priority,
+            data=data,
+            timestamp=timestamp,
+        )
+
+        if console_log:
+            self.logger.log(getattr(logging, priority.name, logging.INFO), description)
+
+        self.result.events.append(event)
+
+    def _init_result(self):
+        result = TaskResult(task=self.__class__.__name__, parent=self.parent)
+        return result
+
+    def _run_hooks(self, result, **kwargs):
+        for hook in self.task_result_hooks:
+            hook.process_result(result, **kwargs)

nodescraper/interfaces/taskresulthook.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.
+#
+###############################################################################
+import abc
+
+from nodescraper.models import TaskResult
+
+
+class TaskResultHook(abc.ABC):
+
+    @abc.abstractmethod
+    def process_result(self, task_result: TaskResult, **kwargs):
+        """post process task result
+
+        Args:
+            task_result (TaskResult): input task result
+        """

nodescraper/models/__init__.py

@@ -0,0 +1,48 @@
+###############################################################################
+#
+# 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 .analyzerargs import AnalyzerArgs
+from .collectorargs import CollectorArgs
+from .datamodel import DataModel
+from .datapluginresult import DataPluginResult
+from .event import Event
+from .pluginconfig import PluginConfig
+from .pluginresult import PluginResult
+from .systeminfo import SystemInfo
+from .taskresult import TaskResult
+from .timerangeargs import TimeRangeAnalysisArgs
+
+__all__ = [
+    "AnalyzerArgs",
+    "CollectorArgs",
+    "DataModel",
+    "TaskResult",
+    "Event",
+    "SystemInfo",
+    "PluginResult",
+    "DataPluginResult",
+    "PluginConfig",
+    "TimeRangeAnalysisArgs",
+]

nodescraper/models/analyzerargs.py

@@ -0,0 +1,93 @@
+###############################################################################
+#
+# 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 Any
+
+from pydantic import BaseModel, model_validator
+
+
+class AnalyzerArgs(BaseModel):
+    """Base class for all analyzer arguments.
+
+    This class provides automatic string stripping for all string values
+    in analyzer args. All analyzer args classes should inherit from this
+    directly.
+
+    """
+
+    model_config = {"extra": "forbid", "exclude_none": True}
+
+    @model_validator(mode="before")
+    @classmethod
+    def strip_string_values(cls, data: Any) -> Any:
+        """Strip whitespace from all string values in analyzer args.
+
+        This validator recursively processes:
+        - String values: strips whitespace
+        - Lists: strips strings in lists
+        - Dicts: strips string values in dicts
+        - Other types: left unchanged
+
+        Args:
+            data: The input data to validate
+
+        Returns:
+            The data with all string values stripped
+        """
+        if isinstance(data, dict):
+            return {k: cls._strip_value(v) for k, v in data.items()}
+        return data
+
+    @classmethod
+    def _strip_value(cls, value: Any) -> Any:
+        """Recursively strip string values.
+
+        Args:
+            value: The value to process
+
+        Returns:
+            The processed value
+        """
+        if isinstance(value, str):
+            return value.strip()
+        elif isinstance(value, list):
+            return [cls._strip_value(item) for item in value]
+        elif isinstance(value, dict):
+            return {k: cls._strip_value(v) for k, v in value.items()}
+        return value
+
+    @classmethod
+    def build_from_model(cls, datamodel):
+        """Build analyzer args instance from data model object
+
+        Args:
+            datamodel (TDataModel): data model to use for creating analyzer args
+
+        Raises:
+            NotImplementedError: Not implemented error
+        """
+        raise NotImplementedError(
+            "Setting analyzer args from datamodel is not implemented for class: %s", cls.__name__
+        )

nodescraper/models/collectorargs.py

@@ -0,0 +1,30 @@
+###############################################################################
+#
+# 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 pydantic import BaseModel
+
+
+class CollectorArgs(BaseModel):
+    model_config = {"extra": "forbid", "exclude_none": True}

nodescraper/models/connectionconfig.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 pydantic import BaseModel, Field
+
+
+class ConnectionConfig(BaseModel):
+    """
+    Model that defines the structure for connection configurations.
+    """
+
+    connection: dict[str, dict] = Field(default_factory=dict)

nodescraper/models/datamodel.py

@@ -0,0 +1,171 @@
+###############################################################################
+#
+# 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 io
+import json
+import os
+import tarfile
+from typing import TypeVar, Union
+
+from pydantic import BaseModel, Field, field_validator
+
+from nodescraper.utils import get_unique_filename
+
+TDataModel = TypeVar("TDataModel", bound="DataModel")
+
+
+class FileModel(BaseModel):
+    file_contents: bytes = Field(exclude=True)
+    file_name: str
+
+    @field_validator("file_contents", mode="before")
+    @classmethod
+    def file_contents_conformer(cls, value: Union[io.BytesIO, str, bytes]) -> bytes:
+        if isinstance(value, io.BytesIO):
+            return value.getvalue()
+        if isinstance(value, str):
+            return value.encode("utf-8")
+        return value
+
+    def log_model(self, log_path: str) -> None:
+        """Log data model to a file
+
+        Args:
+            log_path (str): log path
+        """
+        log_name = os.path.join(log_path, self.file_name)
+        with open(log_name, "wb") as log_file:
+            log_file.write(self.file_contents)
+
+    def file_contents_str(self) -> None:
+        return self.file_contents.decode("utf-8")
+
+
+class DataModel(BaseModel):
+    """Base class for data model, used to define structure of data collected from the system"""
+
+    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,
+            get_unique_filename(log_path, f"{self.__class__.__name__.lower()}.json"),
+        )
+
+        exlude_fields = set()
+        for key in self.model_fields:
+            data = getattr(self, key)
+            if isinstance(data, FileModel):
+                data.log_model(log_path)
+                exlude_fields.add(key)
+
+        with open(log_name, "w", encoding="utf-8") as log_file:
+            log_file.write(self.model_dump_json(indent=2, exclude=exlude_fields))
+
+    def merge_data(self, input_data: "DataModel") -> None:
+        """Merge data into current data"""
+        pass
+
+    @classmethod
+    def import_model(cls: type[TDataModel], model_input: Union[dict, str]) -> TDataModel:
+        """import a data model
+        if the input is a string attempt to read data from file using the string as a file name
+        if input is a dict, pass key value pairs directly to init function
+
+
+        Args:
+            cls (type[DataModel]): Data model class
+            model_input (Union[dict, str]): model data input
+
+        Raises:
+            ValueError: if model_input has an invalid type
+
+        Returns:
+            DataModel: instance of the data model
+        """
+
+        if isinstance(model_input, dict):
+            return cls(**model_input)
+
+        if isinstance(model_input, str):
+            # Build from tarfile if supported
+            if tarfile.is_tarfile(model_input):
+                return cls.build_from_tar(model_input)
+            # Build from folder if supported
+            if os.path.isdir(model_input):
+                return cls.build_from_folder(model_input)
+
+            # Build from json file
+            with open(model_input, "r", encoding="utf-8") as input_file:
+                data = json.load(input_file)
+
+            return cls(**data)
+
+        raise ValueError("Invalid input for model data")
+
+    @classmethod
+    def build_from_tar(cls: type[TDataModel], tar_path: str) -> TDataModel:
+        """Placeholder for building data model from tarfile.
+
+        Intended for use with models that contains multiple FileModel attributes, and when collected they
+        are in a tarfile. This is left blank if the model requires this then this function should be implemented.
+
+        Parameters
+        ----------
+        cls : type[DataModelGeneric@build_from_tar]
+            A DataModel class
+        tar_path : str
+            A path to a folder containing the data in format .tar.xz
+
+        Returns
+        -------
+        DataModelGeneric@build_from_tar
+            A datamodel object of type cls
+        """
+        raise NotImplementedError("Model does not support construction from tar")
+
+    @classmethod
+    def build_from_folder(cls: type[TDataModel], folder_path: str) -> TDataModel:
+        """Placeholder for building data model from folder.
+
+        Intended for use with models that contains multiple FileModel attributes. This is left blank
+        if that model requires this then this function should be implemented.
+
+        Parameters
+        ----------
+        cls : type[DataModelGeneric@build_from_folder]
+            A DataModel class
+        folder_path : str
+            A path to a folder containing the data in format .tar.xz
+
+        Returns
+        -------
+        DataModelGeneric@build_from_folder
+            A datamodel object of type cls
+        """
+        raise NotImplementedError("Model does not support construction from folder")

nodescraper/models/datapluginresult.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 Optional
+
+from pydantic import BaseModel
+
+from .datamodel import DataModel
+from .taskresult import TaskResult
+
+
+class DataPluginResult(BaseModel):
+    """Object for result of data plugin"""
+
+    system_data: Optional[DataModel] = None
+    collection_result: Optional[TaskResult] = None
+    analysis_result: Optional[TaskResult] = None