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

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

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

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

@@ -197,7 +197,7 @@ async def apply(
             obj.lock,
             audit(dry_run=dry_run),
             diff.enabled(diff_format),
-            manager.from_manifest(actual or instance, settings=_site.SETTINGS),
+            manager.from_manifest(instance, settings=_site.SETTINGS, actual=actual),
         ):
             ret = await instances.apply(_site.SETTINGS, instance)
     if output_format == "json":

{pglift_cli-2.6.1 → pglift_cli-3.0.0}/src/pglift_cli/prometheus.py

@@ -71,7 +71,7 @@ async def apply(
     dry_run: bool,
     diff_format: diff.Format | None,
 ) -> None:
-    """Apply manifest as a Prometheus postgres_exporter."""
+    """Apply manifest as a Prometheus postgres_exporter (DEPRECATED)."""
     settings = prometheus.get_settings(_site.SETTINGS)
     name = data["name"]
     op: types.Operation = "update" if impl.exists(name, settings) else "create"
@@ -93,7 +93,7 @@ async def apply(
 @click.pass_obj
 @async_command
 async def install(obj: Obj, postgresexporter: PostgresExporter) -> None:
-    """Install the service for a (non-local) instance."""
+    """Install the service for a (non-local) instance (DEPRECATED)."""
     settings = prometheus.get_settings(_site.SETTINGS)
     with obj.lock, audit():
         async with task.async_transaction():
@@ -105,7 +105,7 @@ async def install(obj: Obj, postgresexporter: PostgresExporter) -> None:
 @click.pass_obj
 @async_command
 async def uninstall(obj: Obj, name: str) -> None:
-    """Uninstall the service."""
+    """Uninstall the service (DEPRECATED)."""
     with obj.lock, audit():
         await impl.drop(_site.SETTINGS, name)
 
@@ -121,6 +121,8 @@ async def start(obj: Obj, name: str, foreground: bool) -> None:
     The NAME argument is a local identifier for the postgres_exporter
     service. If the service is bound to a local instance, it should be
     <version>-<name>.
+
+    Deprecation warning: in a future version, only local instances will be handled.
     """
     settings = prometheus.get_settings(_site.SETTINGS)
     with obj.lock, audit():
@@ -140,6 +142,8 @@ async def stop(obj: Obj, name: str) -> None:
     The NAME argument is a local identifier for the postgres_exporter
     service. If the service is bound to a local instance, it should be
     <version>-<name>.
+
+    Deprecation warning: in a future version, only local instances will be handled.
     """
     settings = prometheus.get_settings(_site.SETTINGS)
     with obj.lock, audit():

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

@@ -173,7 +173,7 @@ async def ls(instance: PostgreSQLInstance, output_format: OutputFormat | None) -
             partial(
                 model_dump,
                 context={"pretty": True},
-                exclude={"hba_records", "validity"},
+                exclude={"hba_records"},
             ),
         )
 
@@ -198,7 +198,7 @@ async def get(
             partial(
                 model_dump,
                 context={"pretty": True},
-                exclude={"hba_records", "validity"},
+                exclude={"hba_records"},
             ),
             box=None,
         )

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

@@ -218,7 +218,7 @@ List instances
   $ pglift instance list -o json | jq '.[] | .name, .status'
   "main"
   "running"
-  $ pglift instance list --version=14
+  $ pglift instance list --version=15
 
 Get the status of an instance:
 
@@ -235,6 +235,16 @@ Reload, restart:
 
   $ pglift instance reload
   INFO reloading PostgreSQL configuration for 1\d\/main (re)
+  $ pglift instance stop
+  INFO stopping PostgreSQL 1\d\/main (re)
+  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)
+  INFO starting 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)
@@ -251,19 +261,20 @@ Stop, alter, (re)start an instance:
   $ pglift instance alter --no-data-checksums
   INFO configuring PostgreSQL
   INFO disabling data checksums
-  $ pglift instance alter --prometheus-port=$PGEPORT1 --state=started --powa-password=p0W@ --diff
+  $ pglift instance alter --prometheus-port=$PGEPORT1 -o json --diff
   INFO configuring PostgreSQL
-  INFO starting PostgreSQL 1\d\/main (re)
   INFO reconfiguring Prometheus postgres_exporter 1\d-main (re)
-  INFO restarting Prometheus postgres_exporter 1\d-main (re)
+  {
+    "change_state": "changed",
+    "diff": [
+      "--- $TMPDIR/etc/prometheus/postgres_exporter-1*-main.conf\n+++ $TMPDIR/etc/prometheus/postgres_exporter-1*-main.conf\n@@ -1,2 +1,2 @@\n DATA_SOURCE_NAME=postgresql://prometheus@:*/postgres?*\n-POSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'\n+POSTGRES_EXPORTER_OPTS='--web.listen-address :* --log.level info'" (glob)
+    ],
+    "pending_restart": false
+  }
+  $ pglift instance alter --state=started --powa-password=p0W@ --diff
+  INFO configuring PostgreSQL
+  INFO starting PostgreSQL 1\d\/main (re)
   INFO starting Prometheus postgres_exporter 1\d-main (re)
-  --- $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=* (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
   +++ $TMPDIR/run/prometheus/1*-main.pid (glob)
   @@ -0,0 +1 @@
@@ -378,6 +389,10 @@ PostgreSQL configuration
   $ pglift --non-interactive pgconf remove fsync
   Error: 'fsync' not found in managed configuration
   [1]
+  $ pglift --non-interactive pgconf set Port=9988
+  INFO configuring PostgreSQL
+  Error: invalid postgresql configuration, Bad line: 'Port = 9988\n'.
+  [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
@@ -398,6 +413,7 @@ PostgreSQL configuration
   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)
+  WARNING Due to 'port' change, the instance may be in an unstable state until it is restarted.
   port: \d+ -> 1234 (re)
   DRY RUN: no changes made
 
@@ -567,7 +583,6 @@ Add and manipulate roles:
     "replication": false,
     "connection_limit": 10,
     "valid_until": "2026-01-01T00:00:00Z",
-    "validity": "2026-01-01T00:00:00Z",
     "memberships": [
       {
         "role": "pg_monitor"
@@ -647,7 +662,6 @@ Add and manipulate roles:
     "replication": false,
     "connection_limit": 3,
     "valid_until": null,
-    "validity": null,
     "memberships": [
       {
         "role": "pg_monitor"
@@ -703,7 +717,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": null,
       "valid_until": null,
-      "validity": null,
       "memberships": [],
       "hba_records": []
     },
@@ -718,7 +731,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": 10,
       "valid_until": "2026-01-01T00:00:00Z",
-      "validity": "2026-01-01T00:00:00Z",
       "memberships": [
         {
           "role": "pg_monitor"
@@ -737,7 +749,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": null,
       "valid_until": null,
-      "validity": null,
       "memberships": [],
       "hba_records": []
     },
@@ -752,7 +763,6 @@ Add and manipulate roles:
       "replication": true,
       "connection_limit": null,
       "valid_until": null,
-      "validity": null,
       "memberships": [],
       "hba_records": []
     },
@@ -767,7 +777,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": null,
       "valid_until": null,
-      "validity": null,
       "memberships": [
         {
           "role": "pg_monitor"
@@ -786,7 +795,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": null,
       "valid_until": null,
-      "validity": null,
       "memberships": [],
       "hba_records": []
     },
@@ -801,7 +809,6 @@ Add and manipulate roles:
       "replication": false,
       "connection_limit": 3,
       "valid_until": null,
-      "validity": null,
       "memberships": [
         {
           "role": "pg_monitor"

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

@@ -143,7 +143,6 @@ Check this role from the standby
     "replication": true,
     "connection_limit": null,
     "valid_until": null,
-    "validity": null,
     "memberships": [],
     "hba_records": []
   }

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

@@ -12,9 +12,9 @@ Site settings
   $ export PGLIFT_RUN_PREFIX=$TMPDIR/run
 
   $ 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
+  $ mkdir -p $bindir/pgsql/18/bin
+  $ touch $bindir/pgsql/18/bin/pg_ctl
+  $ chmod +x $bindir/pgsql/18/bin/pg_ctl
   $ export PGLIFT_POSTGRESQL__BINDIR=$bindir/pgsql/{version}/bin \
   >     PGLIFT_POSTGRESQL__AUTH__PASSFILE="null" \
   >     PGLIFT_POSTGRESQL__REPLROLE="replication"
@@ -32,13 +32,23 @@ Site settings
   $ export PGLIFT_POWA='{}'
 
   $ pglift site-settings --no-defaults -o json \
-  >   | jq '.postgresql, .pgbackrest, .prometheus, .prefix, .run_prefix'
+  >   | jq '.patroni, .postgresql, .pgbackrest, .prometheus, .prefix, .run_prefix'
   {
-    "bindir": "$TMPDIR/*/bin/pgsql/{version}/bin", (glob)
+    "execpath": "$TMPDIR/test-help.t/bin/patroni",
+    "ctlpath": "$TMPDIR/test-help.t/bin/patronictl",
+    "configpath": "$TMPDIR/etc/patroni/{name}.yaml",
+    "logpath": "$TMPDIR/log/patroni",
+    "pid_file": "$TMPDIR/run/patroni/{name}.pid",
+    "postgresql": {
+      "passfile": "$TMPDIR/etc/patroni/{name}.pgpass"
+    }
+  }
+  {
+    "bindir": "$TMPDIR/test-help.t/bin/pgsql/{version}/bin",
     "versions": [
       {
-        "version": "17",
-        "bindir": "$TMPDIR/*/bin/pgsql/17/bin" (glob)
+        "version": "18",
+        "bindir": "$TMPDIR/*/bin/pgsql/18/bin" (glob)
       }
     ],
     "auth": {
@@ -223,7 +233,7 @@ Instance commands
     Initialize a PostgreSQL instance
   
   Options:
-    --version [17|16|15|14|13]      PostgreSQL version; if unspecified,
+    --version [18|17|16|15|14]      PostgreSQL version; if unspecified,
                                     determined from site settings or most recent
                                     PostgreSQL installation available on site.
     --standby-for DSN               DSN of primary for streaming replication.
@@ -363,7 +373,7 @@ Instance commands
     List the available instances
   
   Options:
-    --version [17|16|15|14|13]  Only list instances of specified version.
+    --version [18|17|16|15|14]  Only list instances of specified version.
     -o, --output-format [json]  Specify the output format.
     --help                      Show this message and exit.
   $ pglift instance logs --help
@@ -525,7 +535,7 @@ Instance commands
     Required if there is more than one instance on system.
   
   Options:
-    --version [17|16|15|14|13]  PostgreSQL version of the new instance (default
+    --version [18|17|16|15|14]  PostgreSQL version of the new instance (default
                                 to site-configured value).
     --name TEXT                 Name of the new instance (default to old
                                 instance name).
@@ -617,7 +627,6 @@ Role commands
                                     make.
     --valid-until VALID_UNTIL       Date and time after which the role's
                                     password is no longer valid.
-    --validity VALIDITY             DEPRECATED. Use 'valid_until' instead.
     --grant ROLE                    Grant membership of the given role. (Can be
                                     used multiple times.)
     --revoke ROLE                   Revoke membership of the given role. (Can be
@@ -646,7 +655,6 @@ Role commands
                                     make.
     --valid-until VALID_UNTIL       Date and time after which the role's
                                     password is no longer valid.
-    --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.
@@ -1012,15 +1020,15 @@ Patroni commands:
     --help    Show this message and exit.
   
   Commands:
-    apply      Apply manifest as a Prometheus postgres_exporter.
-    install    Install the service for a (non-local) instance.
+    apply      Apply manifest as a Prometheus postgres_exporter (DEPRECATED).
+    install    Install the service for a (non-local) instance (DEPRECATED).
     start      Start postgres_exporter service NAME.
     stop       Stop postgres_exporter service NAME.
-    uninstall  Uninstall the service.
+    uninstall  Uninstall the service (DEPRECATED).
   $ pglift postgres_exporter apply --help
   Usage: pglift postgres_exporter apply [OPTIONS]
   
-    Apply manifest as a Prometheus postgres_exporter.
+    Apply manifest as a Prometheus postgres_exporter (DEPRECATED).
   
   Options:
     -f, --file MANIFEST         [required]
@@ -1032,7 +1040,7 @@ Patroni commands:
   $ pglift postgres_exporter install --help
   Usage: pglift postgres_exporter install [OPTIONS] NAME DSN PORT
   
-    Install the service for a (non-local) instance.
+    Install the service for a (non-local) instance (DEPRECATED).
   
   Options:
     --password PASSWORD        Connection password.
@@ -1046,6 +1054,9 @@ Patroni commands:
     The NAME argument is a local identifier for the postgres_exporter service.
     If the service is bound to a local instance, it should be <version>-<name>.
   
+    Deprecation warning: in a future version, only local instances will be
+    handled.
+  
   Options:
     --foreground  Start the program in foreground.
     --help        Show this message and exit.
@@ -1057,12 +1068,15 @@ Patroni commands:
     The NAME argument is a local identifier for the postgres_exporter service.
     If the service is bound to a local instance, it should be <version>-<name>.
   
+    Deprecation warning: in a future version, only local instances will be
+    handled.
+  
   Options:
     --help  Show this message and exit.
   $ pglift postgres_exporter uninstall --help
   Usage: pglift postgres_exporter uninstall [OPTIONS] NAME
   
-    Uninstall the service.
+    Uninstall the service (DEPRECATED).
   
   Options:
     --help  Show this message and exit.

{pglift_cli-2.6.1 → pglift_cli-3.0.0}/tests/unit/test_util.py

@@ -367,6 +367,6 @@ def test_get_instance(
         ):
             util.get_instance("foo", None, settings)
     assert [call.args for call in system_lookup.call_args_list] == [
-        ("foo", "14", settings),
-        ("foo", "17", settings),
+        ("foo", "15", settings),
+        ("foo", "18", settings),
     ]