cmem-cmemc 23.1.3__py3-none-any.whl → 23.3.0__py3-none-any.whl

cmem/cmemc/cli/commands/store.py

@@ -1,14 +1,18 @@
 """DataPlatform store commands for the cmem command line interface."""
 import os
-import sys
 from os.path import exists
 
 import click
+from click import UsageError
 
 from cmem.cmemc.cli import completion
 from cmem.cmemc.cli.commands import CmemcCommand, CmemcGroup
 from cmem.cmemc.cli.context import ApplicationContext
-from cmem.cmempy.dp.admin import create_showcase_data, import_bootstrap_data
+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
 
 
@@ -17,32 +21,37 @@ from cmem.cmempy.dp.admin.backup import get_zip, post_zip
     "--import", "import_",
     is_flag=True,
     help="Delete existing bootstrap data if present and import bootstrap "
-         "data which was delivered "
+         "data which was delivered with Corporate Memory."
+)
+@click.option(
+    "--remove",
+    is_flag=True,
+    help="Delete existing bootstrap data if present."
 )
 @click.pass_obj
-def bootstrap_command(app: ApplicationContext, import_):
-    """Update/Import bootstrap data.
+def bootstrap_command(app: ApplicationContext, import_, remove):
+    """Update/Import or remove bootstrap data.
+
+    Use `--import` to import the bootstrap data needed for managing shapes and
+    configuration objects. This will remove the old data first.
 
-    This command imports the bootstrap data needed for managing shapes and
-    configuration objects.
+    Use `--remove` to delete bootstrap data.
 
-    Note: The command will first remove all existing bootstrap data
-    (identified with the isSystemResource flag) and will then import the new data
-    to the corresponding graphs (shape catalog, vocabulary catalog, configuration
-    graph).
+    Note: The removal of existing bootstrap data will search for resources which are
+    flagged with the isSystemResource property.
     """
-    if "store" not in sys.argv:
-        app.echo_warning(
-            "The 'admin bootstrap' command is deprecated and will be removed "
-            "in the next major release.\n"
-            "Please use the 'admin store bootstrap' command instead."
-        )
-    if not import_:
-        raise ValueError("Use the --import flag to update/import "
-                         "bootstrap data.")
-    app.echo_info("Update or import bootstrap data ... ", nl=False)
-    import_bootstrap_data()
-    app.echo_success("done")
+    if import_ and remove or not import_ and not remove:
+        raise UsageError("Either use the --import or the --remove option.")
+    if import_:
+        app.echo_info("Update or import bootstrap data ... ", nl=False)
+        import_bootstrap_data()
+        app.echo_success("done")
+        return
+    if remove:
+        app.echo_info("Remove bootstrap data ... ", nl=False)
+        delete_bootstrap_data()
+        app.echo_success("done")
+        return
 
 
 @click.command(cls=CmemcCommand, name="showcase")
@@ -77,12 +86,6 @@ def showcase_command(app, scale, create, delete):
     you need to remove the showcase graphs manually (or just remove all
     graphs).
     """
-    if "store" not in sys.argv:
-        app.echo_warning(
-            "The 'admin showcase' command is deprecated and will be removed "
-            "in the next major release.\n"
-            "Please use the 'admin store showcase' command instead."
-        )
     if not delete and not create:
         raise ValueError("Either use the --create or the --delete flag.")
     if delete:
@@ -102,7 +105,7 @@ def showcase_command(app, scale, create, delete):
 @click.command(cls=CmemcCommand, name="export")
 @click.argument(
     "BACKUP_FILE",
-    autocompletion=completion.graph_backup_files,
+    shell_complete=completion.graph_backup_files,
     required=True,
     type=click.Path(
         writable=True,
@@ -161,7 +164,7 @@ def export_command(app, backup_file, overwrite):
 @click.command(cls=CmemcCommand, name="import")
 @click.argument(
     "BACKUP_FILE",
-    autocompletion=completion.graph_backup_files,
+    shell_complete=completion.graph_backup_files,
     required=True,
     type=click.Path(
         readable=True,

cmem/cmemc/cli/commands/user.py

@@ -17,7 +17,7 @@ from cmem.cmempy.keycloak.user import (
     create_user,
     update_user,
     assign_groups,
-    unassign_groups, user_groups
+    unassign_groups, user_groups, request_password_change
 )
 
 NO_USER_ERROR = "{} is not a valid user account. Use the 'admin user list' command " \
@@ -27,6 +27,7 @@ NO_GROUP_ERROR = "{} is not a valid group. Valid groups are {}"
 INVALID_UNASSIGN_GROUP_ERROR = (
         "Group {} is not assigned to user. Valid groups are {}"
 )
+NO_EMAIL_ERROR = "Email is empty for {} user."
 
 
 @click.command(cls=CmemcCommand, name="list")
@@ -75,7 +76,7 @@ def list_command(app: ApplicationContext, raw, id_only):
 @click.command(cls=CmemcCommand, name="delete")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.pass_obj
 def delete_command(app: ApplicationContext, username):
@@ -129,7 +130,7 @@ def create_command(app: ApplicationContext, username):
 @click.command(cls=CmemcCommand, name="update")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.option(
     "--first-name",
@@ -153,14 +154,14 @@ def create_command(app: ApplicationContext, username):
     "--assign-group",
     type=click.STRING,
     multiple=True,
-    autocompletion=completion.user_group_ids,
+    shell_complete=completion.user_group_ids,
     help="Assign a group."
 )
 @click.option(
     "--unassign-group",
     type=click.STRING,
     multiple=True,
-    autocompletion=completion.user_group_ids,
+    shell_complete=completion.user_group_ids,
     help="Unassign a group."
 )
 @click.pass_obj
@@ -237,7 +238,7 @@ def update_command(
 @click.command(cls=CmemcCommand, name="password")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.option(
     "--value",
@@ -248,8 +249,19 @@ def update_command(
     is_flag=True,
     help="If enabled, the user must change the password on next login."
 )
+@click.option(
+    "--request-change",
+    is_flag=True,
+    help="If enabled, will send a email to user to reset the password."
+)
 @click.pass_obj
-def password_command(app: ApplicationContext, username, value, temporary):
+def password_command(
+        app: ApplicationContext,
+        username,
+        value,
+        temporary,
+        request_change
+):
     """
     Change the password of a user account.
 
@@ -268,7 +280,7 @@ def password_command(app: ApplicationContext, username, value, temporary):
     users = get_user_by_username(username)
     if not users:
         raise ValueError(NO_USER_ERROR.format(username))
-    if not value:
+    if not value and not request_change:
         app.echo_info("\nNew password: ", nl=False)
         value = getpass(prompt="")
         app.echo_info("Retype new password: ", nl=False)
@@ -277,7 +289,12 @@ def password_command(app: ApplicationContext, username, value, temporary):
             app.echo_error("Sorry, passwords do not match.")
             app.echo_error("password unchanged")
             sys.exit(1)
-    reset_password(user_id=users[0]["id"], value=value, temporary=temporary)
+    if value:
+        reset_password(user_id=users[0]["id"], value=value, temporary=temporary)
+    if request_change and not users[0].get("email", None):
+        raise ValueError(NO_EMAIL_ERROR.format(username))
+    if request_change:
+        request_password_change(users[0]["id"])
     app.echo_success("done")
 
 
@@ -287,7 +304,7 @@ def password_command(app: ApplicationContext, username, value, temporary):
     nargs=-1,
     required=False,
     type=click.STRING,
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.pass_obj
 def open_command(app: ApplicationContext, usernames: str):

cmem/cmemc/cli/commands/variable.py

@@ -0,0 +1,364 @@
+"""DataIntegration variable commands for cmemc."""
+import re
+
+import click
+from click import UsageError
+
+from cmem.cmemc.cli import completion
+from cmem.cmemc.cli.commands import CmemcCommand, CmemcGroup
+from cmem.cmemc.cli.utils import split_task_id, check_or_select_project
+from cmem.cmempy.workspace.projects.variables import (
+    create_or_update_variable,
+    delete_variable,
+    get_all_variables,
+    get_variable
+)
+from cmem.cmemc.cli.context import ApplicationContext
+
+VARIABLES_FILTER_TYPES = ["project", 'regex']
+VARIABLES_FILTER_TYPES_HIDDEN = ["ids"]
+VARIABLES_FILTER_TEXT = (
+    "Filter variables based on metadata. "
+    f"First parameter CHOICE can be one of {str(VARIABLES_FILTER_TYPES)}"
+    ". The second parameter is based on CHOICE, e.g. a project "
+    "ID or a regular expression string."
+)
+
+
+def _get_variables_filtered(variables, filter_name, filter_value):
+    """Get variables but filtered according to name and value."""
+    filter_types = VARIABLES_FILTER_TYPES + VARIABLES_FILTER_TYPES_HIDDEN
+    # check for correct filter names (filter ids is used internally only)
+    if filter_name not in filter_types:
+        raise ValueError(
+            f"{filter_name} is an unknown filter name. "
+            f"Use one of {VARIABLES_FILTER_TYPES}."
+        )
+    # filter by ID list
+    if filter_name == "ids":
+        return [_ for _ in variables if _["id"] in filter_value]
+    # filter by project
+    if filter_name == "project":
+        return [_ for _ in variables if _["project"] == filter_value]
+    # filter by regex
+    if filter_name == "regex":
+        return [
+            _ for _ in variables
+            if re.search(filter_value, _["id"])
+            or re.search(filter_value, _["value"])
+            or re.search(filter_value, _.get("description", ""))
+            or re.search(filter_value, _.get("template", ""))
+        ]
+    # return unfiltered list
+    return variables
+
+
+@click.command(cls=CmemcCommand, name="list")
+@click.option(
+    "--raw",
+    is_flag=True,
+    help="Outputs raw JSON."
+)
+@click.option(
+    "--id-only",
+    is_flag=True,
+    help="Lists only variables names and no other metadata. "
+         "This is useful for piping the IDs into other commands."
+)
+@click.option(
+    "--filter", "filters_",
+    multiple=True,
+    type=(str, str),
+    shell_complete=completion.variable_list_filter,
+    help=VARIABLES_FILTER_TEXT
+)
+@click.pass_obj
+def list_command(app: ApplicationContext, raw, id_only, filters_):
+    """List available project variables.
+
+    Outputs a table or a list of project variables.
+    """
+    variables = get_all_variables()
+
+    for _ in filters_:
+        filter_name, filter_value = _
+        variables = _get_variables_filtered(
+            variables, filter_name, filter_value
+        )
+    if raw:
+        app.echo_info_json(variables)
+        return
+    if id_only:
+        for _ in sorted(_["id"] for _ in variables):
+            app.echo_result(_)
+        return
+    # output a user table
+    table = []
+    headers = ["ID", "Value", "Template", "Description"]
+    for _ in variables:
+        row = [
+            _["id"],
+            _["value"],
+            _.get("template", ""),
+            _.get("description", ""),
+        ]
+        table.append(row)
+    app.echo_info_table(table, headers=headers, sort_column=0)
+
+
+@click.command(cls=CmemcCommand, name="get")
+@click.argument(
+    "variable_id",
+    required=True,
+    type=click.STRING,
+    shell_complete=completion.variable_ids
+)
+@click.option(
+    "--key",
+    type=click.Choice(
+        ["value", "template", "description"],
+        case_sensitive=False
+    ),
+    default="value",
+    show_default=True,
+    help="Specify the name of the value you want to get."
+)
+@click.option(
+    "--raw",
+    is_flag=True,
+    help="Outputs raw json."
+)
+@click.pass_obj
+def get_command(app: ApplicationContext, variable_id, key, raw):
+    """Get the value or other data of a project variable.
+
+    Use the `--key` option to specify which information you want to get.
+
+    Note: Only the `value` key is always available on a project variable.
+    Static value variables have no `template` key, and the `description` key
+    is optional for both types of variables.
+    """
+    project_name, variable_name = split_task_id(variable_id)
+    _ = get_variable(variable_name=variable_name, project_name=project_name)
+    if raw:
+        app.echo_info_json(_)
+        return
+    try:
+        app.echo_info(_[key], nl=False)
+    except KeyError as error:
+        raise UsageError(
+            f"Variable {variable_name} has no value of '{key}'."
+        ) from error
+
+
+@click.command(cls=CmemcCommand, name="delete")
+@click.argument(
+    "variable_id",
+    required=True,
+    type=click.STRING,
+    shell_complete=completion.variable_ids
+)
+@click.pass_obj
+def delete_command(app: ApplicationContext, variable_id):
+    """Delete a project variable.
+
+    Note: You can not delete a variable which is used by another
+    (template based) variable. In order to do so, delete the template based
+    variable first.
+    """
+    project_name, variable_name = split_task_id(variable_id)
+    app.echo_info(
+        f"Delete variable {variable_name} from project {project_name} ... ",
+        nl=False
+    )
+    delete_variable(variable_name=variable_name, project_name=project_name)
+    app.echo_success("done")
+
+
+# pylint: disable=too-many-arguments
+@click.command(cls=CmemcCommand, name="create")
+@click.argument(
+    "variable_name",
+    required=True,
+    type=click.STRING,
+)
+@click.option(
+    "--value",
+    type=click.STRING,
+    help="The value of the new project variable."
+)
+@click.option(
+    "--template",
+    type=click.STRING,
+    help="The template of the new project variable. You can use Jinja template "
+         "syntax, e.g. use '{{global.myVar}}' for accessing global variables, or "
+         "'{{project.myVar}}' for accessing variables from the same project."
+)
+@click.option(
+    "--description",
+    type=click.STRING,
+    help="The optional description of the new project variable."
+)
+@click.option(
+    "--project", "project_id",
+    type=click.STRING,
+    shell_complete=completion.project_ids,
+    help="The project, where you want to create the variable in. If there is "
+         "only one project in the workspace, this option can be omitted."
+)
+@click.pass_obj
+def create_command(
+        app: ApplicationContext,
+        variable_name, value, template, description,
+        project_id
+):
+    """Create a new project variable.
+
+    Variables need to be created with a value or a template (not both).
+    In addition to that, a project ID and a name are mandatory.
+
+    Example: cmemc project variable create my_var --project my_project --value abc
+
+    Note: cmemc is currently not able to manage the order of the variables in a
+    project. This means you have to create plain value variables in advance,
+    before you can create template based variables, which access these values.
+    """
+    if value and template:
+        raise UsageError(
+            "Either use '--value' or '--template' but not both."
+        )
+    if not value and not template:
+        raise UsageError(
+            "Use '--value' or '--template' to create a new variable."
+        )
+    project_id = check_or_select_project(app, project_id)
+    data = get_variable(project_name=project_id, variable_name=variable_name)
+    if data:
+        raise UsageError(
+            f"Variable '{variable_name}' already exist in project '{project_id}'."
+            )
+    data = {
+        "name": variable_name,
+        "isSensitive": False,
+        "scope": "project"
+    }
+    if value:
+        data["value"] = value
+    if template:
+        data["template"] = template
+    if description:
+        data["description"] = description
+    app.echo_info(
+        f"Create variable {variable_name} in project {project_id} ... ",
+        nl=False
+    )
+    create_or_update_variable(
+        project_name=project_id,
+        variable_name=variable_name,
+        data=data
+    )
+    app.echo_success("done")
+
+
+@click.command(cls=CmemcCommand, name="update")
+@click.argument(
+    "variable_id",
+    required=True,
+    type=click.STRING,
+    shell_complete=completion.variable_ids
+)
+@click.option(
+    "--value",
+    type=click.STRING,
+    help="The new value of the project variable."
+)
+@click.option(
+    "--template",
+    type=click.STRING,
+    help="The new template of the project variable. You can use Jinja template "
+         "syntax, e.g. use '{{global.myVar}}' for accessing global variables, or "
+         "'{{project.myVar}}' for accessing variables from the same project."
+)
+@click.option(
+    "--description",
+    type=click.STRING,
+    help="The new description of the project variable."
+)
+@click.pass_obj
+def update_command(
+        app: ApplicationContext,
+        variable_id, value, template, description,
+):
+    """Update data of an existing project variable.
+
+    With this command you can update the value or the template, as well as the
+    description of a project variable.
+
+    Note: If you update the template of a static variable, it will be transformed
+    to a template based variable. If you want to change the value of a template
+    based variable, an error will be shown.
+    """
+    project_id, variable_name = split_task_id(variable_id)
+    data = get_variable(project_name=project_id, variable_name=variable_name)
+    if not data:
+        raise UsageError(
+            f"Variable '{variable_name}' does not exist in project '{project_id}'."
+            )
+    if value and template:
+        raise UsageError(
+            "Project variables are based on a static value or on a template, but not "
+            "both."
+        )
+    if not value and not template and not description:
+        raise UsageError(
+            "Please specify what you want to update. "
+            "Use at least one of the following options: "
+            "'--value', '--template', '--description'."
+        )
+    if value:
+        if data.get("template", None):
+            raise UsageError(
+                "You can not change the value of a template based variable."
+            )
+        data["value"] = value
+    if template:
+        if not data.get("template", None):
+            app.echo_warning(f"Variable '{variable_id}' will be converted from a "
+                             f"simple to a template based variable.")
+        data["template"] = template
+    if description:
+        data["description"] = description
+    app.echo_info(
+        f"Update variable {variable_name} in project {project_id} ... ",
+        nl=False
+    )
+    create_or_update_variable(
+        project_name=project_id,
+        variable_name=variable_name,
+        data=data
+    )
+    app.echo_success("done")
+
+
+@click.group(cls=CmemcGroup)
+def variable():
+    """List, create, delete or get data from project variables.
+
+    Project variables can be used in dataset and task parameters, and in the template
+    transform operator.
+    Variables are either based on a static value or based on a template.
+    They may use templates that access globally configured
+    variables or other preceding variables from the same project.
+
+    Variables are identified by a VARIABLE_ID. To get a list of existing
+    variables, execute the list command or use tab-completion.
+    The VARIABLE_ID is a concatenation of a PROJECT_ID and a VARIABLE_NAME,
+    such as `my-project:my-variable`.
+    """
+
+
+variable.add_command(list_command)
+variable.add_command(get_command)
+variable.add_command(delete_command)
+variable.add_command(create_command)
+variable.add_command(update_command)

cmem/cmemc/cli/commands/vocabulary.py

@@ -202,7 +202,7 @@ def _transform_cache_to_table(cache_category, table):
 @click.argument(
     "iri",
     type=click.STRING,
-    autocompletion=completion.installed_vocabularies
+    shell_complete=completion.installed_vocabularies
 )
 @click.pass_obj
 def open_command(app, iri):
@@ -276,7 +276,7 @@ def list_command(app, id_only, filter_, raw):
     "iris",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.installable_vocabularies
+    shell_complete=completion.installable_vocabularies
 )
 @click.option(
     "-a", "--all", "all_",
@@ -316,7 +316,7 @@ def install_command(app: ApplicationContext, iris: tuple[str, ...], all_):
     "iris",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.installed_vocabularies
+    shell_complete=completion.installed_vocabularies
 )
 @click.option(
     "-a", "--all", "all_",
@@ -355,7 +355,7 @@ def uninstall_command(app: ApplicationContext, iris: tuple[str, ...], all_):
 @click.argument(
     "FILE",
     required=True,
-    autocompletion=completion.triple_files,
+    shell_complete=completion.triple_files,
     type=click.Path(
         allow_dash=False,
         readable=True
@@ -437,7 +437,7 @@ def import_command(app: ApplicationContext, file, namespace, replace):
     "iris",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.installed_vocabularies
+    shell_complete=completion.installed_vocabularies
 )
 @click.option(
     "-a", "--all", "all_",