splight-cli 4.9.0__tar.gz → 4.11.0__tar.gz

{splight_cli-4.9.0 → splight_cli-4.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 4.9.0
+Version: 4.11.0
 Summary: Splight Command Line Interface
 Author: Splight Dev
 Author-email: dev@splight-ae.com
@@ -15,8 +15,6 @@ 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: deepdiff (==6.3.1)
-Requires-Dist: mock (>=5.1.0,<6.0.0)
 Requires-Dist: packaging (==23.0)
 Requires-Dist: pathspec (==0.11.1)
 Requires-Dist: py7zr (==0.20.8)
@@ -24,14 +22,12 @@ Requires-Dist: requests (==2.31.0)
 Requires-Dist: rich (==13.0.1)
 Requires-Dist: setuptools (==60.9.3)
 Requires-Dist: splight-lib (>=5.2.2,<6.0.0)
+Requires-Dist: toposort (>=1.10,<2.0)
 Requires-Dist: typer (==0.9.0)
 Description-Content-Type: text/markdown
 
 # Splight CLI
 
-![snyk_code](https://github.com/splightplatform/splight-cli/blob/gh-pages/snyk_code.svg?raw=True)
-![snyk_dependencies](https://github.com/splightplatform/splight-cli/blob/gh-pages/snyk_dependencies.svg?raw=True)
-
 ---
 
 ## Table of Content
@@ -76,6 +72,7 @@ pip install splight-cli
 ```
 
 Once you have installed `splight-cli` you can check the installation with
+
 ```bash
 splight --version
 ```
@@ -251,12 +248,15 @@ You can also retrieve one of the parameters using the `get` command:
 ```bash
 splight configure get <parameter>
 ```
+
 for example for reading the `SPLIGHT_PLATFORM_API_HOST`:
+
 ```bash
 splight configure get splight_platform_api_host
 ```
 
 In the same way you can modify one parameter using the `set` command
+
 ```bash
 splight configure set <parameter> <value>
 ```
@@ -311,6 +311,7 @@ The `engine` command is used for interacting with the Splight Engine. So far, th
 subcommands provide an interface for creating, reaading and deleting resources in the engine.
 
 The command is
+
 ```bash
 splight engine <subcommand> <action> [extra args]
 ```
@@ -319,6 +320,7 @@ depending on the which sub-command you use you can get different actions
 to perform
 
 The valid sub-commands so far are:
+
 - `asset`
 - `attribute`
 - `component`
@@ -344,7 +346,7 @@ The available subcommands are
 
 - `create <name>` to create a new workspace. After the creation of a new worskpace you need to configure _Splight CLI_ with `splight configure`.
 - `delete <name>` to delete an existing workspace.
-- `list` to list all workspaces. Current workspace displays a '*' to the left.
+- `list` to list all workspaces. Current workspace displays a '\*' to the left.
 - `select <name>` to switch between different configured workspaces.
 - `show <name>` to display the contents of an existing workspace.
 
@@ -580,10 +582,10 @@ splight component run <component directory> --local
 ```
 
 This way, the component will run using local clients for database and datalake. This is extremely
-useful for development since you can create instances of the different database objects in the 
-local database for running different scenearios or differents tests. The same can be applied for 
+useful for development since you can create instances of the different database objects in the
+local database for running different scenearios or differents tests. The same can be applied for
 datalake data, the local client stores the data in files. In both cases, for database and datalake,
-the files are created in the same directory as the `__init__.py` file of the component, so you 
+the files are created in the same directory as the `__init__.py` file of the component, so you
 can modified it based on your needs.
 
 You can interact with the local databases using the library, for example
@@ -605,3 +607,4 @@ db_client.save(attribute)
 
 df = client.get_dataframe(Number, asset=all_assets[0].id, attribute=attribute.id)
 ```
+

{splight_cli-4.9.0 → splight_cli-4.11.0}/README.md

@@ -1,8 +1,5 @@
 # Splight CLI
 
-![snyk_code](https://github.com/splightplatform/splight-cli/blob/gh-pages/snyk_code.svg?raw=True)
-![snyk_dependencies](https://github.com/splightplatform/splight-cli/blob/gh-pages/snyk_dependencies.svg?raw=True)
-
 ---
 
 ## Table of Content
@@ -47,6 +44,7 @@ pip install splight-cli
 ```
 
 Once you have installed `splight-cli` you can check the installation with
+
 ```bash
 splight --version
 ```
@@ -222,12 +220,15 @@ You can also retrieve one of the parameters using the `get` command:
 ```bash
 splight configure get <parameter>
 ```
+
 for example for reading the `SPLIGHT_PLATFORM_API_HOST`:
+
 ```bash
 splight configure get splight_platform_api_host
 ```
 
 In the same way you can modify one parameter using the `set` command
+
 ```bash
 splight configure set <parameter> <value>
 ```
@@ -282,6 +283,7 @@ The `engine` command is used for interacting with the Splight Engine. So far, th
 subcommands provide an interface for creating, reaading and deleting resources in the engine.
 
 The command is
+
 ```bash
 splight engine <subcommand> <action> [extra args]
 ```
@@ -290,6 +292,7 @@ depending on the which sub-command you use you can get different actions
 to perform
 
 The valid sub-commands so far are:
+
 - `asset`
 - `attribute`
 - `component`
@@ -315,7 +318,7 @@ The available subcommands are
 
 - `create <name>` to create a new workspace. After the creation of a new worskpace you need to configure _Splight CLI_ with `splight configure`.
 - `delete <name>` to delete an existing workspace.
-- `list` to list all workspaces. Current workspace displays a '*' to the left.
+- `list` to list all workspaces. Current workspace displays a '\*' to the left.
 - `select <name>` to switch between different configured workspaces.
 - `show <name>` to display the contents of an existing workspace.
 
@@ -551,10 +554,10 @@ splight component run <component directory> --local
 ```
 
 This way, the component will run using local clients for database and datalake. This is extremely
-useful for development since you can create instances of the different database objects in the 
-local database for running different scenearios or differents tests. The same can be applied for 
+useful for development since you can create instances of the different database objects in the
+local database for running different scenearios or differents tests. The same can be applied for
 datalake data, the local client stores the data in files. In both cases, for database and datalake,
-the files are created in the same directory as the `__init__.py` file of the component, so you 
+the files are created in the same directory as the `__init__.py` file of the component, so you
 can modified it based on your needs.
 
 You can interact with the local databases using the library, for example
@@ -575,4 +578,4 @@ attribute = Attribute(name="SomeAttribute")
 db_client.save(attribute)
 
 df = client.get_dataframe(Number, asset=all_assets[0].id, attribute=attribute.id)
-```
+```

{splight_cli-4.9.0 → splight_cli-4.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-cli"
-version = "4.9.0"
+version = "4.11.0"
 description = "Splight Command Line Interface"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"
@@ -20,8 +20,7 @@ PyYAML = "6.0.1"
 rich = "13.0.1"
 pathspec = "0.11.1"
 packaging = "23.0"
-deepdiff = "6.3.1"
-mock = "^5.1.0"
+toposort = "^1.10"
 
 [tool.poetry.group.dev.dependencies]
 black = "23.3.0"
@@ -32,6 +31,7 @@ flake8 = "^6.1.0"
 pre-commit = "3.2.2"
 pytest = "^7.4.3"
 coverage = "^7.3.2"
+mock = "^5.1.0"
 
 [tool.poetry.scripts]
 splight = "splight_cli.cli:app"

splight_cli-4.11.0/splight_cli/solution/__init__.py

@@ -0,0 +1,88 @@
+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-4.11.0/splight_cli/solution/dict.py

@@ -0,0 +1,50 @@
+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-4.11.0/splight_cli/solution/parser.py

@@ -0,0 +1,103 @@
+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-4.11.0/splight_cli/solution/resource/__init__.py

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

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

@@ -0,0 +1,39 @@
+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:
+            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:
+            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-4.11.0/splight_cli/solution/resource/logger.py

@@ -0,0 +1,36 @@
+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))