cmem-cmemc 24.2.0rc1__py3-none-any.whl → 24.3.0rc1__py3-none-any.whl

cmem_cmemc/commands/store.py

@@ -1,15 +1,33 @@
 """DataPlatform store commands for the cmem command line interface."""
+
 import os
-from pathlib import Path
+from dataclasses import dataclass
 
 import click
-from click import UsageError
+from click import Argument, Context, UsageError
+from click.shell_completion import CompletionItem
 from cmem.cmempy.dp.admin import create_showcase_data, delete_bootstrap_data, import_bootstrap_data
 from cmem.cmempy.dp.admin.backup import get_zip, post_zip
+from cmem.cmempy.dp.workspace import migrate_workspaces
+from cmem.cmempy.health import get_dp_info
+from jinja2 import Template
 
-from cmem_cmemc import completion
-from cmem_cmemc.commands import CmemcCommand, CmemcGroup
+from cmem_cmemc.command import CmemcCommand
+from cmem_cmemc.command_group import CmemcGroup
+from cmem_cmemc.completion import file_list
 from cmem_cmemc.context import ApplicationContext
+from cmem_cmemc.parameter_types.path import ClickSmartPath
+from cmem_cmemc.smart_path import SmartPath as Path
+from cmem_cmemc.utils import validate_zipfile
+
+
+def complete_store_backup_files(
+    ctx: Context,  # noqa: ARG001
+    param: Argument,  # noqa: ARG001
+    incomplete: str,
+) -> list[CompletionItem]:
+    """Prepare a list of Store Backip Files."""
+    return file_list(incomplete=incomplete, suffix=".store.zip", description="Store Backup File")
 
 
 @click.command(cls=CmemcCommand, name="bootstrap")
@@ -32,6 +50,8 @@ def bootstrap_command(app: ApplicationContext, import_: bool, remove: bool) -> N
 
     Note: The removal of existing bootstrap data will search for resources which are
     flagged with the isSystemResource property.
+
+    Note: The import part of this command is equivalent to the 'bootstrap-data' migration recipe
     """
     if import_ and remove or not import_ and not remove:
         raise UsageError("Either use the --import or the --remove option.")
@@ -90,17 +110,24 @@ def showcase_command(app: ApplicationContext, scale: int, create: bool, delete:
 @click.command(cls=CmemcCommand, name="export")
 @click.argument(
     "BACKUP_FILE",
-    shell_complete=completion.graph_backup_files,
-    required=True,
-    type=click.Path(writable=True, allow_dash=False, dir_okay=False),
+    shell_complete=complete_store_backup_files,
+    required=False,
+    type=ClickSmartPath(writable=True, allow_dash=False, dir_okay=False),
 )
 @click.option(
     "--overwrite",
     is_flag=True,
-    help="Overwrite existing files. " "This is a dangerous option, so use it with care.",
+    hidden=True,
+)
+@click.option(
+    "--replace",
+    is_flag=True,
+    help="Replace existing files. This is a dangerous option, so use it with care.",
 )
 @click.pass_obj
-def export_command(app: ApplicationContext, backup_file: str, overwrite: bool) -> None:
+def export_command(
+    app: ApplicationContext, backup_file: str, overwrite: bool, replace: bool
+) -> None:
     """Backup all knowledge graphs to a ZIP archive.
 
     The backup file is a ZIP archive containing all knowledge graphs (one
@@ -109,9 +136,17 @@ def export_command(app: ApplicationContext, backup_file: str, overwrite: bool) -
     This command will create lots of load on the server.
     It can take a long time to complete.
     """
-    if Path(backup_file).exists() and overwrite is not True:
+    if not backup_file:
+        backup_file = Template("{{date}}-{{connection}}.store.zip").render(app.get_template_data())
+    if overwrite:
+        replace = overwrite
+        app.echo_warning(
+            "The option --overwrite is deprecated and will be removed with the next major release."
+            " Please use the --replace option instead."
+        )
+    if Path(backup_file).exists() and replace is not True:
         raise ValueError(
-            f"Export file {backup_file} already exists and --overwrite " "option is not used."
+            f"Export file {backup_file} already exists and --replace option is not used."
         )
     with get_zip() as request:
         request.raise_for_status()
@@ -132,15 +167,19 @@ def export_command(app: ApplicationContext, backup_file: str, overwrite: bool) -
                     app.echo_info(".", nl=False)
                     byte_counter = 0
             app.echo_debug(f"Wrote {overall_byte_counter} bytes to {backup_file}.")
-            app.echo_success(" done")
+            if validate_zipfile(zipfile=backup_file):
+                app.echo_debug(f"{backup_file} successfully validated")
+                app.echo_success(" done")
+            else:
+                app.echo_error(" error (file corrupt)")
 
 
 @click.command(cls=CmemcCommand, name="import")
 @click.argument(
     "BACKUP_FILE",
-    shell_complete=completion.graph_backup_files,
+    shell_complete=complete_store_backup_files,
     required=True,
-    type=click.Path(readable=True, exists=True, allow_dash=False, dir_okay=False),
+    type=ClickSmartPath(readable=True, exists=True, allow_dash=False, dir_okay=False),
 )
 @click.pass_obj
 def import_command(app: ApplicationContext, backup_file: str) -> None:
@@ -166,6 +205,70 @@ def import_command(app: ApplicationContext, backup_file: str) -> None:
     app.echo_success(" done")
 
 
+@dataclass
+class CommandResult:
+    """Represents the result of a command execution"""
+
+    data: list
+    headers: list[str]
+    caption: str
+    empty_state_message: str
+
+
+def _migrate_workspaces() -> CommandResult:
+    """Migrate workspace configurations to the current CMEM version."""
+    request = migrate_workspaces()
+    return CommandResult(
+        data=[(iri,) for iri in request],
+        headers=["IRI"],
+        caption="Migrated workspace configurations",
+        empty_state_message="No migrateable workspace configurations found.",
+    )
+
+
+def _get_migrate_workspaces() -> CommandResult:
+    """Retrieve workspace configurations that have been migrated to the current CMEM version."""
+    dp_info = get_dp_info()
+    migratable_workspace_configurations = dp_info["workspaceConfiguration"]["workspacesToMigrate"]
+    return CommandResult(
+        data=[(_["iri"], _["label"]) for _ in migratable_workspace_configurations],
+        headers=["IRI", "LABEL"],
+        caption="Migrateable configurations workspaces",
+        empty_state_message="No migrateable workspace configurations found.",
+    )
+
+
+@click.command("migrate")
+@click.option(
+    "--workspaces",
+    is_flag=True,
+    help="Migrate workspace configurations to the current version.",
+)
+@click.pass_obj
+def migrate_command(app: ApplicationContext, workspaces: bool) -> None:
+    """Migrate configuration resources to the current version.
+
+    This command serves two purposes: (1) When invoked without an option, it lists
+    all migrateable configuration resources. (2) When invoked with the `--workspaces`
+    option, it migrates the workspace configurations to the current version.
+    """
+    app.echo_warning(
+        "The command is deprecated and will be removed with the next major release. "
+        "Please use the `admin migration` command group instead."
+    )
+    result = _migrate_workspaces() if workspaces else _get_migrate_workspaces()
+
+    if result.data:
+        app.echo_info_table(
+            result.data,
+            headers=result.headers,
+            sort_column=0,
+            caption=result.caption,
+        )
+    else:
+        app.echo_success(result.empty_state_message)
+
+
 @click.group(cls=CmemcGroup)
 def store() -> CmemcGroup:  # type: ignore[empty-body]
     """Import, export and bootstrap the knowledge graph store.
@@ -179,3 +282,4 @@ store.add_command(showcase_command)
 store.add_command(bootstrap_command)
 store.add_command(export_command)
 store.add_command(import_command)
+store.add_command(migrate_command)

cmem_cmemc/commands/user.py

@@ -1,4 +1,5 @@
 """Keycloak user management commands"""
+
 import sys
 from getpass import getpass
 
@@ -19,7 +20,8 @@ from cmem.cmempy.keycloak.user import (
 )
 
 from cmem_cmemc import completion
-from cmem_cmemc.commands import CmemcCommand, CmemcGroup
+from cmem_cmemc.command import CmemcCommand
+from cmem_cmemc.command_group import CmemcGroup
 from cmem_cmemc.context import ApplicationContext
 from cmem_cmemc.object_list import (
     DirectValuePropertyFilter,
@@ -115,7 +117,11 @@ def list_command(
         for usr in users
     ]
     app.echo_info_table(
-        table, headers=["Username", "First Name", "Last Name", "Email"], sort_column=0
+        table,
+        headers=["Username", "First Name", "Last Name", "Email"],
+        sort_column=0,
+        empty_table_message="No user accounts found. "
+        "Use the `admin user create` command to create an account.",
     )