pglift-cli 3.0.0__tar.gz → 3.2.0__tar.gz

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/PKG-INFO

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

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/src/pglift_cli/main.py

@@ -11,7 +11,7 @@ import warnings
 from functools import partial
 from importlib.metadata import version
 from pathlib import Path
-from typing import Literal
+from typing import Any, Literal
 
 import click
 import click.exceptions
@@ -24,7 +24,6 @@ from rich.highlighter import NullHighlighter
 from rich.syntax import Syntax
 
 from pglift import ui
-from pglift._compat import assert_never
 from pglift.system import install
 from pglift.types import LogLevel
 
@@ -234,35 +233,50 @@ def site_settings(
         console.print(syntax)
 
 
-@cli.command(
-    "site-configure",
-    hidden=True,
-)
-@click.argument(
-    "action",
-    type=click.Choice(["install", "uninstall", "check", "list"]),
-    default="install",
+@cli.group(hidden=True)
+def site_configure(**kwargs: Any) -> None:
+    """Manage installation of extra data files for pglift.
+
+    This is an INTERNAL command.
+    """
+
+
+@site_configure.command("install")
+@click.option(
+    "--force",
+    is_flag=True,
+    default=False,
+    help="Force the overwrite of installed files",
 )
 @click.pass_obj
+@async_command
+async def site_configure_install(obj: Obj, force: bool) -> None:
+    with obj.lock, audit():
+        await install.do(_site.SETTINGS, force=force)
+
+
+@site_configure.command("uninstall")
+@click.pass_obj
+@async_command
+async def site_configure_uninstall(obj: Obj) -> None:
+    with obj.lock, audit():
+        await install.undo(_site.SETTINGS)
+
+
+@site_configure.command("check")
+@click.pass_obj
 @click.pass_context
 @async_command
-async def site_configure(
-    context: click.Context, obj: Obj, action: Literal["install", "uninstall", "check"]
-) -> None:
-    """Manage installation of extra data files for pglift.
+async def site_configure_check(context: click.Context, obj: Obj) -> None:
+    with obj.lock, audit():
+        if not install.check(_site.SETTINGS):
+            context.exit(1)
 
-    This is an INTERNAL command.
-    """
+
+@site_configure.command("list")
+@click.pass_obj
+@async_command
+async def site_configure_list(obj: Obj) -> None:
     with obj.lock, audit():
-        if action == "install":
-            await install.do(_site.SETTINGS)
-        elif action == "uninstall":
-            await install.undo(_site.SETTINGS)
-        elif action == "check":
-            if not install.check(_site.SETTINGS):
-                context.exit(1)
-        elif action == "list":
-            for p in install.ls(_site.SETTINGS):
-                click.echo(p)
-        else:
-            assert_never(action)
+        for p in install.ls(_site.SETTINGS):
+            click.echo(p)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/src/pglift_cli/model.py

@@ -18,10 +18,11 @@ import pydantic
 from pydantic.fields import FieldInfo
 from pydantic_core import ErrorDetails
 
-from pglift.annotations import cli
+from pglift.annotations import CreateOnly, cli
 from pglift.exceptions import MutuallyExclusiveError
 from pglift.models.helpers import is_optional, optional_type
 from pglift.models.interface import PresenceState
+from pglift.settings import Settings
 from pglift.types import (
     Operation,
     field_annotation,
@@ -33,6 +34,7 @@ from . import _site, logger
 
 ModelType = type[pydantic.BaseModel]
 T = TypeVar("T", bound=pydantic.BaseModel)
+V = TypeVar("V")
 Callback = Callable[..., Any]
 ClickDecorator = Callable[[Callback], Callback]
 DEFAULT = object()
@@ -167,7 +169,7 @@ class ParamSpec(ABC):
     loc: tuple[str, ...]
     description: str | None = None
 
-    objtype: ClassVar[type[click.Parameter]] = click.Parameter
+    objtype: ClassVar[type[click.Parameter]]
 
     @property
     def param(self) -> click.Parameter:
@@ -296,6 +298,15 @@ def _paramspecs_from_model(
             return DEFAULT
         return value
 
+    def default_factory(
+        _ctx: click.Context,
+        _param: click.Argument,
+        value: V,
+        *,
+        callback: Callable[[Settings, V], V],
+    ) -> V:
+        return callback(_site.SETTINGS, value)
+
     def add_state_field_callback(
         ctx: click.Context,
         _param: click.Argument,
@@ -329,11 +340,7 @@ def _paramspecs_from_model(
     for fname, field in model_type.model_fields.items():
         if field_annotation(field, cli.Hidden):
             continue
-        if (
-            operation == "update"
-            and isinstance(field.json_schema_extra, dict)
-            and field.json_schema_extra.get("readOnly")
-        ):
+        if field_annotation(field, CreateOnly) and operation == "update":
             continue
 
         modelname = argname = field.alias or fname
@@ -361,9 +368,6 @@ def _paramspecs_from_model(
         if not _parents and required:
             if origin_type is typing.Literal:
                 choices = list(typing.get_args(ftype))
-                if config is not None:
-                    assert isinstance(config, cli.Choices)
-                    choices = config.choices
                 attrs["type"] = click.Choice(choices)
             if config is not None and isinstance(config, cli.Option):
                 attrs["required"] = True
@@ -377,6 +381,17 @@ def _paramspecs_from_model(
                     ),
                 )
 
+            elif config is not None and isinstance(config, cli.OptionalArgument):
+                attrs["required"] = False
+                attrs["callback"] = functools.partial(
+                    default_factory,
+                    callback=config.default_factory,
+                )
+
+                yield (
+                    (modelname, argname),
+                    ArgumentSpec((argname,), field, attrs, loc=(modelname,)),
+                )
             else:
                 yield (
                     (modelname, argname),
@@ -386,11 +401,7 @@ def _paramspecs_from_model(
                 )
 
         else:
-            if (
-                config
-                and isinstance(config, cli.Argument | cli.Option)
-                and config.metavar is not None
-            ):
+            if config and isinstance(config, cli.Option) and config.metavar is not None:
                 metavar = config.metavar
             else:
                 metavar = argname

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/src/pglift_cli/pgconf.py

@@ -58,7 +58,7 @@ def show_configuration_changes(
 @cli.command("show")
 @click.argument("parameter", nargs=-1)
 @pass_postgresql_instance
-def show(instance: PostgreSQLInstance, parameter: tuple[str]) -> None:
+def show(instance: PostgreSQLInstance, parameter: tuple[str, ...]) -> None:
     """Show configuration (all parameters or specified ones).
 
     Only uncommented parameters are shown when no PARAMETER is specified. When

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/src/pglift_cli/util.py

@@ -273,7 +273,7 @@ def nameversion_from_id(instance_id: str) -> tuple[str, PostgreSQLVersion | None
 
 
 def postgresql_instance_lookup(
-    context: click.Context, param: click.Parameter, value: None | str | tuple[str]
+    context: click.Context, param: click.Parameter, value: None | str | tuple[str, ...]
 ) -> PostgreSQLInstance | tuple[PostgreSQLInstance, ...]:
     """Return one or more PostgreSQLInstance, possibly guessed if there
     is only one on system, depending on 'param' variadic flag (nargs).
@@ -764,7 +764,7 @@ class PluggableCommandGroup(abc.ABC, Group):
         if obj is None:
             obj = context.ensure_object(Obj)
         if obj is None:
-            return
+            return  # type: ignore[unreachable]
         self.register_plugin_commands(obj)
         self._plugin_commands_loaded = True
 

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-cli-walkthrough.t

@@ -26,7 +26,7 @@ Site settings:
   > postgresql:
   >   auth:
   >     local: md5
-  >     passfile: '$TMPDIR/.pgpass'
+  >     passfile: '$TMPDIR/pgpass/.pgpass'
   >     password_command:
   >       - jq
   >       - -r
@@ -65,7 +65,7 @@ Make sure password_command works:
     "local": "md5",
     "host": "trust",
     "hostssl": "trust",
-    "passfile": "$TMPDIR/.pgpass",
+    "passfile": "$TMPDIR/pgpass/.pgpass",
     "password_command": [
       "jq",
       "-r",
@@ -89,10 +89,11 @@ Make sure password_command works:
   $ pglift site-configure install
   INFO creating base pgBackRest configuration directory: $TMPDIR/etc/pgbackrest
   INFO installing base pgBackRest configuration
-  INFO creating pgBackRest include directory
+  INFO creating pgBackRest include directory: $TMPDIR/etc/pgbackrest/conf.d
   INFO creating pgBackRest repository backups and archive directory: $TMPDIR/pgbackrest
   INFO creating pgBackRest log directory: $TMPDIR/log/pgbackrest
   INFO creating pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
+  INFO creating pgpass file directory: $TMPDIR/pgpass
   INFO creating PostgreSQL log directory: $TMPDIR/log/postgresql
 
   $ trap "pglift --non-interactive instance drop main; \
@@ -116,10 +117,11 @@ Audit log:
   DEBUG - pglift.util - using 'pgbackrest/pgbackrest.conf' configuration file from distribution
   INFO - pglift.util - creating base pgBackRest configuration directory: $TMPDIR/etc/pgbackrest
   INFO - pglift.pgbackrest - installing base pgBackRest configuration
-  INFO - pglift.pgbackrest - creating pgBackRest include directory
+  INFO - pglift.util - creating pgBackRest include directory: $TMPDIR/etc/pgbackrest/conf.d
   INFO - pglift.util - creating pgBackRest repository backups and archive directory: $TMPDIR/pgbackrest
   INFO - pglift.util - creating pgBackRest log directory: $TMPDIR/log/pgbackrest
   INFO - pglift.util - creating pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
+  INFO - pglift.util - creating pgpass file directory: $TMPDIR/pgpass
   INFO - pglift.util - creating PostgreSQL log directory: $TMPDIR/log/postgresql
   INFO - pglift_cli.audit - command completed \(\d+.\d+ seconds\) (re)
 
@@ -166,13 +168,13 @@ Error cases for instance operations
   Error: instance already exists
   [1]
   $ pglift instance create 'in/va/lid' --pgbackrest-stanza=xxx --surole-password=s3per
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
-  Error: Invalid value for 'NAME': String should match pattern '^[^/-]+$'
+  Error: Invalid value for '[NAME]': String should match pattern '^[^/-]+$'
   [2]
   $ pglift instance create stdby --standby-for='port 1234' --pgbackrest-stanza=stddy --surole-password=s3per
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--standby-for': missing "=" after "port" in connection info string
@@ -240,7 +242,6 @@ Reload, restart:
   INFO stopping Prometheus postgres_exporter 1\d-main (re)
   $ pglift instance restart
   INFO restarting instance 1\d\/main (re)
-  INFO stopping Prometheus postgres_exporter 1\d-main (re)
   INFO restarting PostgreSQL
   INFO stopping PostgreSQL 1\d\/main (re)
   INFO starting PostgreSQL 1\d\/main (re)
@@ -341,7 +342,7 @@ Stop, alter, (re)start an instance:
 Instance environment, and program execution:
 
   $ pglift instance env | grep PASSFILE
-  PGPASSFILE=$TMPDIR/.pgpass
+  PGPASSFILE=$TMPDIR/pgpass/.pgpass
   $ pglift instance env -o json | jq '.PGBACKREST_STANZA, .PGHOST, .PGPASSWORD'
   "main"
   "$TMPDIR/run/postgresql"
@@ -518,14 +519,14 @@ Add and manipulate roles:
 
   $ pglift role -i main create dba --login --pgpass --password=qwerty --in-role=pg_read_all_stats --dry-run
   INFO creating role 'dba'
-  INFO adding an entry for 'dba' in \$TMPDIR\/.pgpass \(port=\d+\) (re)
+  INFO adding an entry for 'dba' in \$TMPDIR\/pgpass\/.pgpass \(port=\d+\) (re)
   DRY RUN: no changes made
 
   $ pglift role -i main create dba --login --pgpass --password=qwerty --in-role=pg_read_all_stats
   INFO creating role 'dba'
-  INFO adding an entry for 'dba' in \$TMPDIR\/.pgpass \(port=\d+\) (re)
+  INFO adding an entry for 'dba' in \$TMPDIR\/pgpass\/.pgpass \(port=\d+\) (re)
 
-  $ cat $TMPDIR/.pgpass
+  $ cat $TMPDIR/pgpass/.pgpass
   \*:\d+:\*:dba:qwerty (re)
 
   $ pglift role get dba
@@ -555,8 +556,8 @@ Add and manipulate roles:
   
   $ 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 --dry-run
   INFO altering role 'dba'
-  INFO removing entry for 'dba' in \$TMPDIR\/.pgpass \(port=\d+\) (re)
-  INFO removing now empty $TMPDIR/.pgpass
+  INFO removing entry for 'dba' in \$TMPDIR\/pgpass\/.pgpass \(port=\d+\) (re)
+  INFO removing now empty $TMPDIR/pgpass/.pgpass
   DRY RUN: no changes made
 
   $ pglift role -i main create dba --password=qwerty --encrypted-password=md5azerty
@@ -568,8 +569,8 @@ Add and manipulate roles:
 
   $ 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)
-  INFO removing now empty $TMPDIR/.pgpass
+  INFO removing entry for 'dba' in \$TMPDIR\/pgpass\/.pgpass \(port=\d+\) (re)
+  INFO removing now empty $TMPDIR/pgpass/.pgpass
 
   $ pglift role get dba -o json
   {
@@ -1289,11 +1290,13 @@ Cleanup.
   INFO deconfiguring Prometheus postgres_exporter 1\d-main (re)
   INFO deleting pgBackRest stanza 'main'
   INFO deconfiguring pgBackRest stanza 'main'
-  INFO removing entries matching port=\d+ from \$TMPDIR\/.pgpass (re)
-  INFO deleting PostgreSQL data and WAL directories
-  INFO deleting pgBackRest include directory
+  INFO removing entries matching port=\d+ from \$TMPDIR\/pgpass\/.pgpass (re)
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/main/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/main/wal (re)
+  INFO deleting pgBackRest include directory: $TMPDIR/etc/pgbackrest/conf.d
   INFO uninstalling base pgBackRest configuration
-  INFO deleting pgBackRest log directory
-  INFO deleting pgBackRest spool directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting pgBackRest log directory: $TMPDIR/log/pgbackrest
+  INFO deleting pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
+  INFO deleting pgpass file parent directory
+  INFO deleting PostgreSQL log directory: $TMPDIR/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-demote.t

@@ -220,11 +220,13 @@ And finally check replication is functional
 
   INFO dropping instance 1\d\/pg1 (re)
   INFO stopping PostgreSQL 1\d\/pg1 (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/wal (re)
   INFO dropping instance 1\d\/pg2 (re)
   INFO stopping PostgreSQL 1\d\/pg2 (re)
-  INFO deleting PostgreSQL data and WAL directories
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/2\/srv\/pgsql\/1\d\/pg2\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/2\/srv\/pgsql\/1\d\/pg2\/wal (re)
+  INFO deleting PostgreSQL log directory: $TMPDIR/1/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/1/run/postgresql
+  INFO deleting PostgreSQL log directory: $TMPDIR/2/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/2/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-help.t

@@ -228,7 +228,7 @@ Instance commands
     -o, --output-format [json]      Specify the output format.
     --help                          Show this message and exit.
   $ pglift instance create --help
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   
     Initialize a PostgreSQL instance
   
@@ -249,13 +249,13 @@ Instance commands
     --locale LOCALE                 Default locale.
     --encoding ENCODING             Character encoding of the PostgreSQL
                                     instance.
-    --auth-local [trust|reject|md5|password|scram-sha-256|sspi|ident|peer|pam|ldap|radius]
+    --auth-local [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer]
                                     Authentication method for local-socket
                                     connections.
-    --auth-host [trust|reject|md5|password|scram-sha-256|gss|sspi|ident|pam|ldap|radius]
+    --auth-host [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|gss]
                                     Authentication method for local TCP/IP
                                     connections.
-    --auth-hostssl [trust|reject|md5|password|scram-sha-256|gss|sspi|ident|pam|ldap|radius|cert]
+    --auth-hostssl [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|gss|cert]
                                     Authentication method for SSL-encrypted
                                     TCP/IP connections.
     --surole-password PASSWORD      Super-user role password.
@@ -912,7 +912,7 @@ PostgreSQL configuration commands
   Options:
     --help  Show this message and exit.
 
-pg_hba.conf management commands
+HBA configuration management commands
 
   $ pglift pghba --help
   Usage: pglift pghba [OPTIONS] COMMAND [ARGS]...
@@ -947,7 +947,8 @@ pg_hba.conf management commands
     --database DATABASE             Database name(s). Multiple database names
                                     can be supplied by separating them with
                                     commas.
-    --method TEXT                   Authentication method.  [required]
+    --method [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer|gss|cert]
+                                    Authentication method.  [required]
     --user USER                     User name(s). Multiple user names can be
                                     supplied by separating them with commas.
     --dry-run                       Simulate change operations.
@@ -970,7 +971,8 @@ pg_hba.conf management commands
     --database DATABASE             Database name(s). Multiple database names
                                     can be supplied by separating them with
                                     commas.
-    --method TEXT                   Authentication method.  [required]
+    --method [trust|reject|md5|password|scram-sha-256|sspi|ident|pam|ldap|radius|peer|gss|cert]
+                                    Authentication method.  [required]
     --user USER                     User name(s). Multiple user names can be
                                     supplied by separating them with commas.
     --dry-run                       Simulate change operations.

pglift_cli-3.2.0/tests/expect/test-instance-name.t

@@ -0,0 +1,45 @@
+# SPDX-FileCopyrightText: 2026 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+Site settings and configuration
+
+  $ export PGLIFT_CLI__LOG_FORMAT="%(levelname)-4s %(message)s"
+  $ export PGLIFT_CLI__LOG_LEVEL=info
+  $ export PGLIFT_POSTGRESQL__AUTH__PASSFILE=$TMPDIR/pgpass/.pgpass
+  $ export PGLIFT_INSTANCE_DEFAULT_NAME=myinstance
+  $ export PGLIFT_PREFIX=$TMPDIR
+  $ export PGLIFT_RUN_PREFIX=$TMPDIR/run
+  $ alias pglift="pglift --log-level=INFO --non-interactive"
+
+  $ pglift site-configure install
+  INFO creating pgpass file directory: $TMPDIR/pgpass
+  INFO creating PostgreSQL log directory: $TMPDIR/log/postgresql
+
+(Cleanup steps)
+  $ trap "pglift --non-interactive instance drop; \
+  >   pglift --non-interactive site-configure uninstall; \
+  >   port-for -u postgres" \
+  >   EXIT
+
+Define ports:
+  $ PGPORT=$(port-for pg1)
+
+Create an instance without a name
+  $ pglift instance create --port=$PGPORT
+  INFO initializing PostgreSQL
+  INFO configuring PostgreSQL authentication
+  INFO configuring PostgreSQL
+  INFO creating PostgreSQL socket directory directory: $TMPDIR/run/postgresql
+  INFO starting PostgreSQL 1\d\/myinstance (re)
+  INFO creating instance dumps directory: \$TMPDIR\/srv\/dumps\/1\d-myinstance (re)
+
+Cleanup.
+  INFO dropping instance 1\d\/myinstance (re)
+  INFO stopping PostgreSQL 1\d\/myinstance (re)
+  INFO removing entries matching port=\d+ from \$TMPDIR\/pgpass/.pgpass (re)
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/myinstance/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/myinstance/wal (re)
+  INFO deleting pgpass file parent directory
+  INFO deleting PostgreSQL log directory: $TMPDIR/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-port-validation.t

@@ -27,7 +27,7 @@
   $ pglift site-configure install
   INFO creating base pgBackRest configuration directory: $TMPDIR/etc/pgbackrest
   INFO installing base pgBackRest configuration
-  INFO creating pgBackRest include directory
+  INFO creating pgBackRest include directory: $TMPDIR/etc/pgbackrest/conf.d
   INFO creating pgBackRest repository backups and archive directory: $TMPDIR/pgbackrest-not-used
   INFO creating pgBackRest log directory: $TMPDIR/log/pgbackrest
   INFO creating pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
@@ -57,19 +57,19 @@ With custom ports
   INFO creating instance dumps directory: \$TMPDIR\/srv\/dumps\/1\d-main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
   $ pglift instance create other --port=$PG2PORT --prometheus-port=$PGE1PORT
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   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
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   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
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--prometheus-port': port \d+ already in use (re)
@@ -79,7 +79,8 @@ With custom ports
   INFO stopping PostgreSQL 1\d\/main (re)
   INFO stopping Prometheus postgres_exporter 1\d-main (re)
   INFO deconfiguring Prometheus postgres_exporter 1\d-main (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/wal (re)
 
 With a port set in postgresql.conf template
 
@@ -99,13 +100,13 @@ With a port set in postgresql.conf template
   INFO creating instance dumps directory: \$TMPDIR\/srv\/dumps\/1\d-main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
   $ pglift instance create other --prometheus-port=$PGE2PORT
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   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
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--prometheus-port': port \d+ already in use (re)
@@ -116,7 +117,8 @@ With a port set in postgresql.conf template
   INFO stopping PostgreSQL 1\d\/main (re)
   INFO stopping Prometheus postgres_exporter 1\d-main (re)
   INFO deconfiguring Prometheus postgres_exporter 1\d-main (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/wal (re)
   $ rm -rf $PGLIFT_CONFIG_DIR/postgresql
 
 With default ports
@@ -131,7 +133,7 @@ With default ports
   INFO creating instance dumps directory: \$TMPDIR\/srv\/dumps\/1\d-main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
   $ pglift instance create other
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--port': port 5432 already in use
@@ -142,12 +144,13 @@ With default ports
   INFO stopping PostgreSQL 1\d\/main (re)
   INFO stopping Prometheus postgres_exporter 1\d-main (re)
   INFO deconfiguring Prometheus postgres_exporter 1\d-main (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/main\/wal (re)
 
 (cleanup)
-  INFO deleting pgBackRest include directory
+  INFO deleting pgBackRest include directory: $TMPDIR/etc/pgbackrest/conf.d
   INFO uninstalling base pgBackRest configuration
-  INFO deleting pgBackRest log directory
-  INFO deleting pgBackRest spool directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting pgBackRest log directory: $TMPDIR/log/pgbackrest
+  INFO deleting pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
+  INFO deleting PostgreSQL log directory: $TMPDIR/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-prometheus.t

@@ -44,8 +44,8 @@
       {
         "before_header": "$TMPDIR/etc/prometheus/postgres_exporter-test.conf",
         "after_header": "$TMPDIR/etc/prometheus/postgres_exporter-test.conf",
-        "before": "DATA_SOURCE_NAME=postgresql://:5432/monitoring\nPOSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'", (glob)
-        "after": "DATA_SOURCE_NAME=postgresql://prometheus@:5432/monitoring\nPOSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'" (glob)
+        "before": "DATA_SOURCE_NAME=postgresql://:5432/monitoring\nPOSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'\n", (glob)
+        "after": "DATA_SOURCE_NAME=postgresql://prometheus@:5432/monitoring\nPOSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'\n" (glob)
       },
       {
         "before_header": "$TMPDIR/run/prometheus/test.pid deleted",
@@ -100,4 +100,4 @@ Check port conflicts
   INFO deconfiguring Prometheus postgres_exporter test
 
 (cleanup)
-  INFO deleting PostgreSQL log directory (no-eol)
+  INFO deleting PostgreSQL log directory: $TMPDIR/log/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-standby-pgbackrest.t

@@ -60,7 +60,7 @@ Site settings and configuration
   $ pglift1 site-configure install
   INFO creating base pgBackRest configuration directory: $TMPDIR/1/etc/pgbackrest
   INFO installing base pgBackRest configuration
-  INFO creating pgBackRest include directory
+  INFO creating pgBackRest include directory: $TMPDIR/1/etc/pgbackrest/conf.d
   INFO creating pgBackRest repository backups and archive directory: $TMPDIR/test-standby-pgbackrest/backups
   INFO creating pgBackRest log directory: $TMPDIR/1/log/pgbackrest
   INFO creating pgBackRest spool directory: $TMPDIR/1/srv/pgbackrest/spool
@@ -68,7 +68,7 @@ Site settings and configuration
   $ pglift2 site-configure install
   INFO creating base pgBackRest configuration directory: $TMPDIR/2/etc/pgbackrest
   INFO installing base pgBackRest configuration
-  INFO creating pgBackRest include directory
+  INFO creating pgBackRest include directory: $TMPDIR/2/etc/pgbackrest/conf.d
   INFO creating pgBackRest log directory: $TMPDIR/2/log/pgbackrest
   INFO creating pgBackRest spool directory: $TMPDIR/2/srv/pgbackrest/spool
   INFO creating PostgreSQL log directory: $TMPDIR/2/log/postgresql
@@ -143,7 +143,7 @@ Cannot create a standby with --slot option
   >   --pgbackrest-stanza=stnz \
   >   --standby-for="host=hst" \
   >   --slot=slt
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--slot': replication slots cannot be set on a standby instance
@@ -184,7 +184,7 @@ Try to create primary instance with same stanza
   $ pglift1 instance create err \
   >   --port=$PG3PORT --pgbackrest-stanza=app \
   >   --surole-password=s3per --pgbackrest-password=b@ckUp
-  Usage: pglift instance create [OPTIONS] NAME
+  Usage: pglift instance create [OPTIONS] [NAME]
   Try 'pglift instance create --help' for help.
   
   Error: Invalid value for '--pgbackrest-stanza': Stanza 'app' already bound to another instance \(datadir=\$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/data\) (re)
@@ -301,7 +301,8 @@ new slot on the new primary
   INFO dropping instance 1\d\/pg1 (re)
   WARNING instance 1\d\/pg1 is already stopped (re)
   INFO deconfiguring pgBackRest stanza 'app'
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg1\/wal (re)
   $ pglift1 instance create pg3 \
   >   --standby-for="host=$RUN_PREFIX2/postgresql port=$PG2PORT user=replication" \
   >   --standby-password=r3pl \
@@ -352,20 +353,22 @@ Restore on (new) primary:
   INFO dropping instance 1\d\/pg3 (re)
   INFO stopping PostgreSQL 1\d\/pg3 (re)
   INFO deconfiguring pgBackRest stanza 'app'
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg3\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/1\/srv\/pgsql\/1\d\/pg3\/wal (re)
   INFO dropping instance 1\d\/pg2 (re)
   WARNING instance 1\d\/pg2 is already stopped (re)
   INFO deconfiguring pgBackRest stanza 'app'
-  INFO deleting PostgreSQL data and WAL directories
-  INFO deleting pgBackRest include directory
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/2\/srv\/pgsql\/1\d\/pg2\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/2\/srv\/pgsql\/1\d\/pg2\/wal (re)
+  INFO deleting pgBackRest include directory: $TMPDIR/1/etc/pgbackrest/conf.d
   INFO uninstalling base pgBackRest configuration
-  INFO deleting pgBackRest log directory
-  INFO deleting pgBackRest spool directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory
-  INFO deleting pgBackRest include directory
+  INFO deleting pgBackRest log directory: $TMPDIR/1/log/pgbackrest
+  INFO deleting pgBackRest spool directory: $TMPDIR/1/srv/pgbackrest/spool
+  INFO deleting PostgreSQL log directory: $TMPDIR/1/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/1/run/postgresql
+  INFO deleting pgBackRest include directory: $TMPDIR/2/etc/pgbackrest/conf.d
   INFO uninstalling base pgBackRest configuration
-  INFO deleting pgBackRest log directory
-  INFO deleting pgBackRest spool directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting pgBackRest log directory: $TMPDIR/2/log/pgbackrest
+  INFO deleting pgBackRest spool directory: $TMPDIR/2/srv/pgbackrest/spool
+  INFO deleting PostgreSQL log directory: $TMPDIR/2/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/2/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-standby.t

@@ -111,11 +111,13 @@ Try to pause/resume WAL replay on primary
 
   INFO dropping instance 1\d\/pg1 (re)
   INFO stopping PostgreSQL 1\d\/pg1 (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/primary\/srv\/pgsql\/1\d\/pg1\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/primary\/srv\/pgsql\/1\d\/pg1\/wal (re)
   INFO dropping instance 1\d\/pg2 (re)
   INFO stopping PostgreSQL 1\d\/pg2 (re)
-  INFO deleting PostgreSQL data and WAL directories
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/secondary\/srv\/pgsql\/1\d\/pg2\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/secondary\/srv\/pgsql\/1\d\/pg2\/wal (re)
+  INFO deleting PostgreSQL log directory: $TMPDIR/primary/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/primary/run/postgresql
+  INFO deleting PostgreSQL log directory: $TMPDIR/secondary/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/secondary/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-transactions.t

@@ -41,7 +41,6 @@ Try to create an instance with a non-existing encoding, triggering a failure in
   INFO initializing PostgreSQL
   WARNING Command '['*/bin/pg_ctl', 'init', '-D', '$TMPDIR/srv/pgsql/test/data', '-o', '--auth-host=trust --auth-local=trust --encoding=notanencoding --locale=C --username=postgres --waldir=$TMPDIR/srv/pgsql/test/wal']' returned non-zero exit status 1. (glob)
   WARNING reverting: initializing PostgreSQL
-  INFO deleting PostgreSQL data and WAL directories
   Error: Command '['*/bin/pg_ctl', 'init', '-D', '$TMPDIR/srv/pgsql/test/data', '-o', '--auth-host=trust --auth-local=trust --encoding=notanencoding --locale=C --username=postgres --waldir=$TMPDIR/srv/pgsql/test/wal']' returned non-zero exit status 1. (glob)
   initdb: error: "notanencoding" is not a valid server encoding name
   pg_ctl: database system initialization failed

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/expect/test-upgrade.t

@@ -66,9 +66,11 @@ Create an instance with "password" local authentication method, and upgrade it:
 (cleanup)
   INFO dropping instance 1\d\/old (re)
   WARNING instance 1\d\/old is already stopped (re)
-  INFO deleting PostgreSQL data and WAL directories
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/old\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/old\/wal (re)
   INFO dropping instance 1\d\/new (re)
   INFO stopping PostgreSQL 1\d\/new (re)
-  INFO deleting PostgreSQL data and WAL directories
-  INFO deleting PostgreSQL log directory
-  INFO deleting PostgreSQL socket directory (no-eol)
+  INFO deleting PostgreSQL data directory: \$TMPDIR\/srv\/pgsql\/1\d\/new\/data (re)
+  INFO deleting PostgreSQL WAL directory: \$TMPDIR\/srv\/pgsql\/1\d\/new\/wal (re)
+  INFO deleting PostgreSQL log directory: $TMPDIR/log/postgresql
+  INFO deleting PostgreSQL socket directory: $TMPDIR/run/postgresql (no-eol)

{pglift_cli-3.0.0 → pglift_cli-3.2.0}/tests/unit/test_model.py

@@ -76,6 +76,8 @@ def test_as_parameters(runner: CliRunner) -> None:
         "Options:\n"
         "  --exclude-none\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
+        "  --gender [female|male|nonbinary|prefer not to say]\n"
+        "                                  Gender.  [required]\n"
         "  --age AGE                       Age.\n"
         "  --address-street STREET         Street lines. (Can be used multiple times.)\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
@@ -102,6 +104,7 @@ def test_as_parameters(runner: CliRunner) -> None:
             "alice",
             "friend",
             "--exclude-none",
+            "--gender=female",
             "--age=42",
             "--address-street=bd montparnasse",
             "--address-street=far far away",
@@ -115,7 +118,6 @@ def test_as_parameters(runner: CliRunner) -> None:
             "--nickname=aaa",
             "--phone-numbers=12345",
         ],
-        input="alc\nalc\n",
     )
     assert result.exit_code == 0, click_result_traceback(result)
     assert json.loads(result.stderr) == {
@@ -127,6 +129,7 @@ def test_as_parameters(runner: CliRunner) -> None:
             "zip_code": 0,
             "primary": True,
         },
+        "gender": "female",
         "age": 42,
         "birth": {"date": "1981-02-18"},
         "is_dead": False,
@@ -158,6 +161,7 @@ def test_as_parameters(runner: CliRunner) -> None:
         [
             "foo",
             "friend",
+            "--gender=female",
             "--age=17",
             "--birth-date=1987-06-05",
             "--nickname=aaa",
@@ -187,6 +191,8 @@ def test_as_parameters_update() -> None:
         "\n"
         "Options:\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
+        "  --gender [female|male|nonbinary|prefer not to say]\n"
+        "                                  Gender.  [required]\n"
         "  --age AGE                       Age.\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
         "  --address-town CITY             City.\n"
@@ -210,16 +216,24 @@ def test_as_parameters_update() -> None:
         ["alice", "--age=5", "--birthdate=2042-02-31"],
     )
     assert result.exit_code == 2, result.output
-    assert "Error: No such option: --birthdate" in result.output
+    assert "Error: No such option '--birthdate'" in result.output
 
     result = runner.invoke(
         update_person,
-        ["alice", "other", "--nickname=a", "--age=5", "--birth-date=1987-06-05"],
+        [
+            "alice",
+            "other",
+            "--nickname=a",
+            "--gender=female",
+            "--age=5",
+            "--birth-date=1987-06-05",
+        ],
     )
     assert result.exit_code == 0, result.output
     assert json.loads(result.output) == {
         "name": "alice",
         "nickname": "**********",
+        "gender": "female",
         "relation": "other",
         "age": 5,
         "birth": {"date": "1987-06-05"},
@@ -229,7 +243,14 @@ def test_as_parameters_update() -> None:
 
     result = runner.invoke(
         update_person,
-        ["alice", "friend", "--nickname=a", "--age=abc", "--birth-date=2010-02-03"],
+        [
+            "alice",
+            "friend",
+            "--nickname=a",
+            "--gender=female",
+            "--age=abc",
+            "--birth-date=2010-02-03",
+        ],
     )
     assert result.exit_code == 2
     assert (
@@ -243,6 +264,7 @@ def test_as_parameters_update() -> None:
             "bob",
             "family",
             "--nickname=b",
+            "--gender=male",
             "--birth-date=1987-06-05",
             "--address-town=laville",
             "--address-country=be",
@@ -263,6 +285,7 @@ def test_as_parameters_update() -> None:
             "marcel",
             "other",
             "--nickname=a",
+            "--gender=male",
             "--age=46",
             "--birth-date=1978-03-09",
             "--add-pet=snoopy",
@@ -276,6 +299,7 @@ def test_as_parameters_update() -> None:
         "name": "marcel",
         "nickname": "**********",
         "relation": "other",
+        "gender": "male",
         "age": 46,
         "birth": {"date": "1978-03-09"},
         "pets": [
@@ -340,6 +364,7 @@ def test_parse_params_as() -> None:
         "name": "alice",
         "relation": "other",
         "nickname": "la malice",
+        "gender": "female",
         "age": 42,
         "address": address_params,
         "birth": {"date": "1976-05-04"},
@@ -348,6 +373,7 @@ def test_parse_params_as() -> None:
         name="alice",
         nickname="la malice",
         relation="other",
+        gender="female",
         age=42,
         address=address,
         birth=models.BirthInformation(date=date(1976, 5, 4)),  # type: ignore[call-arg]
@@ -358,8 +384,60 @@ def test_parse_params_as() -> None:
         "name": "alice",
         "relation": "other",
         "nickname": "la malice",
+        "gender": "female",
         "age": 42,
         "birth_date": "1976-05-04",
     }
     params_nested.update({f"address_{k}": v for k, v in address_params.items()})
     assert model.parse_params_as(models.Person, params_nested) == person
+
+
+def test_as_parameters_unrequired_argument(runner: CliRunner) -> None:
+    @click.command("add-product")
+    @model.as_parameters(models.Product, "create")
+    @click.option("--indent", type=int)
+    def add_product(product: models.Product, indent: int) -> None:
+        """Add a new product."""
+        click.echo(
+            product.model_dump_json(by_alias=True, indent=indent),
+            err=True,
+        )
+
+    result = runner.invoke(add_product, ["--help"])
+    assert result.exit_code == 0, click_result_traceback(result)
+    assert result.stdout == (
+        "Usage: add-product [OPTIONS] [NAME]\n"
+        "\n"
+        "  Add a new product.\n"
+        "\n"
+        "Options:\n"
+        "  --price TEXT               Price.  [required]\n"
+        "  --description DESCRIPTION  Description for the product.\n"
+        "  --indent INTEGER\n"
+        "  --help                     Show this message and exit.\n"
+    )
+
+    result = runner.invoke(
+        add_product,
+        [
+            "--price=19.5",
+            "--description=useless stuff",
+        ],
+    )
+    assert result.exit_code == 0, click_result_traceback(result)
+    assert json.loads(result.stderr) == {
+        "description": "useless stuff",
+        "name": "Unnamed product",
+        "price": 19.5,
+    }
+
+    result = runner.invoke(
+        add_product,
+        ["--price=19.5", "--description=useless stuff", "The Product Name"],
+    )
+    assert result.exit_code == 0, click_result_traceback(result)
+    assert json.loads(result.stderr) == {
+        "description": "useless stuff",
+        "name": "The Product Name",
+        "price": 19.5,
+    }