pglift-cli 1.7.0__tar.gz → 1.9.0__tar.gz

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pglift_cli
-Version: 1.7.0
+Version: 1.9.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -18,6 +18,8 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 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: Topic :: Database
 Classifier: Topic :: System :: Systems Administration
 Classifier: Typing :: Typed
@@ -26,18 +28,18 @@ Requires-Dist: click!=8.1.0,!=8.1.4,>=8.0.0
 Requires-Dist: filelock!=3.12.1,>=3.9.0
 Requires-Dist: pluggy
 Requires-Dist: psycopg>=3.1
-Requires-Dist: pydantic>=2.5.0
+Requires-Dist: pydantic!=2.10.0,!=2.10.1,>=2.5.0
 Requires-Dist: pyyaml>=6.0.1
-Requires-Dist: rich>=11.0.0
+Requires-Dist: rich!=13.9.0,>=11.0.0
 Provides-Extra: dev
 Requires-Dist: anyio; extra == 'dev'
-Requires-Dist: mypy!=1.11.*,>=1.10.0; (python_version < '3.10') and extra == 'dev'
+Requires-Dist: mypy!=1.11.*,!=1.12.*,>=1.10.0; (python_version < '3.10') and extra == 'dev'
 Requires-Dist: mypy>=1.10.0; (python_version >= '3.10') and extra == 'dev'
 Requires-Dist: patroni[etcd]>=2.1.5; extra == 'dev'
 Requires-Dist: port-for; extra == 'dev'
 Requires-Dist: prysk[pytest-plugin]>=0.14.0; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
 Requires-Dist: trustme; extra == 'dev'
 Requires-Dist: types-pyyaml>=6.0.12.10; extra == 'dev'
 Provides-Extra: test
@@ -45,11 +47,11 @@ Requires-Dist: anyio; extra == 'test'
 Requires-Dist: patroni[etcd]>=2.1.5; extra == 'test'
 Requires-Dist: port-for; extra == 'test'
 Requires-Dist: prysk[pytest-plugin]>=0.14.0; extra == 'test'
-Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
 Requires-Dist: trustme; extra == 'test'
 Provides-Extra: typing
-Requires-Dist: mypy!=1.11.*,>=1.10.0; (python_version < '3.10') and extra == 'typing'
+Requires-Dist: mypy!=1.11.*,!=1.12.*,>=1.10.0; (python_version < '3.10') and extra == 'typing'
 Requires-Dist: mypy>=1.10.0; (python_version >= '3.10') and extra == 'typing'
 Requires-Dist: types-pyyaml>=6.0.12.10; extra == 'typing'
 Description-Content-Type: text/markdown

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/pyproject.toml

@@ -31,6 +31,8 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3 :: Only",
     "Typing :: Typed",
 ]
@@ -42,8 +44,8 @@ dependencies = [
     "filelock >= 3.9.0, != 3.12.1",
     "pluggy",
     "psycopg >= 3.1",
-    "pydantic >= 2.5.0",
-    "rich >= 11.0.0",
+    "pydantic >= 2.5.0, != 2.10.0, != 2.10.1",
+    "rich >= 11.0.0, != 13.9.0",
 ]
 
 [project.optional-dependencies]
@@ -52,13 +54,13 @@ test = [
     "patroni[etcd] >= 2.1.5",
     "port-for",
     "prysk[pytest-plugin] >= 0.14.0",
-    "pytest",
+    "pytest >= 8",
     "pytest-cov",
     "trustme",
 ]
 typing = [
     "mypy >= 1.10.0 ; python_version >= '3.10'",
-    "mypy >= 1.10.0, != 1.11.* ; python_version < '3.10'",
+    "mypy >= 1.10.0, != 1.11.*, != 1.12.* ; python_version < '3.10'",
     "types-PyYAML >= 6.0.12.10",
 ]
 dev = [
@@ -75,6 +77,3 @@ 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-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/_site.py

@@ -20,7 +20,8 @@ from pglift import exceptions, plugin_manager
 from pglift.models import interface
 
 from . import hookspecs
-from ._settings import Settings, SiteSettings
+from ._settings import Settings
+from ._settings import SiteSettings as SiteSettings
 from .pm import PluginManager
 
 
@@ -30,8 +31,6 @@ def _settings() -> Settings:
         return SiteSettings()
     except (exceptions.SettingsError, pydantic.ValidationError) as e:
         raise click.ClickException(f"invalid site settings\n{e}") from e
-    except exceptions.UnsupportedError as e:
-        raise click.ClickException(f"unsupported operation: {e}") from None
 
 
 _default_settings = cache(Settings)

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/base.py

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

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/instance.py

@@ -14,6 +14,7 @@ from pydantic.v1.utils import deep_update
 
 from pglift import (
     async_hooks,
+    exceptions,
     hooks,
     hookspecs,
     instances,
@@ -127,7 +128,7 @@ async def alter(obj: Obj, instance: system.Instance, **changes: Any) -> None:
         values = deep_update(values, changes)
         # No need for 'settings' in validation_context() as a 'version' key
         # must be present in 'values' when altering.
-        with validation_context(operation="update"):
+        with validation_context(operation="update", instance=manifest):
             altered = _site.INSTANCE_MODEL.model_validate(values)
         await instances.apply(
             _site.SETTINGS, altered, _is_running=status == Status.running
@@ -149,10 +150,18 @@ async def apply(
         version = default_postgresql_version(_site.SETTINGS.postgresql)
     elif not isinstance(version, str):
         version = str(version)
-    op: Operation = (
-        "update" if instances.exists(name, version, _site.SETTINGS) else "create"
-    )
-    with validation_context(operation=op, settings=_site.SETTINGS):
+    op: Operation = "create"
+    actual: interface.Instance | None = None
+    if data.get("state") == "absent":
+        op = "update"
+    else:
+        try:
+            actual = await instances.get((name, version), settings=_site.SETTINGS)
+        except exceptions.InstanceNotFound:
+            pass
+        else:
+            op = "update"
+    with validation_context(operation=op, settings=_site.SETTINGS, instance=actual):
         instance = _site.INSTANCE_MODEL.model_validate(data)
     if dry_run:
         ret = interface.InstanceApplyResult(change_state=None)
@@ -196,7 +205,9 @@ async def get(instance: system.Instance, output_format: OutputFormat | None) ->
         }
         if not instance.postgresql.standby:
             exclude.add("standby")
-        print_table_for([i], partial(model_dump, exclude=exclude), box=None)
+        print_table_for(
+            [i], partial(model_dump, exclude=exclude, mode="pretty"), box=None
+        )
 
 
 @cli.command("list")

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/main.py

@@ -5,11 +5,11 @@
 from __future__ import annotations
 
 import logging
-import pathlib
 import sys
 import warnings
 from functools import partial
 from importlib.metadata import version
+from pathlib import Path
 from typing import Literal
 
 import click
@@ -94,7 +94,7 @@ def log_level(
 @click.option(
     "-l",
     "--log-file",
-    type=click.Path(dir_okay=False, resolve_path=True, path_type=pathlib.Path),
+    type=click.Path(dir_okay=False, resolve_path=True, path_type=Path),
     metavar="LOGFILE",
     help="Write logs to LOGFILE, instead of stderr.",
 )
@@ -133,7 +133,7 @@ def log_level(
 def cli(
     context: click.Context,
     log_level: int | None,
-    log_file: pathlib.Path | None,
+    log_file: Path | None,
     debug: bool,
     interactive: bool,
 ) -> None:
@@ -243,7 +243,7 @@ def site_settings(
 @click.option(
     "--settings",
     "settings_file",
-    type=click.Path(exists=True, path_type=pathlib.Path),
+    type=click.Path(exists=True, path_type=Path),
     help="Custom settings file.",
 )
 @click.argument(
@@ -256,7 +256,7 @@ async def site_configure(
     context: click.Context,
     obj: Obj,
     action: Literal["install", "uninstall", "check"],
-    settings_file: pathlib.Path | None,
+    settings_file: Path | None,
 ) -> None:
     """Manage installation of extra data files for pglift.
 

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/pgconf.py

@@ -105,10 +105,10 @@ async def set_(obj: Obj, instance: system.Instance, parameters: dict[str, Any])
         status = await postgresql.status(pg_instance)
         manifest = await instances._get(instance, status)
         manifest.settings.update(parameters)
-        changes = await instances.configure(
+        r = await instances.configure(
             pg_instance, manifest, _is_running=status == Status.running
         )
-        show_configuration_changes(changes, parameters.keys())
+        show_configuration_changes(r.changes, parameters.keys())
 
 
 @cli.command("remove")
@@ -129,10 +129,10 @@ async def remove(obj: Obj, instance: system.Instance, parameters: tuple[str]) ->
                 raise click.ClickException(
                     f"{p!r} not found in managed configuration"
                 ) from None
-        changes = await instances.configure(
+        r = await instances.configure(
             pg_instance, manifest, _is_running=status == Status.running
         )
-        show_configuration_changes(changes, parameters)
+        show_configuration_changes(r.changes, parameters)
 
 
 @cli.command("edit")
@@ -156,7 +156,7 @@ async def edit(obj: Obj, instance: system.Instance) -> None:
         manifest = await instances._get(instance, status)
         manifest.settings.clear()
         manifest.settings.update(values)
-        changes = await instances.configure(
+        r = await instances.configure(
             pg_instance, manifest, _is_running=status == Status.running
         )
-        show_configuration_changes(changes)
+        show_configuration_changes(r.changes)

pglift_cli-1.9.0/src/pglift_cli/pghba.py

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2024 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import annotations
+
+from typing import Any
+
+import click
+
+from pglift import hba
+from pglift.models import interface, system
+
+from . import model
+from .util import (
+    Group,
+    Obj,
+    audit,
+    instance_identifier_option,
+    pass_postgresql_instance,
+)
+
+
+@click.group(cls=Group)
+@instance_identifier_option
+def cli(**kwargs: Any) -> None:
+    """Manage entries in the pg_hba.conf file of a PostgreSQL instance."""
+
+
+@cli.command("add")
+@model.as_parameters(interface.HbaRecord, "create")
+@pass_postgresql_instance
+@click.pass_obj
+def add(
+    obj: Obj, instance: system.PostgreSQLInstance, hbarecord: interface.HbaRecord
+) -> None:
+    """Add a record in pg_hba.conf.
+
+    If no --connection-* option is specified, a 'local' record is added.
+    """
+    with obj.lock, audit():
+        hba.add(instance, hbarecord)
+
+
+@cli.command("remove")
+@model.as_parameters(interface.HbaRecord, "create")
+@pass_postgresql_instance
+@click.pass_obj
+def remove(
+    obj: Obj, instance: system.PostgreSQLInstance, hbarecord: interface.HbaRecord
+) -> None:
+    """Remove a record from pg_hba.conf.
+
+    If no --connection-* option is specified, a 'local' record is removed.
+    """
+    with obj.lock, audit():
+        hba.remove(instance, hbarecord)

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/role.py

@@ -125,7 +125,12 @@ async def apply(
 ) -> None:
     """Apply manifest as a role"""
     op: Operation = (
-        "update" if await roles.exists(instance, name=data["name"]) else "create"
+        "update"
+        if (
+            data.get("state") == "absent"
+            or await roles.exists(instance, name=data["name"])
+        )
+        else "create"
     )
     with validation_context(operation=op, settings=_site.SETTINGS):
         role = _site.ROLE_MODEL.model_validate(data)
@@ -152,7 +157,14 @@ async def ls(
     if output_format == "json":
         print_json_for([model_dump(r) for r in rls])
     else:
-        print_table_for(rls, partial(model_dump, mode="pretty", exclude={"in_roles"}))
+        print_table_for(
+            rls,
+            partial(
+                model_dump,
+                mode="pretty",
+                exclude={"in_roles", "hba_records", "validity"},
+            ),
+        )
 
 
 @cli.command("get")
@@ -170,7 +182,13 @@ async def get(
         print_json_for(model_dump(r))
     else:
         print_table_for(
-            [r], partial(model_dump, mode="pretty", exclude={"in_roles"}), box=None
+            [r],
+            partial(
+                model_dump,
+                mode="pretty",
+                exclude={"in_roles", "hba_records", "validity"},
+            ),
+            box=None,
         )
 
 

{pglift_cli-1.7.0 → pglift_cli-1.9.0}/src/pglift_cli/util.py

@@ -10,7 +10,6 @@ import json
 import logging
 import logging.handlers
 import os
-import pathlib
 import shlex
 import sys
 import tempfile
@@ -20,6 +19,7 @@ from collections.abc import Coroutine, Iterable, Iterator, Sequence
 from contextlib import contextmanager
 from datetime import timedelta
 from functools import cache, cached_property, partial, singledispatch, wraps
+from pathlib import Path
 from typing import IO, Any, Callable, Literal, TypedDict, TypeVar
 
 import click
@@ -442,10 +442,19 @@ class ManifestData(TypedDict, total=False):
 OutputFormat = Literal["json"]
 
 
+def set_output_format(
+    ctx: click.Context, param: click.Parameter, value: OutputFormat
+) -> OutputFormat:
+    assert ctx.obj.output_format is None
+    ctx.obj.output_format = value
+    return value
+
+
 output_format_option = click.option(
     "-o",
     "--output-format",
     type=click.Choice(typing.get_args(OutputFormat), case_sensitive=False),
+    callback=set_output_format,
     help="Specify the output format.",
 )
 
@@ -537,7 +546,7 @@ def audit(
 
 
 @contextmanager
-def command_logging(logdir: pathlib.Path | None) -> Iterator[None]:
+def command_logging(logdir: Path | None) -> Iterator[None]:
     logdir_created = False
     logfilename = f"{time.time()}.log"
     if logdir is not None:  # pragma: nocover (DEPRECATED)
@@ -549,13 +558,13 @@ def command_logging(logdir: pathlib.Path | None) -> Iterator[None]:
                 logdir_created = True
         except OSError:
             # Might be, e.g. PermissionError, if log file path is not writable.
-            logfile = pathlib.Path(
+            logfile = Path(
                 tempfile.NamedTemporaryFile(
                     prefix="pglift-", suffix="-" + logfilename
                 ).name
             )
     else:
-        logfile = pathlib.Path(
+        logfile = Path(
             tempfile.NamedTemporaryFile(prefix="pglift-", suffix="-" + logfilename).name
         )
     handler = logging.FileHandler(logfile)
@@ -614,8 +623,11 @@ class Obj:
     # instance_identifier_option decorator's callback.
     _instance: str | system.PostgreSQLInstance
 
-    def __init__(self, *, debug: bool = False) -> None:
+    def __init__(
+        self, *, debug: bool = False, output_format: OutputFormat | None = None
+    ) -> None:
         self.debug = debug
+        self.output_format = output_format
 
     @cached_property
     def lock(self) -> filelock.FileLock:
@@ -660,6 +672,8 @@ class Command(click.Command):
                 raise click.Abort from None
             except pydantic.ValidationError as e:
                 logger.debug("a validation error occurred", exc_info=obj.debug)
+                if context.obj.output_format == "json":
+                    console.print_json(e.json(include_url=False, include_context=False))
                 raise click.ClickException(str(e)) from None
             except exceptions.Error as e:
                 logger.debug("an internal error occurred", exc_info=obj.debug)
@@ -680,6 +694,10 @@ class Command(click.Command):
                 raise click.ClickException(str(e).strip()) from None
 
 
+def is_root() -> bool:
+    return os.getuid() == 0
+
+
 class Group(click.Group):
     command_class = Command
     group_class = type
@@ -690,6 +708,8 @@ 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'?",