validio-cli 0.14.0__tar.gz → 0.16.0__tar.gz

{validio_cli-0.14.0 → validio_cli-0.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validio-cli
-Version: 0.14.0
+Version: 0.16.0
 Summary: CLI tool to interact with the Validio platform
 Home-page: https://validio.io/
 License: Apache-2.0
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: camel-converter (>=3.0.0,<4.0.0)
-Requires-Dist: classdiff (>=0.3.0,<0.4.0)
+Requires-Dist: classdiff (==0.4.0)
 Requires-Dist: prompt-toolkit (>=3.0.38,<4.0.0)
 Requires-Dist: pydantic (==2.4.2)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)

{validio_cli-0.14.0 → validio_cli-0.16.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.14.0"
+version = "0.16.0"
 description = "CLI tool to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"
@@ -15,7 +15,7 @@ readme = "README_PUBLIC.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 camel-converter = "^3.0.0"
-classdiff = "^0.3.0"
+classdiff = "0.4.0"
 validio-sdk = "*"
 typer = { extras = ["all"], version = "^0.7.0" }
 prompt-toolkit = "^3.0.38"

{validio_cli-0.14.0 → validio_cli-0.16.0}/validio_cli/bin/entities/code.py

@@ -426,16 +426,25 @@ def _show_update_resource_diff(
     diff_output: DiffOutput,
 ) -> None:
     for r in resources.values():
-        class_key = r.manifest.resource.__class__.__name__
+        class_key = r.manifest.__class__.__name__
 
-        print(f"{class_key} '{r.manifest.resource.name}' will be updated")
+        print(f"{class_key} '{r.manifest.name}' will be updated")
 
         rewrites = _diff_field_rewrites(show_schema)
+
         a_value = code_plan._create_resource_diff_object(
-            r.manifest.resource, show_secrets=show_secrets, rewrites=rewrites
+            r.manifest,
+            show_secrets=show_secrets,
+            rewrites=rewrites,
+            secrets_changed=r.secrets_changed,
+            is_manifest=True,
         )
         b_value = code_plan._create_resource_diff_object(
-            r.server.resource, show_secrets=show_secrets, rewrites=rewrites
+            r.server,
+            show_secrets=show_secrets,
+            rewrites=rewrites,
+            secrets_changed=r.secrets_changed,
+            is_manifest=False,
         )
 
         _show_diff(b_value, a_value, color, diff_output, class_key)

{validio_cli-0.14.0 → validio_cli-0.16.0}/validio_cli/bin/entities/config.py

@@ -77,6 +77,7 @@ def ns(
 def get(
     config_dir: str = ConfigDir,
     output_format: OutputFormat = OutputFormatOption,
+    show_secrets: bool = False,
 ) -> None:
     config_path = Path(config_dir) if config_dir is not None else None
 
@@ -109,7 +110,9 @@ def get(
         "default_namespace": validio_config.default_namespace,
         "endpoint": validio_config.endpoint,
         "access_key": validio_config.access_key,
-        "access_secret": validio_config.access_secret,
+        "access_secret": validio_config._access_secret
+        if show_secrets
+        else validio_config.access_secret,
     }
 
     if output_format == OutputFormat.JSON:

validio_cli-0.16.0/validio_cli/bin/entities/dbt.py

@@ -0,0 +1,120 @@
+import typing
+from pathlib import Path
+from typing import Any, Optional, Tuple
+
+import typer
+from validio_sdk import ValidioError, dbt, util
+
+from validio_cli import AsyncTyper, ConfigDir, Namespace, get_client_and_config
+from validio_cli.bin.entities import credentials
+
+app = AsyncTyper(help="dbt related commands")
+
+"""
+Well-known file name for the manifest artifact.
+
+https://docs.getdbt.com/reference/artifacts/dbt-artifacts
+"""
+MANIFEST_FILE_NAME = "manifest.json"
+
+"""
+Well-known file name for the run-results artifact.
+
+https://docs.getdbt.com/reference/artifacts/dbt-artifacts
+"""
+RUN_RESULTS_FILE_NAME = "run_results.json"
+
+
+def _resolve_file_paths(
+    explicit_manifest_path: Optional[Path],
+    explicit_run_result_path: Optional[Path],
+    target_path: Optional[Path],
+) -> Tuple[Path, Optional[Path]]:
+    if explicit_manifest_path or explicit_run_result_path:
+        print(
+            "Deprecation notice ⚠️: The --manifest and --run-results flags "
+            "have been deprecated and will be removed in a future version. "
+            "Please use the --target-path argument instead."
+        )
+        if not explicit_manifest_path:
+            raise ValidioError(
+                "--manifest is required when combined with the --run-results argument"
+            )
+
+        return explicit_manifest_path, explicit_run_result_path
+
+    if not target_path:
+        raise ValidioError("Missing --target-path argument")
+
+    manifest_path = target_path / MANIFEST_FILE_NAME
+    run_results_path = target_path / RUN_RESULTS_FILE_NAME
+    if not manifest_path.is_file():
+        raise ValidioError(f"manifest file not found at {manifest_path}")
+
+    if not run_results_path.is_file():
+        print(
+            "Warning: run_results file not found at {run_results_path}. "
+            "Uploading only manifest file"
+        )
+        return manifest_path, None
+
+    return manifest_path, run_results_path
+
+
+@app.async_command(help="Upload dbt artifact")
+async def upload(
+    config_dir: str = ConfigDir,
+    namespace: str = Namespace(),
+    credential_id: str = typer.Option(..., help="Credential name or ID"),
+    manifest: Optional[Path] = typer.Option(
+        help="Path to the manifest file. "
+        "(deprecated in favor of the --target-path flag)",
+        default=None,
+    ),
+    job_name: str = typer.Option(
+        ..., help="The job that the dbt execution belongs to, e.g. `staging-pipeline`"
+    ),
+    run_results: Optional[Path] = typer.Option(
+        help="Path to the run results file. "
+        "(deprecated in favor of the --target-path flag)",
+        default=None,
+    ),
+    target_path: Optional[Path] = typer.Option(
+        help="Path to the dbt artifacts target directory. "
+        "(supersedes the --manifest flag)",
+        default=None,
+    ),
+) -> None:
+    vc, cfg = await get_client_and_config(config_dir)
+
+    resolved_credential_id = await credentials.get_credential_id(
+        vc, cfg, credential_id, namespace
+    )
+    if resolved_credential_id is None:
+        raise ValidioError(f"Credential '{credential_id}' not found")
+
+    manifest, run_results = _resolve_file_paths(manifest, run_results, target_path)
+
+    run_results_content = None
+    try:
+        manifest_content = typing.cast(dict[str, Any], util.read_json_file(manifest))
+        if run_results is not None:
+            run_results_content = typing.cast(
+                dict[str, Any],
+                util.read_json_file(run_results),
+            )
+    except Exception as e:
+        raise ValidioError(f"Failed to process artifacts file: {e}")
+
+    await dbt.upload_artifacts(
+        client=vc,
+        credential_id=resolved_credential_id,
+        job_name=job_name,
+        manifest=manifest_content,
+        run_results=run_results_content,
+    )
+    return print("dbt artifact uploaded successfully")
+
+
+if __name__ == "__main__":
+    typer.run(app())

validio_cli-0.16.0/validio_cli/bin/entities/incidents.py

@@ -0,0 +1,155 @@
+from datetime import datetime, timedelta
+from typing import Any
+
+import typer
+from validio_sdk import ValidioError
+from validio_sdk.graphql_client import (
+    GetSourceIncidentsSource,
+    GetValidatorIncidentsValidator,
+)
+from validio_sdk.graphql_client.input_types import TimeRangeInput
+
+from validio_cli import (
+    AsyncTyper,
+    ConfigDir,
+    Namespace,
+    OutputFormat,
+    OutputFormatOption,
+    OutputSettings,
+    _format_relative_time,
+    get_client_and_config,
+    output_json,
+    output_text,
+)
+from validio_cli.bin.entities import sources, validators
+
+app = AsyncTyper(help="Incidents from validators")
+
+
+@app.async_command(
+    help="""List all incidents.
+
+By default you will get incidents from the last hour. You can specify a time
+range for when the incident occurred by specifying when the incident ended.
+
+You can list incidents in different ways:
+
+* Listing all incidents
+
+* Listing all source incidents for a specific source with --source
+
+* Listing all incidents for a specific validator with --validator
+
+* Listing all incidents for a specific segment with --segment
+
+* Listing all incidents for a specific validator and segment with --validator
+and --segment together
+"""
+)
+async def get(
+    config_dir: str = ConfigDir,
+    output_format: OutputFormat = OutputFormatOption,
+    namespace: str = Namespace(),
+    ended_before: datetime = typer.Option(
+        datetime.utcnow(),
+        help="The incident ended before this timestamp",
+    ),
+    ended_after: datetime = typer.Option(
+        (datetime.utcnow() - timedelta(hours=1)),
+        help="The incident ended after this timestamp",
+    ),
+    validator: str = typer.Option(None, help="Validator to fetch incidents for"),
+    segment: str = typer.Option(None, help="Segment to fetch incidents for"),
+    source: str = typer.Option(None, help="Source to fetch incidents for"),
+) -> None:
+    vc, cfg = await get_client_and_config(config_dir)
+
+    if validator is not None:
+        validator_id = await validators.get_validator_id(vc, cfg, validator, namespace)
+        if validator_id is None:
+            return None
+
+    if source is not None:
+        source_id = await sources.get_source_id(vc, cfg, source, namespace)
+        if source_id is None:
+            return None
+
+    # TODO(UI-2006): These should all support namespace
+
+    incidents: (None | GetValidatorIncidentsValidator | GetSourceIncidentsSource) = None
+
+    if validator:
+        incidents = await vc.get_validator_incidents(
+            id=validator_id,
+            range=TimeRangeInput(
+                start=ended_after,
+                end=ended_before,
+            ),
+            segment_id=segment,
+        )
+    elif source:
+        incidents = await vc.get_source_incidents(
+            id=source_id,
+            range=TimeRangeInput(
+                start=ended_after,
+                end=ended_before,
+            ),
+        )
+    else:
+        raise ValidioError(
+            "You need to specify one of --validator and/or --segment or --source"
+        )
+
+    if not incidents:
+        return output_text(None, {})
+
+    if output_format == OutputFormat.JSON:
+        return output_json(incidents)
+
+    return output_text(
+        incidents.incidents,
+        fields={
+            "operator": OutputSettings(
+                attribute_name="metric",
+                reformat=calculate_operator,
+            ),
+            "bound": OutputSettings(
+                attribute_name="metric",
+                reformat=calculate_bound,
+            ),
+            "value": OutputSettings(
+                attribute_name="metric",
+                reformat=lambda x: x.value,
+            ),
+            "age": OutputSettings(
+                attribute_name="metric",
+                reformat=lambda x: _format_relative_time(x.end_time),
+            ),
+        },
+    )
+
+
+def calculate_operator(item: Any) -> str:
+    type_ = item.typename__[len("ValidatorMetricWith") :]
+    if type_ == "DynamicThreshold":
+        operator = item.decision_bounds_type
+    else:
+        operator = item.operator
+
+    return f"{type_}/{operator}"
+
+
+def calculate_bound(item: Any) -> str:
+    type_ = item.typename__[len("ValidatorMetricWith") :]
+    if type_ == "DynamicThreshold":
+        bound = f"{item.lower_bound:.2f} - {item.upper_bound:.2f}"
+    elif type_ == "FixedThreshold":
+        bound = item.bound
+    else:
+        bound = "-"
+
+    return bound
+
+
+if __name__ == "__main__":
+    typer.run(app())

{validio_cli-0.14.0 → validio_cli-0.16.0}/validio_cli/bin/entities/notification_rules.py

@@ -28,9 +28,6 @@ async def get(
     output_format: OutputFormat = OutputFormatOption,
     namespace: str = Namespace(),
     identifier: str = Identifier,
-    source: str = typer.Option(
-        None, help="List notification rules for this source (ID)"
-    ),
 ) -> None:
     vc, cfg = await get_client_and_config(config_dir)
 
@@ -46,12 +43,6 @@ async def get(
             filter=ResourceFilter(resource_namespace=get_namespace(namespace, cfg))
         )
 
-    notification_rules = [
-        nr
-        for nr in notification_rules
-        if source is None or (nr is not None and source in nr.sources)
-    ]
-
     # TODO(UI-2311): Fully support list/get/get_by_resource_name
     notification_rules = _single_resource_if_specified(notification_rules, identifier)
 

validio_cli-0.14.0/validio_cli/bin/entities/dbt.py

@@ -1,55 +0,0 @@
-import json
-import typing
-from pathlib import Path
-from typing import Any
-
-import typer
-from validio_sdk import ValidioError, dbt, util
-from validio_sdk.graphql_client.input_types import DbtArtifactUploadInput
-
-from validio_cli import AsyncTyper, ConfigDir, Namespace, get_client_and_config
-from validio_cli.bin.entities import credentials
-
-app = AsyncTyper(help="dbt related commands")
-
-
-@app.async_command(help="Upload dbt artifact")
-async def upload(
-    config_dir: str = ConfigDir,
-    namespace: str = Namespace(),
-    credential_id: str = typer.Option(..., help="Credential name or ID"),
-    manifest: Path = typer.Option(..., help="Path to the manifest file"),
-    run_results: Path = typer.Option(help="Path to the run results file", default=None),
-) -> None:
-    vc, cfg = await get_client_and_config(config_dir)
-
-    resolved_credential_id = await credentials.get_credential_id(
-        vc, cfg, credential_id, namespace
-    )
-    if resolved_credential_id is None:
-        raise ValidioError(f"Credential '{credential_id}' not found")
-
-    try:
-        manifest_content = util.read_json_file(manifest)
-        trimmed_manifest = dbt.trim_manifest_json(
-            typing.cast(dict[str, Any], manifest_content)
-        )
-    except Exception as e:
-        raise ValidioError(f"Failed to process manifest file: {e}")
-
-    run_results_content = None
-    if run_results is not None:
-        run_results_content = json.dumps(util.read_json_file(run_results))
-
-    await vc.dbt_artifact_upload(
-        input=DbtArtifactUploadInput(
-            credential_id=resolved_credential_id,
-            manifest=json.dumps(trimmed_manifest),
-            run_results=run_results_content,
-        )
-    )
-    return print("dbt artifact uploaded successfully")
-
-
-if __name__ == "__main__":
-    typer.run(app())

validio_cli-0.14.0/validio_cli/bin/entities/incidents.py

@@ -1,256 +0,0 @@
-from dataclasses import dataclass
-from datetime import datetime, timedelta
-from typing import Any
-
-import typer
-from validio_sdk import ValidioError
-from validio_sdk.graphql_client import (
-    GetSegmentIncidentsSegmentIncidents,
-    GetSourceIncidentsSourceIncidentsSegmentLimitExceededNotification,
-    GetValidatorIncidentsValidatorIncidents,
-    GetValidatorSegmentIncidentsValidatorSegmentIncidents,
-)
-from validio_sdk.graphql_client.input_types import (
-    SegmentIncidentsInput,
-    SourceIncidentsInput,
-    TimeRangeInput,
-    ValidatorIncidentsInput,
-    ValidatorSegmentIncidentsInput,
-)
-
-from validio_cli import (
-    AsyncTyper,
-    ConfigDir,
-    Namespace,
-    OutputFormat,
-    OutputFormatOption,
-    OutputSettings,
-    _format_relative_time,
-    get_client_and_config,
-    output_json,
-    output_text,
-)
-from validio_cli.bin.entities import sources, validators
-
-app = AsyncTyper(help="Incidents from validators")
-
-
-@app.async_command(
-    help="""List all incidents.
-
-By default you will get incidents from the last hour. You can specify a time
-range for when the incident occurred by specifying when the incident ended.
-
-You can list incidents in different ways:
-
-* Listing all incidents
-
-* Listing all source incidents for a specific source with --source
-
-* Listing all incidents for a specific validator with --validator
-
-* Listing all incidents for a specific segment with --segment
-
-* Listing all incidents for a specific validator and segment with --validator
-and --segment together
-"""
-)
-async def get(
-    config_dir: str = ConfigDir,
-    output_format: OutputFormat = OutputFormatOption,
-    namespace: str = Namespace(),
-    ended_before: datetime = typer.Option(
-        datetime.utcnow(),
-        help="The incident ended before this timestamp",
-    ),
-    ended_after: datetime = typer.Option(
-        (datetime.utcnow() - timedelta(hours=1)),
-        help="The incident ended after this timestamp",
-    ),
-    validator: str = typer.Option(None, help="Validator to fetch incidents for"),
-    segment: str = typer.Option(None, help="Segment to fetch incidents for"),
-    source: str = typer.Option(None, help="Source to fetch incidents for"),
-) -> None:
-    vc, cfg = await get_client_and_config(config_dir)
-
-    if validator is not None:
-        validator_id = await validators.get_validator_id(vc, cfg, validator, namespace)
-        if validator_id is None:
-            return None
-
-    if source is not None:
-        source_id = await sources.get_source_id(vc, cfg, source, namespace)
-        if source_id is None:
-            return None
-
-    # TODO(UI-2006): These should all support namespace
-
-    incidents: (
-        None
-        | list[GetValidatorIncidentsValidatorIncidents]
-        | list[GetValidatorSegmentIncidentsValidatorSegmentIncidents]
-        | list[GetSegmentIncidentsSegmentIncidents]
-    ) = None
-
-    if validator and segment:
-        incidents = await vc.get_validator_segment_incidents(
-            ValidatorSegmentIncidentsInput(
-                time_range=TimeRangeInput(
-                    start=ended_after,
-                    end=ended_before,
-                ),
-                validator_id=validator_id,
-                segment_id=segment,
-            )
-        )
-    elif validator:
-        incidents = await vc.get_validator_incidents(
-            ValidatorIncidentsInput(
-                time_range=TimeRangeInput(
-                    start=ended_after,
-                    end=ended_before,
-                ),
-                validator_id=validator_id,
-            )
-        )
-    elif segment:
-        incidents = await vc.get_segment_incidents(
-            SegmentIncidentsInput(
-                time_range=TimeRangeInput(
-                    start=ended_after,
-                    end=ended_before,
-                ),
-                segment_id=segment,
-            )
-        )
-    elif source:
-        # Since source incidents looks completely different we hand them off to
-        # a separate function, we can't re-use any of the rendering.
-        return _output_text_source_incidents(
-            output_format,
-            await vc.get_source_incidents(
-                SourceIncidentsInput(
-                    time_range=TimeRangeInput(
-                        start=ended_after,
-                        end=ended_before,
-                    ),
-                    source_id=source_id,
-                )
-            ),
-        )
-    else:
-        raise ValidioError(
-            "You need to specify one of --validator and/or --segment or --source"
-        )
-
-    if output_format == OutputFormat.JSON:
-        return output_json(incidents)
-
-    return output_text(
-        incidents,
-        fields={
-            "operator": OutputSettings(
-                attribute_name="metric",
-                reformat=calculate_operator,
-            ),
-            "bound": OutputSettings(
-                attribute_name="metric",
-                reformat=calculate_bound,
-            ),
-            "value": OutputSettings(
-                attribute_name="metric",
-                reformat=lambda x: x.value,
-            ),
-            "age": OutputSettings(
-                attribute_name="metric",
-                reformat=lambda x: _format_relative_time(x.end_time),
-            ),
-        },
-    )
-
-
-def _output_text_source_incidents(
-    output_format: OutputFormat, incidents: list[Any]
-) -> None:
-    if output_format == OutputFormat.JSON:
-        return output_json(incidents)
-
-    @dataclass
-    class SchemaChange:
-        field: str
-        change_type: str
-        old_value: str
-        new_value: str
-
-    change_type_to_key = {
-        "Nullability": "nullable",
-        "JtdType": "type",
-        "UnderlyingType": "underlying_type",
-    }
-
-    changes = []
-    for item in incidents:
-        # TODO: We only show schema changes for now
-        if item.typename__ != "SchemaChangeNotification":
-            continue
-
-        for field, field_changes in item.payload.items():
-            for ct in field_changes["change_types"]:
-                k = change_type_to_key.get(ct)
-
-                changes.append(
-                    SchemaChange(
-                        field=field,
-                        change_type=ct,
-                        old_value=field_changes["old"][k] if k else "-",
-                        new_value=field_changes["new"][k] if k else "-",
-                    )
-                )
-
-    return output_text(
-        changes,
-        fields={
-            "field": None,
-            "change_type": None,
-            "old_value": None,
-            "new_value": None,
-        },
-    )
-
-
-def calculate_operator(item: Any) -> str:
-    type_ = item.typename__[len("ValidatorMetricWith") :]
-    if type_ == "DynamicThreshold":
-        operator = item.decision_bounds_type
-    else:
-        operator = item.operator
-
-    return f"{type_}/{operator}"
-
-
-def calculate_bound(item: Any) -> str:
-    type_ = item.typename__[len("ValidatorMetricWith") :]
-    if type_ == "DynamicThreshold":
-        bound = f"{item.lower_bound:.2f} - {item.upper_bound:.2f}"
-    elif type_ == "FixedThreshold":
-        bound = item.bound
-    else:
-        bound = "-"
-
-    return bound
-
-
-def _output_text_source_incidents_segment_limit_exceeded(
-    incidents: list[GetSourceIncidentsSourceIncidentsSegmentLimitExceededNotification],
-) -> None:
-    return output_text(
-        incidents,
-        fields={
-            "limit": None,
-            "age": OutputSettings(attribute_name="created_at"),
-        },
-    )
-
-
-if __name__ == "__main__":
-    typer.run(app())