pglift-cli 2.2.0__tar.gz → 2.4.0__tar.gz

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 2.2.0
+Version: 2.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-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/database.py

@@ -155,7 +155,9 @@ async def get(
     if output_format == "json":
         print_json_for(model_dump(db))
     else:
-        print_table_for([db], functools.partial(model_dump, mode="pretty"), box=None)
+        print_table_for(
+            [db], functools.partial(model_dump, context={"pretty": True}), box=None
+        )
 
 
 @cli.command("list")

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/instance.py

@@ -275,7 +275,9 @@ async def get(instance: Instance, output_format: OutputFormat | None) -> None:
         if not instance.postgresql.standby:
             exclude.add("standby")
         print_table_for(
-            [i], partial(model_dump, exclude=exclude, mode="pretty"), box=None
+            [i],
+            partial(model_dump, exclude=exclude, context={"pretty": True}),
+            box=None,
         )
 
 

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/model.py

@@ -17,8 +17,10 @@ import click
 import pydantic
 from pydantic.fields import FieldInfo
 from pydantic.v1.utils import deep_update, lenient_issubclass
+from pydantic_core import ErrorDetails
 
 from pglift.annotations import cli
+from pglift.exceptions import MutuallyExclusiveError
 from pglift.models.helpers import is_optional, optional_type
 from pglift.models.interface import PresenceState
 from pglift.types import (
@@ -54,7 +56,7 @@ def as_parameters(model_type: ModelType, operation: Operation) -> ClickDecorator
             for modelname, argname in modelnames_and_argnames:
                 value = kwargs.pop(argname)
                 if value is DEFAULT:
-                    continue
+                    continue  # ignore unset or set with default value parameters
                 args[modelname] = value
             return args
 
@@ -165,7 +167,11 @@ class ParamSpec(ABC):
     loc: tuple[str, ...]
     description: str | None = None
 
-    objtype: ClassVar = click.Parameter
+    objtype: ClassVar[type[click.Parameter]] = click.Parameter
+
+    @property
+    def param(self) -> click.Parameter:
+        return self.objtype(self.param_decls, **self.attrs)
 
     @property
     @abstractmethod
@@ -179,9 +185,7 @@ class ParamSpec(ABC):
         return self.loc == loc
 
     def badparameter_exception(self, message: str) -> click.BadParameter:
-        return click.BadParameter(
-            message, None, param=self.objtype(self.param_decls, **self.attrs)
-        )
+        return click.BadParameter(message, None, param=self.param)
 
 
 class ArgumentSpec(ParamSpec):
@@ -226,6 +230,50 @@ class _Parent:
     required: bool
 
 
+def is_editable(ftype: Any) -> bool:
+    """Determine whether a given type is considered "editable".
+
+    A type is considered editable if:
+
+    - It is a subclass of pydantic.BaseModel.
+    - It has a type hint for a field named "state" of type PresenceState.
+
+    This function also handles types wrapped with typing.Annotated,
+    automatically extracting the underlying type for the check.
+
+    >>> class Editable(pydantic.BaseModel):
+    ...     state: typing.Annotated[PresenceState, object()]
+    >>>
+    >>> is_editable(Editable)
+    True
+    >>> class AlsoEditable(pydantic.BaseModel):
+    ...     state: typing.Annotated[typing.Annotated[PresenceState, object()], object()]
+    >>>
+    >>> is_editable(AlsoEditable)
+    True
+    >>>
+    >>> class EditableNotAnnotated(pydantic.BaseModel):
+    ...     state: PresenceState
+    >>>
+    >>> is_editable(EditableNotAnnotated)
+    True
+    >>> class NotEditable(pydantic.BaseModel):
+    ...     state: typing.Annotated[typing.Annotated[str, object()], object()]
+    >>>
+    >>> is_editable(NotEditable)
+    False
+    """
+    # Check if there's a "state" field (PresenceState type)
+    if typing.get_origin(ftype) is typing.Annotated:
+        ftype = typing.get_args(ftype)[0]
+        assert ftype is not None
+    hints = typing.get_type_hints(ftype)
+    return (
+        lenient_issubclass(ftype, pydantic.BaseModel)
+        and hints.get("state") is PresenceState
+    )
+
+
 def _paramspecs_from_model(
     model_type: ModelType,
     operation: Operation,
@@ -237,11 +285,18 @@ def _paramspecs_from_model(
     """
 
     def default(_ctx: click.Context, param: click.Argument, value: Any) -> Any:
+        """This function is intended to distinguish parameters that were
+        explicitly provided by the user versus those that were omitted (or
+        explicitly provided with value equal to the default).
+
+        If the parameter value is unset (or equal to the default value), it
+        returns DEFAULT instead of the raw value.
+        """
         if (param.multiple and value == ()) or (value == param.default):
             return DEFAULT
         return value
 
-    def update_callback(
+    def add_state_field_callback(
         ctx: click.Context,
         _param: click.Argument,
         value: Any,
@@ -250,6 +305,20 @@ def _paramspecs_from_model(
         key: str = "name",
         remove: bool = False,
     ) -> None:
+        """Callback that appends each value to ctx.params[optname] as a dictionary
+        with the specified key and a "state" field, set to either "present" or
+        "absent" depending on the remove argument.
+
+
+         Example, --add-user alice --add-user bob --remove-user carol will
+         result to:
+
+         ctx.params["user"] = (
+                    {"name": "alice", "state": "present"},
+                    {"name": "bob", "state": "present"},
+                    {"name": "carol", "state": "absent"},
+        )
+        """
         if optname not in ctx.params:
             ctx.params[optname] = ()
         ctx.params[optname] += tuple(
@@ -257,17 +326,6 @@ def _paramspecs_from_model(
         )
         return
 
-    def is_editable(ftype: Any) -> bool:
-        # Check if there's a "state" field (PresenceState type)
-        if typing.get_origin(ftype) is typing.Annotated:
-            ftype = typing.get_args(ftype)[0]
-            assert ftype is not None
-        return (
-            lenient_issubclass(ftype, pydantic.BaseModel)
-            and "state" in ftype.model_fields
-            and ftype.model_fields["state"].annotation is PresenceState
-        )
-
     for fname, field in model_type.model_fields.items():
         if field_annotation(field, cli.Hidden):
             continue
@@ -381,7 +439,7 @@ def _paramspecs_from_model(
                             field,
                             {
                                 "callback": functools.partial(
-                                    update_callback,
+                                    add_state_field_callback,
                                     optname=modelname,
                                     key=config.item_key,
                                 ),
@@ -399,7 +457,7 @@ def _paramspecs_from_model(
                             field,
                             {
                                 "callback": functools.partial(
-                                    update_callback,
+                                    add_state_field_callback,
                                     optname=modelname,
                                     remove=True,
                                     key=config.item_key,
@@ -447,15 +505,42 @@ def _paramspecs_from_model(
             )
 
 
+def fieldname_and_options(*paramspec: ParamSpec) -> dict[str, str]:
+    """Return a mapping between model field name and corresponding CLI options."""
+    r: dict[str, str] = {}
+    for pspec in paramspec:
+        param = pspec.param
+        assert param.name
+        r[param.name] = ", ".join(param.opts)
+    return r
+
+
+def format_error_message(error: ErrorDetails, *paramspec: ParamSpec) -> str:
+    """Format templated error message"""
+    try:
+        ctx_error = error["ctx"]["error"]
+    except KeyError:
+        return error["msg"]
+    if isinstance(ctx_error, MutuallyExclusiveError):
+        options = fieldname_and_options(*paramspec)
+        return ctx_error.format(options)
+    return str(ctx_error)
+
+
 @contextmanager
 def catch_validationerror(*paramspec: ParamSpec) -> Iterator[None]:
     try:
         yield None
     except pydantic.ValidationError as e:
         errors = e.errors()
+        for err in errors:
+            if not err.get("loc"):
+                raise click.UsageError(format_error_message(err, *paramspec)) from None
         for pspec in paramspec:
             for err in errors:
                 if pspec.match_loc(err["loc"]):
-                    raise pspec.badparameter_exception(err["msg"]) from None
+                    raise pspec.badparameter_exception(
+                        format_error_message(err, *paramspec)
+                    ) from None
         logger.debug("a validation error occurred", exc_info=True)
         raise click.ClickException(str(e)) from None

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/pgconf.py

@@ -10,7 +10,7 @@ from typing import Any
 import click
 import pgtoolkit.conf
 
-from pglift import h, hook, instances, manager, postgresql
+from pglift import instances, manager, postgresql
 from pglift.models import Instance, PostgreSQLInstance
 from pglift.types import ConfigChanges, Status
 
@@ -153,9 +153,8 @@ async def edit(obj: Obj, instance: Instance) -> None:
     """Edit managed configuration."""
     pg_instance = instance.postgresql
     with obj.lock, audit():
-        actual_config = hook(
-            instance._settings, h.postgresql_editable_conf, instance=pg_instance
-        )
+        with manager.from_instance(pg_instance):
+            actual_config = instances.postgresql_editable_conf(pg_instance)
         edited = click.edit(text=actual_config)
         if edited is None:
             click.echo("no change", err=True)

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/pghba.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 from typing import Any
 
 import click
+from pgtoolkit.hba import parse as parse_hba
 
 from pglift import diff, hba, manager
 from pglift.models import PostgreSQLInstance, interface
@@ -16,6 +17,7 @@ from .console import console
 from .util import (
     Group,
     Obj,
+    async_command,
     audit,
     diff_options,
     dry_run_option,
@@ -38,7 +40,8 @@ def cli(**kwargs: Any) -> None:
 @diff_options["unified"]
 @diff_options["ansible"]
 @click.pass_obj
-def add(
+@async_command
+async def add(
     obj: Obj,
     instance: PostgreSQLInstance,
     hbarecord: interface.HbaRecord,
@@ -56,7 +59,7 @@ def add(
         system_configure(dry_run=dry_run),
         manager.from_instance(instance),
     ):
-        hba.add(instance, hbarecord)
+        await hba.add(instance, hbarecord)
         if (diffvalue := diff.get()) is not None:
             for diffitem in diffvalue:
                 console.print(diffitem)
@@ -69,7 +72,8 @@ def add(
 @diff_options["unified"]
 @diff_options["ansible"]
 @click.pass_obj
-def remove(
+@async_command
+async def remove(
     obj: Obj,
     instance: PostgreSQLInstance,
     hbarecord: interface.HbaRecord,
@@ -87,7 +91,26 @@ def remove(
         system_configure(dry_run=dry_run),
         manager.from_instance(instance),
     ):
-        hba.remove(instance, hbarecord)
+        await hba.remove(instance, hbarecord)
         if (diffvalue := diff.get()) is not None:
             for diffitem in diffvalue:
                 console.print(diffitem)
+
+
+@cli.command("edit")
+@pass_postgresql_instance
+@click.pass_obj
+@async_command
+async def edit(obj: Obj, instance: PostgreSQLInstance) -> None:
+    """Edit managed HBA records."""
+    with obj.lock, audit():
+        with manager.from_instance(instance):
+            hba_ = await hba.get(instance)
+            actual_hba = "\n".join([str(r) for r in hba_.lines])
+        edited = click.edit(text=actual_hba)
+        if edited is None:
+            click.echo("no change", err=True)
+            return
+        entries = parse_hba(edited.splitlines())
+        with manager.from_instance(instance):
+            await hba.save(instance, entries, reload_on_change=True)

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/role.py

@@ -170,7 +170,11 @@ async def ls(instance: PostgreSQLInstance, output_format: OutputFormat | None) -
     else:
         print_table_for(
             rls,
-            partial(model_dump, mode="pretty", exclude={"hba_records", "validity"}),
+            partial(
+                model_dump,
+                context={"pretty": True},
+                exclude={"hba_records", "validity"},
+            ),
         )
 
 
@@ -191,7 +195,11 @@ async def get(
     else:
         print_table_for(
             [r],
-            partial(model_dump, mode="pretty", exclude={"hba_records", "validity"}),
+            partial(
+                model_dump,
+                context={"pretty": True},
+                exclude={"hba_records", "validity"},
+            ),
             box=None,
         )
 

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/src/pglift_cli/util.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 
 import abc
 import asyncio
+import inspect
 import json
 import logging
 import logging.handlers
@@ -390,12 +391,14 @@ def _instance_identifier(
             callback=callback,
             shell_complete=_list_instances,
         )(fn)
-        assert command.__doc__
-        command.__doc__ += (
-            "\n\n    INSTANCE identifies target instance as <version>/<name> where the "
+        doc = inspect.getdoc(command)
+        assert doc
+        doc += (
+            "\n\nINSTANCE identifies target instance as <version>/<name> where the "
             "<version>/ prefix may be omitted if there is only one instance "
             "matching <name>."
         )
+        command.__doc__ = doc
         if not required:
             command.__doc__ += " Required if there is more than one instance on system."
         return command

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/expect/test-cli-walkthrough.t

@@ -167,7 +167,7 @@ Error cases for instance operations
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--standby-for': Value error, missing "=" after "port" in connection info string
+  Error: Invalid value for '--standby-for': missing "=" after "port" in connection info string
   
   [2]
   $ pglift instance apply
@@ -197,11 +197,11 @@ Error cases for instance operations
 
   $ grep 'pglift_cli.audit' $TMPDIR/pglift-audit.log
   INFO - pglift_cli.audit - command: .*\/pglift --non-interactive site-configure install (re)
-  INFO - pglift_cli.audit - command completed \(\d+.\d+ seconds\) (re)
+  INFO - pglift_cli.audit - command completed \(\d+(\.\d+)? seconds\) (re)
   INFO - pglift_cli.audit - command: .*\/pglift --non-interactive instance create main --data-checksums --auth-host=ident --port=\d+ --surole-password=s3per --pgbackrest-stanza=main '--pgbackrest-password=b@ck up!' --prometheus-port=\d+ (re)
-  INFO - pglift_cli.audit - command completed \(\d+.\d+ seconds\) (re)
+  INFO - pglift_cli.audit - command completed \(\d+(\.\d+)? seconds\) (re)
   INFO - pglift_cli.audit - command: .*\/pglift --non-interactive instance create main --pgbackrest-stanza=st --surole-password=s3per (re)
-  ERROR - pglift_cli.audit - command failed \(\d+.\d+ seconds\) (re)
+  ERROR - pglift_cli.audit - command failed \(\d+(\.\d+)? seconds\) (re)
 
 List instances
 
@@ -250,8 +250,8 @@ Stop, alter, (re)start an instance:
   --- $TMPDIR/etc/prometheus/postgres_exporter-1*-main.conf (glob)
   +++ $TMPDIR/etc/prometheus/postgres_exporter-1*-main.conf (glob)
   @@ -1,2 +1,2 @@
-   DATA_SOURCE_NAME=postgresql://prometheus@:*/postgres?host=%2Ftmp%2Fprysk-te (glob)
-  sts-*%2Ftmp%2Frun%2Fpostgresql&sslmode=disable (glob)
+   DATA_SOURCE_NAME=postgresql://prometheus@:*/postgres?host=* (glob)
+  *%2Fpostgresql&sslmode=disable (glob)
   -POSTGRES_EXPORTER_OPTS='--web.listen-address :\d+ --log.level info' (re)
   \+POSTGRES_EXPORTER_OPTS='--web.listen-address :\d+ --log.level info' (re)
   --- /dev/null
@@ -294,7 +294,7 @@ Stop, alter, (re)start an instance:
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
   INFO creating role 'arole'
-  INFO pg_hba.conf updated
+  INFO HBA configuration updated
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
   --- $TMPDIR/srv/pgsql/1*/main/data/postgresql.conf (glob)
   +++ $TMPDIR/srv/pgsql/1*/main/data/postgresql.conf (glob)
@@ -391,8 +391,11 @@ PostgreSQL configuration
   port: \d+ -> 1234 (re)
   DRY RUN: no changes made
 
-pg_hba.conf management:
+HBA configuration management:
 
+  $ version=$(pglift instance list -o json | jq -r '.[] | .version')
+  $ # Adding a comment in the file
+  $ printf "\n# a comment" >> $TMPDIR/srv/pgsql/${version}/main/data/pg_hba.conf
   $ pglift pghba add --user bob --method trust
   INFO entry added to HBA configuration
   $ pglift pghba add --dry-run --diff --user bob --method trust \
@@ -401,8 +404,8 @@ pg_hba.conf management:
   --- $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   +++ $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   @@ -*,3 +*,4 @@ (glob)
-   host    all             all             ::1/128                 ident
    local   adb             arole                                   trust
+   # a comment
    local   all             bob                                     trust
   +host    all             bob             127.0.0.1               trust
   DRY RUN: no changes made
@@ -428,7 +431,6 @@ pg_hba.conf management:
   >     --connection-address 192.168.12.10/32 \
   >     --database mybd,myotherdb
   INFO entry added to HBA configuration
-  $ version=$(pglift instance list -o json | jq -r '.[] | .version')
   $ grep 'bob' $TMPDIR/srv/pgsql/${version}/main/data/pg_hba.conf
   local   all             bob                                     trust
   host    all             bob             127.0.0.1               trust
@@ -446,7 +448,7 @@ pg_hba.conf management:
   --- $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   +++ $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   @@ -*,5 +*,4 @@ (glob)
-   local   adb             arole                                   trust
+   # a comment
    local   all             bob                                     trust
    host    all             bob             127.0.0.1               trust
   -host    myotherdb       bob             192.168.12.10   255.255.255.255 trust
@@ -463,7 +465,7 @@ pg_hba.conf management:
   --- $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   +++ $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   @@ -*,4 +*,3 @@ (glob)
-   local   adb             arole                                   trust
+   # a comment
    local   all             bob                                     trust
    host    all             bob             127.0.0.1               trust
   -host    mybd,myotherdb  bob,peter       192.168.12.10/32         trust
@@ -531,6 +533,13 @@ Add and manipulate roles:
   INFO removing now empty $TMPDIR/.pgpass
   DRY RUN: no changes made
 
+  $ pglift role -i main create dba --password=qwerty --encrypted-password=md5azerty
+  Usage: pglift role create [OPTIONS] NAME
+  Try 'pglift role create --help' for help.
+  
+  Error: '--password' and '--encrypted-password' can't be used together
+  [2]
+
   $ pglift role alter dba --connection-limit=10 --inherit --no-pgpass --no-login --revoke=pg_read_all_stats --grant=pg_monitor --valid-until=2026-01-01
   INFO altering role 'dba'
   INFO removing entry for 'dba' in \$TMPDIR\/.pgpass \(port=\d+\) (re)
@@ -583,7 +592,7 @@ Add and manipulate roles:
   > EOF
   $ pglift role apply -f $TMPDIR/role.yaml --dry-run
   INFO creating role 'test'
-  INFO pg_hba.conf updated
+  INFO HBA configuration updated
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
   DRY RUN: no changes made
   $ grep 'test' $TMPDIR/srv/pgsql/${version}/main/data/pg_hba.conf
@@ -593,12 +602,12 @@ Add and manipulate roles:
   [1]
   $ pglift role apply -f $TMPDIR/role.yaml --diff
   INFO creating role 'test'
-  INFO pg_hba.conf updated
+  INFO HBA configuration updated
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
   --- $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   +++ $TMPDIR/srv/pgsql/1*/main/data/pg_hba.conf (glob)
   \@\@ -\d+,3 \+\d+,7 \@\@ (re)
-   local   adb             arole                                   trust
+   # a comment
    local   all             bob                                     trust
    host    all             bob             127.0.0.1               trust
   +local   mydb            test                                    trust
@@ -1102,7 +1111,7 @@ Databases
 
   $ pglift role drop test --dry-run
   INFO dropping role 'test'
-  INFO removing entries from pg_hba.conf
+  INFO removing entries from HBA configuration
   DRY RUN: no changes made
   $ pglift role drop test
   INFO dropping role 'test'
@@ -1113,15 +1122,41 @@ Databases
   Usage: pglift role drop [OPTIONS] NAME
   Try 'pglift role drop --help' for help.
   
-  Error: Invalid value for '--reassign-owned': Value error, field is mutually exclusive with 'drop_owned'
+  Error: '--drop-owned' and '--reassign-owned' can't be used together
   [2]
   $ pglift role drop test --drop-owned --dry-run
   INFO dropping role 'test'
-  INFO removing entries from pg_hba.conf
+  INFO removing entries from HBA configuration
   DRY RUN: no changes made
   $ pglift role drop test --drop-owned
   INFO dropping role 'test'
-  INFO removing entries from pg_hba.conf
+  INFO removing entries from HBA configuration
+  $ pglift role create doctor
+  INFO creating role 'doctor'
+  $ pglift database create tardis_db --owner doctor
+  INFO creating 'tardis_db' database in 1\d/main (re)
+  $ pglift database get tardis_db --output-format=json | jq -r .owner
+  doctor
+  $ pglift role drop doctor --reassign-owned=postgres
+  INFO dropping role 'doctor'
+  $ pglift database get tardis_db --output-format=json | jq -r .owner
+  postgres
+  $ pglift role create who
+  INFO creating role 'who'
+  $ pglift database create unit_db --owner who
+  INFO creating 'unit_db' database in 1\d/main (re)
+  $ pglift database get unit_db --output-format=json | jq -r .owner
+  who
+  $ pglift role drop who --drop-owned --reassign-owned=postgres
+  Usage: pglift role drop [OPTIONS] NAME
+  Try 'pglift role drop --help' for help.
+  
+  Error: '--drop-owned' and '--reassign-owned' can't be used together
+  [2]
+  $ pglift role drop who --no-drop-owned --reassign-owned=postgres
+  INFO dropping role 'who'
+  $ pglift database get unit_db --output-format=json | jq -r .owner
+  postgres
 
 Profiles
   $ pglift role -i main create dba1 --password mySup3rS3cr3t1377 --login

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/expect/test-help.t

@@ -920,6 +920,7 @@ pg_hba.conf management commands
   
   Commands:
     add     Add a record in HBA configuration.
+    edit    Edit managed HBA records.
     remove  Remove a record from HBA configuration.
   $ pglift pghba add --help
   Usage: pglift pghba add [OPTIONS]
@@ -967,6 +968,13 @@ pg_hba.conf management commands
     --diff                          Include differences resulting from applied
                                     changes in returned result.
     --help                          Show this message and exit.
+  $ pglift pghba edit --help
+  Usage: pglift pghba edit [OPTIONS]
+  
+    Edit managed HBA records.
+  
+  Options:
+    --help  Show this message and exit.
 
 Patroni commands:
 

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/expect/test-port-validation.t

@@ -60,19 +60,19 @@ With custom ports
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--prometheus-port': Value error, port \d+ already in use (re)
+  Error: Invalid value for '--prometheus-port': port \d+ already in use (re)
   [2]
   $ pglift instance create other --port=$PG1PORT --prometheus-port=$PGE2PORT
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--port': Value error, port \d+ already in use (re)
+  Error: Invalid value for '--port': port \d+ already in use (re)
   [2]
   $ pglift instance create other --port=$PG1PORT --prometheus-port=$PGE1PORT
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--prometheus-port': Value error, port \d+ already in use (re)
+  Error: Invalid value for '--prometheus-port': port \d+ already in use (re)
   [2]
   $ pglift instance drop main
   INFO dropping instance 1\d\/main (re)
@@ -102,13 +102,13 @@ With a port set in postgresql.conf template
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--port': Value error, port \d+ already in use (re)
+  Error: Invalid value for '--port': port \d+ already in use (re)
   [2]
   $ pglift instance create other --port=$PG2PORT --prometheus-port=$PGE1PORT
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--prometheus-port': Value error, port \d+ already in use (re)
+  Error: Invalid value for '--prometheus-port': port \d+ already in use (re)
   [2]
 
   $ pglift instance drop main
@@ -134,7 +134,7 @@ With default ports
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--port': Value error, port 5432 already in use
+  Error: Invalid value for '--port': port 5432 already in use
   [2]
 
   $ pglift instance drop main

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/expect/test-prometheus.t

@@ -91,7 +91,7 @@ Check port conflicts
   Usage: pglift postgres_exporter install [OPTIONS] NAME DSN PORT
   Try 'pglift postgres_exporter install --help' for help.
   
-  Error: Invalid value for 'PORT': Value error, port \d+ already in use (re)
+  Error: Invalid value for 'PORT': port \d+ already in use (re)
   [2]
 
   $ pglift postgres_exporter uninstall test

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/expect/test-standby-pgbackrest.t

@@ -146,7 +146,7 @@ Cannot create a standby with --slot option
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--slot': Value error, replication slots cannot be set on a standby instance
+  Error: Invalid value for '--slot': replication slots cannot be set on a standby instance
   [2]
 
 
@@ -187,7 +187,7 @@ Try to create primary instance with same stanza
   Usage: pglift instance create [OPTIONS] NAME
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for '--pgbackrest-stanza': Value error, Stanza 'app' already bound to another instance \(datadir=\$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/data\) (re)
+  Error: Invalid value for '--pgbackrest-stanza': Stanza 'app' already bound to another instance \(datadir=\$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/data\) (re)
   [2]
 
 Add some data to the primary, check replication

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/unit/test_audit.py

@@ -36,7 +36,7 @@ def test_audit(tmp_path: Path) -> None:
         assert logf.read().splitlines() == [
             "INFO:pglift_cli.audit command: test error",
             "ERROR:pglift oups",
-            "ERROR:pglift_cli.audit command failed (0.00 seconds)",
+            "ERROR:pglift_cli.audit command failed (0 seconds)",
         ]
 
         with audit(["test", "ok"], settings, dry_run=True):
@@ -44,7 +44,7 @@ def test_audit(tmp_path: Path) -> None:
         assert logf.read().splitlines() == [
             "INFO:pglift_cli.audit command: test ok (DRY RUN)",
             "DEBUG:pglift running",
-            "INFO:pglift_cli.audit command completed (0.00 seconds)",
+            "INFO:pglift_cli.audit command completed (0 seconds)",
         ]
 
         with pytest.raises(exceptions.Cancelled):
@@ -54,5 +54,5 @@ def test_audit(tmp_path: Path) -> None:
         assert logf.read().splitlines() == [
             "INFO:pglift_cli.audit command: test cancel",
             "INFO:pglift trying",
-            "WARNING:pglift_cli.audit command cancelled (0.00 seconds)",
+            "WARNING:pglift_cli.audit command cancelled (0 seconds)",
         ]

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/unit/test_cli.py

@@ -16,6 +16,8 @@ import pytest
 import yaml
 from click.shell_completion import ShellComplete
 from click.testing import CliRunner
+from pgtoolkit.hba import HBARecord
+from pgtoolkit.hba import parse as parse_hba
 from rich.console import ConsoleDimensions
 
 from pglift import instances, postgresql
@@ -499,6 +501,31 @@ def test_pgconf_edit(
     assert result.stderr == "bonjour: on -> 'matin\n"
 
 
+@pytest.mark.usefixtures("installed")
+def test_pghba_edit(runner: CliRunner, obj: Obj, instance: Instance) -> None:
+    hba_r = HBARecord(
+        conntype="local", user="santaclaus", database="list", method="md5"
+    )
+    hba_f = postgresql.hba_path(instance.postgresql)
+    assert hba_r not in parse_hba(hba_f)
+    with (
+        patch("click.edit", return_value=str(hba_r), autospec=True),
+        # Unfortunately we patch postgresql.is_running(), because we can't
+        # inject a custom (fake) instance manager here. Indeed pytest and the
+        # pglift CLI do not share the same event loop. Since the instance
+        # manager is passed via a ContextVar, and ContextVars are local to their
+        # event loop, it is not accessible across that "boundary".
+        patch.object(postgresql, "is_running", return_value=False),
+    ):
+        result = runner.invoke(
+            cli,
+            ["pghba", f"--instance={instance}", "edit"],
+            obj=obj,
+        )
+        assert result.exit_code == 0, result.stderr
+    assert hba_r in parse_hba(hba_f)
+
+
 @pytest.mark.usefixtures("installed")
 def test_pgconf_edit_no_change(
     runner: CliRunner, obj: Obj, instance: Instance, postgresql_conf: str

{pglift_cli-2.2.0 → pglift_cli-2.4.0}/tests/unit/test_model.py

@@ -87,6 +87,7 @@ def test_as_parameters(runner: CliRunner) -> None:
         "  --address-coords-lat LAT        Latitude.\n"
         "  --birth-date DATE               Date of birth.  [required]\n"
         "  --birth-place PLACE             Place of birth.\n"
+        "  --is-dead / --no-is-dead        Is dead.\n"
         "  --phone-numbers PHONE_NUMBERS   Phone numbers. (Can be used multiple times.)\n"
         "  --pet PET                       Owned pets. (Can be used multiple times.)\n"
         "  --member-of GROUP               Groups the person is a member of. (Can be used\n"
@@ -128,6 +129,7 @@ def test_as_parameters(runner: CliRunner) -> None:
         },
         "age": 42,
         "birth": {"date": "1981-02-18"},
+        "is_dead": False,
         "name": "alice",
         "nickname": "**********",
         "relation": "friend",
@@ -151,6 +153,21 @@ def test_as_parameters(runner: CliRunner) -> None:
         in result.stderr
     )
 
+    result = runner.invoke(
+        add_person,
+        [
+            "foo",
+            "friend",
+            "--age=17",
+            "--birth-date=1987-06-05",
+            "--nickname=aaa",
+            "--is-dead",
+        ],
+    )
+    assert result.exit_code == 2
+    assert "--is-dead' and '--age' can't be used together" in result.stderr
+    assert "For further information visit" not in result.stderr
+
 
 def test_as_parameters_update() -> None:
     @click.command("update-person")
@@ -179,6 +196,7 @@ def test_as_parameters_update() -> None:
         "  --address-coords-long LONG      Longitude.\n"
         "  --address-coords-lat LAT        Latitude.\n"
         "  --birth-date DATE               Date of birth.  [required]\n"
+        "  --is-dead / --no-is-dead        Is dead.\n"
         "  --add-pet PET                   Add pet. (Can be used multiple times.)\n"
         "  --remove-pet PET                Remove pet. (Can be used multiple times.)\n"
         "  --add-to GROUP                  Add to group. (Can be used multiple times.)\n"