pglift-cli 1.3.1__tar.gz → 1.5.0__tar.gz

{pglift_cli-1.3.1 → pglift_cli-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pglift_cli
-Version: 1.3.1
+Version: 1.5.0
 Summary: Command-line interface for pglift
 Project-URL: Documentation, https://pglift.readthedocs.io/
 Project-URL: Source, https://gitlab.com/dalibo/pglift/
@@ -30,7 +30,15 @@ Requires-Dist: pydantic>=2.5.0
 Requires-Dist: pyyaml>=6.0.1
 Requires-Dist: rich>=11.0.0
 Provides-Extra: dev
-Requires-Dist: pglift-cli[test,typing]; extra == 'dev'
+Requires-Dist: anyio; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; 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: trustme; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.12.10; extra == 'dev'
 Provides-Extra: test
 Requires-Dist: anyio; extra == 'test'
 Requires-Dist: patroni[etcd]>=2.1.5; extra == 'test'
@@ -40,7 +48,7 @@ Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'
 Requires-Dist: trustme; extra == 'test'
 Provides-Extra: typing
-Requires-Dist: mypy>=1.8.0; extra == 'typing'
+Requires-Dist: mypy>=1.10.0; extra == 'typing'
 Requires-Dist: types-pyyaml>=6.0.12.10; extra == 'typing'
 Description-Content-Type: text/markdown
 

{pglift_cli-1.3.1 → pglift_cli-1.5.0}/pyproject.toml

@@ -57,7 +57,7 @@ test = [
     "trustme",
 ]
 typing = [
-    "mypy >= 1.8.0",
+    "mypy >= 1.10.0",
     "types-PyYAML >= 6.0.12.10",
 ]
 dev = [

pglift_cli-1.5.0/src/pglift_cli/__init__.py

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2024 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import logging
+import os
+
+import pluggy
+
+logger = logging.getLogger(__name__)
+try:
+    loggers = list(os.environ["PGLIFT_LOGGERS"].split(","))
+except KeyError:
+    loggers = [__name__, "pglift"]
+hookimpl = pluggy.HookimplMarker(__name__)

pglift_cli-1.5.0/src/pglift_cli/_settings.py

@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2021 Dalibo
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+import warnings
+from pathlib import Path
+from typing import Annotated, Any, Optional
+
+from pydantic import AfterValidator, Field, ValidationInfo
+
+from pglift.settings import Settings as BaseSettings
+from pglift.settings import SiteSettings as BaseSiteSettings
+from pglift.settings.base import BaseModel, LogPath, RunPath
+
+
+def deprecated(value: Any, info: ValidationInfo) -> Any:
+    if value is not None:
+        warnings.warn(
+            f"{info.field_name!r} setting is deprecated", FutureWarning, stacklevel=2
+        )
+    return value
+
+
+class AuditSettings(BaseModel):
+    """Settings for change operations auditing."""
+
+    path: Annotated[
+        Annotated[Path, LogPath],
+        Field(description="Log file path"),
+    ]
+    log_format: Annotated[
+        str,
+        Field(description="Format for log messages"),
+    ] = "%(levelname)-8s - %(asctime)s - %(name)s - %(message)s"
+    date_format: Annotated[
+        str,
+        Field(description="Date format in log messages"),
+    ] = "%Y-%m-%d %H:%M:%S"
+
+
+class CLISettings(BaseModel):
+    """Settings for pglift's command-line interface."""
+
+    logpath: Annotated[
+        Annotated[Optional[Path], LogPath],
+        Field(
+            description="Directory where temporary debug files from command executions will be stored (DEPRECATED).",
+        ),
+        AfterValidator(deprecated),
+    ] = None
+
+    log_format: Annotated[
+        str, Field(description="Format for log messages when written to a file")
+    ] = "%(asctime)s %(levelname)-8s %(name)s - %(message)s"
+
+    date_format: Annotated[
+        str, Field(description="Date format in log messages when written to a file")
+    ] = "%Y-%m-%d %H:%M:%S"
+
+    lock_file: Annotated[
+        Path, RunPath, Field(description="Path to lock file dedicated to pglift")
+    ] = Path(".pglift.lock")
+
+    audit: Annotated[
+        Optional[AuditSettings],
+        Field(description="Settings for change operations auditing"),
+    ] = None
+
+
+class Settings(BaseSettings):
+    cli: Annotated[CLISettings, Field(default_factory=CLISettings)]
+
+
+class SiteSettings(Settings, BaseSiteSettings):
+    pass

{pglift_cli-1.3.1 → pglift_cli-1.5.0}/src/pglift_cli/database.py

@@ -7,10 +7,11 @@ from __future__ import annotations
 import functools
 from collections.abc import Sequence
 from pathlib import Path
-from typing import IO, Any
+from typing import Any
 
 import click
 import psycopg
+from attrs import asdict
 from pydantic.v1.utils import deep_update
 
 from pglift import databases, postgresql, privileges, task
@@ -19,11 +20,14 @@ from pglift.models import interface, system
 from . import model
 from .util import (
     Group,
+    ManifestData,
     Obj,
     OutputFormat,
     async_command,
+    audit,
     dry_run_option,
     instance_identifier_option,
+    manifest_option,
     model_dump,
     output_format_option,
     pass_instance,
@@ -66,7 +70,7 @@ async def create(
     obj: Obj, instance: system.Instance, database: interface.Database
 ) -> None:
     """Create a database in a PostgreSQL instance"""
-    with obj.lock:
+    with obj.lock, audit():
         async with postgresql.running(instance):
             if await databases.exists(instance, database.name):
                 raise click.ClickException("database already exists")
@@ -84,7 +88,7 @@ async def alter(
     obj: Obj, instance: system.Instance, dbname: str, **changes: Any
 ) -> None:
     """Alter a database in a PostgreSQL instance"""
-    with obj.lock:
+    with obj.lock, audit():
         async with postgresql.running(instance):
             values = (await databases.get(instance, dbname)).model_dump(by_alias=True)
             values = deep_update(values, changes)
@@ -93,7 +97,7 @@ async def alter(
 
 
 @cli.command("apply", hidden=True)
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @pass_instance
@@ -102,16 +106,16 @@ async def alter(
 async def apply(
     obj: Obj,
     instance: system.Instance,
-    file: IO[str],
+    data: ManifestData,
     output_format: OutputFormat,
     dry_run: bool,
 ) -> None:
     """Apply manifest as a database"""
-    database = interface.Database.parse_yaml(file)
+    database = interface.Database.model_validate(data)
     if dry_run:
         ret = interface.ApplyResult(change_state=None)
     else:
-        with obj.lock:
+        with obj.lock, audit():
             async with postgresql.running(instance):
                 ret = await databases.apply(instance, database)
     if output_format == OutputFormat.json:
@@ -169,7 +173,7 @@ async def drop(
     obj: Obj, instance: system.Instance, databasedropped: interface.DatabaseDropped
 ) -> None:
     """Drop a database"""
-    with obj.lock:
+    with obj.lock, audit():
         async with postgresql.running(instance):
             await databases.drop(instance, databasedropped)
 
@@ -249,7 +253,7 @@ async def run(
     "--output",
     metavar="DIRECTORY",
     type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path),
-    help="Write dump file(s) to DIRECTORY instead of configured 'dumps_directory'.",
+    help="Write dump file(s) to DIRECTORY instead of default dumps directory.",
 )
 @click.argument("dbname")
 @pass_instance
@@ -258,3 +262,46 @@ async def dump(instance: system.Instance, dbname: str, output: Path | None) -> N
     """Dump a database"""
     async with postgresql.running(instance):
         await databases.dump(instance, dbname, output)
+
+
+@cli.command("dumps")
+@click.argument("dbname", nargs=-1)
+@output_format_option
+@pass_instance
+@async_command
+async def dumps(
+    instance: system.Instance, dbname: Sequence[str], output_format: OutputFormat
+) -> None:
+    """List the database dumps
+
+    Only dumps created in the default dumps directory are listed.
+    """
+    values = [asdict(dump) async for dump in databases.dumps(instance, dbnames=dbname)]
+    if output_format == OutputFormat.json:
+        print_json_for(values)
+    else:
+        dbnames = ", ".join(dbname) if dbname else "all databases"
+        print_table_for(values, lambda d: d, title=f"Dumps for {dbnames}")
+
+
+@cli.command("restore")
+@click.argument("dump_id")
+@click.argument("targetdbname", required=False)
+@pass_instance
+@async_command
+async def restore(
+    instance: system.Instance, dump_id: str, targetdbname: str | None
+) -> None:
+    """Restore a database dump
+
+    DUMP_ID identifies the dump id.
+
+    TARGETDBNAME identifies the (optional) name of the database in which the
+    dump is reloaded. If provided, the database needs to be created beforehand.
+
+    If TARGETDBNAME is not provided, the dump is reloaded using the database
+    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)

{pglift_cli-1.3.1 → pglift_cli-1.5.0}/src/pglift_cli/instance.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 import os
 from collections.abc import Sequence
 from functools import partial
-from typing import IO, Any
+from typing import Any
 
 import click
 from pydantic.v1.utils import deep_update
@@ -22,20 +22,24 @@ from pglift import (
     task,
 )
 from pglift.models import interface, system
+from pglift.settings import default_postgresql_version
 from pglift.settings._postgresql import PostgreSQLVersion
-from pglift.types import Status
+from pglift.types import Operation, Status, validation_context
 
 from . import _site
 from . import hookspecs as h
 from . import model
 from .util import (
+    ManifestData,
     Obj,
     OutputFormat,
     PluggableCommandGroup,
     async_command,
+    audit,
     dry_run_option,
     foreground_option,
     instance_identifier,
+    manifest_option,
     model_dump,
     output_format_option,
     print_argspec,
@@ -102,7 +106,7 @@ def cli() -> None:
 @async_command
 async def create(obj: Obj, instance: interface.Instance, drop_on_error: bool) -> None:
     """Initialize a PostgreSQL instance"""
-    with obj.lock:
+    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):
@@ -116,32 +120,44 @@ async def create(obj: Obj, instance: interface.Instance, drop_on_error: bool) ->
 @async_command
 async def alter(obj: Obj, instance: system.Instance, **changes: Any) -> None:
     """Alter PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         status = await postgresql.status(instance)
         manifest = await instances._get(instance, status)
         values = manifest.model_dump(by_alias=True, exclude={"settings"})
         values = deep_update(values, changes)
-        altered = _site.INSTANCE_MODEL.model_validate(values)
+        # No need for 'settings' in validation_context() as a 'version' key
+        # must be present in 'values' when altering.
+        with validation_context(operation="update"):
+            altered = _site.INSTANCE_MODEL.model_validate(values)
         await instances.apply(
             _site.SETTINGS, altered, _is_running=status == Status.running
         )
 
 
 @cli.command("apply", hidden=True)
-@click.option("-f", "--file", type=click.File("r"), metavar="MANIFEST", required=True)
+@manifest_option
 @output_format_option
 @dry_run_option
 @click.pass_obj
 @async_command
 async def apply(
-    obj: Obj, file: IO[str], output_format: OutputFormat, dry_run: bool
+    obj: Obj, data: ManifestData, output_format: OutputFormat, dry_run: bool
 ) -> None:
     """Apply manifest as a PostgreSQL instance"""
-    instance = _site.INSTANCE_MODEL.parse_yaml(file)
+    name, version = data["name"], data.get("version")
+    if version is None:
+        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):
+        instance = _site.INSTANCE_MODEL.model_validate(data)
     if dry_run:
         ret = interface.InstanceApplyResult(change_state=None)
     else:
-        with obj.lock:
+        with obj.lock, audit():
             ret = await instances.apply(_site.SETTINGS, instance)
     if output_format == OutputFormat.json:
         print_json_for(ret)
@@ -153,7 +169,7 @@ async def apply(
 @async_command
 async def promote(obj: Obj, instance: system.Instance) -> None:
     """Promote standby PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         await instances.promote(instance)
 
 
@@ -206,7 +222,7 @@ async def ls(version: PostgreSQLVersion | None, output_format: OutputFormat) ->
 @async_command
 async def drop(obj: Obj, instance: tuple[system.Instance, ...]) -> None:
     """Drop PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         for i in instance:
             await instances.drop(i)
 
@@ -254,7 +270,7 @@ async def start(
         raise click.UsageError(
             "only one INSTANCE argument may be given with --foreground"
         )
-    with obj.lock:
+    with obj.lock, audit():
         for i in instance:
             await instances.start(i, foreground=foreground)
 
@@ -268,7 +284,7 @@ async def stop(
     obj: Obj, instance: tuple[system.Instance, ...], all_instances: bool
 ) -> None:
     """Stop PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         for i in instance:
             await instances.stop(i)
 
@@ -282,7 +298,7 @@ async def reload(
     obj: Obj, instance: tuple[system.Instance, ...], all_instances: bool
 ) -> None:
     """Reload PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         for i in instance:
             await instances.reload(i)
 
@@ -296,7 +312,7 @@ async def restart(
     obj: Obj, instance: tuple[system.Instance, ...], all_instances: bool
 ) -> None:
     """Restart PostgreSQL INSTANCE"""
-    with obj.lock:
+    with obj.lock, audit():
         for i in instance:
             await instances.restart(i)
 
@@ -452,7 +468,7 @@ async def upgrade(
     jobs: int | None,
 ) -> None:
     """Upgrade INSTANCE using pg_upgrade"""
-    with obj.lock:
+    with obj.lock, audit():
         await postgresql.check_status(instance, Status.not_running)
         async with task.async_transaction():
             new_instance = await instances.upgrade(

{pglift_cli-1.3.1 → pglift_cli-1.5.0}/src/pglift_cli/main.py

@@ -26,16 +26,16 @@ from pglift import install, ui
 from pglift._compat import assert_never
 
 from . import __name__ as pkgname
-from . import _site
+from . import _site, loggers
 from ._settings import Settings
 from .base import CLIGroup
 from .console import console as console
 from .util import (
     InteractiveUserInterface,
-    LogDisplayer,
     Obj,
     OutputFormat,
     async_command,
+    audit,
     output_format_option,
 )
 
@@ -145,10 +145,7 @@ def cli(
             stacklevel=1,
         )
     if not context.obj:
-        context.obj = Obj(
-            displayer=None if log_file else LogDisplayer(),
-            debug=debug,
-        )
+        context.obj = Obj(debug=debug)
     else:
         assert isinstance(context.obj, Obj), context.obj
 
@@ -156,12 +153,9 @@ def cli(
     if interactive:
         ui_token = ui.set(InteractiveUserInterface())
 
-    loggers = [logging.getLogger(n) for n in ("pglift", "dotenv", "filelock")]
-    for logger in loggers:
-        logger.setLevel(logging.DEBUG)
+    handler: logging.Handler | rich.logging.RichHandler
     if debug:
         log_level = logging.DEBUG
-    handler: logging.Handler | rich.logging.RichHandler
     if log_file or not sys.stderr.isatty():
         if log_file:
             handler = logging.FileHandler(log_file)
@@ -182,11 +176,15 @@ def cli(
             show_path=False,
             highlighter=NullHighlighter(),
         )
-    for logger in loggers:
+
+    for name in loggers:
+        logger = logging.getLogger(name)
+        logger.setLevel(logging.DEBUG)
         logger.addHandler(handler)
-    # Remove rich handler on close since this would pollute all tests stderr
-    # otherwise.
-    context.call_on_close(partial(logger.removeHandler, handler))
+        # Remove rich handler on close since this would pollute all tests
+        # stderr otherwise.
+        context.call_on_close(partial(logger.removeHandler, handler))
+
     # Reset contextvars
     if ui_token is not None:
         context.call_on_close(partial(ui.reset, ui_token))
@@ -264,7 +262,7 @@ async def site_configure(
 
     This is an INTERNAL command.
     """
-    with obj.lock:
+    with obj.lock, audit():
         if action == "install":
             env = {"SETTINGS": f"@{settings_file}"} if settings_file else {}
             await install.do(_site.SETTINGS, env=env)