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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pglift_cli
-Version: 2.0.0
+Version: 2.2.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.2.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.2.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.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.0.0 → pglift_cli-2.2.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")
@@ -307,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
 
@@ -322,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.0.0 → pglift_cli-2.2.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
@@ -114,8 +117,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 +216,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)
@@ -244,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
@@ -368,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.
@@ -491,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(
@@ -519,8 +557,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.2.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.0.0 → pglift_cli-2.2.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.2.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.2.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)