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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 2.0.0
+Version: 2.1.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.0.0
+Requires-Dist: click!=8.1.0,!=8.1.4,<8.2.0,>=8.0.0
 Requires-Dist: filelock!=3.12.1,>=3.9.0
 Requires-Dist: pluggy
 Requires-Dist: psycopg>=3.1

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

@@ -39,7 +39,7 @@ dynamic = ["version"]
 
 dependencies = [
     "PyYAML >= 6.0.1",
-    "click >= 8.0.0, != 8.1.0, != 8.1.4",
+    "click >= 8.0.0, != 8.1.0, != 8.1.4, < 8.2.0",
     "filelock >= 3.9.0, != 3.12.1",
     "pluggy",
     "psycopg >= 3.1",

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

@@ -37,6 +37,7 @@ from .util import (
     print_result_diff,
     print_schema,
     print_table_for,
+    system_configure,
 )
 
 
@@ -65,14 +66,18 @@ def cli(**kwargs: Any) -> None:
 
 @cli.command("create")
 @model.as_parameters(interface.Database, "create")
+@dry_run_option
 @pass_postgresql_instance
 @click.pass_obj
 @async_command
 async def create(
-    obj: Obj, instance: PostgreSQLInstance, database: interface.Database
+    obj: Obj,
+    instance: PostgreSQLInstance,
+    database: interface.Database,
+    dry_run: bool,
 ) -> None:
     """Create a database in a PostgreSQL instance"""
-    with obj.lock, audit():
+    with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         async with postgresql.running(instance):
             if await databases.exists(instance, database.name):
                 raise click.ClickException("database already exists")
@@ -83,14 +88,19 @@ async def create(
 @cli.command("alter")
 @model.as_parameters(interface.Database, "update")
 @click.argument("dbname")
+@dry_run_option
 @pass_postgresql_instance
 @click.pass_obj  # type: ignore[arg-type]
 @async_command
 async def alter(
-    obj: Obj, instance: PostgreSQLInstance, dbname: str, **changes: Any
+    obj: Obj,
+    instance: PostgreSQLInstance,
+    dbname: str,
+    dry_run: bool,
+    **changes: Any,
 ) -> None:
     """Alter a database in a PostgreSQL instance"""
-    with obj.lock, audit():
+    with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         async with postgresql.running(instance):
             values = (await databases.get(instance, dbname)).model_dump(by_alias=True)
             values = deep_update(values, changes)
@@ -117,12 +127,14 @@ async def apply(
 ) -> None:
     """Apply manifest as a database"""
     database = interface.Database.model_validate(data)
-    if dry_run:
-        ret = interface.ApplyResult(change_state=None)
-    else:
-        with obj.lock, audit(dry_run=dry_run), diff.enabled(diff_format):
-            async with postgresql.running(instance):
-                ret = await databases.apply(instance, database)
+    with (
+        obj.lock,
+        audit(dry_run=dry_run),
+        diff.enabled(diff_format),
+        system_configure(dry_run=dry_run),
+    ):
+        async with postgresql.running(instance):
+            ret = await databases.apply(instance, database)
     if output_format == "json":
         print_json_for(ret)
     else:
@@ -181,6 +193,7 @@ async def ls(
 
 @cli.command("drop")
 @model.as_parameters(interface.DatabaseDropped, "create")
+@dry_run_option
 @pass_postgresql_instance
 @click.pass_obj
 @async_command
@@ -188,9 +201,10 @@ async def drop(
     obj: Obj,
     instance: PostgreSQLInstance,
     databasedropped: interface.DatabaseDropped,
+    dry_run: bool,
 ) -> None:
     """Drop a database"""
-    with obj.lock, audit():
+    with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         async with postgresql.running(instance):
             await databases.drop(instance, databasedropped)
 
@@ -274,11 +288,15 @@ async def run(
 )
 @click.argument("dbname")
 @pass_postgresql_instance
+@dry_run_option
 @async_command
-async def dump(instance: PostgreSQLInstance, dbname: str, output: Path | None) -> None:
+async def dump(
+    instance: PostgreSQLInstance, dbname: str, output: Path | None, dry_run: bool
+) -> None:
     """Dump a database"""
-    async with postgresql.running(instance):
-        await databases.dump(instance, dbname, output)
+    with system_configure(dry_run=dry_run):
+        async with postgresql.running(instance):
+            await databases.dump(instance, dbname, output)
 
 
 @cli.command("dumps")

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

@@ -114,8 +114,8 @@ async def create(obj: Obj, instance: interface.Instance, drop_on_error: bool) ->
     with obj.lock, audit():
         if instances.exists(instance.name, instance.version, _site.SETTINGS):
             raise click.ClickException("instance already exists")
-        async with task.async_transaction(drop_on_error):
-            with manager.from_manifest(instance, settings=_site.SETTINGS):
+        with manager.from_manifest(instance, settings=_site.SETTINGS):
+            async with task.async_transaction(drop_on_error):
                 await instances.apply(_site.SETTINGS, instance)
 
 
@@ -213,6 +213,41 @@ async def promote(obj: Obj, instance: Instance) -> None:
         await instances.promote(instance)
 
 
+@cli.command("demote")
+@instance_identifier(nargs=1)
+@model.as_parameters(postgresql.RewindSource, "create")
+@click.option(
+    "--start/--no-start",
+    help="Start the instance at the end of the demotion process",
+    default=True,
+    show_default=True,
+)
+@click.argument("rewind_opts", nargs=-1, type=click.UNPROCESSED)
+@click.pass_obj
+@async_command
+async def demote(
+    obj: Obj,
+    instance: Instance,
+    rewindsource: postgresql.RewindSource,
+    start: bool,
+    rewind_opts: tuple[str, ...],
+) -> None:
+    """Demote PostgreSQL INSTANCE as standby of specified source server using pg_rewind.
+
+    The instance must not be running and it may be started at the end of the
+    "demotion" process.
+
+    Extra options can be passed to the pg_rewind command. They may need to
+    be prefixed with -- to separate them from the current command options
+    when confusion arises. When using extra options, providing the instance
+    identifier is required.
+    """
+    with obj.lock, audit(), manager.from_instance(instance.postgresql):
+        await instances.demote(instance, rewindsource, rewind_opts=rewind_opts)
+        if start:
+            await instances.start(instance)
+
+
 @cli.command("get")
 @output_format_option
 @instance_identifier(nargs=1)
@@ -519,8 +554,8 @@ async def upgrade(
     """
     with obj.lock, audit():
         await postgresql.check_status(instance.postgresql, Status.not_running)
-        async with task.async_transaction():
-            with manager.from_instance(instance.postgresql):
+        with manager.from_instance(instance.postgresql):
+            async with task.async_transaction():
                 new_instance = await instances.upgrade(
                     instance,
                     version=newversion,

{pglift_cli-2.0.0 → pglift_cli-2.1.0}/src/pglift_cli/pgbackrest/__init__.py

@@ -12,7 +12,7 @@ import click
 
 from pglift import pgbackrest, postgresql, types
 from pglift.models import Instance
-from pglift.pgbackrest import base, models
+from pglift.pgbackrest import models
 from pglift.pgbackrest import register_if as register_if
 
 from .. import _site, hookimpl
@@ -46,7 +46,7 @@ def pgbackrest_proxy(
     """Proxy to pgbackrest operations on an instance"""
     s = context.obj.instance.service(models.Service)
     settings = pgbackrest.get_settings(_site.SETTINGS)
-    cmd_args = base.make_cmd(s.stanza, settings, *command)
+    cmd_args = pgbackrest.make_cmd(s.stanza, settings, *command)
     try:
         subprocess.run(cmd_args, capture_output=False, check=True)  # nosec
     except subprocess.CalledProcessError as e:
@@ -70,7 +70,7 @@ async def instance_restore(
         ) from None
     settings = pgbackrest.get_settings(_site.SETTINGS)
     with obj.lock, audit():
-        await base.restore(instance, settings, label=label, date=date)
+        await pgbackrest.restore(instance, settings, label=label, date=date)
 
 
 @click.command("backups", cls=Command)
@@ -82,7 +82,7 @@ async def instance_backups(
 ) -> None:
     """List available backups for INSTANCE"""
     settings = pgbackrest.get_settings(_site.SETTINGS)
-    backups = [b async for b in base.iter_backups(instance, settings)]
+    backups = [b async for b in pgbackrest.iter_backups(instance, settings)]
     if output_format == "json":
         print_json_for([model_dump(b) for b in backups])
     else:

{pglift_cli-2.0.0 → pglift_cli-2.1.0}/src/pglift_cli/role.py

@@ -35,6 +35,7 @@ from .util import (
     print_result_diff,
     print_schema,
     print_table_for,
+    system_configure,
 )
 
 
@@ -76,11 +77,14 @@ def cli(**kwargs: Any) -> None:
 @cli.command("create")
 @model.as_parameters(_site.ROLE_MODEL, "create")
 @pass_postgresql_instance
+@dry_run_option
 @click.pass_obj
 @async_command
-async def create(obj: Obj, instance: PostgreSQLInstance, role: interface.Role) -> None:
+async def create(
+    obj: Obj, instance: PostgreSQLInstance, role: interface.Role, dry_run: bool
+) -> None:
     """Create a role in a PostgreSQL instance"""
-    with obj.lock, audit():
+    with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         async with postgresql.running(instance):
             if await roles.exists(instance, role.name):
                 raise click.ClickException("role already exists")
@@ -92,13 +96,14 @@ async def create(obj: Obj, instance: PostgreSQLInstance, role: interface.Role) -
 @model.as_parameters(_site.ROLE_MODEL, "update")
 @click.argument("rolname")
 @pass_postgresql_instance
+@dry_run_option
 @click.pass_obj  # type: ignore[arg-type]
 @async_command
 async def alter(
-    obj: Obj, instance: PostgreSQLInstance, rolname: str, **changes: Any
+    obj: Obj, instance: PostgreSQLInstance, rolname: str, dry_run: bool, **changes: Any
 ) -> None:
     """Alter a role in a PostgreSQL instance"""
-    with obj.lock, audit():
+    with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         async with postgresql.running(instance):
             with manager.from_instance(instance):
                 values = model_dump(await roles.get(instance, rolname))
@@ -136,13 +141,15 @@ async def apply(
     )
     with validation_context(operation=op, settings=_site.SETTINGS):
         role = _site.ROLE_MODEL.model_validate(data)
-    if dry_run:
-        ret = interface.ApplyResult(change_state=None)
-    else:
-        with obj.lock, audit(dry_run=dry_run), diff.enabled(diff_format):
-            async with postgresql.running(instance):
-                with manager.from_instance(instance):
-                    ret = await roles.apply(instance, role)
+    with (
+        obj.lock,
+        audit(dry_run=dry_run),
+        diff.enabled(diff_format),
+        system_configure(dry_run=dry_run),
+    ):
+        async with postgresql.running(instance):
+            with manager.from_instance(instance):
+                ret = await roles.apply(instance, role)
     if output_format == "json":
         print_json_for(ret)
     else:
@@ -192,14 +199,16 @@ async def get(
 @cli.command("drop")
 @model.as_parameters(interface.RoleDropped, "create")
 @pass_postgresql_instance
+@dry_run_option
 @async_command
 async def drop(
-    instance: PostgreSQLInstance, roledropped: interface.RoleDropped
+    instance: PostgreSQLInstance, roledropped: interface.RoleDropped, dry_run: bool
 ) -> None:
     """Drop a role"""
-    async with postgresql.running(instance):
-        with manager.from_instance(instance):
-            await roles.drop(instance, roledropped)
+    with audit(dry_run=dry_run), system_configure(dry_run=dry_run):
+        async with postgresql.running(instance):
+            with manager.from_instance(instance):
+                await roles.drop(instance, roledropped)
 
 
 @cli.command("privileges")

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

@@ -218,7 +218,6 @@ Get the status of an instance:
   DEBUG debug logging at \$TMPDIR/pglift-\w+-\d+.\d+.log (re)
   DEBUG looking for 'postgres_exporter@1\d-main' service status by its PID at \$TMPDIR\/run\/prometheus\/1\d-main.pid (re)
   DEBUG get status of PostgreSQL instance 1\d\/main (re)
-  DEBUG \/usr\/.+1\d\/bin\/pg_ctl --version (re)
   DEBUG \/usr\/.+1\d\/bin\/pg_ctl status -D \$TMPDIR\/srv\/pgsql\/1\d\/main\/data (re)
 
 Reload, restart:
@@ -347,6 +346,7 @@ PostgreSQL configuration
   Error: Invalid value for '<PARAMETER>=<VALUE>...': invalid
   [2]
   $ pglift --non-interactive pgconf set --dry-run log_statement=ddl
+  WARNING failed to get data_checksums status: 'Data page checksum version' not found in controldata
   INFO configuring PostgreSQL
   INFO instance 1\d\/main needs reload due to parameter changes: log_statement (re)
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
@@ -368,6 +368,7 @@ PostgreSQL configuration
   Error: 'fsync' not found in managed configuration
   [1]
   $ pglift --non-interactive pgconf remove --dry-run log_statement
+  WARNING failed to get data_checksums status: 'Data page checksum version' not found in controldata
   INFO configuring PostgreSQL
   INFO instance 1\d\/main needs reload due to parameter changes: log_statement (re)
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
@@ -380,6 +381,14 @@ PostgreSQL configuration
   log_statement: ddl -> None
   $ pglift pgconf show log_statement
   # log_statement = 'ddl'
+  $ pglift --non-interactive pgconf set port=1234 --dry-run
+  WARNING failed to get data_checksums status: 'Data page checksum version' not found in controldata
+  INFO configuring PostgreSQL
+  INFO reconfiguring Prometheus postgres_exporter 1\d-main (re)
+  INFO restarting Prometheus postgres_exporter 1\d-main (re)
+  INFO configuring pgBackRest stanza 'main' for pg1-path=\$TMPDIR\/srv\/pgsql\/1\d\/main\/data (re)
+  port: \d+ -> 1234 (re)
+  DRY RUN: no changes made
 
 pg_hba.conf management:
 
@@ -478,6 +487,11 @@ Roles
 
 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)
+  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)
@@ -489,6 +503,10 @@ Add and manipulate roles:
    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)
 
+  $ pglift role -i main create dba --dry-run
+  Error: role already exists
+  [1]
+
   $ pglift role -i main create dba
   Error: role already exists
   [1]
@@ -500,6 +518,11 @@ Add and manipulate roles:
   dba
   (1 row)
   
+  $ 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
+  DRY RUN: no changes made
 
   $ 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'
@@ -551,6 +574,16 @@ Add and manipulate roles:
   >   database: otherdb
   >   method: trust
   > EOF
+  $ pglift role apply -f $TMPDIR/role.yaml --dry-run
+  INFO creating role 'test'
+  INFO pg_hba.conf 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
+  [1]
+  $ pglift role get test
+  Error: role 'test' not found
+  [1]
   $ pglift role apply -f $TMPDIR/role.yaml --diff
   INFO creating role 'test'
   INFO pg_hba.conf updated
@@ -760,20 +793,40 @@ Add and manipulate roles:
 
 Databases
 
+  $ pglift database create test --dry-run
+  INFO creating 'test' database in 1\d\/main (re)
+  DRY RUN: no changes made
   $ pglift database create test --owner test
   INFO creating 'test' database in 1\d\/main (re)
   $ pglift database create myapp --owner dba --schema app
   INFO creating 'myapp' database in 1\d\/main (re)
   INFO creating schema 'app' in database myapp with owner 'dba'
 
-  $ pglift database create other
-  INFO creating 'other' database in 1\d/main (re)
   $ cat > $TMPDIR/other.yaml <<EOF
   > name: other
   > extensions:
   >   - name: pg_stat_statements
   > EOF
   $ pglift database apply -f $TMPDIR/other.yaml --dry-run
+  INFO creating 'other' database in 1\d/main (re)
+  INFO creating extension 'pg_stat_statements' in database other
+  DRY RUN: no changes made
+  $ pglift database create other
+  INFO creating 'other' database in 1\d/main (re)
+  $ pglift database apply -f $TMPDIR/other.yaml --dry-run
+  INFO altering 'other' database on instance 1\d\/main (re)
+  INFO creating extension 'pg_stat_statements' in database other
+  DRY RUN: no changes made
+  $ pglift database run -d other "SELECT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'pg_stat_statements')"
+  INFO running "SELECT EXISTS \(SELECT 1 FROM pg_extension WHERE extname = 'pg_stat_statements'\)" on other database of 1\d\/main (re)
+  INFO SELECT 1
+   Database 
+    other   
+  ┏━━━━━━━━┓
+  ┃ 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
@@ -781,6 +834,26 @@ Databases
     "change_state": "changed",
     "diff": []
   }
+  $ pglift database run -d other "SELECT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'pg_stat_statements')"
+  INFO running "SELECT EXISTS \(SELECT 1 FROM pg_extension WHERE extname = 'pg_stat_statements'\)" on other database of 1\d\/main (re)
+  INFO SELECT 1
+   Database 
+    other   
+  ┏━━━━━━━━┓
+  ┃ exists ┃
+  ┡━━━━━━━━┩
+  │ True   │
+  └────────┘
+  $ cat > $TMPDIR/other.yaml <<EOF
+  > name: other
+  > state: absent
+  > EOF
+  $ pglift database apply -f $TMPDIR/other.yaml --dry-run
+  INFO dropping 'other' database
+  DRY RUN: no changes made
+  $ pglift database drop other --dry-run
+  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)
@@ -788,6 +861,12 @@ Databases
   Error: database already exists
   [1]
 
+  $ pglift database alter other --owner=test --add-extension=unaccent --add-schema=myschema --dry-run
+  INFO altering 'other' database on instance 1\d\/main (re)
+  INFO creating schema 'myschema' in database other with owner 'test'
+  INFO creating extension 'unaccent' in database other
+  DRY RUN: no changes made
+
   $ pglift database alter other --owner=test --add-extension=unaccent --add-schema=myschema
   INFO altering 'other' database on instance 1\d\/main (re)
   INFO creating schema 'myschema' in database other with owner 'test'
@@ -933,6 +1012,9 @@ Databases
   INFO backing up database 'nosuchdb' on instance 1\d\/main (re)
   Error: .+ database "nosuchdb" does not exist (re)
   [1]
+  $ pglift database dump postgres --dry-run
+  INFO backing up database 'postgres' on instance 1\d/main (re)
+  DRY RUN: no changes made
   $ pglift database dump postgres
   INFO backing up database 'postgres' on instance 1\d/main (re)
   $ ls $TMPDIR/srv/dumps/*-main
@@ -996,6 +1078,10 @@ Databases
   $ pglift database drop myapp
   INFO dropping 'myapp' database
 
+  $ pglift role drop test --dry-run
+  INFO dropping role 'test'
+  INFO removing entries from pg_hba.conf
+  DRY RUN: no changes made
   $ pglift role drop test
   INFO dropping role 'test'
   Error: role "test" cannot be dropped because some objects depend on it (detail: owner of database test
@@ -1007,6 +1093,10 @@ Databases
   
   Error: Invalid value for '--reassign-owned': Value error, field is mutually exclusive with 'drop_owned'
   [2]
+  $ pglift role drop test --drop-owned --dry-run
+  INFO dropping role 'test'
+  INFO removing entries from pg_hba.conf
+  DRY RUN: no changes made
   $ pglift role drop test --drop-owned
   INFO dropping role 'test'
   INFO removing entries from pg_hba.conf

pglift_cli-2.1.0/tests/expect/test-demote.t

@@ -0,0 +1,231 @@
+# SPDX-FileCopyrightText: 2021 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+Site settings and configuration
+
+  $ PASSWORDS=$TMPDIR/passwords.json
+  $ cat > $PASSWORDS << 'EOF'
+  > {
+  >   "postgres": "s3per",
+  >   "replication": "r3pl"
+  > }
+  > EOF
+
+  $ export PGLIFT_CLI__LOG_FORMAT="%(levelname)-4s %(message)s"
+  $ export PGLIFT_POSTGRESQL__AUTH__LOCAL=md5
+  $ export PGLIFT_POSTGRESQL__AUTH__PASSFILE=null
+  $ export PGLIFT_POSTGRESQL__AUTH__PASSWORD_COMMAND='["jq", "-r", ".{role}", "'$PASSWORDS'"]'
+  $ export PGLIFT_POSTGRESQL__REPLROLE=replication
+
+  $ export PGLIFT_CONFIG_DIR="$TMPDIR/$TESTFILE.conf.d"
+  $ mkdir -p $PGLIFT_CONFIG_DIR/postgresql
+  $ cat > $PGLIFT_CONFIG_DIR/postgresql/pg_hba.conf << 'EOF'
+  > local   all             {surole}                                {auth.local}
+  > local   all             all                                     {auth.local}
+  > host    all             all             127.0.0.1/32            {auth.host}
+  > host    all             all             ::1/128                 {auth.host}
+  > local   replication     all                                     {auth.local}
+  > host    replication     {replrole}      127.0.0.1/32            {auth.host}
+  > host    replication     {replrole}      ::1/128                 {auth.host}
+  > EOF
+
+  $ PREFIX1=$TMPDIR/1
+  $ PREFIX2=$TMPDIR/2
+  $ RUN_PREFIX1=$PREFIX1/run
+  $ RUN_PREFIX2=$PREFIX2/run
+  $ PG1PORT=$(port-for pg1)
+  $ PG2PORT=$(port-for pg2)
+  $ alias pglift1="env PGLIFT_PREFIX=$PREFIX1 PGLIFT_RUN_PREFIX=$RUN_PREFIX1 pglift --log-level=INFO --non-interactive"
+  $ alias pglift2="env PGLIFT_PREFIX=$PREFIX2 PGLIFT_RUN_PREFIX=$RUN_PREFIX2 pglift --log-level=INFO --non-interactive"
+
+  $ pglift1 site-configure install
+  INFO creating PostgreSQL log directory: $TMPDIR/1/log/postgresql
+  $ pglift2 site-configure install
+  INFO creating PostgreSQL log directory: $TMPDIR/2/log/postgresql
+
+(Cleanup steps)
+
+  $ trap "
+  >     pglift1 instance drop; \
+  >     pglift2 instance drop; \
+  >     pglift1 site-configure uninstall; \
+  >     pglift2 site-configure uninstall; \
+  >     port-for -u pg1; port-for -u pg2" \
+  >     EXIT
+
+Create a primary instance
+
+  $ cat > $TMPDIR/primary.yaml <<EOF
+  > name: pg1
+  > port: $PG1PORT
+  > surole_password: s3per
+  > replrole_password: r3pl
+  > data_checksums: true
+  > settings:
+  >   log_line_prefix: ' ~ '
+  > EOF
+  $ pglift1 instance apply -f $TMPDIR/primary.yaml
+  INFO initializing PostgreSQL
+  INFO configuring PostgreSQL authentication
+  INFO configuring PostgreSQL
+  INFO creating PostgreSQL socket directory directory: $TMPDIR/1/run/postgresql
+  INFO starting PostgreSQL 1\d\/pg1 (re)
+  INFO creating role 'replication'
+  INFO creating instance dumps directory: \$TMPDIR\/1\/srv\/dumps\/1\d-pg1 (re)
+
+Create a standby instance
+
+  $ pglift2 instance create pg2 \
+  >   --data-checksums \
+  >   --standby-for="host=$RUN_PREFIX1/postgresql port=$PG1PORT user=replication" \
+  >   --standby-password=r3pl \
+  >   --port=$PG2PORT \
+  >   --surole-password=s3per
+  INFO initializing PostgreSQL
+  INFO configuring PostgreSQL authentication
+  INFO configuring PostgreSQL
+  INFO creating PostgreSQL socket directory directory: $TMPDIR/2/run/postgresql
+  INFO starting PostgreSQL 1\d\/pg2 (re)
+  INFO creating instance dumps directory: \$TMPDIR\/2\/srv\/dumps\/1\d-pg2 (re)
+
+Add some data to the primary, check replication
+
+  $ pglift1 database run -d postgres \
+  >   "CREATE TABLE t AS (SELECT generate_series(1, 3) i)"
+  INFO running "CREATE TABLE t AS \(SELECT generate_series\(1, 3\) i\)" on postgres database of 1\d\/pg1 (re)
+  INFO SELECT 3
+  $ pglift2 -Lerror database run -o json -d postgres "SELECT i FROM t"
+  {
+    "postgres": [
+      {
+        "i": 1
+      },
+      {
+        "i": 2
+      },
+      {
+        "i": 3
+      }
+    ]
+  }
+  $ pglift2 instance get -o json \
+  >   | jq '.standby.slot, .standby.replication_lag, .standby.wal_sender_state, .state'
+  null
+  "0"
+  "streaming"
+  "started"
+
+Prepare the primary for rewind connection by creating a rewind user (and resp.
+connection database), on the primary (to be demoted)
+
+  $ pglift1 -Lerror role create rwd --login --replication --password=rwdpw
+  $ pglift1 -Lerror database create rwdb --owner rwd
+  $ pglift1 -Lerror database run -d rwdb \
+  >   "GRANT EXECUTE ON function pg_catalog.pg_ls_dir(text, boolean, boolean) TO rwd"
+  $ pglift1 -Lerror database run -d rwdb \
+  >   "GRANT EXECUTE ON function pg_catalog.pg_stat_file(text, boolean) TO rwd"
+  $ pglift1 -Lerror database run -d rwdb \
+  >   "GRANT EXECUTE ON function pg_catalog.pg_read_binary_file(text) TO rwd"
+  $ pglift1 -Lerror database run -d rwdb \
+  >   "GRANT EXECUTE ON function pg_catalog.pg_read_binary_file(text, bigint, bigint, boolean) TO rwd"
+
+Check this role from the standby
+  $ pglift2 -Lerror role get rwd -o json
+  {
+    "name": "rwd",
+    "has_password": true,
+    "inherit": true,
+    "login": true,
+    "superuser": false,
+    "createdb": false,
+    "createrole": false,
+    "replication": true,
+    "connection_limit": null,
+    "valid_until": null,
+    "validity": null,
+    "memberships": [],
+    "hba_records": []
+  }
+
+Promote the standby
+
+  $ pglift1 -Lerror instance stop
+  $ pglift2 instance status
+  PostgreSQL: running
+  $ pglift2 instance promote
+  INFO promoting PostgreSQL instance
+
+Check connection to the new primary
+
+  $ psql -t -d "host=$RUN_PREFIX2/postgresql port=$PG2PORT user=rwd password=rwdpw dbname=rwdb" -c 'show cluster_name'
+   pg2
+  
+
+Demote (rewind) the primary as a standby
+
+  $ pglift1 instance demote pg1 \
+  >   --from="host=$RUN_PREFIX2/postgresql port=$PG2PORT user=rwd dbname=rwdb" \
+  >   --password=rwdpw \
+  >   -- --no-ensure-shutdown
+  INFO demoting PostgreSQL instance
+  INFO configuring PostgreSQL
+  INFO starting PostgreSQL 1\d\/pg1 (re)
+
+Check we can connect to the standby with the replication user
+
+  $ psql -t -d "host=$RUN_PREFIX1/postgresql port=$PG1PORT user=replication password=r3pl dbname=postgres" -c 'show cluster_name'
+   pg1
+  
+
+Check that the instance is really a standby
+
+  $ ls $PREFIX1/srv/pgsql/1*/pg1/data/standby.signal
+  $TMPDIR/1/srv/pgsql/1*/pg1/data/standby.signal (glob)
+  $ pglift1 -Lerror database run -d postgres 'SHOW primary_conninfo' -o json
+  {
+    "postgres": [
+      {
+        "primary_conninfo": "user=rwd password=rwdpw channel_binding=prefer host='$TMPDIR/2/run/postgresql' port=* sslmode=prefer *" (glob)
+      }
+    ]
+  }
+  $ pglift1 instance get -o json \
+  >   | jq '.standby.slot, .standby.replication_lag, .standby.wal_sender_state, .state'
+  null
+  "0"
+  null
+  "started"
+
+And finally check replication is functional
+
+  $ pglift2 -Lerror database create rewindme
+  $ pglift2 -Lerror database run -d rewindme "CREATE TABLE t AS (SELECT * FROM generate_series(1, 3) v)"
+
+  $ pglift1 -Lerror database run -d rewindme "TABLE t" -o json
+  {
+    "rewindme": [
+      {
+        "v": 1
+      },
+      {
+        "v": 2
+      },
+      {
+        "v": 3
+      }
+    ]
+  }
+
+(Cleanup)
+
+  INFO dropping instance 1\d\/pg1 (re)
+  INFO stopping PostgreSQL 1\d\/pg1 (re)
+  INFO deleting PostgreSQL data and WAL directories
+  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)

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

@@ -117,6 +117,7 @@ Instance commands
     backup      Back up PostgreSQL INSTANCE
     backups     List available backups for INSTANCE
     create      Initialize a PostgreSQL instance
+    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...
@@ -403,6 +404,30 @@ Instance commands
   
   Options:
     --help  Show this message and exit.
+  $ pglift instance demote --help
+  Usage: pglift instance demote [OPTIONS] [INSTANCE] [REWIND_OPTS]...
+  
+    Demote PostgreSQL INSTANCE as standby of specified source server using
+    pg_rewind.
+  
+    The instance must not be running and it may be started at the end of the
+    "demotion" process.
+  
+    Extra options can be passed to the pg_rewind command. They may need to be
+    prefixed with -- to separate them from the current command options when
+    confusion arises. When using extra options, providing the instance
+    identifier is required.
+  
+    INSTANCE identifies target instance as <version>/<name> where the <version>/
+    prefix may be omitted if there is only one instance matching <name>.
+    Required if there is more than one instance on system.
+  
+  Options:
+    --from TEXT           DSN of source server to synchronize from.  [required]
+    --password PASSWORD   Password for the rewind user.
+    --start / --no-start  Start the instance at the end of the demotion process
+                          [default: start]
+    --help                Show this message and exit.
   $ pglift instance reload --help
   Usage: pglift instance reload [OPTIONS] [INSTANCE]...
   
@@ -578,6 +603,7 @@ Role commands
                                     used multiple times.)
     --revoke ROLE                   Revoke membership of the given role. (Can be
                                     used multiple times.)
+    --dry-run                       Simulate change operations.
     --help                          Show this message and exit.
   $ pglift role create --help
   Usage: pglift role create [OPTIONS] NAME
@@ -604,6 +630,7 @@ Role commands
     --validity VALIDITY             DEPRECATED. Use 'valid_until' instead.
     --in-role ROLE                  Roles which this role should be a member of.
                                     (Can be used multiple times.)
+    --dry-run                       Simulate change operations.
     --help                          Show this message and exit.
   $ pglift role drop --help
   Usage: pglift role drop [OPTIONS] NAME
@@ -617,6 +644,7 @@ Role commands
                                     Reassign all PostgreSQL's objects owned by
                                     the role being dropped to the specified role
                                     name.
+    --dry-run                       Simulate change operations.
     --help                          Show this message and exit.
   $ pglift role get --help
   Usage: pglift role get [OPTIONS] NAME
@@ -691,6 +719,7 @@ Database commands
                                   be used multiple times.)
     --tablespace TABLESPACE       The name of the tablespace that will be
                                   associated with the database.
+    --dry-run                     Simulate change operations.
     --help                        Show this message and exit.
   $ pglift database create --help
   Usage: pglift database create [OPTIONS] NAME
@@ -714,6 +743,7 @@ Database commands
                                     Only restore the schema (data definitions).
     --tablespace TABLESPACE         The name of the tablespace that will be
                                     associated with the database.
+    --dry-run                       Simulate change operations.
     --help                          Show this message and exit.
   $ pglift database drop --help
   Usage: pglift database drop [OPTIONS] NAME
@@ -722,6 +752,7 @@ Database commands
   
   Options:
     --force / --no-force  Force the drop.
+    --dry-run             Simulate change operations.
     --help                Show this message and exit.
   $ pglift database dump --help
   Usage: pglift database dump [OPTIONS] DBNAME
@@ -731,6 +762,7 @@ Database commands
   Options:
     -o, --output DIRECTORY  Write dump file(s) to DIRECTORY instead of default
                             dumps directory.
+    --dry-run               Simulate change operations.
     --help                  Show this message and exit.
   $ pglift database dumps --help
   Usage: pglift database dumps [OPTIONS] [DBNAME]...

pglift_cli-2.1.0/tests/expect/test-transactions.t

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: 2025 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+Tests for transactions (revert of created objects in case of operational errors).
+
+  $ export PGLIFT_CLI__LOG_FORMAT="%(levelname)-4s %(message)s"
+  $ export PGLIFT_PREFIX=$TMPDIR
+  $ export PGLIFT_RUN_PREFIX=$TMPDIR/run
+  $ export PGLIFT_POSTGRESQL='{
+  >       "datadir": "pgsql/{name}/data",
+  >       "waldir": "pgsql/{name}/wal"
+  > }'
+  $ export PGLIFT_CONFIG_DIR=/dev/null
+
+  $ trap "
+  >   pglift --non-interactive instance drop; \
+  >   pglift site-configure uninstall; \
+  >   port-for -u pg" \
+  >   EXIT
+
+  $ PGPORT=$(port-for pg)
+
+  $ pglift -Linfo site-configure install
+  INFO creating PostgreSQL log directory: $TMPDIR/log/postgresql
+
+Create a working instance for later use (this also checks that creating an instance "stopped" works)
+
+  $ pglift -Linfo instance create main --port=$PGPORT --state=stopped
+  INFO initializing PostgreSQL
+  INFO configuring PostgreSQL authentication
+  INFO configuring PostgreSQL
+  INFO creating PostgreSQL socket directory directory: $TMPDIR/run/postgresql
+  INFO starting PostgreSQL 1\d\/main (re)
+  INFO stopping PostgreSQL 1\d/main (re)
+  INFO creating instance dumps directory: $TMPDIR/srv/dumps/1*-main (glob)
+
+Try to create an instance with a non-existing encoding, triggering a failure in 'initdb'
+
+  $ pglift -Linfo instance create test --encoding=notanencoding --port=$PGPORT
+  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
+  
+  The files belonging to this database system will be owned by user "*". (glob)
+  This user must also own the server process.
+  
+  The database cluster will be initialized with locale "C".
+  
+  [1]
+
+Try to create a database with a non-existing tablespace
+(XXX the final error message is wrong, probably a bug here)
+
+  $ pglift -Linfo database create db --tablespace=nosuchtbspc
+  INFO starting PostgreSQL 1\d\/main (re)
+  INFO creating 'db' database in 1\d\/main (re)
+  WARNING tablespace "nosuchtbspc" does not exist
+  WARNING reverting: creating 'db' database in 1\d\/main (re)
+  INFO dropping 'db' database
+  INFO stopping PostgreSQL 1\d\/main (re)
+  Error: database "db" does not exist
+  [1]
+
+(cleanup)
+  WARNING instance 1*/main is already stopped (no-eol) (glob)

{pglift_cli-2.0.0 → pglift_cli-2.1.0}/tests/unit/test__site.py

@@ -17,29 +17,25 @@ def test_site_settings(
     monkeypatch: pytest.MonkeyPatch, tmp_path: Path, prefix_dir: str
 ) -> None:
     prefix = tmp_path / prefix_dir
-    with monkeypatch.context() as m:
-        m.setenv("PGLIFT_PREFIX", str(prefix))
-        s = _site.SETTINGS
-        assert s.prefix == prefix
+    monkeypatch.setenv("PGLIFT_PREFIX", str(prefix))
+    s = _site.SETTINGS
+    assert s.prefix == prefix
 
 
 @pytest.mark.usefixtures("cache_clear")
 def test_settings_global(monkeypatch: pytest.MonkeyPatch) -> None:
-    with monkeypatch.context() as m:
-        m.setenv("pglift_postgresql", json.dumps({"invalid": None}))
-        with pytest.raises(click.ClickException, match="invalid site settings"):
-            _ = _site.SETTINGS
+    monkeypatch.setenv("pglift_postgresql", json.dumps({"invalid": None}))
+    with pytest.raises(click.ClickException, match="invalid site settings"):
+        _ = _site.SETTINGS
 
 
 @pytest.mark.usefixtures("cache_clear")
-def test_yaml_site_settings_error(
-    monkeypatch: pytest.MonkeyPatch, tmp_path: Path
-) -> None:
+def test_yaml_site_settings_error(tmp_path: Path) -> None:
     configdir = tmp_path / "pglift"
     configdir.mkdir()
     settings_fpath = configdir / "settings.yaml"
     settings_fpath.write_text("this is not yaml")
-    with monkeypatch.context() as m:
-        m.setattr(_site.SiteSettings, "yaml_file", settings_fpath)
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setattr(_site.SiteSettings, "yaml_file", settings_fpath)
         with pytest.raises(click.ClickException, match="invalid site settings"):
             _ = _site.SETTINGS

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

@@ -70,15 +70,13 @@ def settings(settings: BaseSettings) -> Settings:
 
 
 @pytest.fixture
-def site_settings(
-    monkeypatch: pytest.MonkeyPatch, settings: Settings, tmp_path: Path
-) -> Iterator[Settings]:
+def site_settings(settings: Settings, tmp_path: Path) -> Iterator[Settings]:
     """Make _site.SETTINGS filled with the value of 'settings' fixture."""
     sf = tmp_path / "settings.yaml"
     sf.write_text(yaml.dump(settings.model_dump(mode="json")))
     _site.clear_caches()
-    with monkeypatch.context() as m:
-        m.setattr(_site.SiteSettings, "yaml_file", sf)
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setattr(_site.SiteSettings, "yaml_file", sf)
         yield _site.SETTINGS
     _site.clear_caches()
 
@@ -283,6 +281,7 @@ def test_instance_commands_completion(obj: Obj) -> None:
         "backup",
         "backups",
         "create",
+        "demote",
         "drop",
         "env",
         "exec",
@@ -321,14 +320,12 @@ def test_site_settings_json(runner: CliRunner, settings: Settings, obj: Obj) ->
 
 
 @pytest.mark.usefixtures("site_settings")
-def test_site_settings_defaults(
-    runner: CliRunner, obj: Obj, monkeypatch: pytest.MonkeyPatch
-) -> None:
+def test_site_settings_defaults(runner: CliRunner, obj: Obj) -> None:
     """site-settings --defaults returns default settings, not accounting for
     settings.yaml or env vars.
     """
-    with monkeypatch.context() as m:
-        m.setenv("PGLIFT_PREFIX", "/srv/pglift")
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setenv("PGLIFT_PREFIX", "/srv/pglift")
         result = runner.invoke(
             cli, ["site-settings", "-o", "json", "--defaults"], obj=obj
         )
@@ -343,12 +340,11 @@ def test_site_settings_no_defaults(
     runner: CliRunner,
     settings: Settings,
     obj: Obj,
-    monkeypatch: pytest.MonkeyPatch,
 ) -> None:
     s = settings.model_dump(mode="json")
     assert s["powa"] is not None
-    with monkeypatch.context() as m:
-        m.setenv("PGLIFT_PREFIX", "/srv/pglift")
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setenv("PGLIFT_PREFIX", "/srv/pglift")
         result = runner.invoke(
             cli, ["site-settings", "-o", "json", "--no-defaults"], obj=obj
         )
@@ -419,8 +415,8 @@ def test_instance_schema(runner: CliRunner, obj: Obj) -> None:
 def test_instance_shell_var_missing(
     runner: CliRunner, instance: Instance, obj: Obj, monkeypatch: pytest.MonkeyPatch
 ) -> None:
-    with patch("os.execle", autospec=True) as execle, monkeypatch.context() as m:
-        m.delenv("SHELL", raising=False)
+    with patch("os.execle", autospec=True) as execle:
+        monkeypatch.delenv("SHELL", raising=False)
         r = runner.invoke(
             cli,
             ["instance", "shell", instance.name],
@@ -438,8 +434,8 @@ def test_instance_shell_var_missing(
 def test_instance_shell(
     runner: CliRunner, instance: Instance, obj: Obj, monkeypatch: pytest.MonkeyPatch
 ) -> None:
-    with patch("os.execle", autospec=True) as execle, monkeypatch.context() as m:
-        m.setenv("SHELL", "fooshell")
+    with patch("os.execle", autospec=True) as execle:
+        monkeypatch.setenv("SHELL", "fooshell")
         runner.invoke(
             cli,
             ["instance", "shell", instance.name],

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

@@ -55,17 +55,15 @@ def test_completion(runner: CliRunner, shell: str) -> None:
 
 
 @pytest.mark.usefixtures("cache_clear")
-def test_log_level(
-    runner: CliRunner, obj: Obj, monkeypatch: pytest.MonkeyPatch
-) -> None:
+def test_log_level(runner: CliRunner, obj: Obj) -> None:
     @main.cli.command("foo")
     def foo() -> None:
         logger = logging.getLogger("pglift")
         logger.debug("debug message")
         print("something")
 
-    with monkeypatch.context() as m:
-        m.setenv("PGLIFT_CLI__LOG_LEVEL", "invalid")
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setenv("PGLIFT_CLI__LOG_LEVEL", "invalid")
         result = runner.invoke(main.cli, ["foo"], obj=obj)
         assert result.exit_code == 1
         assert (
@@ -73,15 +71,15 @@ def test_log_level(
             in result.stderr
         )
 
-    with monkeypatch.context() as m:
-        m.setenv("PGLIFT_CLI__LOG_LEVEL", "debug")
+    with pytest.MonkeyPatch.context() as mp:
+        mp.setenv("PGLIFT_CLI__LOG_LEVEL", "debug")
         result = runner.invoke(main.cli, ["foo"])
         assert result.exit_code == 0 and "something" in result.stdout, result.stderr
         assert "debug message" in result.stderr
 
-    with monkeypatch.context() as m:
+    with pytest.MonkeyPatch.context() as mp:
         # -L option takes precedence
-        m.setenv("PGLIFT_CLI__LOG_LEVEL", "debug")
+        mp.setenv("PGLIFT_CLI__LOG_LEVEL", "debug")
         result = runner.invoke(main.cli, ["-Linfo", "foo"], obj=obj)
         assert result.exit_code == 0 and "something" in result.stdout, result.stderr
         assert "debug message" not in result.stderr