This is an automated email from the ASF dual-hosted git repository.
phanikumv pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 2e39fbd7d2 allow providing credentials through keyword argument in
AzureKeyVaultBackend (#34706)
2e39fbd7d2 is described below
commit 2e39fbd7d229a76ec0b93e3755bee103804de20e
Author: Wei Lee <[email protected]>
AuthorDate: Tue Oct 3 13:19:01 2023 +0800
allow providing credentials through keyword argument in
AzureKeyVaultBackend (#34706)
---
.../providers/microsoft/azure/secrets/key_vault.py | 21 +++++++++++++++--
.../azure/secrets/test_azure_key_vault.py | 27 ++++++++++++++++++++++
2 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/airflow/providers/microsoft/azure/secrets/key_vault.py
b/airflow/providers/microsoft/azure/secrets/key_vault.py
index af8089287d..3c6b909570 100644
--- a/airflow/providers/microsoft/azure/secrets/key_vault.py
+++ b/airflow/providers/microsoft/azure/secrets/key_vault.py
@@ -23,7 +23,7 @@ import warnings
from functools import cached_property
from azure.core.exceptions import ResourceNotFoundError
-from azure.identity import DefaultAzureCredential
+from azure.identity import ClientSecretCredential, DefaultAzureCredential
from azure.keyvault.secrets import SecretClient
from airflow.exceptions import AirflowProviderDeprecationWarning
@@ -72,6 +72,12 @@ class AzureKeyVaultBackend(BaseSecretsBackend, LoggingMixin):
If set to None (null), requests for configurations will not be sent to
Azure Key Vault
:param vault_url: The URL of an Azure Key Vault to use
:param sep: separator used to concatenate secret_prefix and secret_id.
Default: "-"
+ :param tenant_id: The tenant id of an Azure Key Vault to use.
+ If not given, it falls back to ``DefaultAzureCredential``
+ :param client_id: The client id of an Azure Key Vault to use.
+ If not given, it falls back to ``DefaultAzureCredential``
+ :param client_secret: The client secret of an Azure Key Vault to use.
+ If not given, it falls back to ``DefaultAzureCredential``
"""
def __init__(
@@ -81,6 +87,10 @@ class AzureKeyVaultBackend(BaseSecretsBackend, LoggingMixin):
config_prefix: str = "airflow-config",
vault_url: str = "",
sep: str = "-",
+ *,
+ tenant_id: str = "",
+ client_id: str = "",
+ client_secret: str = "",
**kwargs,
) -> None:
super().__init__()
@@ -105,12 +115,19 @@ class AzureKeyVaultBackend(BaseSecretsBackend,
LoggingMixin):
logger.setLevel(logging.WARNING)
self.sep = sep
+ self.tenant_id = tenant_id
+ self.client_id = client_id
+ self.client_secret = client_secret
self.kwargs = kwargs
@cached_property
def client(self) -> SecretClient:
"""Create a Azure Key Vault client."""
- credential = DefaultAzureCredential()
+ credential: ClientSecretCredential | DefaultAzureCredential
+ if all([self.tenant_id, self.client_id, self.client_secret]):
+ credential = ClientSecretCredential(self.tenant_id,
self.client_id, self.client_secret)
+ else:
+ credential = DefaultAzureCredential()
client = SecretClient(vault_url=self.vault_url, credential=credential,
**self.kwargs)
return client
diff --git a/tests/providers/microsoft/azure/secrets/test_azure_key_vault.py
b/tests/providers/microsoft/azure/secrets/test_azure_key_vault.py
index a6afbee671..6b5c8d5dd2 100644
--- a/tests/providers/microsoft/azure/secrets/test_azure_key_vault.py
+++ b/tests/providers/microsoft/azure/secrets/test_azure_key_vault.py
@@ -150,3 +150,30 @@ class TestAzureKeyVaultBackend:
backend = AzureKeyVaultBackend(**kwargs)
assert backend.get_config("test_mysql") is None
mock_get_secret.assert_not_called()
+
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.DefaultAzureCredential")
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.ClientSecretCredential")
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.SecretClient")
+ def test_client_authenticate_with_default_azure_credential(
+ self, mock_client, mock_client_secret_credential,
mock_defaul_azure_credential
+ ):
+ backend =
AzureKeyVaultBackend(vault_url="https://example-akv-resource-name.vault.azure.net/")
+ backend.client
+ assert not mock_client_secret_credential.called
+ mock_defaul_azure_credential.assert_called_once()
+
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.DefaultAzureCredential")
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.ClientSecretCredential")
+
@mock.patch("airflow.providers.microsoft.azure.secrets.key_vault.SecretClient")
+ def test_client_authenticate_with_client_secret_credential(
+ self, mock_client, mock_client_secret_credential,
mock_defaul_azure_credential
+ ):
+ backend = AzureKeyVaultBackend(
+ vault_url="https://example-akv-resource-name.vault.azure.net/",
+ tenant_id="tenant_id",
+ client_id="client_id",
+ client_secret="client_secret",
+ )
+ backend.client
+ assert not mock_defaul_azure_credential.called
+ mock_client_secret_credential.assert_called_once()