Skip to content

Improve chained and defaultazurecredential error messages #8109

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
KieranBrantnerMagee merged 4 commits into from
Nov 8, 2019
Merged

Improve chained and defaultazurecredential error messages #8109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62991e6
Attempt to bolster chained and defaultazurecredential error messages …
KieranBrantnerMagee Oct 22, 2019
524b9c0
Add aka link to identity docs for defaultazurecredential exceptions
KieranBrantnerMagee Oct 22, 2019
7911d34
Fix lint failures, further nitpicks to capitalization, spacing, and v…
KieranBrantnerMagee Oct 23, 2019
7da2bd4
PR comments, tweaking error verbage and pylint modifiers.
KieranBrantnerMagee Oct 23, 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
3 changes: 2 additions & 1 deletion sdk/identity/azure-identity/azure/identity/_credentials/chained.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,5 @@ def _get_error_message(history):
attempts.append("{}: {}".format(credential.__class__.__name__, error))
else:
attempts.append(credential.__class__.__name__)
return "No valid token received. {}".format(". ".join(attempts))
return """No credential in this chain provided a token.
Attempted credentials:\n\t{}""".format("\n\t".join(attempts))
12 changes: 12 additions & 0 deletions sdk/identity/azure-identity/azure/identity/_credentials/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
# ------------------------------------
import os

from azure.core.exceptions import ClientAuthenticationError

from .._constants import EnvironmentVariables
from .chained import ChainedTokenCredential
from .environment import EnvironmentCredential
Expand Down Expand Up @@ -42,3 +44,13 @@ def __init__(self, **kwargs):
)

super(DefaultAzureCredential, self).__init__(*credentials)

def get_token(self, *scopes, **kwargs):
try:
return super(DefaultAzureCredential, self).get_token(*scopes, **kwargs)
except ClientAuthenticationError as e:
raise ClientAuthenticationError(message="""
{}\n\nPlease visit the Azure identity Python SDK docs at
https://aka.ms/python-sdk-identity#defaultazurecredential
to learn what options DefaultAzureCredential supports"""
.format(e.message))