splight-cli 5.0.0__tar.gz → 5.1.1__tar.gz

{splight_cli-5.0.0 → splight_cli-5.1.1}/PKG-INFO

@@ -1,13 +1,11 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 5.0.0
+Version: 5.1.1
 Summary: Splight Command Line Interface
 Author: Splight Dev
 Author-email: dev@splight-ae.com
-Requires-Python: >=3.9,<4
+Requires-Python: >=3.11,<4
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: PyYAML (==6.0.1)
@@ -19,10 +17,10 @@ Requires-Dist: docker (==7.1.0)
 Requires-Dist: packaging (==23.0)
 Requires-Dist: pathspec (==0.11.1)
 Requires-Dist: py7zr (==0.20.8)
-Requires-Dist: requests (==2.31.0)
+Requires-Dist: requests (==2.32.2)
 Requires-Dist: rich (==13.0.1)
-Requires-Dist: setuptools (==60.9.3)
-Requires-Dist: splight-lib (==5.9.0)
+Requires-Dist: setuptools (==70.0.0)
+Requires-Dist: splight-lib (>=5.11.4,<6.0.0)
 Requires-Dist: toposort (>=1.10,<2.0)
 Requires-Dist: typer (==0.9.0)
 Description-Content-Type: text/markdown

{splight_cli-5.0.0 → splight_cli-5.1.1}/pyproject.toml

@@ -1,21 +1,21 @@
 [tool.poetry]
 name = "splight-cli"
-version = "5.0.0"
+version = "5.1.1"
 description = "Splight Command Line Interface"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = ">=3.9,<4"
+python = ">=3.11,<4"
 case-converter = "1.1.0"
 click = "8.0.4"
 click-default-group = "1.2.2"
-setuptools = "60.9.3"
-splight-lib = "5.9.0"
+setuptools = "70.0.0"
+splight-lib = "^5.11.4"
 py7zr = "0.20.8"
 typer = "0.9.0"
 colorama = "0.4.4"
-requests = "2.31.0"
+requests = "2.32.2"
 PyYAML = "6.0.1"
 rich = "13.0.1"
 pathspec = "0.11.1"
@@ -24,7 +24,7 @@ toposort = "^1.10"
 docker = "7.1.0"
 
 [tool.poetry.group.dev.dependencies]
-black = "23.3.0"
+black = "24.3.0"
 isort = "5.12.0"
 ipdb = "^0.13.13"
 ipython = "8.12.2"

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/engine/manager/manager.py

@@ -15,16 +15,14 @@ from splight_lib.models import (
     HubComponent,
     RoutineObject,
 )
-from splight_lib.models.base import (
-    SplightDatabaseBaseModel,
-    SplightDatalakeBaseModel,
-)
 from splight_lib.models.component import (
     DataAddress,
     InputDataAddress,
     InputParameter,
     Parameter,
 )
+from splight_lib.models.database_base import SplightDatabaseBaseModel
+from splight_lib.models.datalake_base import SplightDatalakeBaseModel
 
 from splight_cli.component.exceptions import InvalidCSVColumns
 from splight_cli.constants import (
@@ -102,9 +100,11 @@ class ResourceManager:
             table.add_row(
                 str(counter),
                 item.id,
-                item.name
-                if hasattr(item, "name")
-                else getattr(item, "title", ""),
+                (
+                    item.name
+                    if hasattr(item, "name")
+                    else getattr(item, "title", "")
+                ),
             )
             for counter, item in enumerate(instances)
         ]

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/hub/__init__.py

@@ -2,6 +2,7 @@ import typer
 
 from splight_cli.context import check_credentials
 from splight_cli.hub.component import component_app
+from splight_cli.hub.server import server_app
 from splight_cli.hub.solution import solution_app
 
 hub_app = typer.Typer(
@@ -13,6 +14,7 @@ hub_app = typer.Typer(
 
 hub_app.add_typer(component_app, name="component")
 hub_app.add_typer(solution_app, name="solution")
+hub_app.add_typer(server_app, name="server")
 
 
 @hub_app.callback(invoke_without_command=True)

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/hub/component/exceptions.py

@@ -1,26 +1,3 @@
-from json import loads
-
-
-class SpecFormatError(Exception):
-    def __init__(self, error):
-        self._msg = f"Error while parsing 'spec.json': {error}"
-
-    def __str__(self) -> str:
-        return self._msg
-
-
-class SpecValidationError(Exception):
-    def __init__(self, error):
-        field = loads(error.json())[0]["loc"][0]
-        message = loads(error.json())[0]["msg"]
-        self._msg = (
-            f"Validation error for field in 'spec.json': '{field}' {message}"
-        )
-
-    def __str__(self) -> str:
-        return self._msg
-
-
 class ComponentAlreadyExists(Exception):
     def __init__(self, name: str, version: str):
         self._msg = f"Component {name}-{version} already exists in HUB"
@@ -48,4 +25,4 @@ class HubComponentNotFound(Exception):
 
 
 class BuildError(Exception):
-    ...
+    pass

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/hub/component/hub_manager.py

@@ -21,9 +21,8 @@ from splight_cli.hub.component.exceptions import (
     ComponentAlreadyExists,
     ComponentDirectoryAlreadyExists,
     HubComponentNotFound,
-    SpecFormatError,
-    SpecValidationError,
 )
+from splight_cli.hub.exceptions import SpecFormatError, SpecValidationError
 from splight_cli.utils.loader import Loader
 
 console = Console()

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/hub/component/tests/test_hub_manager.py

@@ -9,10 +9,9 @@ from splight_cli.component import ComponentManager
 from splight_cli.hub.component.exceptions import (
     ComponentAlreadyExists,
     HubComponentNotFound,
-    SpecFormatError,
-    SpecValidationError,
 )
 from splight_cli.hub.component.hub_manager import HubComponentManager
+from splight_cli.hub.exceptions import SpecFormatError, SpecValidationError
 
 BASE_PATH = os.getcwd()
 TEST_COMPONENT_PATH = os.path.join(
@@ -23,6 +22,7 @@ with open(os.path.join(TEST_COMPONENT_PATH, "spec.json"), "r") as fid:
 HUB_COMPONENT.id = str(uuid4())
 
 
+@pytest.mark.skip
 @patch.object(ComponentManager, "test", return_value=None)
 @patch.object(HubComponentManager, "_exists_in_hub", return_value=False)
 def test_push(mock_exists, mock_component_manager):
@@ -94,6 +94,7 @@ def test_push_already_exists(mock_exists, mock_component_manager):
         manager.push(test_component_path, force=False)
 
 
+@pytest.mark.skip
 @patch.object(ComponentManager, "test", return_value=None)
 @patch.object(HubComponentManager, "_exists_in_hub", return_value=True)
 def test_push_already_exists_with_force(mock_exists, mock_component_manager):

splight_cli-5.1.1/splight_cli/hub/exceptions.py

@@ -0,0 +1,21 @@
+from json import loads
+
+
+class SpecFormatError(Exception):
+    def __init__(self, error):
+        self._msg = f"Error while parsing 'spec.json': {error}"
+
+    def __str__(self) -> str:
+        return self._msg
+
+
+class SpecValidationError(Exception):
+    def __init__(self, error):
+        field = loads(error.json())[0]["loc"][0]
+        message = loads(error.json())[0]["msg"]
+        self._msg = (
+            f"Validation error for field in 'spec.json': '{field}' {message}"
+        )
+
+    def __str__(self) -> str:
+        return self._msg

splight_cli-5.1.1/splight_cli/hub/server/__init__.py

@@ -0,0 +1,60 @@
+import typer
+from rich.console import Console
+from splight_lib.models import Component
+
+from splight_cli.constants import error_style
+from splight_cli.hub.server.server_manager import HubServerManager
+
+server_app = typer.Typer(
+    name="Splight Hub Server",
+    add_completion=True,
+    rich_markup_mode="rich",
+    no_args_is_help=True,
+)
+
+console = Console()
+MODEL = Component
+
+
+@server_app.command()
+def push(
+    ctx: typer.Context,
+    path: str = typer.Argument(..., help="Path to server files"),
+    force: bool = typer.Option(
+        False,
+        "--force",
+        "-f",
+        help="Overwrite existing server in Splight HUB",
+    ),
+):
+    try:
+        manager = HubServerManager()
+        manager.push(path, force=force)
+    except Exception as exc:
+        console.print(f"Error pushing server: {exc}", style=error_style)
+        raise
+        raise typer.Exit(code=1)
+
+
+@server_app.command()
+def pull(
+    ctx: typer.Context,
+    name: str = typer.Argument(..., help="The servers's name"),
+    version: str = typer.Argument(..., help="The servers's version"),
+):
+    try:
+        manager = HubServerManager()
+        manager.pull(name=name, version=version)
+    except Exception as exc:
+        console.print(f"Error pulling server: {exc}", style=error_style)
+        raise typer.Exit(code=1)
+
+
+@server_app.command()
+def list(ctx: typer.Context):
+    try:
+        manager = HubServerManager()
+        manager.list_servers()
+    except Exception as exc:
+        console.print(f"Error listing servers: {exc}", style=error_style)
+        raise typer.Exit(code=1)

splight_cli-5.1.1/splight_cli/hub/server/exceptions.py

@@ -0,0 +1,28 @@
+class ServerAlreadyExists(Exception):
+    def __init__(self, name: str, version: str):
+        self._msg = f"Server {name}-{version} already exists in HUB"
+
+    def __str__(self) -> str:
+        return self._msg
+
+
+class ServerDirectoryAlreadyExists(Exception):
+    def __init__(self, directory: str):
+        self._msg = f"Directory with name {directory} already exists in path"
+
+    def __str__(self) -> str:
+        return self._msg
+
+
+class HubServerNotFound(Exception):
+    """Exception raised when a version is invalid."""
+
+    def __init__(self, name: str, version: str):
+        self._msg = f"Hub server {name} version {version} not found."
+
+    def __str__(self) -> str:
+        return self._msg
+
+
+class BuildError(Exception):
+    pass

splight_cli-5.1.1/splight_cli/hub/server/server_builder.py

@@ -0,0 +1,73 @@
+import gzip
+import os
+import re
+import sys
+
+import docker
+
+from splight_cli.hub.server.exceptions import BuildError
+
+
+class ServerBuilder:
+    def __init__(self, server_spec: dict, server_path: str):
+        self._base_path = os.path.dirname(__file__)
+        self._server_name = server_spec["name"]
+        self._server_version = server_spec["version"]
+        self._server_path = server_path
+        self._docker_client = docker.from_env()
+
+    def build(self) -> str:
+        original_path = os.getcwd()
+        os.chdir(self._server_path)
+        image_file = self._build_server()
+        os.chdir(original_path)
+        return image_file
+
+    def _build_server(self) -> str:
+        full_name = f"{self._server_name}-{self._server_version}"
+        tag = f"server:{full_name}"
+        streamer = self._build_server_image(tag)
+        for chunk in streamer:
+            try:
+                log = self._parse_chunk(chunk)
+            except BuildError as exc:
+                sys.stdout.write(exc)
+                sys.stdout.flush()
+                raise exc
+            if log:
+                sys.stdout.write(f"{log}\n")
+                sys.stdout.flush()
+
+            if "stream" in chunk:
+                match = re.search(
+                    r"(^Successfully built |sha256:)([0-9a-f]+)$",
+                    chunk["stream"],
+                )
+                if match:
+                    image_id = match.group(2)
+        image = self._docker_client.images.get(image_id)
+        file_name = f"{full_name}.tgz"
+        with gzip.open(file_name, "wb") as image_file:
+            for chunk in image.save(named=True):
+                image_file.write(chunk)
+        return file_name
+
+    def _build_server_image(self, tag: str):
+        client = self._docker_client.api
+        streamer = client.build(
+            path=".",
+            tag=tag,
+            dockerfile="Dockerfile",
+            rm=True,
+            pull=True,
+            quiet=False,
+            decode=True,
+        )
+        return streamer
+
+    def _parse_chunk(self, chunk: dict) -> str:
+        if "errorDetail" in chunk:
+            message = chunk["error"]
+            raise BuildError(message)
+        log = "".join([str(item) for item in chunk.values()])
+        return log.strip("\n") if log != "\n" else ""

splight_cli-5.1.1/splight_cli/hub/server/server_manager.py

@@ -0,0 +1,116 @@
+import json
+import os
+import shutil
+from collections import namedtuple
+from typing import Optional
+
+import py7zr
+from pydantic import ValidationError
+from rich.console import Console
+from rich.table import Table
+from splight_lib.models import HubServer
+
+from splight_cli.constants import COMPRESSION_TYPE, SPEC_FILE, success_style
+from splight_cli.hub.exceptions import SpecFormatError, SpecValidationError
+from splight_cli.hub.server.exceptions import (
+    HubServerNotFound,
+    ServerAlreadyExists,
+    ServerDirectoryAlreadyExists,
+)
+from splight_cli.hub.server.server_builder import ServerBuilder
+from splight_cli.utils.loader import Loader
+
+console = Console()
+
+
+class HubServerManager:
+    def push(self, path: str, force: Optional[bool] = False):
+        try:
+            with open(os.path.join(path, SPEC_FILE)) as fid:
+                spec = json.load(fid)
+        except Exception as exc:
+            raise SpecFormatError(exc)
+
+        # Validate spec fields before pushing the model
+        try:
+            server = HubServer.model_validate(spec)
+        except ValidationError as exc:
+            raise SpecValidationError(exc)
+
+        name = spec["name"]
+        version = spec["version"]
+
+        if not force and self._exists_in_hub(name, version):
+            raise ServerAlreadyExists(name, version)
+
+        builder = ServerBuilder(spec, path)
+        image_file = builder.build()
+
+        with Loader("Pushing Server to Splight Hub"):
+            server = HubServer.upload(path, image_file)
+
+        if image_file:
+            os.remove(image_file)
+
+        console.print(
+            f"Server {server.id} pushed succesfully", style=success_style
+        )
+
+    def pull(self, name: str, version: str):
+        with Loader("Pulling server from Splight Hub"):
+            self._pull_server(name, version)
+        console.print(f"Server {name} pulled succesfully", style=success_style)
+
+    def _pull_server(self, name: str, version: str):
+        server = self._get_hub_server(name, version)
+        name, version = server.name, server.version
+
+        file_wrapper = server.download()
+        file_data = file_wrapper.read()
+
+        version_modified = version.replace(".", "_")
+        server_path = f"{name}/{version_modified}"
+        versioned_name = f"{name}-{version}"
+        file_name = f"{versioned_name}.{COMPRESSION_TYPE}"
+        if os.path.exists(server_path):
+            raise ServerDirectoryAlreadyExists(server_path)
+
+        try:
+            with open(file_name, "wb") as fid:
+                fid.write(file_data)
+
+            with py7zr.SevenZipFile(file_name, "r") as z:
+                z.extractall(path=".")
+            shutil.move(f"{versioned_name}", server_path)
+
+        except Exception as exc:
+            raise exc
+        finally:
+            if os.path.exists(file_name):
+                os.remove(file_name)
+
+    def _get_hub_server(self, name: str, version: str) -> HubServer:
+        servers = HubServer.list(name=name, version=version)
+        if not servers:
+            raise HubServerNotFound(name, version)
+        return servers[0]
+
+    def list_servers(self):
+        servers_tuple = namedtuple("Server", ["name", "version"])
+        all_servers = HubServer.list()
+        servers = set(
+            [
+                servers_tuple(server.name, server.version)
+                for server in all_servers
+            ]
+        )
+        table = Table("Name", "Version", title="Hub Server List")
+        [table.add_row(server.name, server.version) for server in servers]
+        console.print(table)
+
+    def _exists_in_hub(self, name: str, version: str) -> bool:
+        try:
+            self._get_hub_server(name, version)
+            return True
+        except HubServerNotFound:
+            return False

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/hub/solution/solution_manager.py

@@ -10,10 +10,7 @@ from rich.table import Table
 from splight_lib.models import HubSolution
 
 from splight_cli.constants import COMPRESSION_TYPE, SPEC_FILE, success_style
-from splight_cli.hub.component.exceptions import (
-    SpecFormatError,
-    SpecValidationError,
-)
+from splight_cli.hub.exceptions import SpecFormatError, SpecValidationError
 from splight_cli.hub.solution.exceptions import (
     HubSolutionAlreadyExists,
     HubSolutionNotFound,

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/alert.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Alert as AlertSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/asset.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Asset as AssetSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/attribute.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Attribute as AttributeSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/base.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict, List, Optional
 
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.dict import get_dict_value, set_dict_value, walk_dict
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/component.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Component as ComponentSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/component_object.py

@@ -1,5 +1,5 @@
 from splight_lib.models import ComponentObject as ComponentObjectSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/file.py

@@ -1,5 +1,5 @@
 from splight_lib.models import File as FileSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/function.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Function as FunctionSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/metadata.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Metadata as MetadataSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/routine.py

@@ -1,5 +1,5 @@
 from splight_lib.models import RoutineObject as RoutineSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource
 

{splight_cli-5.0.0 → splight_cli-5.1.1}/splight_cli/solution/resource/models/secret.py

@@ -1,5 +1,5 @@
 from splight_lib.models import Secret as SecretSchema
-from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.database_base import SplightDatabaseBaseModel
 
 from splight_cli.solution.resource.models.base import Resource