1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
from datetime import datetime
import json
from azure.identity import AzureCliCredential, CredentialUnavailableError
from azure.identity._credentials.azure_cli import CLI_NOT_FOUND, NOT_LOGGED_IN
from azure.core.exceptions import ClientAuthenticationError
import subprocess
import pytest
from helpers import mock
CHECK_OUTPUT = AzureCliCredential.__module__ + ".subprocess.check_output"
TEST_ERROR_OUTPUTS = (
'{"accessToken": "secret value',
'{"accessToken": "secret value"',
'{"accessToken": "secret value and some other nonsense"',
'{"accessToken": "secret value", some invalid json, "accessToken": "secret value"}',
'{"accessToken": "secret value"}',
'{"accessToken": "secret value", "subscription": "some-guid", "tenant": "some-guid", "tokenType": "Bearer"}',
"no secrets or json here",
"{}",
)
def raise_called_process_error(return_code, output, cmd="..."):
error = subprocess.CalledProcessError(return_code, cmd=cmd, output=output)
return mock.Mock(side_effect=error)
def test_no_scopes():
"""The credential should raise ValueError when get_token is called with no scopes"""
with pytest.raises(ValueError):
AzureCliCredential().get_token()
def test_multiple_scopes():
"""The credential should raise ValueError when get_token is called with more than one scope"""
with pytest.raises(ValueError):
AzureCliCredential().get_token("one scope", "and another")
def test_get_token():
"""The credential should parse the CLI's output to an AccessToken"""
access_token = "access token"
expected_expires_on = 1602015811
successful_output = json.dumps(
{
"expiresOn": datetime.fromtimestamp(expected_expires_on).strftime("%Y-%m-%d %H:%M:%S.%f"),
"accessToken": access_token,
"subscription": "some-guid",
"tenant": "some-guid",
"tokenType": "Bearer",
}
)
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=successful_output)):
token = AzureCliCredential().get_token("scope")
assert token.token == access_token
assert type(token.expires_on) == int
assert token.expires_on == expected_expires_on
def test_cli_not_installed_linux():
"""The credential should raise CredentialUnavailableError when the CLI isn't installed"""
output = "/bin/sh: 1: az: not found"
with mock.patch(CHECK_OUTPUT, raise_called_process_error(127, output)):
with pytest.raises(CredentialUnavailableError, match=CLI_NOT_FOUND):
AzureCliCredential().get_token("scope")
def test_cli_not_installed_windows():
"""The credential should raise CredentialUnavailableError when the CLI isn't installed"""
output = "'az' is not recognized as an internal or external command, operable program or batch file."
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, output)):
with pytest.raises(CredentialUnavailableError, match=CLI_NOT_FOUND):
AzureCliCredential().get_token("scope")
def test_cannot_execute_shell():
"""The credential should raise CredentialUnavailableError when the subprocess doesn't start"""
with mock.patch(CHECK_OUTPUT, mock.Mock(side_effect=OSError())):
with pytest.raises(CredentialUnavailableError):
AzureCliCredential().get_token("scope")
def test_not_logged_in():
"""When the CLI isn't logged in, the credential should raise CredentialUnavailableError"""
output = "ERROR: Please run 'az login' to setup account."
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, output)):
with pytest.raises(CredentialUnavailableError, match=NOT_LOGGED_IN):
AzureCliCredential().get_token("scope")
def test_unexpected_error():
"""When the CLI returns an unexpected error, the credential should raise an error containing the CLI's output"""
output = "something went wrong"
with mock.patch(CHECK_OUTPUT, raise_called_process_error(42, output)):
with pytest.raises(ClientAuthenticationError, match=output):
AzureCliCredential().get_token("scope")
@pytest.mark.parametrize("output", TEST_ERROR_OUTPUTS)
def test_parsing_error_does_not_expose_token(output):
"""Errors during CLI output parsing shouldn't expose access tokens in that output"""
with mock.patch(CHECK_OUTPUT, mock.Mock(return_value=output)):
with pytest.raises(ClientAuthenticationError) as ex:
AzureCliCredential().get_token("scope")
assert "secret value" not in str(ex.value)
assert "secret value" not in repr(ex.value)
@pytest.mark.parametrize("output", TEST_ERROR_OUTPUTS)
def test_subprocess_error_does_not_expose_token(output):
"""Errors from the subprocess shouldn't expose access tokens in CLI output"""
with mock.patch(CHECK_OUTPUT, raise_called_process_error(1, output=output)):
with pytest.raises(ClientAuthenticationError) as ex:
AzureCliCredential().get_token("scope")
assert "secret value" not in str(ex.value)
assert "secret value" not in repr(ex.value)
|
