validio-cli 7.5.0__tar.gz → 8.1.0__tar.gz

{validio_cli-7.5.0 → validio_cli-8.1.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: validio-cli
-Version: 7.5.0
+Version: 8.1.0
 Summary: CLI tool to interact with the Validio platform
-Home-page: https://validio.io/
 License: Apache-2.0
+License-File: LICENSE
 Author: Validio
 Author-email: support@validio.io
 Requires-Python: >=3.10,<4.0
@@ -11,6 +11,9 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: camel-converter (>=3.0.0,<4.0.0)
 Requires-Dist: classdiff (>=0.5.2,<0.6.0)
 Requires-Dist: prompt-toolkit (>=3.0.38,<4.0.0)
@@ -19,6 +22,7 @@ Requires-Dist: typer[all] (>=0.8.0,<0.16.0)
 Requires-Dist: types-tabulate (>=0.9.0.2,<0.10.0.0)
 Requires-Dist: validio-sdk
 Project-URL: Documentation, https://docs.validio.io/
+Project-URL: Homepage, https://validio.io/
 Description-Content-Type: text/markdown
 
 # validio-cli

{validio_cli-7.5.0 → validio_cli-8.1.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 = "7.5.0"
+version = "8.1.0"
 description = "CLI tool to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"

{validio_cli-7.5.0 → validio_cli-8.1.0}/validio_cli/__init__.py

@@ -25,14 +25,6 @@ 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"""
 

{validio_cli-7.5.0 → validio_cli-8.1.0}/validio_cli/bin/entities/code.py

@@ -17,6 +17,7 @@ from validio_sdk.resource._resource import DiffContext, Resource, ResourceDeprec
 from validio_sdk.resource._util import SourceSchemaReinference
 from validio_sdk.resource.replacement import (
     ImmutableFieldReplacementReason,
+    RecreateOnChangeReplacementReason,
     ReplacementReason,
 )
 
@@ -101,7 +102,6 @@ update_all_schemas_option = typer.Option(
 show_progress_option = typer.Option(
     sys.stdout.isatty(),
     help=(
-        f"{BETA_BANNER} "
         "If enabled, progress updates will be displayed during "
         "execution of this command"
     ),
@@ -111,8 +111,8 @@ show_progress_option = typer.Option(
 def target_option(resource_type: str) -> Any:
     return typer.Option(
         [],
+        f"--{resource_type}",
         help=(
-            f"{BETA_BANNER} "
             f"Only target selected {resource_type.replace('-', ' ')}(s) and ignore "
             f"changes for others. E.g. `--{resource_type} resource-a"
         ),
@@ -148,6 +148,7 @@ async def plan(
     color: bool = color_option,
     channel: list[str] = target_option("channel"),
     credential: list[str] = target_option("credential"),
+    filter_: list[str] = target_option("filter"),
     notification_rule: list[str] = target_option("notification-rule"),
     segmentation: list[str] = target_option("segmentation"),
     source: list[str] = target_option("source"),
@@ -177,6 +178,7 @@ async def plan(
         targets=code_plan.ResourceNames(
             channels=set(channel),
             credentials=set(credential),
+            filters=set(filter_),
             notification_rules=set(notification_rule),
             segmentations=set(segmentation),
             sources=set(source),
@@ -204,6 +206,7 @@ async def apply(
     color: bool = color_option,
     channel: list[str] = target_option("channel"),
     credential: list[str] = target_option("credential"),
+    filter_: list[str] = target_option("filter"),
     notification_rule: list[str] = target_option("notification-rule"),
     segmentation: list[str] = target_option("segmentation"),
     source: list[str] = target_option("source"),
@@ -212,14 +215,12 @@ async def apply(
     progress: bool = show_progress_option,
     test_credentials: bool = typer.Option(
         True,
-        help=(
-            f"{BETA_BANNER} Test that credentials are valid before creating or updating"
-        ),
+        help="Test that credentials are valid before creating or updating",
     ),
     dry_run_sql: bool = typer.Option(
         False,
-        help=f"""
-            {BETA_BANNER} Dry run SQL queries before creating/updating SQL Filters,
+        help="""
+            Dry run SQL queries before creating/updating SQL Filters,
             SQL Sources or SQL Validators.
             Note: this feature is unsupported on Azure based warehouses.
         """,
@@ -247,6 +248,7 @@ async def apply(
         targets=code_plan.ResourceNames(
             channels=set(channel),
             credentials=set(credential),
+            filters=set(filter_),
             notification_rules=set(notification_rule),
             segmentations=set(segmentation),
             sources=set(source),
@@ -307,21 +309,21 @@ async def _import(
     credential: list[str] = typer.Option(
         [],
         help=(
-            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'"
+            "Target credential resources to move into "
+            "the current project's namespace. "
+            "This moves any specified credentials together with their "
+            "attached sources, windows, filters, segmentations and validators. "
+            "Only applicable with '--import-namespace'"
         ),
     ),
     channel: list[str] = typer.Option(
         [],
         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'"
+            "Target channel resources to move into "
+            "the current project's namespace. "
+            "This moves any specified channels together with their "
+            "attached notification rules. "
+            "Only applicable with '--import-namespace'"
         ),
     ),
     progress: bool = show_progress_option,
@@ -598,7 +600,10 @@ def _show_replace_resource_diff(
 
         rewrites = _diff_field_rewrites(show_schema)
         a_value, b_value = (None, None)
-        if isinstance(reason, ImmutableFieldReplacementReason):
+        if isinstance(
+            reason,
+            (ImmutableFieldReplacementReason, RecreateOnChangeReplacementReason),
+        ):
             update = reason.resource_update
             a_value = code_plan._create_resource_diff_object(
                 update.manifest,

{validio_cli-7.5.0 → validio_cli-8.1.0}/validio_cli/bin/entities/namespaces.py

@@ -1,5 +1,6 @@
-from typing import Optional
+from typing import Any, Optional
 
+import click
 import typer
 from validio_sdk import ValidioError
 
@@ -9,12 +10,27 @@ from validio_cli import (
     OutputFormat,
     OutputFormatOption,
     OutputSettings,
-    Role,
     get_client,
     output_json,
     output_text,
 )
 
+
+class RoleSuggestion(click.ParamType):
+    name = "role"
+
+    def get_metavar(self, _: click.Parameter) -> str | None:
+        return "[Admin|Editor|Viewer|<Custom>]"
+
+    def convert(
+        self,
+        value: Any,
+        _param: click.Parameter | None,
+        _ctx: click.Context | None,
+    ) -> Any:
+        return value
+
+
 app = AsyncTyper(help="Namespaces used to separate resources")
 
 
@@ -40,12 +56,16 @@ async def get(
     )
 
 
-@app.async_command(help="[red][bold]BETA[/bold][/red] Create a namespace")
+@app.async_command(help="Create a namespace")
 async def create(
     config_dir: str = ConfigDir,
     output_format: OutputFormat = OutputFormatOption,
     identifier: str = typer.Argument(..., help="Namespace name"),
-    role: Role = typer.Option(None, help="The role to assign --api-key and --member"),
+    role: str = typer.Option(
+        None,
+        click_type=RoleSuggestion(),
+        help="The role to assign --api-key and --member",
+    ),
     api_key: list[str] = typer.Option(
         [],
         "--api-key",
@@ -68,19 +88,23 @@ async def create(
             "--role is specified but no --member or --api-key to assign the role"
         )
 
+    role_configs = await vc.get_namespace_role_configs()
+
     ns_api_keys = [
         {
             "id": cfg.access_key,
-            "role": Role.ADMIN,
+            "roleId": _find_admin_role_id(role_configs),
         }
     ]
 
-    for ak in api_key:
-        ns_api_keys.append({"id": ak, "role": role})
+    if role:
+        role_id = _find_role_id(role_configs, role)
+        for ak in api_key:
+            ns_api_keys.append({"id": ak, "roleId": role_id})
 
-    ns_members = []
-    for m in member:
-        ns_members.append({"id": m, "role": role})
+        ns_members = [{"id": m, "roleId": role_id} for m in member]
+    else:
+        ns_members = []
 
     namespaces = await vc.create_namespace(
         namespace_id=identifier,
@@ -101,12 +125,16 @@ async def create(
     )
 
 
-@app.async_command(help="[red][bold]BETA[/bold][/red] Update a namespace")
+@app.async_command(help="Update a namespace")
 async def update(
     config_dir: str = ConfigDir,
     output_format: OutputFormat = OutputFormatOption,
     identifier: str = typer.Argument(..., help="Namespace name"),
-    role: Role = typer.Option(None, help="The role to assign --api-key and --member"),
+    role: str = typer.Option(
+        None,
+        click_type=RoleSuggestion(),
+        help="The role to assign --api-key and --member",
+    ),
     api_key: list[str] = typer.Option(
         [],
         "--api-key",
@@ -128,13 +156,16 @@ async def update(
             "--role is specified but no --member or --api-key to assign the role"
         )
 
-    ns_api_keys = []
-    for ak in api_key:
-        ns_api_keys.append({"id": ak, "role": role})
+    role_configs = await vc.get_namespace_role_configs()
+    ns_api_keys, ns_members = [], []
 
-    ns_members = []
-    for m in member:
-        ns_members.append({"id": m, "role": role})
+    if role:
+        role_id = _find_role_id(role_configs, role)
+        for ak in api_key:
+            ns_api_keys.append({"id": ak, "roleId": role_id})
+
+        for m in member:
+            ns_members.append({"id": m, "roleId": role_id})
 
     namespace = await vc.get_namespaces(identifier)
     if namespace is None:
@@ -144,15 +175,21 @@ async def update(
         raise ValidioError("failed to get namespace")
 
     api_keys = [
-        {"id": x["apiKey"]["id"], "role": x["role"]}
-        for x in namespace.get("apiKeys", {})
-        if x["apiKey"]["id"] not in api_key
+        {
+            "id": ns_roles["apiKey"]["id"],
+            "roleId": _find_role_id(role_configs, ns_roles["role"]),
+        }
+        for ns_roles in namespace.get("apiKeys", {})
+        if ns_roles["apiKey"]["id"] not in api_key
     ] + ns_api_keys
 
     members = [
-        {"id": x["user"]["id"], "role": x["role"]}
-        for x in namespace["members"]
-        if x["user"]["id"] not in member
+        {
+            "id": ns_roles["user"]["id"],
+            "roleId": _find_role_id(role_configs, ns_roles["role"]),
+        }
+        for ns_roles in namespace["members"]
+        if ns_roles["user"]["id"] not in member
     ] + ns_members
 
     namespaces = await vc.update_namespace_roles(
@@ -194,3 +231,19 @@ async def remove(
             "status": OutputSettings(pass_full_object=True, reformat=lambda _: status),
         },
     )
+
+
+def _find_role_id(role_configs: list[dict[str, Any]], role_name: str) -> str:
+    for rc in role_configs:
+        if rc["name"].upper() == role_name.upper():
+            return rc["id"]
+
+    raise ValidioError(f"role '{role_name}' not found")
+
+
+def _find_admin_role_id(role_configs: list[dict[str, Any]]) -> str:
+    for rc in role_configs:
+        if rc.get("isSystemRole") and rc["name"] == "Admin":
+            return rc["id"]
+
+    raise ValidioError("could not find system Admin role for namespace")