pglift-cli 1.3.1__tar.gz → 1.4.0__tar.gz

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pglift_cli
-Version: 1.3.1
+Version: 1.4.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/database.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import functools
 from collections.abc import Sequence
 from pathlib import Path
-from typing import IO, Any
+from typing import Any
 
 import click
 import psycopg
@@ -19,11 +19,13 @@ from pglift.models import interface, system
 from . import model
 from .util import (
     Group,
+    ManifestData,
     Obj,
     OutputFormat,
     async_command,
     dry_run_option,
     instance_identifier_option,
+    manifest_option,
     model_dump,
     output_format_option,
     pass_instance,
@@ -93,7 +95,7 @@ async def alter(
 
 
 @cli.command("apply", hidden=True)
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @pass_instance
@@ -102,12 +104,12 @@ async def alter(
 async def apply(
     obj: Obj,
     instance: system.Instance,
-    file: IO[str],
+    data: ManifestData,
     output_format: OutputFormat,
     dry_run: bool,
 ) -> None:
     """Apply manifest as a database"""
-    database = interface.Database.parse_yaml(file)
+    database = interface.Database.model_validate(data)
     if dry_run:
         ret = interface.ApplyResult(change_state=None)
     else:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/instance.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import os
 from collections.abc import Sequence
 from functools import partial
-from typing import IO, Any
+from typing import Any
 
 import click
 from pydantic.v1.utils import deep_update
@@ -23,12 +23,13 @@ from pglift import (
 )
 from pglift.models import interface, system
 from pglift.settings._postgresql import PostgreSQLVersion
-from pglift.types import Status
+from pglift.types import Status, validation_context
 
 from . import _site
 from . import hookspecs as h
 from . import model
 from .util import (
+    ManifestData,
     Obj,
     OutputFormat,
     PluggableCommandGroup,
@@ -36,6 +37,7 @@ from .util import (
     dry_run_option,
     foreground_option,
     instance_identifier,
+    manifest_option,
     model_dump,
     output_format_option,
     print_argspec,
@@ -121,23 +123,28 @@ async def alter(obj: Obj, instance: system.Instance, **changes: Any) -> None:
         manifest = await instances._get(instance, status)
         values = manifest.model_dump(by_alias=True, exclude={"settings"})
         values = deep_update(values, changes)
-        altered = _site.INSTANCE_MODEL.model_validate(values)
+        with validation_context({"operation": "update"}):
+            altered = _site.INSTANCE_MODEL.model_validate(values)
         await instances.apply(
             _site.SETTINGS, altered, _is_running=status == Status.running
         )
 
 
 @cli.command("apply", hidden=True)
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @click.pass_obj
 @async_command
 async def apply(
-    obj: Obj, file: IO[str], output_format: OutputFormat, dry_run: bool
+    obj: Obj, data: ManifestData, output_format: OutputFormat, dry_run: bool
 ) -> None:
     """Apply manifest as a PostgreSQL instance"""
-    instance = _site.INSTANCE_MODEL.parse_yaml(file)
+    name, version = data["name"], data.get("version")
+    assert isinstance(version, (str, type(None)))
+    op = "update" if instances.exists(name, version, _site.SETTINGS) else "create"
+    with validation_context({"operation": op}):
+        instance = _site.INSTANCE_MODEL.model_validate(data)
     if dry_run:
         ret = interface.InstanceApplyResult(change_state=None)
     else:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/model.py

@@ -20,10 +20,15 @@ import pydantic
 from pydantic.fields import FieldInfo
 from pydantic.v1.utils import deep_update, lenient_issubclass
 
-from pglift import exceptions
 from pglift._compat import zip
-from pglift.models.helpers import Operation, is_optional, optional_type
-from pglift.types import CLIConfig, StrEnum, field_annotation
+from pglift.models.helpers import is_optional, optional_type
+from pglift.types import (
+    CLIConfig,
+    Operation,
+    StrEnum,
+    field_annotation,
+    validation_context,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -94,7 +99,10 @@ def as_parameters(
             @functools.wraps(f)
             def callback(**kwargs: Any) -> Any:
                 args = params_to_modelargs(kwargs)
-                with catch_validationerror(*paramspecs):
+                with (
+                    catch_validationerror(*paramspecs),
+                    validation_context({"operation": operation}),
+                ):
                     model = parse_params_as(model_type, args)
                 kwargs[model_argname] = model
                 return f(**kwargs)
@@ -336,7 +344,7 @@ def choices_from_enum(e: type[enum.Enum]) -> list[Any]:
 def catch_validationerror(*paramspec: ParamSpec) -> Iterator[None]:
     try:
         yield None
-    except (exceptions.ValidationError, pydantic.ValidationError) as e:
+    except pydantic.ValidationError as e:
         errors = e.errors()
         for pspec in paramspec:
             for err in errors:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/pgbackrest/__init__.py

@@ -12,8 +12,9 @@ import click
 
 from pglift import pgbackrest, postgresql, types
 from pglift.models import system
-from pglift.pgbackrest import base, models
+from pglift.pgbackrest import base
 from pglift.pgbackrest import register_if as register_if  # noqa: F401
+from pglift.pgbackrest.models.system import Service
 
 from .. import _site, hookimpl
 from ..util import (
@@ -43,7 +44,7 @@ def pgbackrest_proxy(
     context: click.Context, /, command: tuple[str, ...], **kwargs: Any
 ) -> None:
     """Proxy to pgbackrest operations on an instance"""
-    s = context.obj.instance.service(models.Service)
+    s = context.obj.instance.service(Service)
     settings = pgbackrest.get_settings(_site.SETTINGS)
     cmd_args = base.make_cmd(s.stanza, settings, *command)
     try:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/prometheus.py

@@ -5,23 +5,25 @@
 from __future__ import annotations
 
 from functools import partial
-from typing import IO
 
 import click
 
-from pglift import exceptions, prometheus, task
+from pglift import exceptions, prometheus, task, types
 from pglift.models import interface
-from pglift.prometheus import impl, models
+from pglift.prometheus import impl
 from pglift.prometheus import register_if as register_if  # noqa: F401
+from pglift.prometheus.models.interface import PostgresExporter
 
 from . import _site, hookimpl, model
 from .util import (
     Group,
+    ManifestData,
     Obj,
     OutputFormat,
     async_command,
     dry_run_option,
     foreground_option,
+    manifest_option,
     output_format_option,
     print_argspec,
     print_json_for,
@@ -33,7 +35,7 @@ from .util import (
 @click.option(
     "--schema",
     is_flag=True,
-    callback=partial(print_schema, model=models.PostgresExporter),
+    callback=partial(print_schema, model=PostgresExporter),
     expose_value=False,
     is_eager=True,
     help="Print the JSON schema of postgres_exporter model and exit.",
@@ -41,7 +43,7 @@ from .util import (
 @click.option(
     "--ansible-argspec",
     is_flag=True,
-    callback=partial(print_argspec, model=models.PostgresExporter),
+    callback=partial(print_argspec, model=PostgresExporter),
     expose_value=False,
     is_eager=True,
     hidden=True,
@@ -52,20 +54,23 @@ def cli() -> None:
 
 
 @cli.command("apply")
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @click.pass_obj
 @async_command
 async def apply(
-    obj: Obj, file: IO[str], output_format: OutputFormat, dry_run: bool
+    obj: Obj, data: ManifestData, output_format: OutputFormat, dry_run: bool
 ) -> None:
     """Apply manifest as a Prometheus postgres_exporter."""
-    exporter = models.PostgresExporter.parse_yaml(file)
+    settings = prometheus.get_settings(_site.SETTINGS)
+    name = data["name"]
+    op = "update" if impl.exists(name, settings) else "create"
+    with types.validation_context({"operation": op}):
+        exporter = PostgresExporter.model_validate(data)
     if dry_run:
         ret = interface.ApplyResult(change_state=None)
     else:
-        settings = prometheus.get_settings(_site.SETTINGS)
         with obj.lock:
             ret = await impl.apply(exporter, _site.SETTINGS, settings)
     if output_format == OutputFormat.json:
@@ -73,10 +78,10 @@ async def apply(
 
 
 @cli.command("install")
-@model.as_parameters(models.PostgresExporter, "create")
+@model.as_parameters(PostgresExporter, "create")
 @click.pass_obj
 @async_command
-async def install(obj: Obj, postgresexporter: models.PostgresExporter) -> None:
+async def install(obj: Obj, postgresexporter: PostgresExporter) -> None:
     """Install the service for a (non-local) instance."""
     settings = prometheus.get_settings(_site.SETTINGS)
     with obj.lock:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/role.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 from collections.abc import Sequence
 from functools import partial
-from typing import IO, Any
+from typing import Any
 
 import click
 from pydantic.v1.utils import deep_update
@@ -17,11 +17,13 @@ from pglift.models import interface, system
 from . import _site, model
 from .util import (
     Group,
+    ManifestData,
     Obj,
     OutputFormat,
     async_command,
     dry_run_option,
     instance_identifier_option,
+    manifest_option,
     model_dump,
     output_format_option,
     pass_instance,
@@ -100,7 +102,7 @@ async def alter(
 
 
 @cli.command("apply", hidden=True)
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @pass_instance
@@ -109,12 +111,12 @@ async def alter(
 async def apply(
     obj: Obj,
     instance: system.Instance,
-    file: IO[str],
+    data: ManifestData,
     output_format: OutputFormat,
     dry_run: bool,
 ) -> None:
     """Apply manifest as a role"""
-    role = _site.ROLE_MODEL.parse_yaml(file)
+    role = _site.ROLE_MODEL.model_validate(data)
     if dry_run:
         ret = interface.ApplyResult(change_state=None)
     else:

{pglift_cli-1.3.1 → pglift_cli-1.4.0}/src/pglift_cli/util.py

@@ -17,7 +17,7 @@ import typing
 from collections.abc import Coroutine, Iterable, Iterator, Sequence
 from contextlib import contextmanager
 from functools import cache, cached_property, singledispatch, wraps
-from typing import Any, Callable, TypeVar
+from typing import IO, Any, Callable, TypedDict, TypeVar
 
 import click
 import filelock
@@ -26,6 +26,7 @@ import pydantic
 import pydantic_core
 import rich
 import rich.prompt
+import yaml
 from click.shell_completion import CompletionItem
 from rich.console import Console
 from rich.table import Table
@@ -364,6 +365,35 @@ instance_identifier_option = click.option(
 )
 
 
+def yaml_load(
+    ctx: click.Context, param: click.Parameter, value: IO[str]
+) -> dict[str, Any]:
+    try:
+        data = yaml.safe_load(value)
+    except yaml.YAMLError as e:
+        raise click.BadParameter(f"invalid YAML: {e}") from e
+    if not isinstance(data, dict):
+        raise click.BadParameter(f"invalid YAML: expecting an object, got {type(data)}")
+    if "name" not in data:
+        raise click.BadParameter("invalid YAML: missing required 'name' field")
+    return data
+
+
+manifest_option = click.option(
+    "-f",
+    "--file",
+    "data",
+    type=click.File("r"),
+    metavar="MANIFEST",
+    required=True,
+    callback=yaml_load,
+)
+
+
+class ManifestData(TypedDict, total=False):
+    name: str
+
+
 class OutputFormat(AutoStrEnum):
     """Output format"""
 
@@ -517,7 +547,7 @@ class Command(click.Command):
             except exceptions.Cancelled as e:
                 logger.warning(str(e))
                 raise click.Abort from None
-            except (exceptions.ValidationError, pydantic.ValidationError) as e:
+            except pydantic.ValidationError as e:
                 raise click.ClickException(str(e)) from None
             except exceptions.Error as e:
                 logger.debug("an internal error occurred", exc_info=obj.debug)
@@ -529,7 +559,12 @@ class Command(click.Command):
                         msg += f"\n{e.stdout}"
                 raise click.ClickException(msg) from None
             except psycopg.DatabaseError as e:
-                logger.debug("a database error occurred", exc_info=True)
+                logger.debug(
+                    "a database error occurred: %s (SQLSTATE=%s)",
+                    e,
+                    e.sqlstate,
+                    exc_info=obj.debug,
+                )
                 raise click.ClickException(str(e).strip()) from None