validio-cli 0.23.0__tar.gz → 0.24.0__tar.gz

{validio_cli-0.23.0 → validio_cli-0.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validio-cli
-Version: 0.23.0
+Version: 0.24.0
 Summary: CLI tool to interact with the Validio platform
 Home-page: https://validio.io/
 License: Apache-2.0

{validio_cli-0.23.0 → validio_cli-0.24.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "validio-cli"
 # This version does not represent the released version or any tag. For each
 # release we automatically bump this before building and publishing so this
 # should be kept at 0.0.1dev1
-version = "0.23.0"
+version = "0.24.0"
 description = "CLI tool to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"
@@ -16,20 +16,20 @@ readme = "README_PUBLIC.md"
 python = "^3.10"
 camel-converter = "^3.0.0"
 classdiff = "^0.5.0"
-validio-sdk = "*"
 typer = { extras = ["all"], version = "^0.7.0" }
 prompt-toolkit = "^3.0.38"
 tabulate = "^0.9.0"
 types-tabulate = "^0.9.0.2"
 pydantic = "2.4.2"
+validio-sdk = "*"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "^0.1.11"
 mypy = "^1.2.0"
-validio-sdk = { path = "../validio-sdk", develop = true }
 licensecheck = "^2023.1.1"
 pytest = "^7.4.3"
 flameprof = "^0.4"
+validio-sdk = { path = "../validio-sdk" }
 
 [build-system]
 requires = ["poetry-core"]

{validio_cli-0.23.0 → validio_cli-0.24.0}/validio_cli/__init__.py

@@ -15,6 +15,7 @@ import typer
 from camel_converter import to_snake
 from tabulate import tabulate
 from validio_sdk import config
+from validio_sdk._api.api import APIClient
 from validio_sdk.config import Config, ValidioConfig
 from validio_sdk.util import ClassJSONEncoder
 from validio_sdk.validio_client import ValidioAPIClient
@@ -25,6 +26,14 @@ T = TypeVar("T", bound="OutputSettings")
 DEFAULT_NAMESPACE: str = "default"
 
 
+class Role(str, Enum):
+    """User roles."""
+
+    ADMIN = "ADMIN"
+    EDITOR = "EDITOR"
+    VIEWER = "VIEWER"
+
+
 class OutputFormat(str, Enum):
     """Available output formats for the CLI"""
 
@@ -45,6 +54,9 @@ OutputFormatOption = typer.Option(
 Identifier = typer.Argument(
     default=None, help="Name or ID of the resource to get of this type"
 )
+Identifiers = typer.Argument(
+    default=None, help="Names or IDs of the sources to apply the command on"
+)
 
 
 # ruff: noqa: N802
@@ -82,13 +94,20 @@ class AsyncTyper(typer.Typer):
         return decorator
 
 
+def get_client(
+    config_dir: str = ConfigDir,
+) -> tuple[APIClient, ValidioConfig]:
+    cfg = Config(Path(config_dir)).read()
+    return APIClient(config=cfg), cfg
+
+
 async def get_client_and_config(
     config_dir: str = ConfigDir,
 ) -> tuple[ValidioAPIClient, ValidioConfig]:
     cfg = Config(Path(config_dir)).read()
     vc = ValidioAPIClient(validio_config=cfg)
 
-    return (vc, cfg)
+    return vc, cfg
 
 
 @dataclass
@@ -104,6 +123,16 @@ class OutputSettings:
             reformat=lambda x: to_snake(x.removesuffix(trim)).upper(),
         )
 
+    @classmethod
+    def string_as_datetime(cls: type[T], attribute_name: str | None) -> T:
+        format = "%Y-%m-%dT%H:%M:%S.%fZ"
+        return cls(
+            attribute_name=attribute_name,
+            reformat=lambda x: datetime.strptime(x, format).replace(
+                tzinfo=timezone.utc
+            ),
+        )
+
 
 def output_json(obj: Any, identifier: str | None = None) -> None:
     # If we have an identifier we only want to display a single object so grab
@@ -135,17 +164,20 @@ def output_text(items: Any, fields: dict[str, OutputSettings | None]) -> None:
                 row.append(settings.reformat(item))
                 continue
 
-            if not hasattr(item, attribute_name):
+            if isinstance(item, dict):
+                value = item.get(attribute_name)
+            elif hasattr(item, attribute_name):
+                value = getattr(item, attribute_name)
+            else:
                 row.append("UNKNOWN")
                 continue
 
-            value = getattr(item, attribute_name)
-            if isinstance(value, datetime):
-                value = _format_relative_time(value)
-
             if settings is not None and settings.reformat is not None:
                 value = settings.reformat(value)
 
+            if isinstance(value, datetime):
+                value = _format_relative_time(value)
+
             row.append(value)
 
         table.append(row)
@@ -199,7 +231,10 @@ def _single_resource_if_specified(items: list[Any], identifier: str | None) -> A
             for item in items
             if (hasattr(item, "resource_name") and item.resource_name == identifier)
             or (hasattr(item, "name") and item.name == identifier)
-            or item.id == identifier
+            or (hasattr(item, "id") and item.id == identifier)
+            or (isinstance(item, dict) and item.get("resourceName") == identifier)
+            or (isinstance(item, dict) and item.get("name") == identifier)
+            or (isinstance(item, dict) and item.get("id") == identifier)
         ),
         None,
     )
@@ -220,18 +255,14 @@ def _resource_filter(
 
     # Traverse the object til the resource we need for filtering.
     for field in field_path:
-        # If the object doesn't even have the field we can't do comparison so filter
-        # it out.
-        if not hasattr(resource, field):
-            return False
+        resource = resource.get(field)
 
-        resource = getattr(resource, field)
         # If the object field value we need for filtering out is none we filter
         # it out.
         if resource is None:
             return False
 
-    return value in (resource.id, resource.resource_name)
+    return value in [resource["id"], resource["resourceName"]]
 
 
 def _fixed_width(message: str, width: int = 25) -> str:

validio_cli-0.24.0/validio_cli/bin/entities/channels.py

@@ -0,0 +1,57 @@
+import typer
+from camel_converter import to_snake
+
+from validio_cli import (
+    AsyncTyper,
+    ConfigDir,
+    Identifier,
+    Namespace,
+    OutputFormat,
+    OutputFormatOption,
+    OutputSettings,
+    _single_resource_if_specified,
+    get_client,
+    output_json,
+    output_text,
+)
+from validio_cli.namespace import get_namespace
+
+app = AsyncTyper(help="Channels used for notifications")
+
+
+@app.async_command(help="Get channels")
+async def get(
+    config_dir: str = ConfigDir,
+    output_format: OutputFormat = OutputFormatOption,
+    namespace: str = Namespace(),
+    identifier: str = Identifier,
+) -> None:
+    client, cfg = get_client(config_dir)
+
+    channels = await client.get_channels(
+        channel_id=identifier,
+        namespace_id=get_namespace(namespace, cfg),
+    )
+
+    # TODO(UI-2311): Fully support list/get/get_by_resource_name
+    if isinstance(channels, list):
+        channels = _single_resource_if_specified(channels, identifier)
+
+    if output_format == OutputFormat.JSON:
+        return output_json(channels, identifier)
+
+    return output_text(
+        channels,
+        fields={
+            "name": OutputSettings(attribute_name="resourceName"),
+            "type": OutputSettings(
+                attribute_name="__typename",
+                reformat=lambda x: to_snake(x.removesuffix("Channel")).upper(),
+            ),
+            "age": OutputSettings.string_as_datetime("createdAt"),
+        },
+    )
+
+
+if __name__ == "__main__":
+    typer.run(app())

{validio_cli-0.23.0 → validio_cli-0.24.0}/validio_cli/bin/entities/code.py

@@ -8,22 +8,22 @@ from typing import Any
 import classdiff  # type: ignore
 import typer
 from validio_sdk import ValidioError
+from validio_sdk._api.api import APIClient
 from validio_sdk.code import _import as code_import
 from validio_sdk.code import apply as code_apply
 from validio_sdk.code import plan as code_plan
 from validio_sdk.code import scaffold
-from validio_sdk.resource._diff import DiffContext, GraphDiff, ResourceUpdate
-from validio_sdk.resource._resource import Resource
+from validio_sdk.resource._diff import GraphDiff, ResourceUpdate
+from validio_sdk.resource._resource import DiffContext, Resource, ResourceDeprecation
 from validio_sdk.resource._util import SourceSchemaReinference
 from validio_sdk.resource.replacement import (
     ImmutableFieldReplacementReason,
     ReplacementReason,
 )
-from validio_sdk.validio_client import ValidioAPIClient
 
-from validio_cli import AsyncTyper, ConfigDir, Namespace, get_client_and_config
-from validio_cli.bin.entities.resources import do_move
-from validio_cli.components import proceed_with_operation
+from validio_cli import AsyncTyper, ConfigDir, Namespace, get_client
+from validio_cli.bin.entities.resources import ResourceNamesToMove, do_move
+from validio_cli.components import BETA_BANNER, proceed_with_operation
 
 """Maximum number of deprecation warnings to show."""
 MAX_DEPRECATIONS_TO_SHOW = 20
@@ -99,15 +99,16 @@ update_all_schemas_option = typer.Option(
     ),
 )
 
-target_option = typer.Option(
-    [],
-    help=(
-        "[red][bold]BETA[/bold][/red] "
-        "Only target selected resources and ignore changes for others."
-        "Format is '<type>:<name>', e.g. 'source:my-bq-source' or "
-        "'window:my-global-window'"
-    ),
-)
+
+def target_option(resource_type: str) -> Any:
+    return typer.Option(
+        [],
+        help=(
+            f"{BETA_BANNER} "
+            f'Only target selected {resource_type.replace("-", " ")}(s) and ignore '
+            f"changes for others. E.g. `--{resource_type} resource-a"
+        ),
+    )
 
 
 @app.command(help="Initialize a new IaC project")
@@ -137,10 +138,16 @@ async def plan(
     destroy: bool = destroy_option,
     show_secrets: bool = show_secrets_option,
     color: bool = color_option,
-    target: list[str] = target_option,
+    channel: list[str] = target_option("channel"),
+    credential: list[str] = target_option("credential"),
+    notification_rule: list[str] = target_option("notification-rule"),
+    segmentation: list[str] = target_option("segmentation"),
+    source: list[str] = target_option("source"),
+    validator: list[str] = target_option("validator"),
+    window: list[str] = target_option("window"),
 ) -> None:
     dir_path = directory_or_default(directory)
-    client, _ = await get_client_and_config(config_dir)
+    client, _ = get_client(config_dir)
 
     schema_reinference = create_source_schema_reinference(
         update_schema, update_all_schemas
@@ -158,7 +165,15 @@ async def plan(
         show_schema=show_schema,
         diff_output=diff_output,
         show_secrets=show_secrets,
-        targets=set(target),
+        targets=code_plan.ResourceNames(
+            channels=set(channel),
+            credentials=set(credential),
+            notification_rules=set(notification_rule),
+            segmentations=set(segmentation),
+            sources=set(source),
+            validators=set(validator),
+            windows=set(window),
+        ),
     )
 
 
@@ -177,10 +192,16 @@ async def apply(
     destroy: bool = destroy_option,
     show_secrets: bool = show_secrets_option,
     color: bool = color_option,
-    target: list[str] = target_option,
+    channel: list[str] = target_option("channel"),
+    credential: list[str] = target_option("credential"),
+    notification_rule: list[str] = target_option("notification-rule"),
+    segmentation: list[str] = target_option("segmentation"),
+    source: list[str] = target_option("source"),
+    validator: list[str] = target_option("validator"),
+    window: list[str] = target_option("window"),
 ) -> None:
     dir_path = directory_or_default(directory)
-    client, _ = await get_client_and_config(config_dir)
+    client, _ = get_client(config_dir)
 
     schema_reinference = create_source_schema_reinference(
         update_schema, update_all_schemas
@@ -198,7 +219,15 @@ async def apply(
         show_schema=show_schema,
         diff_output=diff_output,
         show_secrets=show_secrets,
-        targets=set(target),
+        targets=code_plan.ResourceNames(
+            channels=set(channel),
+            credentials=set(credential),
+            notification_rules=set(notification_rule),
+            segmentations=set(segmentation),
+            sources=set(source),
+            validators=set(validator),
+            windows=set(window),
+        ),
     )
 
     if diff.num_operations() == 0:
@@ -241,33 +270,45 @@ async def _import(
         None,
         "--import-namespace",
         help=(
-            "If a file is specified, resources in that file will be moved."
-            " Otherwise all resources in this namespace will be moved."
-            " If providing file to move resources, this is a mandatory parameter"
+            "Shorthand to first 'move' resources into the current "
+            "project's namespace before performing the import. "
         ),
     ),
-    file: pathlib.Path = typer.Option(
+    credential: list[str] = typer.Option(
         None,
-        "--file",
-        "-f",
         help=(
-            "Path to a JSON-encoded file containing a list of resource to be"
-            " moved into the current project before generating resource declarations."
-            " If provided, then --import-namespace must be specified"
+            f"{BETA_BANNER} Target credential resources to move into "
+            f"the current project's namespace. "
+            f"This moves any specified credentials together with their "
+            f"attached sources, windows, filters, segmentations and validators. "
+            f"Only applicable with '--import-namespace'"
+        ),
+    ),
+    channel: list[str] = typer.Option(
+        None,
+        help=(
+            f"{BETA_BANNER} Target channel resources to move into "
+            f"the current project's namespace. "
+            f"This moves any specified channels together with their "
+            f"attached notification rules. "
+            f"Only applicable with '--import-namespace'"
         ),
     ),
     auto_approve: bool = typer.Option(
         False, help="Automatically approve and perform the import operation"
     ),
 ) -> None:
-    if file is not None and import_namespace is None:
+    resource_names = ResourceNamesToMove(
+        credentials=set(credential), channels=set(channel)
+    )
+
+    if resource_names.is_empty() and import_namespace is None:
         raise ValidioError(
-            "--import-namespace must be provided if -f is provided and vice versa"
+            "--import-namespace is required when targeting resources to move"
         )
 
     dir_path = directory_or_default(directory)
-    client, _ = await get_client_and_config(config_dir)
-
+    client, _ = get_client(config_dir)
     namespace = get_namespace(dir_path)
 
     if import_namespace:
@@ -275,7 +316,7 @@ async def _import(
             client=client,
             namespace=import_namespace,
             target_namespace=namespace,
-            file=file,
+            resource_names=resource_names,
             auto_approve=auto_approve,
         )
         if num_moved_resources is None:
@@ -284,7 +325,7 @@ async def _import(
         if num_moved_resources > 0:
             print(f"Moved {num_moved_resources} resources")
 
-    diff, manifest_ctx = await _plan(
+    diff, _ = await _plan(
         namespace=namespace,
         client=client,
         directory=dir_path,
@@ -295,6 +336,7 @@ async def _import(
         show_schema=False,
         show_secrets=False,
         show_diff=False,
+        import_mode=True,
     )
 
     if diff.num_deletes() == 0:
@@ -317,7 +359,7 @@ def directory_or_default(directory: str) -> pathlib.Path:
 
 async def _plan(
     namespace: str,
-    client: ValidioAPIClient,
+    client: APIClient,
     directory: pathlib.Path,
     schema_reinference: SourceSchemaReinference,
     destroy: bool,
@@ -327,7 +369,8 @@ async def _plan(
     diff_output: DiffOutput = DiffOutput.FULL,
     show_secrets: bool = False,
     show_diff: bool = True,
-    targets: set[str] = set(),
+    targets: code_plan.ResourceNames = code_plan.ResourceNames(),
+    import_mode: bool = False,
 ) -> tuple[GraphDiff, DiffContext]:
     plan_result = await code_plan.plan(
         namespace=namespace,
@@ -337,7 +380,8 @@ async def _plan(
         destroy=destroy,
         no_capture=no_capture,
         show_secrets=show_secrets,
-        targets=_create_resource_names(targets),
+        targets=targets,
+        import_mode=import_mode,
     )
 
     diff, manifest_ctx = plan_result.graph_diff, plan_result.diff_context
@@ -345,16 +389,16 @@ async def _plan(
     if show_diff:
         if diff.num_operations() == 0:
             _print_no_changes()
-            return diff, manifest_ctx
+        else:
+            _show_resources_diff(
+                diff=diff,
+                show_schema=show_schema,
+                show_secrets=show_secrets,
+                escape=sys.stdout.isatty() and color,
+                diff_output=diff_output,
+            )
 
-        _show_resources_diff(
-            diff=diff,
-            show_schema=show_schema,
-            show_secrets=show_secrets,
-            escape=sys.stdout.isatty() and color,
-            diff_output=diff_output,
-            deprecations=plan_result.deprecations,
-        )
+    _show_deprecations(plan_result.deprecations)
 
     return diff, manifest_ctx
 
@@ -365,7 +409,6 @@ def _show_resources_diff(
     show_secrets: bool,
     escape: bool,
     diff_output: DiffOutput,
-    deprecations: list[code_plan.ResourceDeprecation],
 ) -> None:
     resource_types = DiffContext.fields()
     if diff.num_creates() > 0:
@@ -410,8 +453,6 @@ def _show_resources_diff(
             diff_output,
         )
 
-    _show_deprecations(deprecations)
-
     print(
         "\n"
         f"Plan: {diff.num_creates()} to create, {diff.num_updates()} to update, "
@@ -477,7 +518,14 @@ def _show_update_resource_diff(
     for r in resources.values():
         class_key = r.manifest.__class__.__name__
 
-        print(f"{class_key} '{r.manifest.name}' will be updated")
+        cascade_update = ""
+        if r.replacement_cascaded_update_parent:
+            (cls, parent_name) = r.replacement_cascaded_update_parent
+            cascade_update = (
+                f" (due to replacement of " f"{cls.__name__}({repr(parent_name)}))"
+            )
+
+        print(f"{class_key} '{r.manifest.name}' will be updated{cascade_update}")
 
         rewrites = _diff_field_rewrites(show_schema)
 
@@ -573,7 +621,7 @@ def _diff_field_rewrites(show_schema: bool) -> dict[str, Any]:
     return {} if show_schema else {"jtd_schema": "[NOT SHOWN]"}
 
 
-def _show_deprecations(deprecations: list[code_plan.ResourceDeprecation]) -> None:
+def _show_deprecations(deprecations: list[ResourceDeprecation]) -> None:
     if not deprecations:
         return
 
@@ -601,32 +649,9 @@ def create_source_schema_reinference(
     elif len(schemas_to_update) > 0:
         source_names = schemas_to_update
 
-    return SourceSchemaReinference(set(source_names) if source_names else None)
-
-
-def _create_resource_names(strings: set[str]) -> code_plan.ResourceNames:
-    """Construct object from a set of strings.
-
-    Strings in format <resource_type>:<resource_name> will be converted by
-    splitting on `:` and parsing the values.
-    """
-    resource_names = code_plan.ResourceNames()
-
-    for target in strings:
-        # A resource name can't contain `:` so it's safe to split like this.
-        resource_type, name = target.split(":")
-
-        # User specifies resources in singular (credential) but the class fields
-        # throughout the code uses plural so we add an 's'
-        resource_type = f"{resource_type}s"
-
-        if not hasattr(resource_names, resource_type):
-            raise ValidioError(f"Invalid resource type '{resource_type}'")
-
-        v = getattr(resource_names, resource_type)
-        v.add(name)
-
-    return resource_names
+    return SourceSchemaReinference(
+        set(source_names) if source_names is not None else None
+    )
 
 
 def _print_no_changes() -> None:

{validio_cli-0.23.0 → validio_cli-0.24.0}/validio_cli/bin/entities/config.py

@@ -1,19 +1,18 @@
 from pathlib import Path
 from typing import Any
 
-import httpx
 import typer
 from prompt_toolkit import PromptSession
 from prompt_toolkit.completion import WordCompleter
 from prompt_toolkit.shortcuts import confirm
 from tabulate import tabulate
+from validio_sdk._api.api import APIClient
 from validio_sdk.config import (
     Config,
     ConfigInvalidError,
     ConfigNotFoundError,
     ValidioConfig,
 )
-from validio_sdk.validio_client import UnauthorizedError, ValidioAPIClient
 
 import validio_cli
 from validio_cli import (
@@ -178,14 +177,5 @@ async def _prompt_for_config(current_config: ValidioConfig | None) -> ValidioCon
 
 
 async def _test_configuration(config: ValidioConfig) -> str | None:
-    vc = ValidioAPIClient(validio_config=config)
-
-    try:
-        # NOTE: Do we need an explicit ping command here?
-        await vc.list_users()
-    except UnauthorizedError:
-        return "Unauthorized"
-    except httpx.ConnectError:
-        return "Failed to connect to server"
-
-    return None
+    vc = APIClient(config=config)
+    return await vc.test_connection()