feat: deprecated basic auth airflow.api.auth.backend.basic_auth remov…

…ed (apache#41663) * deprecatd basic auth airflow.api.auth.backend.basic_auth removed * news fragment added * deprecatd basic auth airflow.api.auth.backend.basic_auth removed
okirialbert · Aug 22, 2024 · c2a9833 · c2a9833
1 parent a11656c
commit c2a9833
Show file tree

Hide file tree

Showing 13 changed files with 21 additions and 120 deletions.
diff --git a/.github/workflows/basic-tests.yml b/.github/workflows/basic-tests.yml
@@ -169,7 +169,8 @@ jobs:
           nohup airflow webserver --port 8080 &
           echo "Started webserver"
         env:
-          AIRFLOW__API__AUTH_BACKENDS: airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth
+          AIRFLOW__API__AUTH_BACKENDS: >-
+            airflow.api.auth.backend.session,airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
           AIRFLOW__WEBSERVER__EXPOSE_CONFIG: "True"
           AIRFLOW__CORE__LOAD_EXAMPLES: "True"
           AIRFLOW_HOME: "${{ github.workspace }}/airflow_home"

diff --git a/airflow/api/auth/backend/basic_auth.py b/airflow/api/auth/backend/basic_auth.py
diff --git a/airflow/api_connexion/openapi/v1.yaml b/airflow/api_connexion/openapi/v1.yaml
@@ -176,7 +176,7 @@ info:
     `airflow config get-value api auth_backends` command as in the example below.
     ```bash
     $ airflow config get-value api auth_backends
-    airflow.api.auth.backend.basic_auth
+    airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
     ```
     The default is to deny all requests.
 

diff --git a/airflow/auth/managers/fab/api/auth/backend/basic_auth.py b/airflow/auth/managers/fab/api/auth/backend/basic_auth.py
diff --git a/clients/python/README.md b/clients/python/README.md
@@ -182,7 +182,7 @@ If you want to check which auth backend is currently set, you can use
 
 ```bash
 $ airflow config get-value api auth_backends
-airflow.api.auth.backend.basic_auth
+airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 ```
 
 The default is to deny all requests.
@@ -534,11 +534,11 @@ that uses the API to run the tests. To do that, you need to:
 
 ```ini
 [api]
-auth_backend = airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth
+auth_backend = airflow.api.auth.backend.session,airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 ```
 
 You can also set it by env variable:
-`export AIRFLOW__API__AUTH_BACKENDS=airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth`
+`export AIRFLOW__API__AUTH_BACKENDS=airflow.api.auth.backend.session,airflow.providers.fab.auth_manager.api.auth.backend.basic_auth`
 
 * configure your airflow webserver to load example dags
   In the `[core]` section of your `airflow.cfg` set:

diff --git a/clients/python/test_python_client.py b/clients/python/test_python_client.py
@@ -49,7 +49,7 @@
 # configured also with the basic_auth as backend additionally to regular session backend needed
 # by the UI. In the `[api]` section of your `airflow.cfg` set:
 #
-# auth_backend = airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth
+# auth_backend = airflow.api.auth.backend.session,airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 #
 # Make sure that your user/name are configured properly - using the user/password that has admin
 # privileges in Airflow

diff --git a/dev/README_RELEASE_PYTHON_CLIENT.md b/dev/README_RELEASE_PYTHON_CLIENT.md
@@ -464,7 +464,7 @@ and allows you to test the client in a real environment.
    variable in `files/airflow-breeze-config/init.sh`:
 
 ```shell
-export AIRFLOW__API__AUTH_BACKENDS=airflow.api.auth.backend.session,airflow.api.auth.backend.basic_auth
+export AIRFLOW__API__AUTH_BACKENDS=airflow.api.auth.backend.session,airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 export AIRFLOW__WEBSERVER__EXPOSE_CONFIG=True
 ```
 

diff --git a/dev/breeze/src/airflow_breeze/commands/kubernetes_commands.py b/dev/breeze/src/airflow_breeze/commands/kubernetes_commands.py
@@ -1024,7 +1024,7 @@ def _deploy_helm_chart(
             "-v",
             "1",
             "--set",
-            "config.api.auth_backends=airflow.api.auth.backend.basic_auth",
+            "config.api.auth_backends=airflow.providers.fab.auth_manager.api.auth.backend.basic_auth",
             "--set",
             "config.logging.logging_level=DEBUG",
             "--set",

diff --git a/docs/apache-airflow-providers-fab/auth-manager/api-authentication.rst b/docs/apache-airflow-providers-fab/auth-manager/api-authentication.rst
@@ -43,7 +43,7 @@ command as in the example below.
 .. code-block:: console
 
     $ airflow config get-value api auth_backends
-    airflow.api.auth.backend.basic_auth
+    airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 
 Kerberos authentication
 '''''''''''''''''''''''
@@ -78,7 +78,7 @@ To enable basic authentication, set the following in the configuration:
 .. code-block:: ini
 
     [api]
-    auth_backends = airflow.api.auth.backend.basic_auth
+    auth_backends = airflow.providers.fab.auth_manager.api.auth.backend.basic_auth
 
 Username and password needs to be base64 encoded and send through the
 ``Authorization`` HTTP header in the following format:

diff --git a/docs/apache-airflow/howto/docker-compose/docker-compose.yaml b/docs/apache-airflow/howto/docker-compose/docker-compose.yaml
@@ -60,7 +60,8 @@ x-airflow-common:
     AIRFLOW__CORE__FERNET_KEY: ''
     AIRFLOW__CORE__DAGS_ARE_PAUSED_AT_CREATION: 'true'
     AIRFLOW__CORE__LOAD_EXAMPLES: 'true'
-    AIRFLOW__API__AUTH_BACKENDS: 'airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session'
+    AIRFLOW__API__AUTH_BACKENDS: >-
+       airflow.providers.fab.auth_manager.api.auth.backend.basic_auth,airflow.api.auth.backend.session
     # yamllint disable rule:line-length
     # Use simple http server on scheduler for health checks
     # See https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/logging-monitoring/check-health.html#scheduler-health-check-server

diff --git a/newsfragments/41663.significant.rst b/newsfragments/41663.significant.rst
@@ -0,0 +1 @@
+Removed deprecated auth ``airflow.api.auth.backend.basic_auth`` from ``auth_backends``. Please use ``airflow.providers.fab.auth_manager.api.auth.backend.basic_auth`` instead.
diff --git a/tests/core/test_configuration.py b/tests/core/test_configuration.py
@@ -646,13 +646,15 @@ def test_auth_backends_adds_session(self):
                     ),
                 },
             }
-            test_conf.read_dict({"api": {"auth_backends": "airflow.api.auth.backend.basic_auth"}})
+            test_conf.read_dict(
+                {"api": {"auth_backends": "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth"}}
+            )
 
             with pytest.warns(FutureWarning):
                 test_conf.validate()
                 assert (
                     test_conf.get("api", "auth_backends")
-                    == "airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session"
+                    == "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth,airflow.api.auth.backend.session"
                 )
 
     def test_command_from_env(self):
@@ -1028,11 +1030,11 @@ def test_deprecated_values_from_conf(self):
         "old, new",
         [
             (
-                ("api", "auth_backend", "airflow.api.auth.backend.basic_auth"),
+                ("api", "auth_backend", "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth"),
                 (
                     "api",
                     "auth_backends",
-                    "airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session",
+                    "airflow.providers.fab.auth_manager.api.auth.backend.basic_auth,airflow.api.auth.backend.session",
                 ),
             ),
             (

diff --git a/tests/providers/fab/auth_manager/api/auth/backend/test_basic_auth.py b/tests/providers/fab/auth_manager/api/auth/backend/test_basic_auth.py
@@ -22,7 +22,7 @@
 from flask import Response
 from flask_appbuilder.const import AUTH_LDAP
 
-from airflow.api.auth.backend.basic_auth import requires_authentication
+from airflow.providers.fab.auth_manager.api.auth.backend.basic_auth import requires_authentication
 from airflow.www import app as application
 from tests.test_utils.compat import AIRFLOW_V_2_9_PLUS
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Removed deprecated auth ``airflow.api.auth.backend.basic_auth`` from ``auth_backends``. Please use ``airflow.providers.fab.auth_manager.api.auth.backend.basic_auth`` instead.