splight-cli 5.1.5__tar.gz → 5.2.0__tar.gz

{splight_cli-5.1.5 → splight_cli-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 5.1.5
+Version: 5.2.0
 Summary: Splight Command Line Interface
 Author: Splight Dev
 Author-email: dev@splight-ae.com
@@ -20,7 +20,7 @@ Requires-Dist: py7zr (==0.20.8)
 Requires-Dist: requests (==2.32.2)
 Requires-Dist: rich (==13.0.1)
 Requires-Dist: setuptools (==70.0.0)
-Requires-Dist: splight-lib (>=5.11.4,<6.0.0)
+Requires-Dist: splight-lib (>=5.12.0,<6.0.0)
 Requires-Dist: toposort (>=1.10,<2.0)
 Requires-Dist: typer (==0.9.0)
 Description-Content-Type: text/markdown

{splight_cli-5.1.5 → splight_cli-5.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-cli"
-version = "5.1.5"
+version = "5.2.0"
 description = "Splight Command Line Interface"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"
@@ -11,7 +11,7 @@ case-converter = "1.1.0"
 click = "8.0.4"
 click-default-group = "1.2.2"
 setuptools = "70.0.0"
-splight-lib = "^5.11.4"
+splight-lib = "^5.12.0"
 py7zr = "0.20.8"
 typer = "0.9.0"
 colorama = "0.4.4"

{splight_cli-5.1.5 → splight_cli-5.2.0}/splight_cli/cli.py

@@ -7,7 +7,7 @@ from splight_cli.component import component_app
 from splight_cli.config import config_app
 from splight_cli.constants import error_style
 from splight_cli.context import Context
-from splight_cli.context.exceptions import MissingConfigurationFile
+from splight_cli.context.workspace import ConfigurationError
 from splight_cli.engine import engine_app
 from splight_cli.hub import hub_app
 from splight_cli.solution import solution_app
@@ -50,7 +50,7 @@ def main(
                 True if ctx.invoked_subcommand == "configure" else False
             )
         )
-    except MissingConfigurationFile as exc:
+    except ConfigurationError as exc:
         console.print(
             (
                 f"Error running Splight: {str(exc)}. "

{splight_cli-5.1.5 → splight_cli-5.2.0}/splight_cli/context/workspace.py

@@ -42,7 +42,7 @@ class WorkspaceManager:
         self._workspaces = self._config.workspaces
         self._current_workspace = self._config.current_workspace
         self._settings = self._workspaces[self._current_workspace]
-        if not self._settings.is_configured():
+        if not self._settings.is_configured() and not new_workspace:
             raise ConfigurationError(
                 (
                     "There is at least one variable missing. "

{splight_cli-5.1.5 → splight_cli-5.2.0}/splight_cli/hub/__init__.py

@@ -3,7 +3,6 @@ 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(
     name="Splight Hub",
@@ -13,7 +12,6 @@ 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")
 
 

splight_cli-5.1.5/splight_cli/context/exceptions.py

@@ -1,3 +0,0 @@
-class MissingConfigurationFile(Exception):
-    def __init__(self, message):
-        super().__init__(message)

splight_cli-5.1.5/splight_cli/hub/solution/__init__.py

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

splight_cli-5.1.5/splight_cli/hub/solution/constants.py

@@ -1,4 +0,0 @@
-MAIN_FILE = "main.tf"
-VARIABLES_FILE = "variables.tf"
-VALUES_FILE = "variables.tfvars"
-README_FILE = "README.md"

splight_cli-5.1.5/splight_cli/hub/solution/exceptions.py

@@ -1,30 +0,0 @@
-class HubSolutionAlreadyExists(Exception):
-    def __init__(self, name: str, version: str):
-        self._msg = f"Solution {name}-{version} already exists in Splight Hub"
-
-    def __str__(self) -> str:
-        return self._msg
-
-
-class HubSolutionNotFound(Exception):
-    def __init__(self, name: str, version: str):
-        self._msg = f"Solution {name}-{version} not found in Splight Hub"
-
-    def __str__(self) -> str:
-        return self._msg
-
-
-class MissingSolutionFile(Exception):
-    def __init__(self, name: str, path: str):
-        self._msg = f"Missing solution file {name} in path {path}"
-
-    def __str__(self) -> str:
-        return self._msg
-
-
-class SolutionDirectoryAlreadyExists(Exception):
-    def __init__(self, path: str):
-        self._msg = f"Solution directory {path} already exists"
-
-    def __str__(self) -> str:
-        return self._msg

splight_cli-5.1.5/splight_cli/hub/solution/solution_manager.py

@@ -1,112 +0,0 @@
-import json
-import os
-import shutil
-from collections import namedtuple
-
-import py7zr
-from pydantic import ValidationError
-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.hub.exceptions import SpecFormatError, SpecValidationError
-from splight_cli.hub.solution.exceptions import (
-    HubSolutionAlreadyExists,
-    HubSolutionNotFound,
-    SolutionDirectoryAlreadyExists,
-)
-from splight_cli.utils.loader import Loader
-
-console = Console()
-
-
-class HubSolutionManager:
-    def list_solutions(self):
-        solution_tuple = namedtuple("Solution", ["name", "version"])
-        all_solutions = HubSolution.list()
-        solutions = set(
-            [
-                solution_tuple(solution.name, solution.version)
-                for solution in all_solutions
-            ]
-        )
-        table = Table("Name", "Version", title="Hub Solution List")
-        [table.add_row(sol.name, sol.version) for sol in solutions]
-        console.print(table)
-
-    def push(
-        self,
-        path: str = ".",
-        force: 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:
-            instance = HubSolution.model_validate(spec)
-        except ValidationError as exc:
-            raise SpecValidationError(exc)
-
-        name = instance.name
-        version = instance.version
-
-        if not force and self._exists_in_hub(name, version):
-            raise HubSolutionAlreadyExists(name, version)
-
-        with Loader("Pushing Solution to Splight Hub"):
-            solution = HubSolution.upload(path)
-
-        console.print(
-            f"Solution {solution.id} pushed succesfully", style=success_style
-        )
-
-    def pull(self, name: str, version: str):
-        with Loader("Pulling solution from Splight Hub"):
-            self._pull_solution(name, version)
-        console.print(
-            f"Solution {name} pulled succesfully", style=success_style
-        )
-
-    def _pull_solution(self, name: str, version: str):
-        solution = self._get_hub_solution(name, version)
-        name, version = solution.name, solution.version
-        file_wrapper = solution.download()
-        file_data = file_wrapper.read()
-
-        version_modified = version.replace(".", "_")
-        solution_path = f"{name}/{version_modified}"
-        versioned_name = f"{name}-{version}"
-        file_name = f"{versioned_name}.{COMPRESSION_TYPE}"
-        if os.path.exists(solution_path):
-            raise SolutionDirectoryAlreadyExists(solution_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}", solution_path)
-        except Exception as exc:
-            raise exc
-        finally:
-            if os.path.exists(file_name):
-                os.remove(file_name)
-
-    def _get_hub_solution(self, name: str, version: str) -> HubSolution:
-        solutions = HubSolution.list(name=name, version=version)
-        if not solutions:
-            raise HubSolutionNotFound(name, version)
-        return solutions[0]
-
-    def _exists_in_hub(self, name: str, version: str) -> bool:
-        try:
-            self._get_hub_solution(name, version)
-            return True
-        except HubSolutionNotFound:
-            return False

splight_cli-5.1.5/splight_cli/solution/__init__.py

@@ -1,88 +0,0 @@
-import typer
-from rich.console import Console
-
-from splight_cli.context import check_credentials
-from splight_cli.solution.parser import Parser
-from splight_cli.solution.resource import ResourceManager
-from splight_cli.solution.state import State
-
-solution_app = typer.Typer(
-    name="Splight Solution",
-    add_completion=True,
-    rich_markup_mode="rich",
-    no_args_is_help=True,
-)
-
-console = Console()
-
-
-@solution_app.callback(invoke_without_command=True)
-def callback(ctx: typer.Context):
-    check_credentials(ctx)
-
-
-# FIXME: find a nice way to print the exceptions.
-# Take into account that most exception messages are short and do not have
-# that much content. I would include the traceback, or at least some part of it.
-# Another option is to not catch them, and show the entire error, so the user can
-# debug it.
-@solution_app.command()
-def apply(
-    _: typer.Context,
-    spec_file: str = typer.Argument(..., help="Path to the spec file."),
-    state_file: str = typer.Option(
-        "state.json", "--state", "-s", help="Path to the state file."
-    ),
-) -> None:
-    state = State(path=state_file)
-    state.load()
-
-    parser = Parser(spec_file=spec_file)
-    specs, dependency_graph = parser.parse()
-
-    manager = ResourceManager(
-        state=state,
-        specs=specs,
-        dependency_graph=dependency_graph,
-    )
-    manager.refresh()
-    plan = manager.plan()
-    if plan:
-        manager.apply()
-
-
-@solution_app.command()
-def plan(
-    _: typer.Context,
-    spec_file: str = typer.Argument(..., help="Path to the spec file."),
-    state_file: str = typer.Option(
-        "state.json", "--state", "-s", help="Path to the state file."
-    ),
-) -> None:
-    state = State(path=state_file)
-    state.load()
-
-    parser = Parser(spec_file=spec_file)
-    specs, dependency_graph = parser.parse()
-
-    manager = ResourceManager(
-        state=state,
-        specs=specs,
-        dependency_graph=dependency_graph,
-    )
-    manager.refresh()
-    manager.plan()
-
-
-@solution_app.command()
-def refresh(
-    _: typer.Context,
-    state_file: str = typer.Option(
-        "state.json", "--state", "-s", help="Path to the state file."
-    ),
-) -> None:
-    state = State(path=state_file)
-    state.load()
-
-    manager = ResourceManager(state=state)
-    manager.refresh()

splight_cli-5.1.5/splight_cli/solution/dict.py

@@ -1,50 +0,0 @@
-from typing import Any, Dict, List
-
-
-# FIXME: make this faster using a stack
-def walk_dict(data: Dict, current=[]):
-    result = []
-
-    if isinstance(data, Dict):
-        for key, value in data.items():
-            current.append(key)
-            result.extend(walk_dict(value, current.copy()))
-            current.pop()
-    elif isinstance(data, List):
-        for index, item in enumerate(data):
-            current.append(index)
-            result.extend(walk_dict(item, current.copy()))
-            current.pop()
-    else:
-        result.append((current.copy(), data))
-
-    return result
-
-
-def get_dict_value(path: List, data: Dict):
-    # Assumes the path exists
-    current = data
-    for key in path:
-        if isinstance(current, dict):
-            current = current[key]
-        elif isinstance(current, list):
-            current = current[int(key)]
-        else:
-            raise ValueError(f"Invalid path: {path}")
-    return current
-
-
-def set_dict_value(value: Any, path: List, data: Dict):
-    # Assumes the path exists
-    current = data
-    for key in path[:-1]:
-        current = current[key]
-
-    last_key = path[-1]
-
-    if isinstance(current, dict):
-        current[last_key] = value
-    elif isinstance(current, list):
-        current[int(last_key)] = value
-    else:
-        raise ValueError(f"Invalid path: {path}")

splight_cli-5.1.5/splight_cli/solution/parser.py

@@ -1,103 +0,0 @@
-import re
-from typing import Dict, List, Optional
-
-import yaml
-
-from splight_cli.solution.dict import walk_dict
-
-
-class DuplicateResourceError(Exception):
-    pass
-
-
-def parse_reference(value: str) -> Optional[Dict]:
-    """Return the reference if it matches the regex or None otherwise"""
-    # FIXME: make it so we are able to reference the 'name' of a resource.
-    # This is super easy to do:
-    # 1. Add '.id' and '.name' at the end of the regex
-    # 2. Save that accessor to the references dict in each spec.
-    # 3. Change the 'replace_references' function in ResourceManager so it
-    #    gets the correct attribute.
-
-    # Only process strings
-    if isinstance(value, str):
-        # Building this with format strings breaks the expression
-        pattern = r"^\${{(Asset|Attribute|Metadata|File|Function|Secret|Alert|Component|Routine)\.(\w+)}}$"
-
-        # Get the matches
-        match = re.match(pattern, value)
-
-        if match:
-            type, name = match.groups()
-            key = f"{type}:{name}"
-            return key
-
-
-class Parser:
-    def __init__(self, spec_file: str) -> None:
-        try:
-            with open(spec_file, "r") as fp:
-                self._spec_file_data = yaml.safe_load(fp)
-        except FileNotFoundError:
-            raise Exception(f"Spec file '{spec_file}' not found.")
-
-    def parse(self) -> List[Dict]:
-        # Here we build the dependency graph using the resource keys
-        dependency_graph = {}
-
-        # - Does not destroy all elements.
-        specs = {}
-        for resource_spec in self._spec_file_data or []:
-            name = resource_spec["name"]
-            type = resource_spec["type"]
-            arguments = resource_spec["arguments"]
-
-            # Parse each resource leaf value to see if its a reference
-            depends_on = set({})
-            references = []
-            for path, value in walk_dict(resource_spec["arguments"]):
-                result = parse_reference(value)
-                if result is not None:
-                    key = result
-
-                    # Must be done here, otherwise it would affect the dependency graph.
-                    # Paths and values are validated later on, since we may need data
-                    # that is available after creation.
-                    # This also prevents trying to delete a resource which has another
-                    # one referencing it.
-                    # Also prevents self-referencing.
-                    if key not in specs:
-                        raise ValueError(
-                            f"Reference '{value}' in resource '{name}' of type '{type}' points to a non existing resource."
-                        )
-
-                    reference = {
-                        "key": key,  # Key of the referenced resource
-                        "target": path,  # Where to put the value
-                        "string": value,  # The string value of the reference
-                    }
-
-                    references.append(reference)
-                    depends_on.add(key)
-
-            key = f"{type}:{name}"
-            if key in specs:
-                raise DuplicateResourceError(
-                    f"Resource '{name}' of type '{type}' is defined twice."
-                )
-
-            specs[key] = {
-                "name": name,
-                "type": type,
-                "depends_on": list(depends_on),
-                "references": references,
-                "arguments": arguments,
-            }
-
-            # Add its dependecies to the graph
-            dependency_graph[key] = depends_on
-
-        # NOTE: Before adding/changing features of the parser, insert a breakpoint
-        # here and inspect the specs and dependency_graph objects, to see the shape
-        # of the objects that the rest of the code needs.
-        return specs, dependency_graph

splight_cli-5.1.5/splight_cli/solution/resource/__init__.py

@@ -1,5 +0,0 @@
-from splight_cli.solution.resource.manager import ResourceManager
-
-__all__ = [
-    "ResourceManager",
-]

splight_cli-5.1.5/splight_cli/solution/resource/diff.py

@@ -1,39 +0,0 @@
-from typing import Dict
-
-from colorama import Fore, Style
-
-from splight_cli.solution.dict import get_dict_value, walk_dict
-
-
-def strike_text(text):
-    return "".join(["\u0336{}".format(c) for c in str(text)])
-
-
-def Diff(new_arguments: Dict, old_arguments: Dict) -> Dict:
-    # FIXME: this try catch mechanic could be simplified by improving
-    # the 'Dict' related functions.
-
-    # FIXME: Try replacing the QueryFilter in a function for a single value.
-    # The diff will show incorrectly.
-    diff = []
-    for path, new_value in walk_dict(new_arguments):
-        try:
-            get_dict_value(path, old_arguments)
-        except Exception:
-            line = f"\t{Fore.GREEN}+{Style.RESET_ALL} {'.'.join([str(key) for key in path])}: {new_value}"
-            diff.append(line)
-            continue
-
-        old_value = get_dict_value(path, old_arguments)
-        if new_value != old_value:
-            line = f"\t{Fore.YELLOW}~{Style.RESET_ALL} {'.'.join([str(key) for key in path])}: {strike_text(old_value)} -> {new_value} "
-            diff.append(line)
-
-    for path, old_value in walk_dict(old_arguments):
-        try:
-            get_dict_value(path, new_arguments)
-        except Exception:
-            line = f"\t{Fore.RED}-{Style.RESET_ALL} {'.'.join([str(key) for key in path])}: {strike_text(old_value)}"
-            diff.append(line)
-
-    return diff

splight_cli-5.1.5/splight_cli/solution/resource/logger.py

@@ -1,36 +0,0 @@
-from colorama import Style
-
-
-class ResourceLogger:
-    template = '{type}["{name}"]: {message} [id={id}]'
-
-    @staticmethod
-    def _bold(message: str) -> str:
-        return f"{Style.BRIGHT}{message}{Style.RESET_ALL}"
-
-    def resource(self, message: str, resource):
-        formatted_message = self.template.format(
-            type=resource.type,
-            name=resource.name,
-            id=resource.id,
-            message=message,
-        )
-        print(self._bold(formatted_message))
-
-    def event(
-        self,
-        message: str,
-        previous_line: bool = False,
-        new_line: bool = False,
-        bold: bool = False,
-    ):
-        formatted_message = ""
-        if previous_line:
-            formatted_message += "\n"
-        formatted_message += f"{self._bold(message)}" if bold else message
-        if new_line:
-            formatted_message += "\n"
-        print(formatted_message)
-
-    def diff(self, diff):
-        print("\n".join(diff))