Skip to content

Ensure offline DefaultAzureCredential tests pass during live runs #8777

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
chlowell merged 2 commits into from
Nov 21, 2019
Merged

Ensure offline DefaultAzureCredential tests pass during live runs #8777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27a56f5
ensure offline tests pass during live runs
chlowell Nov 21, 2019
422ae84
reword comments for the sake of future generations
chlowell Nov 21, 2019
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
20 changes: 16 additions & 4 deletions sdk/identity/azure-identity/tests/test_default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from azure.core.credentials import AccessToken
import os

from azure.identity import (
DefaultAzureCredential,
InteractiveBrowserCredential,
Expand Down Expand Up @@ -64,7 +65,9 @@ def send(request, **_):
assert access_token == expected_access_token

# shared cache credential should respect authority
account = get_account_event(username="spam@eggs", uid="guid", utid="tenant", authority=authority_kwarg)
upn = os.environ.get(EnvironmentVariables.AZURE_USERNAME, "spam@eggs") # preferring environment values to
tenant = os.environ.get(EnvironmentVariables.AZURE_TENANT_ID, "tenant") # prevent failure during live runs
account = get_account_event(username=upn, uid="guid", utid=tenant, authority=authority_kwarg)
cache = populated_cache(account)
with patch.object(SharedTokenCacheCredential, "supported"):
credential = DefaultAzureCredential(_cache=cache, authority=authority_kwarg, transport=Mock(send=send))
Expand Down Expand Up @@ -115,7 +118,12 @@ def test_shared_cache_tenant_id():
expected_access_token = "expected-access-token"
refresh_token_a = "refresh-token-a"
refresh_token_b = "refresh-token-b"
upn = "spam@eggs"

# The value of the UPN is arbitrary because this test verifies the credential's behavior given a specified
# tenant ID. During a complete live test run, $AZURE_USERNAME will have a value which DefaultAzureCredential
# should pass to SharedTokenCacheCredential. This test will fail if the mock accounts don't match that value.
upn = os.environ.get(EnvironmentVariables.AZURE_USERNAME, "spam@eggs")

tenant_a = "tenant-a"
tenant_b = "tenant-b"

Expand Down Expand Up @@ -158,7 +166,11 @@ def test_shared_cache_username():
refresh_token_b = "refresh-token-b"
upn_a = "spam@eggs"
upn_b = "eggs@spam"
tenant_id = "the-tenant"

# The value of the tenant ID is arbitrary because this test verifies the credential's behavior given a specified
# username. During a complete live test run, $AZURE_TENANT_ID will have a value which DefaultAzureCredential should
# pass to SharedTokenCacheCredential. This test will fail if the mock accounts don't match that value.
tenant_id = os.environ.get(EnvironmentVariables.AZURE_TENANT_ID, "the-tenant")

# two cached accounts, same tenant, different usernames -> shared_cache_username should prevail
account_a = get_account_event(username=upn_a, uid="another-guid", utid=tenant_id, refresh_token=refresh_token_a)
Expand Down
18 changes: 15 additions & 3 deletions sdk/identity/azure-identity/tests/test_default_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Licensed under the MIT License.
# ------------------------------------
import asyncio
import os
from unittest.mock import Mock, patch
from urllib.parse import urlparse

Expand Down Expand Up @@ -69,7 +70,9 @@ async def send(request, **_):
assert access_token == expected_access_token

# shared cache credential should respect authority
account = get_account_event(username="spam@eggs", uid="guid", utid="tenant", authority=authority_kwarg)
upn = os.environ.get(EnvironmentVariables.AZURE_USERNAME, "spam@eggs") # preferring environment values to
tenant = os.environ.get(EnvironmentVariables.AZURE_TENANT_ID, "tenant") # prevent failure during live runs
account = get_account_event(username=upn, uid="guid", utid=tenant, authority=authority_kwarg)
cache = populated_cache(account)
with patch.object(SharedTokenCacheCredential, "supported"):
credential = DefaultAzureCredential(_cache=cache, authority=authority_kwarg, transport=Mock(send=send))
Expand Down Expand Up @@ -115,7 +118,12 @@ async def test_shared_cache_tenant_id():
expected_access_token = "expected-access-token"
refresh_token_a = "refresh-token-a"
refresh_token_b = "refresh-token-b"
upn = "spam@eggs"

# The value of upn is arbitrary because this test verifies the credential's behavior given a specified
# tenant. During a complete live test run, $AZURE_USERNAME will have a value which DefaultAzureCredential
# should pass to SharedTokenCacheCredential. This test will fail if the mock accounts don't match that value.
upn = os.environ.get(EnvironmentVariables.AZURE_USERNAME, "spam@eggs")

tenant_a = "tenant-a"
tenant_b = "tenant-b"

Expand Down Expand Up @@ -159,7 +167,11 @@ async def test_shared_cache_username():
refresh_token_b = "refresh-token-b"
upn_a = "spam@eggs"
upn_b = "eggs@spam"
tenant_id = "the-tenant"

# The value of tenant_id is arbitrary because this test verifies the credential's behavior given a specified
# username. During a complete live test run, $AZURE_TENANT_ID will have a value which DefaultAzureCredential
# should pass to SharedTokenCacheCredential. This test will fail if the mock accounts don't match that value.
tenant_id = os.environ.get(EnvironmentVariables.AZURE_TENANT_ID, "the-tenant")

# two cached accounts, same tenant, different usernames -> shared_cache_username should prevail
account_a = get_account_event(username=upn_a, uid="another-guid", utid=tenant_id, refresh_token=refresh_token_a)
Expand Down