Merge branch 'development' into alex_rocm_fix

Author: alexandraBara

dev-setup.sh

@@ -1,7 +1,7 @@
 # Create venv if not already present
 if [ ! -d "venv" ]; then
-    python3 -m pip install virtualenv
-    python3 -m virtualenv venv
+    python3 -m pip install venv
+    python3 -m venv venv
 fi
 
 # Activate the desired venv

nodescraper/base/inbandcollectortask.py

@@ -27,7 +27,7 @@
 from typing import Generic, Optional
 
 from nodescraper.connection.inband import InBandConnection
-from nodescraper.connection.inband.inband import CommandArtifact, FileArtifact
+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
@@ -99,7 +99,7 @@ def _run_sut_cmd(
 
     def _read_sut_file(
         self, filename: str, encoding="utf-8", strip: bool = True, log_artifact=True
-    ) -> FileArtifact:
+    ) -> BaseFileArtifact:
         """
         Read a file from the SUT and return its content.
 
@@ -110,7 +110,7 @@ def _read_sut_file(
             log_artifact (bool, optional): whether we should log the contents of the file. Defaults to True.
 
         Returns:
-            FileArtifact: The content of the file read from the SUT, which includes the file name and content
+            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:

nodescraper/connection/inband/__init__.py

@@ -23,7 +23,13 @@
 # SOFTWARE.
 #
 ###############################################################################
-from .inband import CommandArtifact, FileArtifact, InBandConnection
+from .inband import (
+    BaseFileArtifact,
+    BinaryFileArtifact,
+    CommandArtifact,
+    InBandConnection,
+    TextFileArtifact,
+)
 from .inbandlocal import LocalShell
 from .inbandmanager import InBandConnectionManager
 from .sshparams import SSHConnectionParams
@@ -33,6 +39,8 @@
     "LocalShell",
     "InBandConnectionManager",
     "InBandConnection",
-    "FileArtifact",
+    "BaseFileArtifact",
+    "TextFileArtifact",
+    "BinaryFileArtifact",
     "CommandArtifact",
 ]

nodescraper/connection/inband/inband.py

@@ -24,6 +24,8 @@
 #
 ###############################################################################
 import abc
+import os
+from typing import Optional
 
 from pydantic import BaseModel
 
@@ -37,12 +39,103 @@ class CommandArtifact(BaseModel):
     exit_code: int
 
 
-class FileArtifact(BaseModel):
-    """Artifact to contains contents of file read into memory"""
+class BaseFileArtifact(BaseModel, abc.ABC):
+    """Base class for files"""
 
     filename: str
+
+    @abc.abstractmethod
+    def log_model(self, log_path: str) -> None:
+        """Write file to path
+
+        Args:
+            log_path (str): Path for file
+        """
+        pass
+
+    @abc.abstractmethod
+    def contents_str(self) -> str:
+        pass
+
+    @classmethod
+    def from_bytes(
+        cls,
+        filename: str,
+        raw_contents: bytes,
+        encoding: Optional[str] = "utf-8",
+        strip: bool = True,
+    ) -> "BaseFileArtifact":
+        """factory method
+
+        Args:
+            filename (str): name of file to be read
+            raw_contents (bytes): Raw file content
+            encoding (Optional[str], optional): Optional encoding. Defaults to "utf-8".
+            strip (bool, optional): Remove padding. Defaults to True.
+
+        Returns:
+            BaseFileArtifact: _Returns instance of Artifact file
+        """
+        if encoding is None:
+            return BinaryFileArtifact(filename=filename, contents=raw_contents)
+
+        try:
+            text = raw_contents.decode(encoding)
+            return TextFileArtifact(filename=filename, contents=text.strip() if strip else text)
+        except UnicodeDecodeError:
+            return BinaryFileArtifact(filename=filename, contents=raw_contents)
+
+
+class TextFileArtifact(BaseFileArtifact):
+    """Class for text file artifacts"""
+
     contents: str
 
+    def log_model(self, log_path: str) -> None:
+        """Write file to disk
+
+        Args:
+            log_path (str): Path for file
+        """
+        path = os.path.join(log_path, self.filename)
+        with open(path, "w", encoding="utf-8") as f:
+            f.write(self.contents)
+
+    def contents_str(self) -> str:
+        """Get content as str
+
+        Returns:
+            str: Str instance of file content
+        """
+        return self.contents
+
+
+class BinaryFileArtifact(BaseFileArtifact):
+    """Class for binary file artifacts"""
+
+    contents: bytes
+
+    def log_model(self, log_path: str) -> None:
+        """Write file to disk
+
+        Args:
+            log_path (str): Path for file
+        """
+        log_name = os.path.join(log_path, self.filename)
+        with open(log_name, "wb") as f:
+            f.write(self.contents)
+
+    def contents_str(self) -> str:
+        """File content
+
+        Returns:
+            str: Str instance of file content
+        """
+        try:
+            return self.contents.decode("utf-8")
+        except UnicodeDecodeError:
+            return f"<binary data: {len(self.contents)} bytes>"
+
 
 class InBandConnection(abc.ABC):
 
@@ -63,14 +156,16 @@ def run_command(
         """
 
     @abc.abstractmethod
-    def read_file(self, filename: str, encoding: str = "utf-8", strip: bool = True) -> FileArtifact:
-        """Read a file into a FileArtifact
+    def read_file(
+        self, filename: str, encoding: str = "utf-8", strip: bool = True
+    ) -> BaseFileArtifact:
+        """Read a file into a BaseFileArtifact
 
         Args:
             filename (str): filename
             encoding (str, optional): encoding to use when opening file. Defaults to "utf-8".
             strip (bool): automatically strip file contents
 
         Returns:
-            FileArtifact: file artifact
+            BaseFileArtifact: file artifact
         """

nodescraper/connection/inband/inbandlocal.py

@@ -26,7 +26,11 @@
 import os
 import subprocess
 
-from .inband import CommandArtifact, FileArtifact, InBandConnection
+from .inband import (
+    BaseFileArtifact,
+    CommandArtifact,
+    InBandConnection,
+)
 
 
 class LocalShell(InBandConnection):
@@ -64,22 +68,25 @@ def run_command(
             exit_code=res.returncode,
         )
 
-    def read_file(self, filename: str, encoding: str = "utf-8", strip: bool = True) -> FileArtifact:
-        """Read a local file into a FileArtifact
+    def read_file(
+        self, filename: str, encoding: str = "utf-8", strip: bool = True
+    ) -> BaseFileArtifact:
+        """Read a local file into a BaseFileArtifact
 
         Args:
             filename (str): filename
             encoding (str, optional): encoding to use when opening file. Defaults to "utf-8".
             strip (bool): automatically strip file contents
 
         Returns:
-            FileArtifact: file artifact
+            BaseFileArtifact: file artifact
         """
-        contents = ""
-        with open(filename, "r", encoding=encoding) as local_file:
-            contents = local_file.read().strip()
+        with open(filename, "rb") as f:
+            raw_contents = f.read()
 
-        return FileArtifact(
+        return BaseFileArtifact.from_bytes(
             filename=os.path.basename(filename),
-            contents=contents.strip() if strip else contents,
+            raw_contents=raw_contents,
+            encoding=encoding,
+            strip=strip,
         )

nodescraper/connection/inband/inbandremote.py

@@ -34,7 +34,11 @@
     SSHException,
 )
 
-from .inband import CommandArtifact, FileArtifact, InBandConnection
+from .inband import (
+    BaseFileArtifact,
+    CommandArtifact,
+    InBandConnection,
+)
 from .sshparams import SSHConnectionParams
 
 
@@ -94,27 +98,26 @@ def connect_ssh(self):
     def read_file(
         self,
         filename: str,
-        encoding="utf-8",
+        encoding: str | None = "utf-8",
         strip: bool = True,
-    ) -> FileArtifact:
-        """Read a remote file into a file artifact
+    ) -> BaseFileArtifact:
+        """Read a remote file into a BaseFileArtifact.
 
         Args:
-            filename (str): filename
-            encoding (str, optional): remote file encoding. Defaults to "utf-8".
-            strip (bool): automatically strip file contents
+            filename (str): Path to file on remote host
+            encoding (str | None, optional): 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:
-            FileArtifact: file artifact
+            BaseFileArtifact: Object representing file contents
         """
-        contents = ""
-
-        with self.client.open_sftp().open(filename) as remote_file:
-            contents = remote_file.read().decode(encoding=encoding, errors="ignore")
-
-        return FileArtifact(
+        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),
-            contents=contents.strip() if strip else contents,
+            raw_contents=raw_contents,
+            encoding=encoding,
+            strip=strip,
         )
 
     def run_command(

nodescraper/plugins/inband/dmesg/dmesg_analyzer.py

@@ -28,7 +28,7 @@
 from typing import Optional
 
 from nodescraper.base.regexanalyzer import ErrorRegex, RegexAnalyzer
-from nodescraper.connection.inband import FileArtifact
+from nodescraper.connection.inband import TextFileArtifact
 from nodescraper.enums import EventCategory, EventPriority
 from nodescraper.models import Event, TaskResult
 
@@ -386,7 +386,7 @@ def analyze_data(
                 args.analysis_range_end,
             )
             self.result.artifacts.append(
-                FileArtifact(filename="filtered_dmesg.log", contents=dmesg_content)
+                TextFileArtifact(filename="filtered_dmesg.log", contents=dmesg_content)
             )
         else:
             dmesg_content = data.dmesg_content

nodescraper/plugins/inband/nvme/__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 .nvme_plugin import NvmePlugin
+
+__all__ = ["NvmePlugin"]