phlo-postgres 0.3.2__tar.gz → 0.4.0__tar.gz

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phlo-postgres
-Version: 0.3.2
+Version: 0.4.0
 Summary: Postgres service plugin for Phlo
 Author-email: Phlo Team <team@phlo.dev>
 License: MIT
@@ -8,7 +8,6 @@ Requires-Python: >=3.11
 Description-Content-Type: text/plain
 Requires-Dist: phlo>=0.1.0
 Requires-Dist: psycopg2-binary>=2.9.11
-Requires-Dist: pyyaml>=6.0.1
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/pyproject.toml

@@ -9,12 +9,11 @@ requires = [
 dependencies = [
     "phlo>=0.1.0",
     "psycopg2-binary>=2.9.11",
-    "pyyaml>=6.0.1",
 ]
 description = "Postgres service plugin for Phlo"
 name = "phlo-postgres"
 requires-python = ">=3.11"
-version = "0.3.2"
+version = "0.4.0"
 
 [[project.authors]]
 email = "team@phlo.dev"

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/src/phlo_postgres/__init__.py

@@ -27,4 +27,4 @@ __all__ = [
     "PostgresSettings",
     "get_settings",
 ]
-__version__ = "0.3.2"
+__version__ = "0.4.0"

phlo_postgres-0.4.0/src/phlo_postgres/authorization.py

@@ -0,0 +1,41 @@
+"""phlo_postgres CLI authorization table."""
+
+from __future__ import annotations
+
+from phlo.cli.authorization import cli_surface_adapter_class
+
+SURFACE_NAME = "phlo-postgres-cli"
+FRAMEWORK_TYPE = "cli"
+MUTATION_COMMANDS: frozenset[str] = frozenset(
+    ["postgres", "postgres.dump", "postgres.query", "postgres.restore", "postgres.vacuum"]
+)
+READ_COMMANDS: frozenset[str] = frozenset([])
+COMMAND_RESOURCE_MAP: dict[str, str] = {
+    "postgres.query": "dataset",
+    "postgres.dump": "dataset",
+    "postgres.restore": "dataset",
+    "postgres.vacuum": "dataset",
+    "postgres": "dataset",
+}
+COMMAND_ACTION_MAP: dict[str, str] = {
+    "postgres.query": "dataset.query",
+    "postgres.dump": "dataset.manage",
+    "postgres.restore": "dataset.manage",
+    "postgres.vacuum": "dataset.manage",
+    "postgres": "dataset.query",
+}
+
+PostgresCliSurfaceAdapter = cli_surface_adapter_class(
+    "PostgresCliSurfaceAdapter",
+    surface_name=SURFACE_NAME,
+    mutation_commands=MUTATION_COMMANDS,
+    read_commands=READ_COMMANDS,
+    command_resource_map=COMMAND_RESOURCE_MAP,
+    command_action_map=COMMAND_ACTION_MAP,
+    default_action_prefix="postgres",
+    default_resource_prefix="postgres",
+)
+
+
+def get_postgres_cli_adapter() -> PostgresCliSurfaceAdapter:
+    return PostgresCliSurfaceAdapter.get_instance()

phlo_postgres-0.4.0/src/phlo_postgres/cli_plugin.py

@@ -0,0 +1,17 @@
+"""Postgres CLI plugin registration."""
+
+from __future__ import annotations
+
+
+from phlo.plugins.base import cli_command_plugin_class
+
+from phlo_postgres.cli import postgres_group
+
+
+PostgresCliPlugin = cli_command_plugin_class(
+    "PostgresCliPlugin",
+    name="postgres",
+    version="0.1.0",
+    description="CLI commands for PostgreSQL service access",
+    commands=[postgres_group],
+)

phlo_postgres-0.4.0/src/phlo_postgres/plugin.py

@@ -0,0 +1,130 @@
+"""PostgreSQL service plugin implementations.
+
+This module provides plugin implementations that integrate PostgreSQL with the
+phlo plugin system. It includes service plugins for the PostgreSQL database,
+Prometheus exporter, and volume setup, as well as a resource provider plugin
+that exposes PostgreSQL capabilities to the rest of the system.
+
+Example:
+    >>> from phlo_postgres.plugin import PostgresServicePlugin
+    >>> plugin = PostgresServicePlugin()
+    >>> print(plugin.metadata.name)
+    postgres
+    >>> definition = plugin.service_definition
+
+"""
+
+from __future__ import annotations
+
+from phlo.capabilities import PublishTargetSpec, ResourceSpec
+from phlo.plugins import PluginMetadata, ResourceProviderPlugin, service_plugin_class
+
+from phlo_postgres.publish_target import PostgresPublishTarget
+from phlo_postgres.resource import PostgresResource
+
+
+PostgresServicePlugin = service_plugin_class(
+    "PostgresServicePlugin",
+    name="postgres",
+    version="0.1.0",
+    description="PostgreSQL database for metadata and operational storage",
+    author="Phlo Team",
+    tags=["core", "database", "postgres"],
+)
+
+
+PostgresExporterServicePlugin = service_plugin_class(
+    "PostgresExporterServicePlugin",
+    name="postgres-exporter",
+    version="0.1.0",
+    description="Prometheus exporter for PostgreSQL metrics",
+    author="Phlo Team",
+    tags=["observability", "metrics", "postgres"],
+    service_definition_file="exporter_service.yaml",
+)
+
+
+PostgresVolumeSetupServicePlugin = service_plugin_class(
+    "PostgresVolumeSetupServicePlugin",
+    name="postgres-volume-setup",
+    version="0.1.0",
+    description="Initialize PostgreSQL data volume permissions",
+    author="Phlo Team",
+    tags=["core", "database", "postgres"],
+    service_definition_file="volume_setup.yaml",
+)
+
+
+class PostgresResourceProvider(ResourceProviderPlugin):
+    """Resource provider plugin that exposes PostgreSQL capabilities.
+
+    This plugin registers the PostgresResource and PostgresPublishTarget with
+    the phlo resource system, making them available to other components for
+    database operations and data publishing.
+
+    Example:
+        >>> provider = PostgresResourceProvider()
+        >>> resources = provider.get_resources()
+        >>> targets = provider.get_publish_targets()
+
+    """
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        """Return plugin metadata for the PostgreSQL resource provider.
+
+        Returns:
+            PluginMetadata: Metadata describing the resource provider plugin.
+
+        Example:
+            >>> provider = PostgresResourceProvider()
+            >>> meta = provider.metadata
+            >>> print(meta.name)
+            postgres
+
+        """
+        return PluginMetadata(
+            name="postgres",
+            version="0.1.0",
+            description="Postgres resource for Phlo",
+        )
+
+    def get_resources(self) -> list[ResourceSpec]:
+        """Return resource specifications exposed by this provider.
+
+        Returns:
+            list[ResourceSpec]: List of registered resource specifications
+                that can be accessed by other phlo components.
+
+        Example:
+            >>> provider = PostgresResourceProvider()
+            >>> specs = provider.get_resources()
+            >>> print(specs[0].name)
+            postgres
+
+        """
+        return [ResourceSpec(name="postgres", resource=PostgresResource())]
+
+    def get_publish_targets(self) -> list[PublishTargetSpec]:
+        """Return publish target capability specs exposed by this provider.
+
+        Returns:
+            list[PublishTargetSpec]: List of publish target specifications
+                that define where data can be published to PostgreSQL.
+
+        Example:
+            >>> provider = PostgresResourceProvider()
+            >>> targets = provider.get_publish_targets()
+            >>> print(targets[0].name)
+            postgres
+            >>> print(targets[0].metadata)
+            {'target_system': 'postgres', 'role': 'serving'}
+
+        """
+        return [
+            PublishTargetSpec(
+                name="postgres",
+                provider=PostgresPublishTarget(),
+                metadata={"target_system": "postgres", "role": "serving"},
+            )
+        ]

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/src/phlo_postgres.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: phlo-postgres
-Version: 0.3.2
+Version: 0.4.0
 Summary: Postgres service plugin for Phlo
 Author-email: Phlo Team <team@phlo.dev>
 License: MIT
@@ -8,7 +8,6 @@ Requires-Python: >=3.11
 Description-Content-Type: text/plain
 Requires-Dist: phlo>=0.1.0
 Requires-Dist: psycopg2-binary>=2.9.11
-Requires-Dist: pyyaml>=6.0.1
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/src/phlo_postgres.egg-info/requires.txt

@@ -1,6 +1,5 @@
 phlo>=0.1.0
 psycopg2-binary>=2.9.11
-pyyaml>=6.0.1
 
 [dev]
 pytest>=7.0

{phlo_postgres-0.3.2 → phlo_postgres-0.4.0}/tests/test_authorization.py

@@ -111,7 +111,7 @@ class TestPostgresCliSurfaceAdapter:
         mock_result = MagicMock()
         mock_result.variant = "allow"
 
-        with patch("phlo_postgres.authorization.enforce", return_value=mock_result):
+        with patch("phlo.cli.authorization.enforce", return_value=mock_result):
             with patch.object(adapter, "_resolver"):
                 from phlo.capabilities.interfaces import AuthPrincipal
 

phlo_postgres-0.3.2/src/phlo_postgres/authorization.py

@@ -1,173 +0,0 @@
-"""CLI regulated surface adapter for PostgreSQL.
-
-This module provides the regulated surface adapter for the PostgreSQL CLI,
-declaring mutation commands that require authorization and enforcing
-through core enforcement.
-
-Commands:
-- postgres query: Execute SQL (mutation - can be SELECT or DDL/DML)
-- postgres dump: Create database dump (mutation)
-- postgres restore: Restore from dump (mutation)
-- postgres vacuum: Run vacuumdb maintenance (mutation)
-- postgres: Raw psql passthrough (mutation)
-
-Resource/Action mapping:
-- dataset.query: SQL execution
-- dataset.manage: Database maintenance operations
-"""
-
-from __future__ import annotations
-
-import os
-import threading
-from typing import Any
-
-from phlo.cli.authorization import CliPrincipalResolver
-from phlo.logging import get_logger
-from phlo.security.adapters import (
-    EnforcementResult,
-    SurfaceOperation,
-)
-from phlo.security.enforcement import enforce
-
-logger = get_logger(__name__)
-
-SURFACE_NAME = "phlo-postgres-cli"
-FRAMEWORK_TYPE = "cli"
-
-MUTATION_COMMANDS: frozenset[str] = frozenset(
-    {
-        "postgres.query",
-        "postgres.dump",
-        "postgres.restore",
-        "postgres.vacuum",
-        "postgres",
-    }
-)
-
-READ_COMMANDS: frozenset[str] = frozenset({})
-
-COMMAND_RESOURCE_MAP: dict[str, str] = {
-    "postgres.query": "dataset",
-    "postgres.dump": "dataset",
-    "postgres.restore": "dataset",
-    "postgres.vacuum": "dataset",
-    "postgres": "dataset",
-}
-
-COMMAND_ACTION_MAP: dict[str, str] = {
-    "postgres.query": "dataset.query",
-    "postgres.dump": "dataset.manage",
-    "postgres.restore": "dataset.manage",
-    "postgres.vacuum": "dataset.manage",
-    "postgres": "dataset.query",
-}
-
-
-class PostgresCliSurfaceAdapter:
-    """Regulated surface adapter for PostgreSQL CLI."""
-
-    _instance: PostgresCliSurfaceAdapter | None = None
-    _lock = threading.Lock()
-
-    def __init__(self) -> None:
-        self._resolver = CliPrincipalResolver()
-
-    @classmethod
-    def get_instance(cls) -> PostgresCliSurfaceAdapter:
-        if cls._instance is None:
-            with cls._lock:
-                if cls._instance is None:
-                    cls._instance = cls()
-        return cls._instance
-
-    @property
-    def surface_name(self) -> str:
-        return SURFACE_NAME
-
-    @property
-    def framework_type(self) -> str:
-        return FRAMEWORK_TYPE
-
-    def list_operations(self) -> list[SurfaceOperation]:
-        operations: list[SurfaceOperation] = []
-        for command in MUTATION_COMMANDS:
-            resource_type = COMMAND_RESOURCE_MAP.get(command, "dataset")
-            action = COMMAND_ACTION_MAP.get(command, "dataset.query")
-            operations.append(
-                SurfaceOperation(
-                    action=action,
-                    resource_type=resource_type,
-                    operation_name=command,
-                    resource_id_strategy=None,
-                    framework_metadata={"command": command},
-                )
-            )
-        return operations
-
-    def is_active(self, runtime: Any) -> bool:
-        return True
-
-    def install(self, runtime: Any) -> None:
-        pass
-
-    def enforce_mutation(self, command: str, resource_id: str | None = None) -> EnforcementResult:
-        """Enforce authorization for a mutation command."""
-        if command not in MUTATION_COMMANDS:
-            return EnforcementResult.allow()
-
-        action = COMMAND_ACTION_MAP.get(command, "dataset.query")
-        resource_type = COMMAND_RESOURCE_MAP.get(command, "dataset")
-        resource_id_final = resource_id or f"postgres:{command}"
-
-        principal = self._resolver.resolve()
-
-        from phlo.capabilities.interfaces import ResourceRef
-
-        resource = ResourceRef(
-            resource_type=resource_type,
-            resource_id=resource_id_final,
-        )
-
-        request_id = os.environ.get("PHLO_REQUEST_ID")
-
-        result = enforce(
-            principal=principal,
-            action=action,
-            resource=resource,
-            context=None,
-            request_id=request_id,
-            surface=SURFACE_NAME,
-        )
-
-        logger.debug(
-            "postgres_cli_mutation_enforcement_result",
-            command=command,
-            action=action,
-            result=result.variant,
-            subject=principal.subject,
-        )
-
-        return result
-
-    def check_command_authorization(self, command_path: str) -> EnforcementResult:
-        """Check if a command is authorized to run."""
-        if command_path in READ_COMMANDS:
-            return EnforcementResult.allow()
-
-        if command_path in MUTATION_COMMANDS:
-            return self.enforce_mutation(command_path)
-
-        logger.warning(
-            "postgres_cli_unknown_command_classification",
-            command=command_path,
-        )
-        return EnforcementResult.deny(
-            reason_code="unknown_command",
-            explanation=f"Command '{command_path}' is not classified as read or mutation",
-        )
-
-
-def get_postgres_cli_adapter() -> PostgresCliSurfaceAdapter:
-    """Get the singleton PostgreSQL CLI surface adapter."""
-    return PostgresCliSurfaceAdapter.get_instance()

phlo_postgres-0.3.2/src/phlo_postgres/cli_plugin.py

@@ -1,88 +0,0 @@
-"""CLI plugin for PostgreSQL commands.
-
-This module provides the CLI plugin implementation that registers PostgreSQL
-commands with the phlo CLI system. It exposes the postgres command group and
-its subcommands (query, dump, restore, vacuum) to the main phlo CLI.
-
-Example:
-    >>> from phlo_postgres.cli_plugin import PostgresCliPlugin
-    >>> plugin = PostgresCliPlugin()
-    >>> commands = plugin.get_cli_commands()
-    >>> print(commands[0].name)
-    postgres
-
-"""
-
-from __future__ import annotations
-
-import click
-
-from phlo.plugins.base import CliCommandPlugin, PluginMetadata
-
-from phlo_postgres.cli import postgres_group
-
-
-class PostgresCliPlugin(CliCommandPlugin):
-    """CLI plugin that registers PostgreSQL commands with the phlo CLI.
-
-    This plugin provides the main entry point for PostgreSQL-related CLI
-    commands. It registers the postgres command group which includes
-    subcommands for querying, dumping, restoring, and maintaining PostgreSQL
-    databases.
-
-    Attributes:
-        None (uses class-level plugin registration).
-
-    Example:
-        >>> plugin = PostgresCliPlugin()
-        >>> print(plugin.metadata.name)
-        postgres
-        >>> commands = plugin.get_cli_commands()
-        >>> print([cmd.name for cmd in commands])
-        ['postgres']
-
-    """
-
-    @property
-    def metadata(self) -> PluginMetadata:
-        """Return plugin metadata for the PostgreSQL CLI plugin.
-
-        Returns:
-            PluginMetadata: Metadata describing the CLI plugin including name,
-                version, and description for plugin discovery.
-
-        Example:
-            >>> plugin = PostgresCliPlugin()
-            >>> meta = plugin.metadata
-            >>> print(f"{meta.name} v{meta.version}")
-            postgres v0.1.0
-            >>> print(meta.description)
-            CLI commands for PostgreSQL service access
-
-        """
-        return PluginMetadata(
-            name="postgres",
-            version="0.1.0",
-            description="CLI commands for PostgreSQL service access",
-        )
-
-    def get_cli_commands(self) -> list[click.Command]:
-        """Return CLI commands provided by this plugin.
-
-        Returns:
-            list[click.Command]: List of Click command objects to register
-                with the main phlo CLI. Currently provides the postgres
-                command group which includes query, dump, restore, and
-                vacuum subcommands.
-
-        Example:
-            >>> plugin = PostgresCliPlugin()
-            >>> commands = plugin.get_cli_commands()
-            >>> cmd = commands[0]
-            >>> print(cmd.name)
-            postgres
-            >>> print([c.name for c in cmd.commands.values()])
-            ['query', 'dump', 'restore', 'vacuum']
-
-        """
-        return [postgres_group]

phlo_postgres-0.3.2/src/phlo_postgres/plugin.py

@@ -1,213 +0,0 @@
-"""PostgreSQL service plugin implementations.
-
-This module provides plugin implementations that integrate PostgreSQL with the
-phlo plugin system. It includes service plugins for the PostgreSQL database,
-Prometheus exporter, and volume setup, as well as a resource provider plugin
-that exposes PostgreSQL capabilities to the rest of the system.
-
-Example:
-    >>> from phlo_postgres.plugin import PostgresServicePlugin
-    >>> plugin = PostgresServicePlugin()
-    >>> print(plugin.metadata.name)
-    postgres
-    >>> definition = plugin.service_definition
-
-"""
-
-from __future__ import annotations
-
-from phlo.capabilities import PublishTargetSpec, ResourceSpec
-from phlo.plugins import PackageYamlServicePlugin, PluginMetadata, ResourceProviderPlugin
-
-from phlo_postgres.publish_target import PostgresPublishTarget
-from phlo_postgres.resource import PostgresResource
-
-
-class PostgresServicePlugin(PackageYamlServicePlugin):
-    """Service plugin for managing PostgreSQL as a phlo service.
-
-    This plugin provides the core PostgreSQL database service definition for
-    docker-compose integration. It loads service configuration from package
-    data (service.yaml) and exposes metadata for plugin discovery.
-
-    Example:
-        >>> plugin = PostgresServicePlugin()
-        >>> metadata = plugin.metadata
-        >>> print(f"Service: {metadata.name} v{metadata.version}")
-        Service: postgres v0.1.0
-        >>> definition = plugin.service_definition
-
-    """
-
-    @property
-    def metadata(self) -> PluginMetadata:
-        """Return plugin metadata for the PostgreSQL service.
-
-        Returns:
-            PluginMetadata: Metadata describing the service plugin including
-                name, version, description, author, and tags for categorization.
-
-        Example:
-            >>> plugin = PostgresServicePlugin()
-            >>> meta = plugin.metadata
-            >>> print(meta.name)
-            postgres
-            >>> print(meta.tags)
-            ['core', 'database', 'postgres']
-
-        """
-        return PluginMetadata(
-            name="postgres",
-            version="0.1.0",
-            description="PostgreSQL database for metadata and operational storage",
-            author="Phlo Team",
-            tags=["core", "database", "postgres"],
-        )
-
-
-class PostgresExporterServicePlugin(PackageYamlServicePlugin):
-    """Service plugin for PostgreSQL Prometheus metrics exporter.
-
-    This plugin provides a Prometheus exporter service that exposes PostgreSQL
-    metrics for monitoring and alerting. It runs as a sidecar service alongside
-    the main PostgreSQL container.
-
-    Example:
-        >>> plugin = PostgresExporterServicePlugin()
-        >>> print(plugin.metadata.name)
-        postgres-exporter
-
-    """
-
-    _service_definition_file = "exporter_service.yaml"
-
-    @property
-    def metadata(self) -> PluginMetadata:
-        """Return plugin metadata for the PostgreSQL exporter service.
-
-        Returns:
-            PluginMetadata: Metadata describing the exporter plugin.
-
-        Example:
-            >>> plugin = PostgresExporterServicePlugin()
-            >>> meta = plugin.metadata
-            >>> print(meta.description)
-            Prometheus exporter for PostgreSQL metrics
-
-        """
-        return PluginMetadata(
-            name="postgres-exporter",
-            version="0.1.0",
-            description="Prometheus exporter for PostgreSQL metrics",
-            author="Phlo Team",
-            tags=["observability", "metrics", "postgres"],
-        )
-
-
-class PostgresVolumeSetupServicePlugin(PackageYamlServicePlugin):
-    """Service plugin for PostgreSQL data volume permission setup.
-
-    This plugin provides an initialization service that ensures proper
-    ownership and permissions on PostgreSQL data volumes before the main
-    database container starts. This is particularly important for bind mounts
-    on systems with strict permission requirements.
-
-    Example:
-        >>> plugin = PostgresVolumeSetupServicePlugin()
-        >>> print(plugin.metadata.name)
-        postgres-volume-setup
-
-    """
-
-    _service_definition_file = "volume_setup.yaml"
-
-    @property
-    def metadata(self) -> PluginMetadata:
-        """Return plugin metadata for the PostgreSQL volume setup service.
-
-        Returns:
-            PluginMetadata: Metadata describing the volume setup plugin.
-
-        """
-        return PluginMetadata(
-            name="postgres-volume-setup",
-            version="0.1.0",
-            description="Initialize PostgreSQL data volume permissions",
-            author="Phlo Team",
-            tags=["core", "database", "postgres"],
-        )
-
-
-class PostgresResourceProvider(ResourceProviderPlugin):
-    """Resource provider plugin that exposes PostgreSQL capabilities.
-
-    This plugin registers the PostgresResource and PostgresPublishTarget with
-    the phlo resource system, making them available to other components for
-    database operations and data publishing.
-
-    Example:
-        >>> provider = PostgresResourceProvider()
-        >>> resources = provider.get_resources()
-        >>> targets = provider.get_publish_targets()
-
-    """
-
-    @property
-    def metadata(self) -> PluginMetadata:
-        """Return plugin metadata for the PostgreSQL resource provider.
-
-        Returns:
-            PluginMetadata: Metadata describing the resource provider plugin.
-
-        Example:
-            >>> provider = PostgresResourceProvider()
-            >>> meta = provider.metadata
-            >>> print(meta.name)
-            postgres
-
-        """
-        return PluginMetadata(
-            name="postgres",
-            version="0.1.0",
-            description="Postgres resource for Phlo",
-        )
-
-    def get_resources(self) -> list[ResourceSpec]:
-        """Return resource specifications exposed by this provider.
-
-        Returns:
-            list[ResourceSpec]: List of registered resource specifications
-                that can be accessed by other phlo components.
-
-        Example:
-            >>> provider = PostgresResourceProvider()
-            >>> specs = provider.get_resources()
-            >>> print(specs[0].name)
-            postgres
-
-        """
-        return [ResourceSpec(name="postgres", resource=PostgresResource())]
-
-    def get_publish_targets(self) -> list[PublishTargetSpec]:
-        """Return publish target capability specs exposed by this provider.
-
-        Returns:
-            list[PublishTargetSpec]: List of publish target specifications
-                that define where data can be published to PostgreSQL.
-
-        Example:
-            >>> provider = PostgresResourceProvider()
-            >>> targets = provider.get_publish_targets()
-            >>> print(targets[0].name)
-            postgres
-            >>> print(targets[0].metadata)
-            {'target_system': 'postgres', 'role': 'serving'}
-
-        """
-        return [
-            PublishTargetSpec(
-                name="postgres",
-                provider=PostgresPublishTarget(),
-                metadata={"target_system": "postgres", "role": "serving"},
-            )
-        ]