feat(server): Add CLI task to list organizations

In preparation of #8352, I needed to bootstrap the `tasks` cli group and investigate if it's doable to perform operation without relying on a running backend

Author: FirelightFlagboy

server/parsec/cli/__init__.py

@@ -18,6 +18,7 @@
 from parsec.cli.sequester_create import create_service, generate_service_certificate
 from parsec.cli.sequester_list import list_services
 from parsec.cli.sequester_revoke import generate_service_revocation_certificate, revoke_service
+from parsec.cli.tasks import server_tasks_cmd_group
 from parsec.cli.testbed import TESTBED_AVAILABLE, testbed_cmd
 
 __all__ = ("cli",)
@@ -53,6 +54,8 @@ def cli() -> None:
 cli.add_command(list_deletable_realms, "list_deletable_realms")
 cli.add_command(delete_realm, "delete_realm")
 cli.add_command(server_sequester_cmd, "sequester")
+cli.add_command(server_tasks_cmd_group)
+
 if TESTBED_AVAILABLE:
     cli.add_command(testbed_cmd, "testbed")
     # Since `render_email` is only for debugging purpose, we don't expose it

server/parsec/cli/tasks/__init__.py

@@ -0,0 +1,14 @@
+import click
+
+from parsec.cli.options import version_option
+
+from . import delete_old_organization, list_organization
+
+
+@click.group(name="tasks", short_help="Server tasks collections")
+@version_option
+def server_tasks_cmd_group() -> None:
+    pass
+
+
+server_tasks_cmd_group.add_command(list_organization.cmd)

server/parsec/cli/tasks/list_organization.py

@@ -0,0 +1,47 @@
+import dataclasses as dt
+import json
+
+import click
+
+from parsec._parsec import OrganizationID
+from parsec.cli.options import asyncio_run, db_server_options, logging_config_options
+from parsec.components.organization import OrganizationDump
+from parsec.components.postgresql.handler import asyncpg_pool_factory
+from parsec.components.postgresql.organization import PGOrganizationComponent
+from parsec.config import BaseDatabaseConfig, LogLevel, PostgreSQLDatabaseConfig
+from parsec.webhooks import MockedWebhooksComponent
+
+
+@click.command(name="list-organization", short_help="List organization present on the server")
+@db_server_options
+@logging_config_options(default_log_level="INFO")
+@asyncio_run
+async def cmd(
+    db: BaseDatabaseConfig,
+    db_min_connections: int,
+    db_max_connections: int,
+    log_level: LogLevel,
+    log_format: str,
+    log_file: str | None,
+):
+    orgs = await list_organization(db)
+
+    click.echo_via_pager(json.dumps(orgs, default=dt.asdict, indent=4))
+
+
+async def list_organization(db: BaseDatabaseConfig) -> dict[OrganizationID, OrganizationDump]:
+    # When mocked the organization are stored in volatile memory of the other process (server)
+    # We will not be able to access it, so no organization
+    if db.is_mocked():
+        return {}
+
+    assert isinstance(db, PostgreSQLDatabaseConfig)
+    async with asyncpg_pool_factory(
+        url=db.url, min_connections=db.min_connections, max_connections=db.max_connections
+    ) as pool:
+        org_cmp = PGOrganizationComponent(
+            pool=pool,
+            webhooks=MockedWebhooksComponent(),
+            config=None,  # pyright: ignore [reportArgumentType]
+        )
+        return await org_cmp.list_organizations()

server/parsec/components/postgresql/organization.py

@@ -355,7 +355,7 @@ async def get_tos(
 
     @override
     @no_transaction
-    async def test_dump_organizations(
+    async def list_organizations(
         self, conn: AsyncpgConnection, skip_templates: bool = True
     ) -> dict[OrganizationID, OrganizationDump]:
         return await organization_test_dump_organizations(conn, skip_templates)

server/parsec/webhooks.py

@@ -236,3 +236,55 @@ async def sequester_service_on_realm_rotate_key(
             return SequesterServiceUnavailable(
                 service_id=service_id,
             )
+
+
+class MockedWebhooksComponent(WebhooksComponent):
+    """
+    Webhooks that does nothing,
+
+    Used when creating components that require a webhook class but we do not except that component to use webhook (useful for tasks)"""
+
+    async def __init__(self) -> None:
+        pass
+
+    async def on_organization_bootstrap(
+        self,
+        organization_id: OrganizationID,
+        device_id: DeviceID,
+        device_label: DeviceLabel,
+        human_email: EmailAddress,
+        human_label: str,
+    ) -> None:
+        return None
+
+    async def sequester_service_on_vlob_create_or_update(
+        self,
+        webhook_url: str,
+        service_id: SequesterServiceID,
+        organization_id: OrganizationID,
+        author: DeviceID,
+        realm_id: VlobID,
+        vlob_id: VlobID,
+        key_index: int,
+        version: int,
+        timestamp: DateTime,
+        blob: bytes,
+    ) -> SequesterServiceUnavailable | RejectedBySequesterService | None:
+        return None
+
+    async def sequester_service_on_realm_rotate_key(
+        self,
+        webhook_url: str,
+        service_id: SequesterServiceID,
+        organization_id: OrganizationID,
+        keys_bundle: bytes,
+        keys_bundle_access: bytes,
+        author: DeviceID,
+        timestamp: DateTime,
+        realm_id: VlobID,
+        key_index: int,
+        encryption_algorithm: SecretKeyAlgorithm,
+        hash_algorithm: HashAlgorithm,
+        key_canary: bytes,
+    ) -> SequesterServiceUnavailable | RejectedBySequesterService | None:
+        return None

server/tests/cli/tasks/test_list_organizations.py

@@ -0,0 +1,19 @@
+from click.testing import CliRunner
+
+from parsec.cli.tasks import list_organization
+from parsec.config import BaseDatabaseConfig, PostgreSQLDatabaseConfig
+
+
+def test_list_organization(db_config: BaseDatabaseConfig, db_args: list[str]):
+    runner = CliRunner()
+    args = db_args
+    use_pg = isinstance(db_config, PostgreSQLDatabaseConfig)
+    result = runner.invoke(list_organization.cmd, args, catch_exceptions=True)
+    assert result.exception is None, result.stderr
+    assert result.exit_code == 0
+    assert result.stderr_bytes == b""
+    if not use_pg:
+        assert result.stdout == "{}\n"
+    else:
+        assert result.stdout.startswith("{\n")
+        assert result.stdout.endswith("}\n")

server/tests/conftest.py

@@ -279,6 +279,18 @@ async def db_config(request: pytest.FixtureRequest) -> BaseDatabaseConfig:
         return MockedDatabaseConfig()
 
 
+@pytest.fixture
+async def db_args(db_config: BaseDatabaseConfig) -> list[str]:
+    if isinstance(db_config, PostgreSQLDatabaseConfig):
+        return [
+            f"--db={db_config.url}",
+            f"--db-min-connections={db_config.min_connections}",
+            f"--db-max-connections={db_config.max_connections}",
+        ]
+    else:
+        return ["--db=MOCKED"]
+
+
 @pytest.fixture
 def blockstore_config(db_config: BaseDatabaseConfig) -> BaseBlockStoreConfig:
     # TODO: allow to test against swift ?