pglift-cli 2.1.0__tar.gz → 2.3.0__tar.gz

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 2.1.0
+Version: 2.3.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -23,7 +23,7 @@ Classifier: Topic :: Database
 Classifier: Topic :: System :: Systems Administration
 Classifier: Typing :: Typed
 Requires-Python: <4,>=3.10
-Requires-Dist: click!=8.1.0,!=8.1.4,<8.2.0,>=8.0.0
+Requires-Dist: click>=8.2.0
 Requires-Dist: filelock!=3.12.1,>=3.9.0
 Requires-Dist: pluggy
 Requires-Dist: psycopg>=3.1

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/pyproject.toml

@@ -39,7 +39,7 @@ dynamic = ["version"]
 
 dependencies = [
     "PyYAML >= 6.0.1",
-    "click >= 8.0.0, != 8.1.0, != 8.1.4, < 8.2.0",
+    "click >= 8.2.0",
     "filelock >= 3.9.0, != 3.12.1",
     "pluggy",
     "psycopg >= 3.1",
@@ -75,3 +75,6 @@ Tracker = "https://gitlab.com/dalibo/pglift/-/issues/"
 "pglift_cli.pgbackrest" = "pglift_cli.pgbackrest"
 "pglift_cli.pgbackrest.repo_path" = "pglift_cli.pgbackrest.repo_path"
 "pglift_cli.prometheus" = "pglift_cli.prometheus"
+
+[project.scripts]
+pglift = "pglift_cli.main:cli"

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/src/pglift_cli/database.py

@@ -325,9 +325,10 @@ async def dumps(
 @click.argument("dump_id")
 @click.argument("targetdbname", required=False)
 @pass_postgresql_instance
+@dry_run_option
 @async_command
 async def restore(
-    instance: PostgreSQLInstance, dump_id: str, targetdbname: str | None
+    instance: PostgreSQLInstance, dump_id: str, targetdbname: str | None, dry_run: bool
 ) -> None:
     """Restore a database dump
 
@@ -340,5 +341,6 @@ async def restore(
     name that appears in the dump. In this case, the restore command will
     create the database so it needs to be dropped before running the command.
     """
-    async with postgresql.running(instance):
-        await databases.restore(instance, dump_id, targetdbname)
+    with system_configure(dry_run=dry_run):
+        async with postgresql.running(instance):
+            await databases.restore(instance, dump_id, targetdbname)

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/src/pglift_cli/instance.py

@@ -25,8 +25,11 @@ from pglift import (
     task,
 )
 from pglift.models import Instance, PostgreSQLInstance, interface
-from pglift.settings import default_postgresql_version
-from pglift.settings._postgresql import PostgreSQLVersion
+from pglift.settings import (
+    POSTGRESQL_VERSIONS,
+    PostgreSQLVersion,
+    default_postgresql_version,
+)
 from pglift.types import Operation, Status, validation_context
 
 from . import _site, model
@@ -279,7 +282,7 @@ async def get(instance: Instance, output_format: OutputFormat | None) -> None:
 @cli.command("list")
 @click.option(
     "--version",
-    type=click.Choice(list(PostgreSQLVersion)),
+    type=click.Choice(POSTGRESQL_VERSIONS),
     help="Only list instances of specified version.",
 )
 @output_format_option
@@ -403,7 +406,7 @@ async def restart(
 @instance_identifier(nargs=1, required=True)
 @click.argument("command", required=True, nargs=-1, type=click.UNPROCESSED)
 def exec(instance: Instance, command: tuple[str, ...]) -> None:
-    """Execute command in the libpq environment for PostgreSQL INSTANCE.
+    """Execute COMMAND in the libpq environment for PostgreSQL INSTANCE.
 
     COMMAND parts may need to be prefixed with -- to separate them from
     options when confusion arises.
@@ -526,7 +529,7 @@ async def list_privileges(
 @click.option(
     "--version",
     "newversion",
-    type=click.Choice(list(PostgreSQLVersion)),
+    type=click.Choice(POSTGRESQL_VERSIONS),
     help="PostgreSQL version of the new instance (default to site-configured value).",
 )
 @click.option(

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/src/pglift_cli/model.py

@@ -4,7 +4,6 @@
 
 from __future__ import annotations
 
-import enum
 import functools
 import inspect
 import typing
@@ -24,7 +23,6 @@ from pglift.models.helpers import is_optional, optional_type
 from pglift.models.interface import PresenceState
 from pglift.types import (
     Operation,
-    StrEnum,
     field_annotation,
     validation_context,
 )
@@ -106,7 +104,7 @@ def as_parameters(model_type: ModelType, operation: Operation) -> ClickDecorator
                 )
 
             @functools.wraps(f)
-            def callback(**kwargs: Any) -> Any:  # type: ignore[misc]
+            def callback(**kwargs: Any) -> Any:
                 args = params_to_modelargs(kwargs)
                 with (
                     catch_validationerror(*paramspecs),
@@ -358,14 +356,6 @@ def _paramspecs_from_model(
                     choices = config.choices
                 attrs["type"] = click.Choice(choices)
 
-            elif lenient_issubclass(ftype, enum.Enum):
-                if config:
-                    assert isinstance(config, cli.Choices)
-                    choices = config.choices
-                else:
-                    choices = choices_from_enum(ftype)
-                attrs["type"] = click.Choice(choices)
-
             elif lenient_issubclass(origin_type or ftype, list):
                 attrs["multiple"] = True
                 try:
@@ -373,10 +363,7 @@ def _paramspecs_from_model(
                 except ValueError:
                     pass
                 else:
-                    if lenient_issubclass(itemtype, enum.Enum):
-                        attrs["type"] = click.Choice(choices_from_enum(itemtype))
-                    else:
-                        attrs["metavar"] = metavar
+                    attrs["metavar"] = metavar
                 if not _parents and operation == "update" and is_editable(itemtype):
                     # List fields for the "update" operation are mapped to
                     # --add-<fname>, --remove-<fname> options; built and yield
@@ -460,13 +447,6 @@ def _paramspecs_from_model(
             )
 
 
-def choices_from_enum(e: type[enum.Enum]) -> list[Any]:
-    if lenient_issubclass(e, StrEnum):
-        return list(e)
-    else:
-        return [v.value for v in e]
-
-
 @contextmanager
 def catch_validationerror(*paramspec: ParamSpec) -> Iterator[None]:
     try:

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/src/pglift_cli/pghba.py

@@ -16,6 +16,7 @@ from .console import console
 from .util import (
     Group,
     Obj,
+    async_command,
     audit,
     diff_options,
     dry_run_option,
@@ -38,7 +39,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 +58,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 +71,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 +90,7 @@ 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)

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/src/pglift_cli/util.py

@@ -37,7 +37,7 @@ from rich.table import Table
 
 from pglift import exceptions, instances, system
 from pglift.models import Instance, PostgreSQLInstance, helpers, interface
-from pglift.settings import Settings
+from pglift.settings import PostgreSQLVersion, Settings
 from pglift.system import install
 from pglift.types import ByteSizeType
 
@@ -116,7 +116,6 @@ def print_table_for(
     **kwargs: Any,
 ) -> None:
     """Render a list of items as a table."""
-    table = None
     headers: list[str] = []
     rows = []
     for item in items:
@@ -139,7 +138,13 @@ def print_table_for(
         rows.append(row)
     if not rows:
         return
-    table = Table(*headers, title=title, **kwargs)
+    table = Table(title=title, **kwargs)
+    # https://github.com/Textualize/rich/issues/3761
+    overflow: Literal["ellipsis", "fold"] = (
+        "fold" if console.options.ascii_only else "ellipsis"
+    )
+    for header in headers:
+        table.add_column(header, overflow=overflow)
     for row in rows:
         table.add_row(*row)
     console.print(table)
@@ -219,13 +224,13 @@ def pass_postgresql_instance(f: Callable[P, None]) -> Callable[P, None]:
 
 
 def get_postgresql_instance(
-    name: str, version: str | None, settings: Settings
+    name: str, version: PostgreSQLVersion | None, settings: Settings
 ) -> PostgreSQLInstance:
     """Return a PostgreSQLInstance from name/version, possibly guessing version if unspecified."""
     if version is None:
         found = None
         for v in settings.postgresql.versions:
-            version = v.version.value
+            version = v.version
             try:
                 instance = PostgreSQLInstance.system_lookup(name, version, settings)
             except exceptions.InstanceNotFound:
@@ -249,19 +254,21 @@ def get_postgresql_instance(
         raise click.BadParameter(str(e)) from None
 
 
-def get_instance(name: str, version: str | None, settings: Settings) -> Instance:
+def get_instance(
+    name: str, version: PostgreSQLVersion | None, settings: Settings
+) -> Instance:
     """Return an Instance from name/version, possibly guessing version if unspecified."""
     pg_instance = get_postgresql_instance(name, version, settings)
     return Instance.from_postgresql(pg_instance)
 
 
-def nameversion_from_id(instance_id: str) -> tuple[str, str | None]:
+def nameversion_from_id(instance_id: str) -> tuple[str, PostgreSQLVersion | None]:
     version = None
     try:
         version, name = instance_id.split("/", 1)
     except ValueError:
         name = instance_id
-    return name, version
+    return name, typing.cast(PostgreSQLVersion, version)
 
 
 def postgresql_instance_lookup(
@@ -732,12 +739,13 @@ class Group(click.Group):
         super().add_command(command, name)
 
     def invoke(self, ctx: click.Context) -> Any:
-        if is_root():
-            raise click.ClickException("pglift cannot be used as root")
-        if not install.check(_site.SETTINGS):
-            raise click.ClickException(
-                "broken installation; did you run 'site-configure install'?",
-            )
+        if set(ctx.help_option_names) - set(ctx.args):
+            if is_root():
+                raise click.ClickException("pglift cannot be used as root")
+            if not install.check(_site.SETTINGS):
+                raise click.ClickException(
+                    "broken installation; did you run 'site-configure install'?",
+                )
         return super().invoke(ctx)
 
 

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/expect/test-cli-walkthrough.t

@@ -4,6 +4,7 @@
 
 Site settings:
 
+  $ export PYTHONIOENCODING=ascii
   $ cat > $TMPDIR/passwords.json << 'EOF'
   > {
   >   "main": {
@@ -249,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
@@ -293,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)
@@ -390,7 +391,7 @@ PostgreSQL configuration
   port: \d+ -> 1234 (re)
   DRY RUN: no changes made
 
-pg_hba.conf management:
+HBA configuration management:
 
   $ pglift pghba add --user bob --method trust
   INFO entry added to HBA configuration
@@ -500,8 +501,14 @@ Add and manipulate roles:
   \*:\d+:\*:dba:qwerty (re)
 
   $ pglift role get dba
-   name  has_\xe2\x80\xa6  inhe\xe2\x80\xa6  login  supe\xe2\x80\xa6  crea\xe2\x80\xa6  crea\xe2\x80\xa6  rep\xe2\x80\xa6  conn\xe2\x80\xa6  val\xe2\x80\xa6  memb\xe2\x80\xa6  pgp\xe2\x80\xa6  (esc)
-   dba   True   True   True   False  False  False  Fal\xe2\x80\xa6               pg_r\xe2\x80\xa6  True  (esc)
+                                                         conne                    
+         has_p                                     repl  ction  vali  membe       
+         asswo  inher         super  creat  creat  icat  _limi  d_un  rship  pgpa 
+   name  rd     it     login  user   edb    erole  ion   t      til   s      ss   
+   dba   True   True   True   False  False  False  Fals               pg_re  True 
+                                                   e                  ad_al       
+                                                                      l_sta       
+                                                                      ts          
 
   $ pglift role -i main create dba --dry-run
   Error: role already exists
@@ -576,7 +583,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
@@ -586,7 +593,7 @@ 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)
@@ -822,11 +829,11 @@ Databases
   INFO SELECT 1
    Database 
     other   
-  ┏━━━━━━━━┓
-  ┃ exists ┃
-  ┡━━━━━━━━┩
-  │ False  │
-  └────────┘
+  +--------+
+  | exists |
+  |--------|
+  | False  |
+  +--------+
   $ pglift database apply -f $TMPDIR/other.yaml -o json --diff
   INFO altering 'other' database on instance 1\d\/main (re)
   INFO creating extension 'pg_stat_statements' in database other
@@ -839,11 +846,11 @@ Databases
   INFO SELECT 1
    Database 
     other   
-  ┏━━━━━━━━┓
-  ┃ exists ┃
-  ┡━━━━━━━━┩
-  │ True   │
-  └────────┘
+  +--------+
+  | exists |
+  |--------|
+  | True   |
+  +--------+
   $ cat > $TMPDIR/other.yaml <<EOF
   > name: other
   > state: absent
@@ -855,8 +862,11 @@ Databases
   INFO dropping 'other' database
   DRY RUN: no changes made
   $ pglift database get other
-   name   owner    settin…  schemas  extensi…  locale  public…  subscri…  tables…  (esc)
-   other  postgr…           public   pg_stat…  C                          pg_def…  (esc)
+                   setting           extensio          publica  subscrip  tablesp 
+   name   owner    s        schemas  ns        locale  tions    tions     ace     
+   other  postgre           public   pg_stat_  C                          pg_defa 
+          s                          statemen                             ult     
+                                     ts                                           
   $ pglift database create other
   Error: database already exists
   [1]
@@ -1040,6 +1050,18 @@ Databases
   $ pglift database drop myapp
   INFO dropping 'myapp' database
 
+  $ pglift database restore doesnt_exist_id --dry-run
+  Error: dump 'doesnt_exist_id' not found
+  [1]
+
+  $ pglift database restore doesnt_exist_id
+  Error: dump 'doesnt_exist_id' not found
+  [1]
+
+  $ pglift database restore $DUMP_ID --dry-run
+  INFO restoring dump for 'myapp' on instance 1\d\/main (re)
+  DRY RUN: no changes made
+
   $ pglift database restore $DUMP_ID
   INFO restoring dump for 'myapp' on instance 1\d\/main (re)
 
@@ -1080,7 +1102,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'
@@ -1095,11 +1117,11 @@ Databases
   [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
 
 Profiles
   $ pglift role -i main create dba1 --password mySup3rS3cr3t1377 --login

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/expect/test-help.t

@@ -6,53 +6,77 @@ Tests for --help options of all commands
 
 Site settings
 
-  $ PATRONI_CMD=$(command -v patroni)
-  $ PATRONICTL=$(command -v patronictl)
-  $ POSTGRES_EXPORTER=$(command -v postgres_exporter || command -v prometheus-postgres-exporter)
   $ export PGLIFT_CLI__LOG_FORMAT="%(levelname)-4s %(message)s"
   $ export PGLIFT_CONFIG_DIR=$TMPDIR
   $ export PGLIFT_PREFIX=$TMPDIR
   $ export PGLIFT_RUN_PREFIX=$TMPDIR/run
-  $ export PGLIFT_PATRONI='{"execpath": "'$PATRONI_CMD'", "ctlpath": "'$PATRONICTL'"}'
-  $ export PGLIFT_PGBACKREST='{
-  >       "repository": {
-  >           "mode": "path",
-  >           "path": "'$TMPDIR'/test-help/backups"
-  >       }
-  > }'
-  $ export PGLIFT_POSTGRESQL__AUTH__PASSFILE="null"
-  $ export PGLIFT_POSTGRESQL__REPLROLE="replication"
+
+  $ bindir=$TMPDIR/$TESTFILE/bin
+  $ mkdir -p $bindir/pgsql/17/bin
+  $ touch $bindir/pgsql/17/bin/pg_ctl
+  $ chmod +x $bindir/pgsql/17/bin/pg_ctl
+  $ export PGLIFT_POSTGRESQL__BINDIR=$bindir/pgsql/{version}/bin \
+  >     PGLIFT_POSTGRESQL__AUTH__PASSFILE="null" \
+  >     PGLIFT_POSTGRESQL__REPLROLE="replication"
+  $ export PGLIFT_PATRONI__EXECPATH=$bindir/patroni \
+  >     PGLIFT_PATRONI__CTLPATH=$bindir/patronictl \
+  >     PGLIFT_PGBACKREST__EXECPATH=$bindir/pgbackrest \
+  >     PGLIFT_PROMETHEUS__EXECPATH=$bindir/postgres_exporter
+  $ touch $PGLIFT_PATRONI__EXECPATH \
+  >     $PGLIFT_PATRONI__CTLPATH \
+  >     $PGLIFT_PGBACKREST__EXECPATH \
+  >     $PGLIFT_PROMETHEUS__EXECPATH
+  $ export PGLIFT_PGBACKREST__REPOSITORY__MODE=path \
+  >     PGLIFT_PGBACKREST__REPOSITORY__PATH=$TMPDIR/$TESTFILE/backups
+  $ mkdir $PGLIFT_PGBACKREST__REPOSITORY__PATH
   $ export PGLIFT_POWA='{}'
-  $ export PGLIFT_PROMETHEUS__EXECPATH=$POSTGRES_EXPORTER
+
   $ pglift site-settings --no-defaults -o json \
-  >   | jq '.pgbackrest, .prometheus, .prefix, .run_prefix'
+  >   | jq '.postgresql, .pgbackrest, .prometheus, .prefix, .run_prefix'
   {
+    "bindir": "$TMPDIR/*/bin/pgsql/{version}/bin", (glob)
+    "versions": [
+      {
+        "version": "17",
+        "bindir": "$TMPDIR/*/bin/pgsql/17/bin" (glob)
+      }
+    ],
+    "auth": {
+      "passfile": null
+    },
+    "replrole": "replication",
+    "datadir": "$TMPDIR/srv/pgsql/{version}/{name}/data",
+    "waldir": "$TMPDIR/srv/pgsql/{version}/{name}/wal",
+    "logpath": "$TMPDIR/log/postgresql",
+    "socket_directory": "$TMPDIR/run/postgresql",
+    "dumps_directory": "$TMPDIR/srv/dumps/{version}-{name}"
+  }
+  {
+    "execpath": "$TMPDIR/*/bin/pgbackrest", (glob)
     "configpath": "$TMPDIR/etc/pgbackrest",
     "repository": {
       "mode": "path",
-      "path": "$TMPDIR/test-help/backups"
+      "path": "$TMPDIR/*/backups" (glob)
     },
     "logpath": "$TMPDIR/log/pgbackrest",
     "spoolpath": "$TMPDIR/srv/pgbackrest/spool",
     "lockpath": "$TMPDIR/run/pgbackrest/lock"
   }
   {
-    "execpath": ".*postgres[-_]exporter", (re)
+    "execpath": "$TMPDIR/*/bin/postgres_exporter", (glob)
     "configpath": "$TMPDIR/etc/prometheus/postgres_exporter-{name}.conf",
     "pid_file": "$TMPDIR/run/prometheus/{name}.pid"
   }
   "$TMPDIR"
   "$TMPDIR/run"
 
-  $ trap "pglift --non-interactive --log-level=INFO site-configure uninstall" EXIT
-
   $ pglift --help
   Usage: pglift [OPTIONS] COMMAND [ARGS]...
   
     Deploy production-ready instances of PostgreSQL
   
   Options:
-    -L, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
+    -L, --log-level [debug|info|warning|error|critical]
                                     Set log threshold (default to INFO when
                                     logging to stderr or WARNING when logging to
                                     a file).
@@ -81,23 +105,17 @@ Site configuration
   $ pglift site-configure list
   $TMPDIR/etc/pgbackrest/conf.d
   $TMPDIR/etc/pgbackrest/pgbackrest.conf
-  $TMPDIR/test-help/backups
+  $TMPDIR/*/backups (glob)
   $TMPDIR/log/pgbackrest
   $TMPDIR/srv/pgbackrest/spool
   $TMPDIR/log/postgresql
-  $ pglift --log-level=INFO 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 repository backups and archive directory: $TMPDIR/test-help/backups
-  INFO creating pgBackRest log directory: $TMPDIR/log/pgbackrest
-  INFO creating pgBackRest spool directory: $TMPDIR/srv/pgbackrest/spool
-  INFO creating PostgreSQL log directory: $TMPDIR/log/postgresql
   $ env PGLIFT_LOGGERS='pglift_cli,pglift,filelock' \
   >     pglift --log-level=debug --log-file=$TMPDIR/check.log site-configure check
+  [1]
   $ cat $TMPDIR/check.log
   DEBUG Attempting to acquire lock \d+ on \$TMPDIR\/run\/.pglift.lock (re)
   DEBUG Lock \d+ acquired on \$TMPDIR\/run\/.pglift.lock (re)
+  ERROR pgBackRest configuration path $TMPDIR/etc/pgbackrest/conf.d missing
   DEBUG Attempting to release lock \d+ on \$TMPDIR\/run\/.pglift.lock (re)
   DEBUG Lock \d+ released on \$TMPDIR\/run\/.pglift.lock (re)
 
@@ -120,7 +138,7 @@ Instance commands
     demote      Demote PostgreSQL INSTANCE as standby of specified source...
     drop        Drop PostgreSQL INSTANCE
     env         Output environment variables suitable to handle to...
-    exec        Execute command in the libpq environment for PostgreSQL...
+    exec        Execute COMMAND in the libpq environment for PostgreSQL...
     get         Get the description of PostgreSQL INSTANCE.
     list        List the available instances
     logs        Output PostgreSQL logs of INSTANCE.
@@ -313,7 +331,7 @@ Instance commands
   $ pglift instance exec --help
   Usage: pglift instance exec [OPTIONS] INSTANCE COMMAND...
   
-    Execute command in the libpq environment for PostgreSQL INSTANCE.
+    Execute COMMAND in the libpq environment for PostgreSQL INSTANCE.
   
     COMMAND parts may need to be prefixed with -- to separate them from options
     when confusion arises.
@@ -774,6 +792,23 @@ Database commands
   Options:
     -o, --output-format [json]  Specify the output format.
     --help                      Show this message and exit.
+  $ pglift database restore --help
+  Usage: pglift database restore [OPTIONS] DUMP_ID [TARGETDBNAME]
+  
+    Restore a database dump
+  
+    DUMP_ID identifies the dump id.
+  
+    TARGETDBNAME identifies the (optional) name of the database in which the
+    dump is reloaded. If provided, the database needs to be created beforehand.
+  
+    If TARGETDBNAME is not provided, the dump is reloaded using the database
+    name that appears in the dump. In this case, the restore command will create
+    the database so it needs to be dropped before running the command.
+  
+  Options:
+    --dry-run  Simulate change operations.
+    --help     Show this message and exit.
   $ pglift database get --help
   Usage: pglift database get [OPTIONS] NAME
   
@@ -1023,9 +1058,3 @@ Patroni commands:
   Options:
     --help  Show this message and exit.
 
-(Cleanup)
-  INFO deleting pgBackRest include directory
-  INFO uninstalling base pgBackRest configuration
-  INFO deleting pgBackRest log directory
-  INFO deleting pgBackRest spool directory
-  INFO deleting PostgreSQL log directory (no-eol)

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/unit/conftest.py

@@ -19,7 +19,7 @@ pytest_plugins = [
 
 @pytest.fixture
 def runner() -> CliRunner:
-    return CliRunner(mix_stderr=False)
+    return CliRunner()
 
 
 @pytest.fixture

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/unit/test_cli.py

@@ -259,7 +259,7 @@ def test_command_as_root(runner: CliRunner, obj: Obj) -> None:
 
     @app.command
     def cmd(instance: system.Instance) -> None:
-        pass
+        """Something for testing."""
 
     with patch("pglift_cli.util.is_root", autospec=True, return_value=True) as is_root:
         result = runner.invoke(app, ["cmd"], obj=obj)
@@ -267,6 +267,13 @@ def test_command_as_root(runner: CliRunner, obj: Obj) -> None:
     assert result.exit_code == 1
     assert "Error: pglift cannot be used as root" in result.stderr
 
+    # Invocation with --help is allowed though.
+    with patch("pglift_cli.util.is_root", autospec=True, return_value=True) as is_root:
+        result = runner.invoke(app, ["cmd", "myinstance", "--help"], obj=obj)
+    assert not is_root.called
+    assert result.exit_code == 0
+    assert "Something for testing." in result.stdout
+
 
 @pytest.mark.usefixtures("site_settings")
 def test_instance_commands_completion(obj: Obj) -> None:

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/unit/test_main.py

@@ -24,8 +24,8 @@ def obj() -> Obj:
 def test_cli(runner: CliRunner, obj: Obj) -> None:
     # invoke the CLI with no option, sanity check
     result = runner.invoke(main.cli, obj=obj)
-    assert result.exit_code == 0
-    assert result.stdout.splitlines()[0] == "Usage: cli [OPTIONS] COMMAND [ARGS]..."
+    assert result.exit_code == 2
+    assert result.stderr.splitlines()[0] == "Usage: cli [OPTIONS] COMMAND [ARGS]..."
 
 
 def test_non_interactive(runner: CliRunner) -> None:

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/unit/test_model.py

@@ -52,7 +52,7 @@ def test_as_parameters_typeerror() -> None:
             pass
 
 
-def test_as_parameters() -> None:
+def test_as_parameters(runner: CliRunner) -> None:
     @click.command("add-person")
     @click.option("--exclude-none", is_flag=True, default=False)
     @model.as_parameters(models.Person, "create")
@@ -66,7 +66,6 @@ def test_as_parameters() -> None:
             err=True,
         )
 
-    runner = CliRunner(mix_stderr=False)
     result = runner.invoke(add_person, ["--help"])
     assert result.exit_code == 0, click_result_traceback(result)
     assert result.stdout == (
@@ -77,7 +76,6 @@ def test_as_parameters() -> None:
         "Options:\n"
         "  --exclude-none\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
-        "  --gender [M|F]\n"
         "  --age AGE                       Age.\n"
         "  --address-street STREET         Street lines. (Can be used multiple times.)\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
@@ -104,7 +102,6 @@ def test_as_parameters() -> None:
             "friend",
             "--exclude-none",
             "--age=42",
-            "--gender=F",
             "--address-street=bd montparnasse",
             "--address-street=far far away",
             "--address-town=paris",
@@ -131,7 +128,6 @@ def test_as_parameters() -> None:
         },
         "age": 42,
         "birth": {"date": "1981-02-18"},
-        "gender": "F",
         "name": "alice",
         "nickname": "**********",
         "relation": "friend",
@@ -174,7 +170,6 @@ def test_as_parameters_update() -> None:
         "\n"
         "Options:\n"
         "  --nickname TEXT                 Your secret nickname.  [required]\n"
-        "  --gender [M|F]\n"
         "  --age AGE                       Age.\n"
         "  --address-zip-code ZIP_CODE     ZIP code.\n"
         "  --address-town CITY             City.\n"
@@ -279,7 +274,6 @@ def test_unnest() -> None:
     params = {
         "name": "alice",
         "age": 42,
-        "gender": "F",
         "address_city": "paris",
         "address_country": "fr",
         "address_street": ["bd montparnasse"],
@@ -291,7 +285,6 @@ def test_unnest() -> None:
     assert model.unnest(models.Person, params) == {
         "name": "alice",
         "age": 42,
-        "gender": "F",
         "address": {
             "city": "paris",
             "coords": {"long": 0, "lat": 1.2},
@@ -330,7 +323,6 @@ def test_parse_params_as() -> None:
         "relation": "other",
         "nickname": "la malice",
         "age": 42,
-        "gender": "F",
         "address": address_params,
         "birth": {"date": "1976-05-04"},
     }
@@ -339,7 +331,6 @@ def test_parse_params_as() -> None:
         nickname="la malice",
         relation="other",
         age=42,
-        gender=models.Gender.female,
         address=address,
         birth=models.BirthInformation(date=date(1976, 5, 4)),  # type: ignore[call-arg]
     )
@@ -350,7 +341,6 @@ def test_parse_params_as() -> None:
         "relation": "other",
         "nickname": "la malice",
         "age": 42,
-        "gender": "F",
         "birth_date": "1976-05-04",
     }
     params_nested.update({f"address_{k}": v for k, v in address_params.items()})

{pglift_cli-2.1.0 → pglift_cli-2.3.0}/tests/unit/test_util.py

@@ -21,7 +21,7 @@ from rich.console import Console
 
 from pglift import exceptions
 from pglift.models import interface, system
-from pglift.settings import Settings
+from pglift.settings import PostgreSQLVersion, Settings
 from pglift.types import ByteSizeType
 from pglift_cli import util
 
@@ -346,7 +346,7 @@ def test_asynccommand(runner: CliRunner) -> None:
 
 
 def test_get_instance(
-    settings: Settings, pg_version: str, instance: system.Instance
+    settings: Settings, pg_version: PostgreSQLVersion, instance: system.Instance
 ) -> None:
     assert util.get_instance(instance.name, pg_version, settings) == instance