mfd-base-tool 0.1.0__py3-none-any.whl

mfd_base_tool/__init__.py

@@ -0,0 +1,5 @@
+# Copyright (C) 2025 Intel Corporation
+# SPDX-License-Identifier: MIT
+"""Module for tool template."""
+
+from .mfd_base_tool import ToolTemplate

mfd_base_tool/exceptions.py

@@ -0,0 +1,13 @@
+# Copyright (C) 2025 Intel Corporation
+# SPDX-License-Identifier: MIT
+"""Module for exceptions."""
+
+import subprocess
+
+
+class ToolException(subprocess.CalledProcessError):
+    """Handle tool exceptions."""
+
+
+class ToolNotAvailable(ToolException):
+    """Handle tool not available exception."""

mfd_base_tool/mfd_base_tool.py

@@ -0,0 +1,129 @@
+# Copyright (C) 2025 Intel Corporation
+# SPDX-License-Identifier: MIT
+"""Main module."""
+
+import logging
+import typing
+from abc import ABC, abstractmethod
+from pathlib import Path, PurePosixPath, PureWindowsPath
+from typing import Optional, Union, Dict
+from mfd_typing import OSType
+from mfd_common_libs import add_logging_level, log_levels
+
+if typing.TYPE_CHECKING:
+    from mfd_connect import Connection
+
+logger = logging.getLogger(__name__)
+add_logging_level("MODULE_DEBUG", log_levels.MODULE_DEBUG)
+
+
+class ToolTemplate(ABC):
+    """
+    Class for abstraction for Tool.
+
+    eg.
+    >>>class MyTool(ToolTemplate):
+    ...
+    ...tool_executable_name = {OSType.WINDOWS : "samplew64e.exe", OSType.POSIX : "sample64e"}
+    or
+    >>>tool_executable_name = "sample64e"
+    ...    def __init__(self, *args, **kwargs):
+    ...        super().__init__(*args, **kwargs)
+    ...
+    ...    def _get_tool_exec_factory(self) -> str:
+    ...        return self.tool_executable_name
+    ...
+    ...    def check_if_available(self) -> None:
+    ...        if not "if statement for check":
+    ...            raise MyToolNotAvailable()
+    ...
+    ...    def get_version(self) -> str:
+    ...        return "my read tool version"
+    ...
+    ...    def my_tool_method(self):
+    ...        pass
+    """
+
+    tool_executable_name: Union[str, Dict] = None
+
+    def __init__(
+        self, *, connection: "Connection", absolute_path_to_binary_dir: Optional[Union[Path, str]] = None
+    ) -> None:
+        """
+        Initialize tool.
+
+        :param connection: Connection object
+        :param absolute_path_to_binary_dir: path to dir where binary of tool is stored
+                                            if None tool should be added to $PATH
+        """
+        assert self.tool_executable_name is not None, "tool_executable_name must be defined."
+        self._connection = connection
+        self._tool_exec = self._get_tool_exec(absolute_path_to_binary_dir)
+        self.check_if_available()
+
+        logger.log(
+            level=log_levels.MODULE_DEBUG,
+            msg=f"{self.__class__.__name__} tool class uses {self._tool_exec}. Tool version: {self.get_version()}.",
+        )
+
+    @abstractmethod
+    def _get_tool_exec_factory(self) -> str:
+        """
+        Get correct tool name.
+
+        Eg. depended by OSType via tool_executable_name
+        >>> return self.tool_executable_name
+        or
+        >>> return self.tool_executable_name[self._connection.get_os_type()]
+
+        :return: Tool exec name
+        """
+        raise NotImplementedError
+
+    def _get_tool_exec(self, absolute_path_to_binary_dir: Optional[Union[Path, str]]) -> str:
+        """
+        Create path to tool.
+
+        :param absolute_path_to_binary_dir: Path to binary directory
+        :return: Tool executable name
+        """
+
+        def _stringify_path_with_executable() -> str:
+            try:
+                os_type = self._connection.get_os_type()
+            except NotImplementedError as e:
+                raise TypeError("Type of connection not supported.") from e
+
+            if os_type == OSType.POSIX:
+                return str(PurePosixPath(absolute_path_to_binary_dir) / executable_name)
+            else:
+                return str(PureWindowsPath(absolute_path_to_binary_dir) / executable_name)
+
+        executable_name = self._get_tool_exec_factory()
+        if absolute_path_to_binary_dir:
+            return _stringify_path_with_executable()
+        else:
+            return executable_name
+
+    @abstractmethod
+    def check_if_available(self) -> None:
+        """
+        Check if tool is available in system.
+
+        eg.
+        >>> _ = self._connection.execute_command(f"{self._tool_exec} /help", custom_exception = ToolNotAvailable)
+        :raises ToolNotAvailable when tool not available.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get_version(self) -> str:
+        """
+        Get version of tool.
+
+        eg.
+        >>> return self._connection.execute_command(f"{self._tool_exec} /version").stdout
+
+        :return: Version of tool
+        """
+        raise NotImplementedError

mfd_base_tool-0.1.0.dist-info/METADATA

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: mfd-base-tool
+Version: 0.1.0
+Summary: Module that contains abstraction of tool in Modular Framework Design (MFD).
+Project-URL: Homepage, https://github.com/intel/mfd
+Project-URL: Repository, https://github.com/intel/mfd-tool
+Project-URL: Issues, https://github.com/intel/mfd-tool/issues
+Project-URL: Changelog, https://github.com/intel/mfd-tool/blob/main/CHANGELOG.md
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+License-File: AUTHORS.md
+Requires-Dist: mfd-typing<2,>=1.23.0
+Requires-Dist: mfd-common-libs<2,>=1.11.0
+Dynamic: license-file
+
+> [!IMPORTANT]  
+> This project is under development. All source code and features on the main branch are for the purpose of testing or evaluation and not production ready.
+
+# MFD Base Tool
+Module for abstraction of tool (wrappers).
+
+ToolTemplate has got 3 main methods:
+
+* `_get_tool_exec_factory(self) -> str` - responsible to return correct tool execute name according to e.g. OS. Should use `tool_executable_name` structure as store for names.
+* `check_if_available(self) -> None` - responsible for checking, if tool is available and executable in system. Should raise exception if not
+* `get_version(self) -> str` - responsible for getting version of tool.
+
+All methods and `tool_executable_name` variable in class must be implemented in developed tool.
+Arguments in public methods must be forced as named arguments:
+`__init__(self, *, arg1, arg2)` etc.
+
+## Usage
+Example implementation using ToolTemplate:
+
+```python
+from mfd_base_tool import ToolTemplate
+
+
+class MyTool(ToolTemplate):
+    tool_executable_name = "my tool name"
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def _get_tool_exec_factory(self) -> str:
+        return self.tool_executable_name
+
+    def check_if_available(self) -> None:
+        if not "if statement for check":
+            raise MyToolNotAvailable()
+
+    def get_version(self) -> str:
+        return "my read tool version"
+    
+    def my_tool_method(self):
+        pass
+```
+## OS supported:
+* LNX
+* WINDOWS
+* ESXI
+* FREEBSD
+* EFI shell support
+
+## Issue reporting
+
+If you encounter any bugs or have suggestions for improvements, you're welcome to contribute directly or open an issue [here](https://github.com/intel/mfd-base-tool/issues).

mfd_base_tool-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+mfd_base_tool/__init__.py,sha256=xA0rBR4kE0gpkyRR3HtuoBEpjMEDj5TkOsnURByX3tQ,143
+mfd_base_tool/exceptions.py,sha256=_SO0qziZntIZ0aroB2ogiKJo6ePxik28KspVI2X337w,294
+mfd_base_tool/mfd_base_tool.py,sha256=EmVQW5PRQBXZnIWpIARfwqkw-GgkzDetJaRjNaITUxE,4132
+mfd_base_tool-0.1.0.dist-info/licenses/AUTHORS.md,sha256=J4h6eTr4h150r7TOQljn8TLgtQRV1A7CSw_LhYLNC3s,255
+mfd_base_tool-0.1.0.dist-info/licenses/LICENSE.md,sha256=WOf_4_WDB4iXqQS77WHhRCKATy-GRxRwYwgTMDGZQdM,1089
+mfd_base_tool-0.1.0.dist-info/METADATA,sha256=bsKqnm7meSW1EQoSLLWwi7EOKvoSPrn1DYDP7XTRfk0,2335
+mfd_base_tool-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+mfd_base_tool-0.1.0.dist-info/top_level.txt,sha256=BG5lYVNJsR2M6YfFl1jZILEfj40pHAjVptAvaQXb6Gw,19
+mfd_base_tool-0.1.0.dist-info/RECORD,,

mfd_base_tool-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mfd_base_tool-0.1.0.dist-info/licenses/AUTHORS.md

@@ -0,0 +1,7 @@
+# AUTHORS
+
+* Arkadiusz Baczek (arkadiusz.baczek@intel.com)
+* Mateusz Chrominski (mateusz.chrominski@intel.com)
+* Hubert Cymerys (hubert.cymerys@intel.com)
+* Agnieszka Flizikowska (agnieszka.flizikowska@intel.com)
+* Adrian Lasota (adrian.lasota@intel.com)

mfd_base_tool-0.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 Intel Corporation
+
+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.

mfd_base_tool-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+mfd_base_tool