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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# --------------------------------------------------------------------------
import logging
import os
import sys
import pytest
from typing import NamedTuple
from unittest.mock import patch, MagicMock
# module under test
import azure.core.settings as m
from azure.core import AzureClouds
class TestPrioritizedSetting(object):
def test_env_var_property(self):
ps = m.PrioritizedSetting("foo", env_var="AZURE_FOO")
assert ps.env_var == "AZURE_FOO"
def test_everything_unset_raises(self):
ps = m.PrioritizedSetting("foo")
with pytest.raises(RuntimeError):
ps()
def test_implicit_default(self):
ps = m.PrioritizedSetting("foo", default=10)
assert ps() == 10
def test_implicit_default_converts(self):
ps = m.PrioritizedSetting("foo", convert=int, default="10")
assert ps() == 10
def test_system_hook(self):
ps = m.PrioritizedSetting("foo", system_hook=lambda: 20)
assert ps() == 20
def test_system_hook_converts(self):
ps = m.PrioritizedSetting("foo", convert=int, system_hook=lambda: "20")
assert ps() == 20
def test_env_var(self):
os.environ["AZURE_FOO"] = "30"
ps = m.PrioritizedSetting("foo", env_var="AZURE_FOO")
assert ps() == "30"
del os.environ["AZURE_FOO"]
def test_env_var_converts(self):
os.environ["AZURE_FOO"] = "30"
ps = m.PrioritizedSetting("foo", convert=int, env_var="AZURE_FOO")
assert ps() == 30
del os.environ["AZURE_FOO"]
def test_user_set(self):
ps = m.PrioritizedSetting("foo")
ps.set_value(40)
assert ps() == 40
def test_user_unset(self):
ps = m.PrioritizedSetting("foo", default=2)
ps.set_value(40)
assert ps() == 40
ps.unset_value()
assert ps() == 2
def test_user_set_converts(self):
ps = m.PrioritizedSetting("foo", convert=int)
ps.set_value("40")
assert ps() == 40
def test_immediate(self):
ps = m.PrioritizedSetting("foo")
assert ps(50) == 50
def test_immediate_converts(self):
ps = m.PrioritizedSetting("foo", convert=int)
assert ps("50") == 50
def test_precedence(self):
# 0. implicit default
ps = m.PrioritizedSetting("foo", env_var="AZURE_FOO", convert=int, default=10)
assert ps() == 10
# 1. system value
ps = m.PrioritizedSetting("foo", env_var="AZURE_FOO", convert=int, default=10, system_hook=lambda: 20)
assert ps() == 20
# 2. environment variable
os.environ["AZURE_FOO"] = "30"
assert ps() == 30
# 3. previously user-set value
ps.set_value(40)
assert ps() == 40
# 4. immediate values
assert ps(50) == 50
del os.environ["AZURE_FOO"]
def test___str__(self):
ps = m.PrioritizedSetting("foo")
assert str(ps) == "PrioritizedSetting(%r)" % "foo"
def test_descriptors(self):
class FakeSettings(object):
foo = m.PrioritizedSetting("foo", env_var="AZURE_FOO")
bar = m.PrioritizedSetting("bar", env_var="AZURE_BAR", default=10)
s = FakeSettings()
assert s.foo is FakeSettings.foo
assert s.bar() == 10
s.bar = 20
assert s.bar() == 20
class TestConverters(object):
@pytest.mark.parametrize("value", ["Yes", "YES", "yes", "1", "ON", "on", "true", "True", True])
def test_convert_bool(self, value):
assert m.convert_bool(value)
@pytest.mark.parametrize("value", ["No", "NO", "no", "0", "OFF", "off", "false", "False", False])
def test_convert_bool_false(self, value):
assert not m.convert_bool(value)
@pytest.mark.parametrize("value", [True, False])
def test_convert_bool_identity(self, value):
assert m.convert_bool(value) == value
def test_convert_bool_bad(self):
with pytest.raises(ValueError):
m.convert_bool("junk")
@pytest.mark.parametrize("value", ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"])
def test_convert_logging_good(self, value):
assert m.convert_logging(value) == getattr(logging, value)
# check lowercase works too
assert m.convert_logging(value.lower()) == getattr(logging, value)
@pytest.mark.parametrize("value", ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"])
def test_convert_logging_identity(self, value):
level = getattr(logging, value)
assert m.convert_logging(level) == level
def test_convert_logging_bad(self):
with pytest.raises(ValueError):
m.convert_logging("junk")
def test_convert_azure_cloud(self):
with pytest.raises(ValueError):
m.convert_azure_cloud(10)
_standard_settings = ["log_level", "tracing_enabled"]
class TestStandardSettings(object):
@pytest.mark.parametrize("name", _standard_settings)
def test_setting_exists(self, name):
assert hasattr(m.settings, name)
# XXX: This test will need to become more sophisticated if the assumption
# settings.foo -> AZURE_FOO for env vars ever becomes invalidated.
@pytest.mark.parametrize("name", _standard_settings)
def test_setting_env_var(self, name):
ps = getattr(m.settings, name)
assert ps.env_var == "AZURE_" + name.upper()
def test_init(self):
assert m.settings.defaults_only is False
def test_config(self):
val = m.settings.config(log_level=30, tracing_enabled=True)
assert isinstance(val, tuple)
assert val.tracing_enabled is True
assert val.log_level == 30
os.environ["AZURE_LOG_LEVEL"] = "debug"
val = m.settings.config(tracing_enabled=False)
assert val.tracing_enabled is False
assert val.log_level == 10
val = m.settings.config(log_level=30, tracing_enabled=False, tracing_implementation=None)
assert val.tracing_enabled is False
assert val.log_level == 30
assert val.tracing_implementation is None
del os.environ["AZURE_LOG_LEVEL"]
val = m.settings.config(azure_cloud=AzureClouds.AZURE_US_GOVERNMENT)
assert val.azure_cloud == AzureClouds.AZURE_US_GOVERNMENT
def test_defaults(self):
val: NamedTuple = m.settings.defaults
assert val.log_level == logging.INFO
assert val.tracing_enabled is None
assert val.tracing_implementation is None
assert val.azure_cloud == AzureClouds.AZURE_PUBLIC_CLOUD
def test_tracing_setting(self):
mock_tracing_impl = MagicMock()
assert m.settings.tracing_enabled() is False
assert m.settings.tracing_implementation() is None
m.settings.tracing_enabled = None
assert m.settings.tracing_enabled() is False
m.settings.tracing_implementation = mock_tracing_impl
assert m.settings.tracing_implementation() == mock_tracing_impl
assert m.settings.tracing_enabled() is True
m.settings.tracing_enabled = False
assert m.settings.tracing_enabled() is False
m.settings.tracing_implementation = None
def test_current(self):
os.environ["AZURE_LOG_LEVEL"] = "debug"
val = m.settings.current
assert isinstance(val, tuple)
assert val.log_level == 10
del os.environ["AZURE_LOG_LEVEL"]
os.environ["AZURE_CLOUD"] = "AZURE_CHINA_CLOUD"
val = m.settings.current
assert isinstance(val, tuple)
assert val.azure_cloud == AzureClouds.AZURE_CHINA_CLOUD
del os.environ["AZURE_CLOUD"]
|
