Make auth managers provide their own airflow CLI commands (#33481)

* add a way for auth managers to define their own CLI commands
* extract command definition to a different file for readability
* static method to get cli commands + import optims
* move import in method to save exec time

airflow/auth/managers/base_auth_manager.py

@@ -20,11 +20,12 @@
 from abc import abstractmethod
 from typing import TYPE_CHECKING
 
-from airflow.auth.managers.models.base_user import BaseUser
 from airflow.exceptions import AirflowException
 from airflow.utils.log.logging_mixin import LoggingMixin
 
 if TYPE_CHECKING:
+    from airflow.auth.managers.models.base_user import BaseUser
+    from airflow.cli.cli_config import CLICommand
     from airflow.www.security import AirflowSecurityManager
 
 
@@ -38,6 +39,14 @@ class BaseAuthManager(LoggingMixin):
     def __init__(self):
         self._security_manager: AirflowSecurityManager | None = None
 
+    @staticmethod
+    def get_cli_commands() -> list[CLICommand]:
+        """Vends CLI commands to be included in Airflow CLI.
+
+        Override this method to expose commands via Airflow CLI to manage this auth manager.
+        """
+        return []
+
     @abstractmethod
     def get_user_name(self) -> str:
         """Return the username associated to the user in session."""

airflow/auth/managers/fab/cli_commands/__init__.py

@@ -0,0 +1,17 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

airflow/auth/managers/fab/cli_commands/definition.py

@@ -0,0 +1,220 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from __future__ import annotations
+
+import textwrap
+
+from airflow.cli.cli_config import (
+    ARG_OUTPUT,
+    ARG_VERBOSE,
+    ActionCommand,
+    Arg,
+    lazy_load_command,
+)
+
+############
+# # ARGS # #
+############
+
+# users
+ARG_USERNAME = Arg(("-u", "--username"), help="Username of the user", required=True, type=str)
+ARG_USERNAME_OPTIONAL = Arg(("-u", "--username"), help="Username of the user", type=str)
+ARG_FIRSTNAME = Arg(("-f", "--firstname"), help="First name of the user", required=True, type=str)
+ARG_LASTNAME = Arg(("-l", "--lastname"), help="Last name of the user", required=True, type=str)
+ARG_ROLE = Arg(
+    ("-r", "--role"),
+    help="Role of the user. Existing roles include Admin, User, Op, Viewer, and Public",
+    required=True,
+    type=str,
+)
+ARG_EMAIL = Arg(("-e", "--email"), help="Email of the user", required=True, type=str)
+ARG_EMAIL_OPTIONAL = Arg(("-e", "--email"), help="Email of the user", type=str)
+ARG_PASSWORD = Arg(
+    ("-p", "--password"),
+    help="Password of the user, required to create a user without --use-random-password",
+    type=str,
+)
+ARG_USE_RANDOM_PASSWORD = Arg(
+    ("--use-random-password",),
+    help="Do not prompt for password. Use random string instead."
+    " Required to create a user without --password ",
+    default=False,
+    action="store_true",
+)
+ARG_USER_IMPORT = Arg(
+    ("import",),
+    metavar="FILEPATH",
+    help="Import users from JSON file. Example format::\n"
+    + textwrap.indent(
+        textwrap.dedent(
+            """
+            [
+                {
+                    "email": "[email protected]",
+                    "firstname": "Jon",
+                    "lastname": "Doe",
+                    "roles": ["Public"],
+                    "username": "jondoe"
+                }
+            ]"""
+        ),
+        " " * 4,
+    ),
+)
+ARG_USER_EXPORT = Arg(("export",), metavar="FILEPATH", help="Export all users to JSON file")
+
+# roles
+ARG_CREATE_ROLE = Arg(("-c", "--create"), help="Create a new role", action="store_true")
+ARG_LIST_ROLES = Arg(("-l", "--list"), help="List roles", action="store_true")
+ARG_ROLES = Arg(("role",), help="The name of a role", nargs="*")
+ARG_PERMISSIONS = Arg(("-p", "--permission"), help="Show role permissions", action="store_true")
+ARG_ROLE_RESOURCE = Arg(("-r", "--resource"), help="The name of permissions", nargs="*", required=True)
+ARG_ROLE_ACTION = Arg(("-a", "--action"), help="The action of permissions", nargs="*")
+ARG_ROLE_ACTION_REQUIRED = Arg(("-a", "--action"), help="The action of permissions", nargs="*", required=True)
+
+ARG_ROLE_IMPORT = Arg(("file",), help="Import roles from JSON file", nargs=None)
+ARG_ROLE_EXPORT = Arg(("file",), help="Export all roles to JSON file", nargs=None)
+ARG_ROLE_EXPORT_FMT = Arg(
+    ("-p", "--pretty"),
+    help="Format output JSON file by sorting role names and indenting by 4 spaces",
+    action="store_true",
+)
+
+# sync-perm
+ARG_INCLUDE_DAGS = Arg(
+    ("--include-dags",), help="If passed, DAG specific permissions will also be synced.", action="store_true"
+)
+
+################
+# # COMMANDS # #
+################
+
+USERS_COMMANDS = (
+    ActionCommand(
+        name="list",
+        help="List users",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.users_list"),
+        args=(ARG_OUTPUT, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="create",
+        help="Create a user",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.users_create"),
+        args=(
+            ARG_ROLE,
+            ARG_USERNAME,
+            ARG_EMAIL,
+            ARG_FIRSTNAME,
+            ARG_LASTNAME,
+            ARG_PASSWORD,
+            ARG_USE_RANDOM_PASSWORD,
+            ARG_VERBOSE,
+        ),
+        epilog=(
+            "examples:\n"
+            'To create an user with "Admin" role and username equals to "admin", run:\n'
+            "\n"
+            "    $ airflow users create \\\n"
+            "          --username admin \\\n"
+            "          --firstname FIRST_NAME \\\n"
+            "          --lastname LAST_NAME \\\n"
+            "          --role Admin \\\n"
+            "          --email [email protected]"
+        ),
+    ),
+    ActionCommand(
+        name="delete",
+        help="Delete a user",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.users_delete"),
+        args=(ARG_USERNAME_OPTIONAL, ARG_EMAIL_OPTIONAL, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="add-role",
+        help="Add role to a user",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.add_role"),
+        args=(ARG_USERNAME_OPTIONAL, ARG_EMAIL_OPTIONAL, ARG_ROLE, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="remove-role",
+        help="Remove role from a user",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.remove_role"),
+        args=(ARG_USERNAME_OPTIONAL, ARG_EMAIL_OPTIONAL, ARG_ROLE, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="import",
+        help="Import users",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.users_import"),
+        args=(ARG_USER_IMPORT, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="export",
+        help="Export all users",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.user_command.users_export"),
+        args=(ARG_USER_EXPORT, ARG_VERBOSE),
+    ),
+)
+ROLES_COMMANDS = (
+    ActionCommand(
+        name="list",
+        help="List roles",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_list"),
+        args=(ARG_PERMISSIONS, ARG_OUTPUT, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="create",
+        help="Create role",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_create"),
+        args=(ARG_ROLES, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="delete",
+        help="Delete role",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_delete"),
+        args=(ARG_ROLES, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="add-perms",
+        help="Add roles permissions",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_add_perms"),
+        args=(ARG_ROLES, ARG_ROLE_RESOURCE, ARG_ROLE_ACTION_REQUIRED, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="del-perms",
+        help="Delete roles permissions",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_del_perms"),
+        args=(ARG_ROLES, ARG_ROLE_RESOURCE, ARG_ROLE_ACTION, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="export",
+        help="Export roles (without permissions) from db to JSON file",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_export"),
+        args=(ARG_ROLE_EXPORT, ARG_ROLE_EXPORT_FMT, ARG_VERBOSE),
+    ),
+    ActionCommand(
+        name="import",
+        help="Import roles (without permissions) from JSON file to db",
+        func=lazy_load_command("airflow.auth.managers.fab.cli_commands.role_command.roles_import"),
+        args=(ARG_ROLE_IMPORT, ARG_VERBOSE),
+    ),
+)
+
+SYNC_PERM_COMMAND = ActionCommand(
+    name="sync-perm",
+    help="Update permissions for existing roles and optionally DAGs",
+    func=lazy_load_command("airflow.auth.managers.fab.cli_commands.sync_perm_command.sync_perm"),
+    args=(ARG_INCLUDE_DAGS, ARG_VERBOSE),
+)

airflow/cli/commands/role_command.py → airflow/auth/managers/fab/cli_commands/role_command.py

@@ -23,6 +23,7 @@
 import json
 import os
 
+from airflow.auth.managers.fab.cli_commands.utils import get_application_builder
 from airflow.auth.managers.fab.models import Action, Permission, Resource, Role
 from airflow.cli.simple_table import AirflowConsole
 from airflow.utils import cli as cli_utils
@@ -35,8 +36,6 @@
 @providers_configuration_loaded
 def roles_list(args):
     """List all existing roles."""
-    from airflow.utils.cli_app_builder import get_application_builder
-
     with get_application_builder() as appbuilder:
         roles = appbuilder.sm.get_all_roles()
 
@@ -63,8 +62,6 @@ def roles_list(args):
 @providers_configuration_loaded
 def roles_create(args):
     """Create new empty role in DB."""
-    from airflow.utils.cli_app_builder import get_application_builder
-
     with get_application_builder() as appbuilder:
         for role_name in args.role:
             appbuilder.sm.add_role(role_name)
@@ -76,8 +73,6 @@ def roles_create(args):
 @providers_configuration_loaded
 def roles_delete(args):
     """Delete role in DB."""
-    from airflow.utils.cli_app_builder import get_application_builder
-
     with get_application_builder() as appbuilder:
         for role_name in args.role:
             role = appbuilder.sm.find_role(role_name)
@@ -90,8 +85,6 @@ def roles_delete(args):
 
 
 def __roles_add_or_remove_permissions(args):
-    from airflow.utils.cli_app_builder import get_application_builder
-
     with get_application_builder() as appbuilder:
         is_add: bool = args.subcommand.startswith("add")
 
@@ -165,8 +158,6 @@ def roles_export(args):
     Note, this function does not export the permissions associated for each role.
     Strictly, it exports the role names into the passed role json file.
     """
-    from airflow.utils.cli_app_builder import get_application_builder
-
     with get_application_builder() as appbuilder:
         roles = appbuilder.sm.get_all_roles()
         exporting_roles = [role.name for role in roles if role.name not in EXISTING_ROLES]
@@ -196,7 +187,6 @@ def roles_import(args):
     except ValueError as e:
         print(f"File '{json_file}' is not a valid JSON file. Error: {e}")
         exit(1)
-    from airflow.utils.cli_app_builder import get_application_builder
 
     with get_application_builder() as appbuilder:
         existing_roles = [role.name for role in appbuilder.sm.get_all_roles()]

airflow/cli/commands/sync_perm_command.py → airflow/auth/managers/fab/cli_commands/sync_perm_command.py

@@ -26,7 +26,7 @@
 @providers_configuration_loaded
 def sync_perm(args):
     """Update permissions for existing roles and DAGs."""
-    from airflow.utils.cli_app_builder import get_application_builder
+    from airflow.auth.managers.fab.cli_commands.utils import get_application_builder
 
     with get_application_builder() as appbuilder:
         print("Updating actions and resources for all existing roles")