feat: Add workspace field to httpconfiguration (#64)

Author: santhoshramaraj

nisystemlink/clients/core/_http_configuration.py

@@ -22,6 +22,7 @@ def __init__(
         username: Optional[str] = None,
         password: Optional[str] = None,
         cert_path: Optional[pathlib.Path] = None,
+        workspace: Optional[str] = None,
     ) -> None:
         """Initialize a configuration.
 
@@ -38,6 +39,7 @@ def __init__(
             username: The name of the user to use when authorization is required.
             password: The user's password to use when authorization is required.
             cert_path: Local path to an SSL certificate file.
+            workspace: ID of workspace to use for client operations.
 
         Raises:
             ValueError: if ``server_uri`` is missing scheme or host information.
@@ -69,6 +71,8 @@ def __init__(
 
         self._timeout_ms = self.DEFAULT_TIMEOUT_MILLISECONDS
 
+        self._workspace = workspace
+
     @property
     def timeout_milliseconds(self) -> int:  # noqa: D401
         """The number of milliseconds before a request times out with an error.
@@ -126,3 +130,8 @@ def password(self) -> Optional[str]:  # noqa: D401
     def cert_path(self) -> Optional[pathlib.Path]:
         """Local path to an SSL certificate file."""
         return self._cert_path
+
+    @property
+    def workspace(self) -> Optional[str]:  # noqa: D401
+        """ID of workspace to use for Client operations."""
+        return self._workspace

nisystemlink/clients/core/_http_configuration_manager.py

@@ -7,6 +7,7 @@
 import typing
 from typing import Dict, Optional
 
+import yaml
 from nisystemlink.clients import core
 from nisystemlink.clients.core._internal._http_configuration_file import (
     HttpConfigurationFile,
@@ -26,6 +27,9 @@ class HttpConfigurationManager:
     _HTTP_JUPYTER_CONFIGURATION_ID = "SYSTEMLINK_VIRTUAL_JUPYTER"
     """Virtual ID of SystemLink Server's configuration for Jupyter Notebook execution on SLE."""
 
+    _SALT_GRAINS_WORKSPACE_KEY = "systemlink_workspace"
+    """Key of Workspace ID stored in the salt grains config file."""
+
     _configs = None
     _virtual_configs = None
 
@@ -146,6 +150,8 @@ def _read_configurations(cls) -> Dict[str, core.HttpConfiguration]:
                 "Error while accessing HTTP configurations directory: " + str(e)
             )
 
+        workspace = cls._read_system_workspace()
+
         for json_file in json_files:
             try:
                 config_file = cls._read_configuration_file(json_file)
@@ -167,7 +173,10 @@ def _read_configurations(cls) -> Dict[str, core.HttpConfiguration]:
                     if not cert_path.exists():
                         cert_path = None
                 configurations[config_file.id] = core.HttpConfiguration(
-                    config_file.uri, config_file.api_key, cert_path=cert_path
+                    config_file.uri,
+                    config_file.api_key,
+                    cert_path=cert_path,
+                    workspace=workspace,
                 )
             except PermissionError:
                 pass
@@ -215,6 +224,33 @@ def _http_configurations_directory(cls) -> pathlib.Path:
         """Get the platform-specific path to the HTTP Configurations directory.
 
         Returns:
-            The path of the HTTP Configurations directory.
+            pathlib.Path: The path of the HTTP Configurations directory.
         """
         return PathConstants.application_data_directory / "HttpConfigurations"
+
+    @classmethod
+    def _salt_grains_path(cls) -> pathlib.Path:
+        """Get the SALT grains config file path.
+
+        Returns:
+            pathlib.Path: The path of SALT grains config file
+        """
+        return PathConstants.salt_data_directory / "conf" / "grains"
+
+    @classmethod
+    def _read_system_workspace(cls) -> Optional[str]:
+        """Get the workspace of the connected remote system.
+
+        Reads workspace from `grains` file of SystemLink Client.
+
+        Returns:
+            str: Workspace Id of the remote system.
+        """
+        salt_grain_file_path = cls._salt_grains_path()
+
+        if salt_grain_file_path.exists():
+            with open(salt_grain_file_path, "r", encoding="utf-8") as fp:
+                grain_data: Dict = yaml.safe_load(fp)
+            return grain_data.get(cls._SALT_GRAINS_WORKSPACE_KEY)
+
+        return None

nisystemlink/clients/core/_internal/_path_constants.py

@@ -23,6 +23,8 @@ class PathConstants(metaclass=ClasspropertySupport):
 
     _application_data_directory = None  # type: Optional[pathlib.Path]
 
+    _salt_data_directory = None  # type: Optional[pathlib.Path]
+
     def __init_subclass__(cls) -> None:
         raise TypeError("type 'PathConstants' is not an acceptable base type")
 
@@ -47,29 +49,83 @@ def application_data_directory(self) -> pathlib.Path:  # noqa: D401
                 )
         return typing.cast(pathlib.Path, self._application_data_directory)
 
-    @classmethod
-    def _windows_application_data_directory(cls) -> pathlib.Path:
-        """Get the NI Application Data directory on Windows.
+    @ClasspropertySupport.classproperty
+    def salt_data_directory(self) -> pathlib.Path:  # noqa: D401
+        """Get the platform-specific path to the salt minion Data directory.
 
         Returns:
-            The NI Application Data directory on Windows.
+            The platform-specific path to the salt minion Data directory.
+        """
+        if self._salt_data_directory is None:
+            if os.name == "nt":
+                PathConstants._salt_data_directory = self._windows_salt_data_directory()
+
+        return typing.cast(pathlib.Path, self._salt_data_directory)
+
+    @classmethod
+    def _windows_programdata_directory(cls) -> pathlib.Path:
+        """Get the path of Windows PROGRAMDATA directory.
 
         Raises:
             RuntimeError: if this method is called on a non-Windows system.
             RuntimeError: if the ProgramData folder cannot be found.
+
+        Returns:
+            pathlib.Path: Windows PROGRAMDATA directory path.
         """
         if os.name != "nt":
             raise RuntimeError("This function is for Windows only")
 
+        programdata_dir = None
+
         try:
             from . import _winpaths
 
             programdata_dir = pathlib.Path(
                 _winpaths.get_path(_winpaths.FOLDERID.ProgramData)
             )
         except Exception:
-            programdata_dir = pathlib.Path("C:/ProgramData")
+            env_programdata_dir = os.getenv("PROGRAMDATA")
+
+            if env_programdata_dir:
+                programdata_dir = pathlib.Path(env_programdata_dir)
+
+        if programdata_dir is not None and programdata_dir.exists():
+            return programdata_dir
+
+        # Last fallback option, assume that it is in C:/
+        programdata_dir = pathlib.Path("C:/ProgramData")
+
         if not programdata_dir.exists():
             raise RuntimeError("Cannot find ProgramData folder")
 
+        return programdata_dir
+
+    @classmethod
+    def _windows_application_data_directory(cls) -> pathlib.Path:
+        """Get the NI Application Data directory on Windows.
+
+        Returns:
+            pathlib.Path: The NI Application Data directory on Windows.
+
+        Raises:
+            RuntimeError: if this method is called on a non-Windows system.
+            RuntimeError: if the ProgramData folder cannot be found.
+        """
+        programdata_dir = cls._windows_programdata_directory()
+
         return programdata_dir / cls.COMPANY_NAME / cls.PRODUCT_NAME
+
+    @classmethod
+    def _windows_salt_data_directory(cls) -> pathlib.Path:
+        """Get the salt minion Data directory on Windows.
+
+        Returns:
+            pathlib.Path: The salt minion Data directory on Windows.
+
+        Raises:
+            RuntimeError: if this method is called on a non-Windows system.
+            RuntimeError: if the ProgramData folder cannot be found.
+        """
+        programdata_dir = cls._windows_programdata_directory()
+        return programdata_dir / cls.COMPANY_NAME / "salt"

poetry.lock

@@ -37,6 +37,7 @@ httpx    = "^0.23.0"
 requests = "^2.28.1"
 uplink   = "^0.9.7"
 pydantic = "^1.10.2"
+pyyaml = "^6.0.1"
 
 [tool.poetry.group.dev.dependencies]
 black               = ">=22.10,<25.0"
@@ -49,6 +50,7 @@ flake8-docstrings   = "^1.6.0"
 poethepoet          = "^0.16.4"
 types-requests      = "^2.28.11.4"
 responses           = "^0.22.0"
+types-pyyaml        = "^6.0.12"
 
 [tool.poe.tasks]
 test    = "pytest tests -m \"(not slow) and (not cloud) and (not enterprise)\""