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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
from enum import Enum
from os import sep
import pytest
from pydantic import BaseModel
from pydantic_settings import (
BaseSettings,
NestedSecretsSettingsSource,
SecretsSettingsSource,
SettingsConfigDict,
SettingsError,
)
from pydantic_settings.sources.providers.nested_secrets import SECRETS_DIR_MAX_SIZE
class DbSettings(BaseModel):
user: str
passwd: str | None = None
class AppSettings(BaseSettings):
app_key: str | None = None
db: DbSettings
@classmethod
def settings_customise_sources(
cls,
settings_cls,
init_settings,
env_settings,
dotenv_settings,
file_secret_settings,
):
return (
init_settings,
env_settings,
NestedSecretsSettingsSource(file_secret_settings),
)
class SampleEnum(str, Enum):
TEST = 'test'
def test_repr(tmp_path):
class Settings(BaseSettings):
model_config = SettingsConfigDict(
secrets_dir=tmp_path,
)
src = NestedSecretsSettingsSource(SecretsSettingsSource(Settings))
assert f'{src!r}'.startswith(f'{src.__class__.__name__}(')
def test_source_off(env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(
{
'app_key': 'secret1',
'db__passwd': 'secret2',
}
)
class Settings(AppSettings):
model_config = SettingsConfigDict(
env_nested_delimiter='__',
)
assert Settings().model_dump() == {
'app_key': None,
'db': {'user': 'user', 'passwd': None},
}
def test_delimited_name(env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(
{
'app_key': 'secret1',
'db___passwd': 'secret2',
}
)
class Settings(AppSettings):
model_config = SettingsConfigDict(
env_nested_delimiter='__',
secrets_dir=tmp_files.basedir,
secrets_nested_delimiter='___',
)
assert Settings().model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
def test_secrets_dir_as_arg(env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(
{
'app_key': 'secret1',
'db__passwd': 'secret2',
}
)
class Settings(AppSettings):
model_config = SettingsConfigDict(
env_nested_delimiter='__',
secrets_nested_delimiter='__',
)
assert Settings(_secrets_dir=tmp_files.basedir).model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
@pytest.mark.parametrize(
'conf,secrets',
(
(
dict(secrets_nested_delimiter='___', secrets_prefix='prefix_'),
{'prefix_app_key': 'secret1', 'prefix_db___passwd': 'secret2'},
),
(
dict(secrets_nested_subdir=True, secrets_prefix='prefix_'),
{'prefix_app_key': 'secret1', 'prefix_db/passwd': 'secret2'},
),
(
dict(secrets_nested_subdir=True, secrets_prefix=f'dir1{sep}dir2{sep}'),
{'dir1/dir2/app_key': 'secret1', 'dir1/dir2/db/passwd': 'secret2'},
),
),
)
def test_prefix(conf: SettingsConfigDict, secrets, env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(secrets)
class Settings(AppSettings):
model_config = SettingsConfigDict(
env_nested_delimiter='__',
secrets_dir=tmp_files.basedir,
**conf,
)
assert Settings().model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
def test_subdir(env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(
{
'app_key': 'secret1',
'db/passwd': 'secret2', # file in subdir
}
)
class Settings(AppSettings):
model_config = SettingsConfigDict(
secrets_dir=tmp_files.basedir,
env_nested_delimiter='__',
secrets_nested_subdir=True,
)
assert Settings().model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
def test_symlink_subdir(env, tmp_files):
env.set('DB__USER', 'user')
# fmt: off
tmp_files.write({
'app_key': 'secret1',
'db_random/passwd': 'secret2', # file in subdir that is not directly referenced in our settings
})
tmp_files.basedir.joinpath('db').symlink_to(tmp_files.basedir.joinpath('db_random'))
# fmt: on
class Settings(AppSettings):
model_config = SettingsConfigDict(
secrets_dir=tmp_files.basedir,
env_nested_delimiter='__',
secrets_nested_subdir=True,
)
assert Settings().model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
@pytest.mark.parametrize(
'conf,secrets,dirs,expected',
(
(
# when multiple secrets_dir values are given, their values are merged
dict(),
{'dir1/key1': 'a', 'dir1/key2': 'b', 'dir2/key2': 'c'},
['dir1', 'dir2'],
{'key1': 'a', 'key2': 'c'},
),
(
# when secrets_dir is not a directory, error is raised
dict(),
{'some_file': ''},
'some_file',
(SettingsError, 'must reference a directory'),
),
(
# missing secrets_dir emits warning by default
dict(),
{'key1': 'value'},
'missing_subdir',
(UserWarning, 1, 'does not exist', {'key1': None, 'key2': None}),
),
(
# ...or expect warning explicitly (identical behaviour)
dict(secrets_dir_missing='warn'),
{'key1': 'value'},
'missing_subdir',
(UserWarning, 1, 'does not exist', {'key1': None, 'key2': None}),
),
(
# missing secrets_dir warning can be suppressed
dict(secrets_dir_missing='ok'),
{'key1': 'value'},
'missing_subdir',
{'key1': None, 'key2': None},
),
(
# missing secrets_dir can raise error
dict(secrets_dir_missing='error'),
{'key1': 'value'},
'missing_subdir',
(SettingsError, 'does not exist'),
),
(
# invalid secrets_dir_missing value raises error
dict(secrets_dir_missing='uNeXpEcTeD'),
{'key1': 'value'},
'missing_subdir',
(SettingsError, 'invalid secrets_dir_missing value'),
),
(
# when multiple secrets_dir do not exist, multiple warnings are emitted
dict(),
{'key1': 'value'},
['missing_subdir1', 'missing_subdir2'],
(UserWarning, 2, 'does not exist', {'key1': None, 'key2': None}),
),
(
# secrets_dir size is limited
dict(),
{'key1': 'x' * SECRETS_DIR_MAX_SIZE},
'.',
{'key1': 'x' * SECRETS_DIR_MAX_SIZE, 'key2': None},
),
(
# ...and raises error if file is larger than the limit
dict(),
{'key1': 'x' * (SECRETS_DIR_MAX_SIZE + 1)},
'.',
(SettingsError, 'secrets_dir size'),
),
(
# secrets_dir size limit can be adjusted
dict(secrets_dir_max_size=100),
{'key1': 'x' * 100},
'.',
{'key1': 'x' * 100, 'key2': None},
),
(
# ...and raises error if file is larger than the limit
dict(secrets_dir_max_size=100),
{'key1': 'x' * 101},
'.',
(SettingsError, 'secrets_dir size'),
),
(
# ...even if secrets_dir size exceeds limit because of another file
dict(secrets_dir_max_size=100),
{'another_file': 'x' * 101},
'.',
(SettingsError, 'secrets_dir size'),
),
(
# when multiple secrets_dir values are given, their sizes are not added
dict(secrets_dir_max_size=100),
{'dir1/key1': 'x' * 100, 'dir2/key2': 'y' * 100},
['dir1', 'dir2'],
{'key1': 'x' * 100, 'key2': 'y' * 100},
),
),
)
def test_multiple_secrets_dirs(conf: SettingsConfigDict, secrets, dirs, expected, tmp_files):
secrets_dirs = [tmp_files.basedir / d for d in dirs] if isinstance(dirs, list) else tmp_files.basedir / dirs
tmp_files.write(secrets)
class Settings(BaseSettings):
key1: str | None = None
key2: str | None = None
model_config = SettingsConfigDict(secrets_dir=secrets_dirs, **conf)
@classmethod
def settings_customise_sources(
cls,
settings_cls,
init_settings,
env_settings,
dotenv_settings,
file_secret_settings,
):
return (NestedSecretsSettingsSource(file_secret_settings),)
# clean execution
if isinstance(expected, dict):
assert Settings().model_dump() == expected
# error
elif isinstance(expected, tuple) and len(expected) == 2:
error_type, msg_fragment = expected
with pytest.raises(error_type, match=msg_fragment):
Settings()
# warnings
elif isinstance(expected, tuple) and len(expected) == 4:
warning_type, warning_count, msg_fragment, value = expected
with pytest.warns(warning_type) as warninfo:
settings = Settings()
assert len(warninfo) == warning_count
assert all(msg_fragment in str(w.message) for w in warninfo)
assert settings.model_dump() == value
# unexpected
else:
raise AssertionError('unreachable')
def test_strip_whitespace(env, tmp_files):
env.set('DB__USER', 'user')
tmp_files.write(
{
'app_key': ' secret1 ',
'db__passwd': '\tsecret2\n',
}
)
class Settings(AppSettings):
model_config = SettingsConfigDict(
env_nested_delimiter='__',
secrets_dir=tmp_files.basedir,
secrets_nested_delimiter='__',
)
assert Settings(_secrets_dir=tmp_files.basedir).model_dump() == {
'app_key': 'secret1',
'db': {'user': 'user', 'passwd': 'secret2'},
}
def test_invalid_options(tmp_path):
class Settings(AppSettings):
model_config = SettingsConfigDict(
secrets_dir=tmp_path,
env_nested_delimiter='__',
secrets_nested_subdir=True,
secrets_nested_delimiter='__',
)
with pytest.raises(SettingsError, match='mutually exclusive'):
Settings()
@pytest.mark.parametrize(
'conf,expected',
(
# default settings
({}, dict(field_empty='', field_none='null', field_enum=SampleEnum.TEST)),
# env_ignore_empty has no effect on secrets
({'env_ignore_empty': True}, dict(field_empty='')),
({'env_ignore_empty': False}, dict(field_empty='')),
# env_parse_none_str has no effect on secrets
({'env_parse_none_str': 'null'}, dict(field_none='null')),
# env_parse_enums has no effect on secrets
({'env_parse_enums': True}, dict(field_enum=SampleEnum.TEST)),
({'env_parse_enums': False}, dict(field_enum=SampleEnum.TEST)),
),
)
def test_env_ignore_empty(conf: SettingsConfigDict, expected, tmp_files):
tmp_files.write(
{
'field_empty': '',
'field_none': 'null',
'field_enum': 'test',
}
)
class Settings(BaseSettings):
field_empty: str | None = None
field_none: str | None = None
field_enum: SampleEnum | None = None
class Original(Settings):
model_config = SettingsConfigDict(secrets_dir=tmp_files.basedir, **conf)
class Evaluated(Settings):
model_config = SettingsConfigDict(secrets_dir=tmp_files.basedir, **conf)
@classmethod
def settings_customise_sources(
cls,
settings_cls,
init_settings,
env_settings,
dotenv_settings,
file_secret_settings,
):
return (NestedSecretsSettingsSource(file_secret_settings),)
original = Original()
evaluated = Evaluated()
assert original.model_dump() == evaluated.model_dump()
for k, v in expected.items():
assert getattr(original, k) == getattr(evaluated, k) == v
|
