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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pglift_cli
-Version: 1.7.0
+Version: 1.8.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -28,16 +28,16 @@ Requires-Dist: pluggy
 Requires-Dist: psycopg>=3.1
 Requires-Dist: pydantic>=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 +45,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.8.0}/pyproject.toml

@@ -43,7 +43,7 @@ dependencies = [
     "pluggy",
     "psycopg >= 3.1",
     "pydantic >= 2.5.0",
-    "rich >= 11.0.0",
+    "rich >= 11.0.0, != 13.9.0",
 ]
 
 [project.optional-dependencies]
@@ -52,13 +52,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 = [

{pglift_cli-1.7.0 → pglift_cli-1.8.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.8.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.8.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.8.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.8.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,9 @@ 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"})
+        )
 
 
 @cli.command("get")
@@ -170,7 +177,9 @@ 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"}),
+            box=None,
         )
 
 

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

@@ -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.",
 )
 
@@ -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)