Skip to content

setting use_async=True for get_async_default_azure_credential #35432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 3 commits into from
Nov 5, 2023
Merged

setting use_async=True for get_async_default_azure_credential #35432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f001ba
fix(providers/microsoft): setting use_async=True for get_async_defaul…
Lee-W Nov 4, 2023
b94e1fe
Merge branch 'main' into fix-get_async_default_azure_credential
Lee-W Nov 4, 2023
8644602
Merge branch 'main' into fix-get_async_default_azure_credential
Lee-W Nov 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions airflow/providers/microsoft/azure/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ def get_field(*, conn_id: str, conn_type: str, extras: dict, field_name: str):

def _get_default_azure_credential(
*,
managed_identity_client_id: str | None,
workload_identity_tenant_id: str | None,
managed_identity_client_id: str | None = None,
workload_identity_tenant_id: str | None = None,
use_async: bool = False,
) -> DefaultAzureCredential | AsyncDefaultAzureCredential:
"""Get DefaultAzureCredential based on provided arguments.
Expand Down Expand Up @@ -88,7 +88,7 @@ def _get_default_azure_credential(

get_async_default_azure_credential: partial[AsyncDefaultAzureCredential] = partial(
_get_default_azure_credential, # type: ignore[arg-type]
use_async=False,
use_async=True,
)


Expand Down
16 changes: 16 additions & 0 deletions tests/providers/microsoft/azure/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@
from airflow.providers.microsoft.azure.utils import (
AzureIdentityCredentialAdapter,
add_managed_identity_connection_widgets,
get_async_default_azure_credential,
get_field,
# _get_default_azure_credential
get_sync_default_azure_credential,
)

MODULE = "airflow.providers.microsoft.azure.utils"
Expand Down Expand Up @@ -77,6 +80,19 @@ def test_func() -> dict[str, Any]:
assert "workload_identity_tenant_id" in widgets


@mock.patch(f"{MODULE}.DefaultAzureCredential")

@harishkesavarao harishkesavarao Nov 4, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lee-W, the changes look good. Do you think it is a good idea to elaborate the unit tests a bit by adding mock objects and running tests to compare expected vs. actual for the method calls?

@Lee-W Lee-W Nov 5, 2023

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. I think the main point here is verifying we're calling the right object

@potiuk potiuk Nov 5, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah - for me it's enough to check they are called. Too detailed tests are often problematic - especially in case of some auth methods that tend to change when client libraries change. We often have to fix such tests when new versions of libraries are released just to add a new parameter expected etc. So I'd say just "called" is good enough for me - especially that we have detailed test for the credentials class itself

@harishkesavarao harishkesavarao Nov 6, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, @Lee-W and @potiuk, thanks for clarifying.

def test_get_sync_default_azure_credential(mock_default_azure_credential):
get_sync_default_azure_credential()

assert mock_default_azure_credential.called


@mock.patch(f"{MODULE}.AsyncDefaultAzureCredential")
def test_get_async_default_azure_credential(mock_default_azure_credential):
get_async_default_azure_credential()
assert mock_default_azure_credential.called


class TestAzureIdentityCredentialAdapter:
@mock.patch(f"{MODULE}.PipelineRequest")
@mock.patch(f"{MODULE}.BearerTokenCredentialPolicy")
Expand Down