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

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

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 4.14.0
+Version: 5.0.0
 Summary: Splight Command Line Interface
 Author: Splight Dev
 Author-email: dev@splight-ae.com
-Requires-Python: >=3.8.1,<4
+Requires-Python: >=3.9,<4
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -15,13 +15,14 @@ Requires-Dist: case-converter (==1.1.0)
 Requires-Dist: click (==8.0.4)
 Requires-Dist: click-default-group (==1.2.2)
 Requires-Dist: colorama (==0.4.4)
+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: rich (==13.0.1)
 Requires-Dist: setuptools (==60.9.3)
-Requires-Dist: splight-lib (>=5.8.0)
+Requires-Dist: splight-lib (==5.9.0)
 Requires-Dist: toposort (>=1.10,<2.0)
 Requires-Dist: typer (==0.9.0)
 Description-Content-Type: text/markdown

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

@@ -1,17 +1,17 @@
 [tool.poetry]
 name = "splight-cli"
-version = "4.14.0"
+version = "5.0.0"
 description = "Splight Command Line Interface"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = ">=3.8.1,<4"
+python = ">=3.9,<4"
 case-converter = "1.1.0"
 click = "8.0.4"
 click-default-group = "1.2.2"
 setuptools = "60.9.3"
-splight-lib = ">=5.8.0"
+splight-lib = "5.9.0"
 py7zr = "0.20.8"
 typer = "0.9.0"
 colorama = "0.4.4"
@@ -21,6 +21,7 @@ rich = "13.0.1"
 pathspec = "0.11.1"
 packaging = "23.0"
 toposort = "^1.10"
+docker = "7.1.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "23.3.0"

splight_cli-5.0.0/splight_cli/hub/component/component_builder.py

@@ -0,0 +1,109 @@
+import gzip
+import os
+import re
+import shutil
+import sys
+
+import docker
+
+from splight_cli.hub.component.exceptions import BuildError
+
+
+class ComponentBuilder:
+    _RESOURCES_PATH = "resources"
+    _RESOURCES = [
+        "Dockerfile",
+        "installer.py",
+    ]
+
+    def __init__(self, component_spec: dict, component_path: str):
+        self._base_path = os.path.dirname(__file__)
+        self._component_name = component_spec["name"]
+        self._component_version = component_spec["version"]
+        self._spl_pkg = (
+            "splight-lib"
+            if component_spec["splight_lib_version"]
+            else "splight-cli"
+        )
+        self._spl_pkg_version = (
+            component_spec["splight_lib_version"]
+            if component_spec["splight_lib_version"]
+            else component_spec["splight_cli_version"]
+        )
+        self._component_path = component_path
+        self._docker_client = docker.from_env()
+
+    def build(self) -> str:
+        original_path = os.getcwd()
+        self._copy_resources()
+        os.chdir(self._component_path)
+        image_file = self._build_component()
+        self._clean_up()
+        os.chdir(original_path)
+        return image_file
+
+    def _build_component(self) -> str:
+        full_name = f"{self._component_name}-{self._component_version}"
+        tag = f"component:{full_name}"
+        streamer = self._build_component_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_component_image(self, tag: str):
+        client = self._docker_client.api
+        streamer = client.build(
+            path=".",
+            tag=tag,
+            dockerfile="Dockerfile",
+            rm=True,
+            pull=True,
+            quiet=False,
+            buildargs={
+                "COMPONENT_NAME": self._component_name,
+                "COMPONENT_VERSION": self._component_version,
+                "SPL_PACKAGE": self._spl_pkg,
+                "SPL_PACKAGE_VERSION": self._spl_pkg_version,
+            },
+            decode=True,
+        )
+        return streamer
+
+    def _copy_resources(self):
+        for resource in self._RESOURCES:
+            resource_path = os.path.join(
+                self._base_path, self._RESOURCES_PATH, resource
+            )
+            shutil.copy(resource_path, self._component_path)
+
+    def _clean_up(self):
+        for resource in self._RESOURCES:
+            os.remove(resource)
+
+    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-4.14.0 → splight_cli-5.0.0}/splight_cli/hub/component/exceptions.py

@@ -45,3 +45,7 @@ class HubComponentNotFound(Exception):
 
     def __str__(self) -> str:
         return self._msg
+
+
+class BuildError(Exception):
+    ...

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

@@ -10,14 +10,13 @@ from rich.console import Console
 from rich.table import Table
 from splight_lib.models import HubComponent
 
-from splight_cli.component.component import ComponentManager
 from splight_cli.constants import (
     COMPRESSION_TYPE,
-    PYTHON_TESTS_FILE,
     SPEC_FILE,
     SPLIGHT_IGNORE,
     success_style,
 )
+from splight_cli.hub.component.component_builder import ComponentBuilder
 from splight_cli.hub.component.exceptions import (
     ComponentAlreadyExists,
     ComponentDirectoryAlreadyExists,
@@ -40,7 +39,7 @@ class HubComponentManager:
 
         # Validate spec fields before pushing the model
         try:
-            HubComponent.model_validate(spec)
+            component = HubComponent.model_validate(spec)
         except ValidationError as exc:
             raise SpecValidationError(exc)
 
@@ -50,15 +49,11 @@ class HubComponentManager:
         if not force and self._exists_in_hub(name, version):
             raise ComponentAlreadyExists(name, version)
 
-        if os.path.exists(os.path.join(path, PYTHON_TESTS_FILE)):
-            # run test before push to hub. To run test, ctx isn't needed
-            console.print(
-                "Testing component before push to hub...", style=success_style
-            )
-            ComponentManager().test(path)
+        builder = ComponentBuilder(spec, path)
+        image_file = builder.build()
 
         with Loader("Pushing Component to Splight Hub"):
-            component = HubComponent.upload(path)
+            component = HubComponent.upload(path, image_file)
 
         console.print(
             f"Component {component.id} pushed succesfully", style=success_style

splight_cli-5.0.0/splight_cli/hub/component/resources/Dockerfile

@@ -0,0 +1,21 @@
+# syntax=docker/dockerfile:1
+FROM --platform=linux/amd64 python:3.11.7-slim
+
+WORKDIR /whl
+RUN pip install --upgrade splight-runner
+
+ARG SPL_PACKAGE
+ARG SPL_PACKAGE_VERSION
+RUN pip install ${SPL_PACKAGE}==${SPL_PACKAGE_VERSION}
+
+ARG COMPONENT_NAME
+ARG COMPONENT_VERSION
+
+WORKDIR /app
+COPY . .
+RUN python installer.py --name ${COMPONENT_NAME} --version ${COMPONENT_VERSION}
+
+# Cleaning up files
+RUN rm installer.py Dockerfile
+
+ENTRYPOINT ["splight-runner", "run-component"]

splight_cli-5.0.0/splight_cli/hub/component/resources/installer.py

@@ -0,0 +1,80 @@
+import argparse
+import os
+import subprocess
+from typing import List
+
+
+class HubComponentInstaller:
+    _INIT_FILE = "Initialization"
+
+    def __init__(self, name: str, version: str) -> None:
+        self._name = name
+        self._version = version
+        self._component_path = os.getenv("APP_DIR", "/app")
+
+    def _handle_run(self, command: List[str]) -> None:
+        command: str = " ".join(command)
+        try:
+            subprocess.run(
+                command, check=True, cwd=self._component_path, shell=True
+            )
+        except subprocess.CalledProcessError as e:
+            raise Exception(
+                f"Failed to run command: {e.cmd}. Output: {e.output}"
+            )
+
+    def _validate(self):
+        # VALIDATE INIT FILE EXISTS
+        if not os.path.isfile(
+            os.path.join(self._component_path, self._INIT_FILE)
+        ):
+            raise Exception(
+                f"{self._INIT_FILE} file is missing in {self._component_path}"
+            )
+
+    def _load_commands(self) -> List[List[str]]:
+        file = os.path.join(self._component_path, self._INIT_FILE)
+        lines: List[List[str]] = []
+        lines.append(["RUN", "pip", "cache", "purge"])
+        with open(file) as f:
+            for line in f:
+                line = line.strip()
+                if line.startswith("#") or line == "":
+                    continue
+                lines.append(line.split(" "))
+        return lines
+
+    def install(self):
+        self._validate()
+        commands = self._load_commands()
+        for command in commands:
+            prefix: str = command[0].lower()
+            handler = getattr(self, f"_handle_{prefix}", None)
+            if not handler:
+                raise Exception(f"Invalid command: {prefix}")
+            handler(command[1:])
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Install Hub Component")
+    parser.add_argument(
+        "-n",
+        "--name",
+        type=str,
+        nargs=1,
+        help="Hub Component Name",
+        required=True,
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        type=str,
+        nargs=1,
+        help="Hub Component Version",
+        required=True,
+    )
+
+    args = parser.parse_args()
+
+    manager = HubComponentInstaller(name=args.name[0], version=args.version[0])
+    manager.install()

{splight_cli-4.14.0 → splight_cli-5.0.0}/splight_cli/hub/solution/__init__.py

@@ -31,9 +31,6 @@ def push(
         manager = HubSolutionManager()
         manager.push(path, force=force)
     except Exception as exc:
-        import traceback
-        import sys
-        traceback.print_exc(file=sys.stdout)
         console.print(f"Error pushing solution: {exc}", style=error_style)
         raise typer.Exit(code=1)
 

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

@@ -9,11 +9,7 @@ from rich.console import Console
 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.constants import COMPRESSION_TYPE, SPEC_FILE, success_style
 from splight_cli.hub.component.exceptions import (
     SpecFormatError,
     SpecValidationError,
@@ -112,4 +108,8 @@ class HubSolutionManager:
         return solutions[0]
 
     def _exists_in_hub(self, name: str, version: str) -> bool:
-        return bool(self._get_hub_solution(name, version))
+        try:
+            self._get_hub_solution(name, version)
+            return True
+        except HubSolutionNotFound:
+            return False