pglift-cli 2.5.0__tar.gz → 2.6.1__tar.gz

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 2.5.0
+Version: 2.6.1
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Database
 Classifier: Topic :: System :: Systems Administration
 Classifier: Typing :: Typed

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/pyproject.toml

@@ -32,6 +32,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: 3 :: Only",
     "Typing :: Typed",
 ]

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/pytest.ini

@@ -7,4 +7,5 @@ addopts = --strict-config --strict-markers
 filterwarnings =
   error
   ignore:cannot guess 'postgresql.versions' setting as 'bindir' is unset:RuntimeWarning
+  ignore:'asyncio.iscoroutinefunction':DeprecationWarning
 testpaths = tests/unit

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/base.py

@@ -27,6 +27,7 @@ class CLIGroup(click.Group):
         "database",
         "postgres",
         "pghba",
+        "wal",
     ]
 
     @classmethod

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/database.py

@@ -12,10 +12,10 @@ from typing import Any
 import click
 import psycopg
 from attrs import asdict
-from pydantic.v1.utils import deep_update
 
 from pglift import databases, diff, postgresql, privileges, task
 from pglift.models import PostgreSQLInstance, interface
+from pglift.util import deep_update
 
 from . import model
 from .util import (

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/instance.py

@@ -10,7 +10,6 @@ from functools import partial
 from typing import Any
 
 import click
-from pydantic.v1.utils import deep_update
 
 from pglift import (
     async_hooks,
@@ -31,6 +30,7 @@ from pglift.settings import (
     default_postgresql_version,
 )
 from pglift.types import Operation, Status, validation_context
+from pglift.util import deep_update
 
 from . import _site, model
 from . import hookspecs as h

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/model.py

@@ -16,7 +16,6 @@ from typing import Any, ClassVar, TypeVar
 import click
 import pydantic
 from pydantic.fields import FieldInfo
-from pydantic.v1.utils import deep_update, lenient_issubclass
 from pydantic_core import ErrorDetails
 
 from pglift.annotations import cli
@@ -28,6 +27,7 @@ from pglift.types import (
     field_annotation,
     validation_context,
 )
+from pglift.util import deep_update, lenient_issubclass
 
 from . import _site, logger
 

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/pgconf.py

@@ -8,7 +8,7 @@ from collections.abc import Iterable
 from typing import Any
 
 import click
-import pgtoolkit.conf
+import pgtoolkit.conf as pgconf
 
 from pglift import instances, manager, postgresql
 from pglift.models import Instance, PostgreSQLInstance
@@ -108,7 +108,7 @@ async def set_(
     pg_instance = instance.postgresql
     with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         status = await postgresql.status(pg_instance)
-        manifest = await instances._get(instance, status)
+        manifest = await instances._get(instance, status, port_from_config=True)
         manifest.settings.update(parameters)
         with manager.from_instance(pg_instance):
             r = await instances.configure(
@@ -130,7 +130,7 @@ async def remove(
     pg_instance = instance.postgresql
     with obj.lock, audit(dry_run=dry_run), system_configure(dry_run=dry_run):
         status = await postgresql.status(pg_instance)
-        manifest = await instances._get(instance, status)
+        manifest = await instances._get(instance, status, port_from_config=True)
         for p in parameters:
             try:
                 del manifest.settings[p]
@@ -154,15 +154,17 @@ async def edit(obj: Obj, instance: Instance) -> None:
     pg_instance = instance.postgresql
     with obj.lock, audit():
         with manager.from_instance(pg_instance):
-            actual_config = await instances.postgresql_editable_conf(pg_instance)
+            actual_config = "".join(
+                (await instances.postgresql_editable_conf(pg_instance)).lines
+            )
         edited = click.edit(text=actual_config)
         if edited is None:
             click.echo("no change", err=True)
             return
-        config = pgtoolkit.conf.parse_string(edited)
+        config = pgconf.parse_string(edited)
         values = config.as_dict()
         status = await postgresql.status(pg_instance)
-        manifest = await instances._get(instance, status)
+        manifest = await instances._get(instance, status, port_from_config=True)
         manifest.settings.clear()
         manifest.settings.update(values)
         with manager.from_instance(pg_instance):

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/role.py

@@ -9,11 +9,11 @@ from functools import partial
 from typing import Any
 
 import click
-from pydantic.v1.utils import deep_update
 
 from pglift import diff, manager, postgresql, privileges, profiles, roles
 from pglift.models import PostgreSQLInstance, interface
 from pglift.types import Operation, validation_context
+from pglift.util import deep_update
 
 from . import _site, model
 from .util import (

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/src/pglift_cli/util.py

@@ -600,9 +600,8 @@ def command_logging() -> Iterator[None]:
     exception will propagate to stderr.
     """
     logfilename = f"{time.time()}.log"
-    logfile = Path(
-        tempfile.NamedTemporaryFile(prefix="pglift-", suffix="-" + logfilename).name
-    )
+    with tempfile.NamedTemporaryFile(prefix="pglift-", suffix="-" + logfilename) as tmp:
+        logfile = Path(tmp.name)
     logger.debug("debug logging at %s", logfile)
     handler = logging.FileHandler(logfile)
     formatter = logging.Formatter(

pglift_cli-2.6.1/src/pglift_cli/wal.py

@@ -0,0 +1,49 @@
+# SPDX-FileCopyrightText: 2025 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import annotations
+
+from typing import Any
+
+import click
+
+from pglift import instances, manager
+from pglift.models import PostgreSQLInstance
+
+from .util import (
+    Group,
+    Obj,
+    async_command,
+    audit,
+    instance_identifier_option,
+    pass_postgresql_instance,
+)
+
+
+@click.group(cls=Group)
+@instance_identifier_option
+def cli(**kwargs: Any) -> None:
+    """Manage WAL replay of a PostgreSQL instance."""
+
+
+@cli.command("pause-replay")
+@pass_postgresql_instance
+@click.pass_obj
+@async_command
+async def pause_wal_replay(obj: Obj, instance: PostgreSQLInstance) -> None:
+    """Pause WAL replay on PostgreSQL standby INSTANCE"""
+    with obj.lock, audit():
+        with manager.from_instance(instance):
+            await instances.pause_wal_replay(instance)
+
+
+@cli.command("resume-replay")
+@pass_postgresql_instance
+@click.pass_obj
+@async_command
+async def resume_wal_replay(obj: Obj, instance: PostgreSQLInstance) -> None:
+    """Resume WAL replay on PostgreSQL standby INSTANCE"""
+    with obj.lock, audit():
+        with manager.from_instance(instance):
+            await instances.resume_wal_replay(instance)

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/tests/expect/test-cli-walkthrough.t

@@ -152,6 +152,14 @@ Create an instance
   INFO creating instance dumps directory: \$TMPDIR\/srv\/dumps\/1\d-main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
 
+Try editing a parameter that already has a value defined in the pgbackrest template:
+
+  $ pglift pgconf set wal_level='logical'
+  INFO configuring PostgreSQL
+  INFO parameter 'wal_level' is overwritten by 'pgbackrest' configuration, 'replica' will be used instead of 'logical'
+  changes in 'wal_level' not applied
+   hint: either these changes have no effect (values already set) or specified parameters are already defined in an un-managed file (e.g. 'postgresql.conf')
+
 Error cases for instance operations
 
   $ pglift instance create main --pgbackrest-stanza=st --surole-password=s3per
@@ -200,6 +208,8 @@ Error cases for instance operations
   INFO - pglift_cli.audit - command completed \(\d+(\.\d+)? seconds\) (re)
   INFO - pglift_cli.audit - command: .*\/pglift --non-interactive instance create main --data-checksums --auth-host=ident --port=\d+ --surole-password=s3per --pgbackrest-stanza=main '--pgbackrest-password=b@ck up!' --prometheus-port=\d+ (re)
   INFO - pglift_cli.audit - command completed \(\d+(\.\d+)? seconds\) (re)
+  INFO - pglift_cli.audit - command: .*\/pglift --non-interactive pgconf set wal_level=logical (re)
+  INFO - pglift_cli.audit - command completed \(\d+(\.\d+)? seconds\) (re)
   INFO - pglift_cli.audit - command: .*\/pglift --non-interactive instance create main --pgbackrest-stanza=st --surole-password=s3per (re)
   ERROR - pglift_cli.audit - command failed \(\d+(\.\d+)? seconds\) (re)
 

{pglift_cli-2.5.0 → pglift_cli-2.6.1}/tests/expect/test-help.t

@@ -96,6 +96,7 @@ Site settings
     role               Manage roles.
     database           Manage databases.
     pghba              Manage entries in HBA configuration of a PostgreSQL...
+    wal                Manage WAL replay of a PostgreSQL instance.
     patroni            Handle Patroni service for an instance.
     postgres_exporter  Handle Prometheus postgres_exporter
 
@@ -1066,3 +1067,21 @@ Patroni commands:
   Options:
     --help  Show this message and exit.
 
+WAL commands
+
+  $ pglift wal --help
+  Usage: pglift wal [OPTIONS] COMMAND [ARGS]...
+  
+    Manage WAL replay of a PostgreSQL instance.
+  
+  Options:
+    -i, --instance <version>/<name>
+                                    Instance identifier; the <version>/ prefix
+                                    may be omitted if there's only one instance
+                                    matching <name>. Required if there is more
+                                    than one instance on system.
+    --help                          Show this message and exit.
+  
+  Commands:
+    pause-replay   Pause WAL replay on PostgreSQL standby INSTANCE
+    resume-replay  Resume WAL replay on PostgreSQL standby INSTANCE

pglift_cli-2.6.1/tests/expect/test-standby.t

@@ -0,0 +1,121 @@
+# SPDX-FileCopyrightText: 2025 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/primary
+  $ PREFIX2=$TMPDIR/secondary
+  $ 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/primary/log/postgresql
+  $ pglift2 site-configure install
+  INFO creating PostgreSQL log directory: $TMPDIR/secondary/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
+  > 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/primary/run/postgresql
+  INFO starting PostgreSQL 1\d\/pg1 (re)
+  INFO creating role 'replication'
+  INFO creating instance dumps directory: \$TMPDIR\/primary\/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/secondary/run/postgresql
+  INFO starting PostgreSQL 1\d\/pg2 (re)
+  INFO creating instance dumps directory: \$TMPDIR\/secondary\/srv\/dumps\/1\d-pg2 (re)
+
+Show standby information and pause/resume WAL replay on secondary
+
+  $ pglift2 instance get --output-format=json | jq -r '.standby.wal_replay_pause_state'
+  not paused
+  $ pglift2 wal pause-replay
+  INFO pausing WAL replay
+  $ pglift2 instance get --output-format=json | jq -r '.standby.wal_replay_pause_state'
+  paused
+  $ pglift2 wal resume-replay
+  INFO resuming WAL replay
+
+Try to pause/resume WAL replay on primary
+
+  $ pglift1 wal pause-replay
+  Error: 1\d\/pg1 is not a standby (re)
+  [1]
+  $ pglift1 wal resume-replay
+  Error: 1\d\/pg1 is not a standby (re)
+  [1]
+
+(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.5.0 → pglift_cli-2.6.1}/tests/unit/test_cli.py

@@ -494,7 +494,7 @@ def test_pgconf_edit(
         )
     assert result.exit_code == 0, result.stderr
     status.assert_awaited_once_with(pg_instance)
-    _get.assert_awaited_once_with(instance, Status.running)
+    _get.assert_awaited_once_with(instance, Status.running, port_from_config=True)
     edit.assert_called_once_with(text=postgresql_conf)
     assert manifest.settings == {"bonjour": "bonsoir"}
     configure.assert_awaited_once_with(pg_instance, manifest, _is_running=True)