-
Notifications
You must be signed in to change notification settings - Fork 13.7k
/
test_configuration.py
1380 lines (1219 loc) · 55.4 KB
/
test_configuration.py
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import copy
import datetime
import io
import os
import re
import tempfile
import textwrap
import unittest
import warnings
from collections import OrderedDict
from unittest import mock
import pytest
from airflow import configuration
from airflow.configuration import (
AirflowConfigException,
AirflowConfigParser,
_custom_secrets_backend,
conf,
expand_env_var,
get_airflow_config,
get_airflow_home,
parameterized_config,
run_command,
)
from tests.test_utils.config import conf_vars
from tests.test_utils.reset_warning_registry import reset_warning_registry
from tests.utils.test_config import (
remove_all_configurations,
set_deprecated_options,
set_sensitive_config_values,
use_config,
)
HOME_DIR = os.path.expanduser('~')
@unittest.mock.patch.dict(
'os.environ',
{
'AIRFLOW__TESTSECTION__TESTKEY': 'testvalue',
'AIRFLOW__TESTSECTION__TESTPERCENT': 'with%percent',
'AIRFLOW__TESTCMDENV__ITSACOMMAND_CMD': 'echo -n "OK"',
'AIRFLOW__TESTCMDENV__NOTACOMMAND_CMD': 'echo -n "NOT OK"',
},
)
class TestConf:
def test_airflow_home_default(self):
with unittest.mock.patch.dict('os.environ'):
if 'AIRFLOW_HOME' in os.environ:
del os.environ['AIRFLOW_HOME']
assert get_airflow_home() == expand_env_var('~/airflow')
def test_airflow_home_override(self):
with unittest.mock.patch.dict('os.environ', AIRFLOW_HOME='/path/to/airflow'):
assert get_airflow_home() == '/path/to/airflow'
def test_airflow_config_default(self):
with unittest.mock.patch.dict('os.environ'):
if 'AIRFLOW_CONFIG' in os.environ:
del os.environ['AIRFLOW_CONFIG']
assert get_airflow_config('/home/airflow') == expand_env_var('/home/airflow/airflow.cfg')
def test_airflow_config_override(self):
with unittest.mock.patch.dict('os.environ', AIRFLOW_CONFIG='/path/to/airflow/airflow.cfg'):
assert get_airflow_config('/home//airflow') == '/path/to/airflow/airflow.cfg'
@conf_vars({("core", "percent"): "with%%inside"})
def test_case_sensitivity(self):
# section and key are case insensitive for get method
# note: this is not the case for as_dict method
assert conf.get("core", "percent") == "with%inside"
assert conf.get("core", "PERCENT") == "with%inside"
assert conf.get("CORE", "PERCENT") == "with%inside"
def test_config_as_dict(self):
"""Test that getting config as dict works even if
environment has non-legal env vars"""
with unittest.mock.patch.dict('os.environ'):
os.environ['AIRFLOW__VAR__broken'] = "not_ok"
asdict = conf.as_dict(raw=True, display_sensitive=True)
assert asdict.get('VAR') is None
assert asdict['testsection']['testkey'] == 'testvalue'
def test_env_var_config(self):
opt = conf.get('testsection', 'testkey')
assert opt == 'testvalue'
opt = conf.get('testsection', 'testpercent')
assert opt == 'with%percent'
assert conf.has_option('testsection', 'testkey')
with unittest.mock.patch.dict(
'os.environ', AIRFLOW__KUBERNETES_ENVIRONMENT_VARIABLES__AIRFLOW__TESTSECTION__TESTKEY='nested'
):
opt = conf.get('kubernetes_environment_variables', 'AIRFLOW__TESTSECTION__TESTKEY')
assert opt == 'nested'
@mock.patch.dict(
'os.environ', AIRFLOW__KUBERNETES_ENVIRONMENT_VARIABLES__AIRFLOW__TESTSECTION__TESTKEY='nested'
)
@conf_vars({("core", "percent"): "with%%inside"})
def test_conf_as_dict(self):
cfg_dict = conf.as_dict()
# test that configs are picked up
assert cfg_dict['core']['unit_test_mode'] == 'True'
assert cfg_dict['core']['percent'] == 'with%inside'
# test env vars
assert cfg_dict['testsection']['testkey'] == '< hidden >'
assert cfg_dict['kubernetes_environment_variables']['AIRFLOW__TESTSECTION__TESTKEY'] == '< hidden >'
def test_conf_as_dict_source(self):
# test display_source
cfg_dict = conf.as_dict(display_source=True)
assert cfg_dict['core']['load_examples'][1] == 'airflow.cfg'
assert cfg_dict['database']['load_default_connections'][1] == 'airflow.cfg'
assert cfg_dict['testsection']['testkey'] == ('< hidden >', 'env var')
def test_conf_as_dict_sensitive(self):
# test display_sensitive
cfg_dict = conf.as_dict(display_sensitive=True)
assert cfg_dict['testsection']['testkey'] == 'testvalue'
assert cfg_dict['testsection']['testpercent'] == 'with%percent'
# test display_source and display_sensitive
cfg_dict = conf.as_dict(display_sensitive=True, display_source=True)
assert cfg_dict['testsection']['testkey'] == ('testvalue', 'env var')
@conf_vars({("core", "percent"): "with%%inside"})
def test_conf_as_dict_raw(self):
# test display_sensitive
cfg_dict = conf.as_dict(raw=True, display_sensitive=True)
assert cfg_dict['testsection']['testkey'] == 'testvalue'
# Values with '%' in them should be escaped
assert cfg_dict['testsection']['testpercent'] == 'with%%percent'
assert cfg_dict['core']['percent'] == 'with%%inside'
def test_conf_as_dict_exclude_env(self):
# test display_sensitive
cfg_dict = conf.as_dict(include_env=False, display_sensitive=True)
# Since testsection is only created from env vars, it shouldn't be
# present at all if we don't ask for env vars to be included.
assert 'testsection' not in cfg_dict
def test_command_precedence(self):
test_config = '''[test]
key1 = hello
key2_cmd = printf cmd_result
key3 = airflow
key4_cmd = printf key4_result
'''
test_config_default = '''[test]
key1 = awesome
key2 = airflow
[another]
key6 = value6
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
test_conf.sensitive_config_values = test_conf.sensitive_config_values | {
('test', 'key2'),
('test', 'key4'),
}
assert 'hello' == test_conf.get('test', 'key1')
assert 'cmd_result' == test_conf.get('test', 'key2')
assert 'airflow' == test_conf.get('test', 'key3')
assert 'key4_result' == test_conf.get('test', 'key4')
assert 'value6' == test_conf.get('another', 'key6')
assert 'hello' == test_conf.get('test', 'key1', fallback='fb')
assert 'value6' == test_conf.get('another', 'key6', fallback='fb')
assert 'fb' == test_conf.get('another', 'key7', fallback='fb')
assert test_conf.getboolean('another', 'key8_boolean', fallback='True') is True
assert 10 == test_conf.getint('another', 'key8_int', fallback='10')
assert 1.0 == test_conf.getfloat('another', 'key8_float', fallback='1')
assert test_conf.has_option('test', 'key1')
assert test_conf.has_option('test', 'key2')
assert test_conf.has_option('test', 'key3')
assert test_conf.has_option('test', 'key4')
assert not test_conf.has_option('test', 'key5')
assert test_conf.has_option('another', 'key6')
cfg_dict = test_conf.as_dict(display_sensitive=True)
assert 'cmd_result' == cfg_dict['test']['key2']
assert 'key2_cmd' not in cfg_dict['test']
# If we exclude _cmds then we should still see the commands to run, not
# their values
cfg_dict = test_conf.as_dict(include_cmds=False, display_sensitive=True)
assert 'key4' not in cfg_dict['test']
assert 'printf key4_result' == cfg_dict['test']['key4_cmd']
@mock.patch("airflow.providers.hashicorp._internal_client.vault_client.hvac")
@conf_vars(
{
("secrets", "backend"): "airflow.providers.hashicorp.secrets.vault.VaultBackend",
("secrets", "backend_kwargs"): '{"url": "http://127.0.0.1:8200", "token": "token"}',
}
)
def test_config_from_secret_backend(self, mock_hvac):
"""Get Config Value from a Secret Backend"""
mock_client = mock.MagicMock()
mock_hvac.Client.return_value = mock_client
mock_client.secrets.kv.v2.read_secret_version.return_value = {
'request_id': '2d48a2ad-6bcb-e5b6-429d-da35fdf31f56',
'lease_id': '',
'renewable': False,
'lease_duration': 0,
'data': {
'data': {'value': 'sqlite:////Users/airflow/airflow/airflow.db'},
'metadata': {
'created_time': '2020-03-28T02:10:54.301784Z',
'deletion_time': '',
'destroyed': False,
'version': 1,
},
},
'wrap_info': None,
'warnings': None,
'auth': None,
}
test_config = '''[test]
sql_alchemy_conn_secret = sql_alchemy_conn
'''
test_config_default = '''[test]
sql_alchemy_conn = airflow
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
test_conf.sensitive_config_values = test_conf.sensitive_config_values | {
('test', 'sql_alchemy_conn'),
}
assert 'sqlite:////Users/airflow/airflow/airflow.db' == test_conf.get('test', 'sql_alchemy_conn')
def test_hidding_of_sensitive_config_values(self):
test_config = '''[test]
sql_alchemy_conn_secret = sql_alchemy_conn
'''
test_config_default = '''[test]
sql_alchemy_conn = airflow
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
test_conf.sensitive_config_values = test_conf.sensitive_config_values | {
('test', 'sql_alchemy_conn'),
}
assert 'airflow' == test_conf.get('test', 'sql_alchemy_conn')
# Hide sensitive fields
asdict = test_conf.as_dict(display_sensitive=False)
assert '< hidden >' == asdict['test']['sql_alchemy_conn']
# If display_sensitive is false, then include_cmd, include_env,include_secrets must all be True
# This ensures that cmd and secrets env are hidden at the appropriate method and no surprises
with pytest.raises(ValueError):
test_conf.as_dict(display_sensitive=False, include_cmds=False)
# Test that one of include_cmds, include_env, include_secret can be false when display_sensitive
# is True
assert test_conf.as_dict(display_sensitive=True, include_cmds=False)
@mock.patch("airflow.providers.hashicorp._internal_client.vault_client.hvac")
@conf_vars(
{
("secrets", "backend"): "airflow.providers.hashicorp.secrets.vault.VaultBackend",
("secrets", "backend_kwargs"): '{"url": "http://127.0.0.1:8200", "token": "token"}',
}
)
def test_config_raise_exception_from_secret_backend_connection_error(self, mock_hvac):
"""Get Config Value from a Secret Backend"""
_custom_secrets_backend.cache_clear()
mock_client = mock.MagicMock()
# mock_client.side_effect = AirflowConfigException
mock_hvac.Client.return_value = mock_client
mock_client.secrets.kv.v2.read_secret_version.return_value = Exception
test_config = '''[test]
sql_alchemy_conn_secret = sql_alchemy_conn
'''
test_config_default = '''[test]
sql_alchemy_conn = airflow
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
test_conf.sensitive_config_values = test_conf.sensitive_config_values | {
('test', 'sql_alchemy_conn'),
}
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Cannot retrieve config from alternative secrets backend. '
'Make sure it is configured properly and that the Backend '
'is accessible.'
),
):
test_conf.get('test', 'sql_alchemy_conn')
_custom_secrets_backend.cache_clear()
def test_getboolean(self):
"""Test AirflowConfigParser.getboolean"""
test_config = """
[type_validation]
key1 = non_bool_value
[true]
key2 = t
key3 = true
key4 = 1
[false]
key5 = f
key6 = false
key7 = 0
[inline-comment]
key8 = true #123
"""
test_conf = AirflowConfigParser(default_config=test_config)
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to bool. Please check "key1" key in "type_validation" section. '
'Current value: "non_bool_value".'
),
):
test_conf.getboolean('type_validation', 'key1')
assert isinstance(test_conf.getboolean('true', 'key3'), bool)
assert test_conf.getboolean('true', 'key2') is True
assert test_conf.getboolean('true', 'key3') is True
assert test_conf.getboolean('true', 'key4') is True
assert test_conf.getboolean('false', 'key5') is False
assert test_conf.getboolean('false', 'key6') is False
assert test_conf.getboolean('false', 'key7') is False
assert test_conf.getboolean('inline-comment', 'key8') is True
def test_getint(self):
"""Test AirflowConfigParser.getint"""
test_config = """
[invalid]
key1 = str
[valid]
key2 = 1
"""
test_conf = AirflowConfigParser(default_config=test_config)
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to int. Please check "key1" key in "invalid" section. '
'Current value: "str".'
),
):
test_conf.getint('invalid', 'key1')
assert isinstance(test_conf.getint('valid', 'key2'), int)
assert 1 == test_conf.getint('valid', 'key2')
def test_getfloat(self):
"""Test AirflowConfigParser.getfloat"""
test_config = """
[invalid]
key1 = str
[valid]
key2 = 1.23
"""
test_conf = AirflowConfigParser(default_config=test_config)
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to float. Please check "key1" key in "invalid" section. '
'Current value: "str".'
),
):
test_conf.getfloat('invalid', 'key1')
assert isinstance(test_conf.getfloat('valid', 'key2'), float)
assert 1.23 == test_conf.getfloat('valid', 'key2')
@pytest.mark.parametrize(
("config_str", "expected"),
[
pytest.param('{"a": 123}', {'a': 123}, id='dict'),
pytest.param('[1,2,3]', [1, 2, 3], id='list'),
pytest.param('"abc"', 'abc', id='str'),
pytest.param('2.1', 2.1, id='num'),
pytest.param('', None, id='empty'),
],
)
def test_getjson(self, config_str, expected):
config = textwrap.dedent(
f"""
[test]
json = {config_str}
"""
)
test_conf = AirflowConfigParser()
test_conf.read_string(config)
assert test_conf.getjson('test', 'json') == expected
def test_getjson_empty_with_fallback(self):
config = textwrap.dedent(
"""
[test]
json =
"""
)
test_conf = AirflowConfigParser()
test_conf.read_string(config)
assert test_conf.getjson('test', 'json', fallback={}) == {}
assert test_conf.getjson('test', 'json') is None
@pytest.mark.parametrize(
("fallback"),
[
pytest.param({"a": "b"}, id='dict'),
# fallback is _NOT_ json parsed, but used verbatim
pytest.param('{"a": "b"}', id='str'),
pytest.param(None, id='None'),
],
)
def test_getjson_fallback(self, fallback):
test_conf = AirflowConfigParser()
assert test_conf.getjson('test', 'json', fallback=fallback) == fallback
def test_has_option(self):
test_config = '''[test]
key1 = value1
'''
test_conf = AirflowConfigParser()
test_conf.read_string(test_config)
assert test_conf.has_option('test', 'key1')
assert not test_conf.has_option('test', 'key_not_exists')
assert not test_conf.has_option('section_not_exists', 'key1')
def test_remove_option(self):
test_config = '''[test]
key1 = hello
key2 = airflow
'''
test_config_default = '''[test]
key1 = awesome
key2 = airflow
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
assert 'hello' == test_conf.get('test', 'key1')
test_conf.remove_option('test', 'key1', remove_default=False)
assert 'awesome' == test_conf.get('test', 'key1')
test_conf.remove_option('test', 'key2')
assert not test_conf.has_option('test', 'key2')
def test_getsection(self):
test_config = '''
[test]
key1 = hello
[new_section]
key = value
'''
test_config_default = '''
[test]
key1 = awesome
key2 = airflow
[testsection]
key3 = value3
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
assert OrderedDict([('key1', 'hello'), ('key2', 'airflow')]) == test_conf.getsection('test')
assert OrderedDict(
[('key3', 'value3'), ('testkey', 'testvalue'), ('testpercent', 'with%percent')]
) == test_conf.getsection('testsection')
assert OrderedDict([('key', 'value')]) == test_conf.getsection('new_section')
assert test_conf.getsection('non_existent_section') is None
def test_get_section_should_respect_cmd_env_variable(self):
with tempfile.NamedTemporaryFile(delete=False) as cmd_file:
cmd_file.write(b"#!/usr/bin/env bash\n")
cmd_file.write(b"echo -n difficult_unpredictable_cat_password\n")
cmd_file.flush()
os.chmod(cmd_file.name, 0o0555)
cmd_file.close()
with mock.patch.dict("os.environ", {"AIRFLOW__WEBSERVER__SECRET_KEY_CMD": cmd_file.name}):
content = conf.getsection("webserver")
os.unlink(cmd_file.name)
assert content["secret_key"] == "difficult_unpredictable_cat_password"
def test_kubernetes_environment_variables_section(self):
test_config = '''
[kubernetes_environment_variables]
key1 = hello
AIRFLOW_HOME = /root/airflow
'''
test_config_default = '''
[kubernetes_environment_variables]
'''
test_conf = AirflowConfigParser(default_config=parameterized_config(test_config_default))
test_conf.read_string(test_config)
assert OrderedDict([('key1', 'hello'), ('AIRFLOW_HOME', '/root/airflow')]) == test_conf.getsection(
'kubernetes_environment_variables'
)
def test_broker_transport_options(self):
section_dict = conf.getsection("celery_broker_transport_options")
assert isinstance(section_dict['visibility_timeout'], int)
assert isinstance(section_dict['_test_only_bool'], bool)
assert isinstance(section_dict['_test_only_float'], float)
assert isinstance(section_dict['_test_only_string'], str)
def test_auth_backends_adds_session(self):
test_conf = AirflowConfigParser(default_config='')
# Guarantee we have deprecated settings, so we test the deprecation
# lookup even if we remove this explicit fallback
test_conf.deprecated_values = {
'api': {
'auth_backends': (
re.compile(r'^airflow\.api\.auth\.backend\.deny_all$|^$'),
'airflow.api.auth.backend.session',
'3.0',
),
},
}
test_conf.read_dict({'api': {'auth_backends': 'airflow.api.auth.backend.basic_auth'}})
with pytest.warns(FutureWarning):
test_conf.validate()
assert (
test_conf.get('api', 'auth_backends')
== 'airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session'
)
def test_command_from_env(self):
test_cmdenv_config = '''[testcmdenv]
itsacommand = NOT OK
notacommand = OK
'''
test_cmdenv_conf = AirflowConfigParser()
test_cmdenv_conf.read_string(test_cmdenv_config)
test_cmdenv_conf.sensitive_config_values.add(('testcmdenv', 'itsacommand'))
with unittest.mock.patch.dict('os.environ'):
# AIRFLOW__TESTCMDENV__ITSACOMMAND_CMD maps to ('testcmdenv', 'itsacommand') in
# sensitive_config_values and therefore should return 'OK' from the environment variable's
# echo command, and must not return 'NOT OK' from the configuration
assert test_cmdenv_conf.get('testcmdenv', 'itsacommand') == 'OK'
# AIRFLOW__TESTCMDENV__NOTACOMMAND_CMD maps to no entry in sensitive_config_values and therefore
# the option should return 'OK' from the configuration, and must not return 'NOT OK' from
# the environment variable's echo command
assert test_cmdenv_conf.get('testcmdenv', 'notacommand') == 'OK'
@pytest.mark.parametrize('display_sensitive, result', [(True, 'OK'), (False, '< hidden >')])
def test_as_dict_display_sensitivewith_command_from_env(self, display_sensitive, result):
test_cmdenv_conf = AirflowConfigParser()
test_cmdenv_conf.sensitive_config_values.add(('testcmdenv', 'itsacommand'))
with unittest.mock.patch.dict('os.environ'):
asdict = test_cmdenv_conf.as_dict(True, display_sensitive)
assert asdict['testcmdenv']['itsacommand'] == (result, 'cmd')
def test_parameterized_config_gen(self):
config = textwrap.dedent(
"""
[core]
dags_folder = {AIRFLOW_HOME}/dags
sql_alchemy_conn = sqlite:///{AIRFLOW_HOME}/airflow.db
parallelism = 32
fernet_key = {FERNET_KEY}
"""
)
cfg = parameterized_config(config)
# making sure some basic building blocks are present:
assert "[core]" in cfg
assert "dags_folder" in cfg
assert "sql_alchemy_conn" in cfg
assert "fernet_key" in cfg
# making sure replacement actually happened
assert "{AIRFLOW_HOME}" not in cfg
assert "{FERNET_KEY}" not in cfg
def test_config_use_original_when_original_and_fallback_are_present(self):
assert conf.has_option("core", "FERNET_KEY")
assert not conf.has_option("core", "FERNET_KEY_CMD")
fernet_key = conf.get('core', 'FERNET_KEY')
with conf_vars({('core', 'FERNET_KEY_CMD'): 'printf HELLO'}):
fallback_fernet_key = conf.get("core", "FERNET_KEY")
assert fernet_key == fallback_fernet_key
def test_config_throw_error_when_original_and_fallback_is_absent(self):
assert conf.has_option("core", "FERNET_KEY")
assert not conf.has_option("core", "FERNET_KEY_CMD")
with conf_vars({('core', 'fernet_key'): None}):
with pytest.raises(AirflowConfigException) as ctx:
conf.get("core", "FERNET_KEY")
exception = str(ctx.value)
message = "section/key [core/fernet_key] not found in config"
assert message == exception
def test_config_override_original_when_non_empty_envvar_is_provided(self):
key = "AIRFLOW__CORE__FERNET_KEY"
value = "some value"
with mock.patch.dict('os.environ', {key: value}):
fernet_key = conf.get('core', 'FERNET_KEY')
assert value == fernet_key
def test_config_override_original_when_empty_envvar_is_provided(self):
key = "AIRFLOW__CORE__FERNET_KEY"
value = "some value"
with mock.patch.dict('os.environ', {key: value}):
fernet_key = conf.get('core', 'FERNET_KEY')
assert value == fernet_key
@mock.patch.dict("os.environ", {"AIRFLOW__CORE__DAGS_FOLDER": "/tmp/test_folder"})
def test_write_should_respect_env_variable(self):
with io.StringIO() as string_file:
conf.write(string_file)
content = string_file.getvalue()
assert "dags_folder = /tmp/test_folder" in content
def test_run_command(self):
write = r'sys.stdout.buffer.write("\u1000foo".encode("utf8"))'
cmd = f'import sys; {write}; sys.stdout.flush()'
assert run_command(f"python -c '{cmd}'") == '\u1000foo'
assert run_command('echo "foo bar"') == 'foo bar\n'
with pytest.raises(AirflowConfigException):
run_command('bash -c "exit 1"')
def test_confirm_unittest_mod(self):
assert conf.get('core', 'unit_test_mode')
def test_enum_default_task_weight_rule_from_conf(self):
test_conf = AirflowConfigParser(default_config='')
test_conf.read_dict({'core': {'default_task_weight_rule': 'sidestream'}})
with pytest.raises(AirflowConfigException) as ctx:
test_conf.validate()
exception = str(ctx.value)
message = (
"`[core] default_task_weight_rule` should not be 'sidestream'. Possible values: "
"absolute, downstream, upstream."
)
assert message == exception
def test_enum_logging_levels(self):
test_conf = AirflowConfigParser(default_config='')
test_conf.read_dict({'logging': {'logging_level': 'XXX'}})
with pytest.raises(AirflowConfigException) as ctx:
test_conf.validate()
exception = str(ctx.value)
message = (
"`[logging] logging_level` should not be 'XXX'. Possible values: "
"CRITICAL, FATAL, ERROR, WARN, WARNING, INFO, DEBUG."
)
assert message == exception
def test_as_dict_works_without_sensitive_cmds(self):
conf_materialize_cmds = conf.as_dict(display_sensitive=True, raw=True, include_cmds=True)
conf_maintain_cmds = conf.as_dict(display_sensitive=True, raw=True, include_cmds=False)
assert 'sql_alchemy_conn' in conf_materialize_cmds['core']
assert 'sql_alchemy_conn_cmd' not in conf_materialize_cmds['core']
assert 'sql_alchemy_conn' in conf_maintain_cmds['core']
assert 'sql_alchemy_conn_cmd' not in conf_maintain_cmds['core']
assert (
conf_materialize_cmds['core']['sql_alchemy_conn']
== conf_maintain_cmds['core']['sql_alchemy_conn']
)
def test_as_dict_respects_sensitive_cmds(self):
conf_conn = conf['database']['sql_alchemy_conn']
test_conf = copy.deepcopy(conf)
test_conf.read_string(
textwrap.dedent(
"""
[database]
sql_alchemy_conn_cmd = echo -n my-super-secret-conn
"""
)
)
conf_materialize_cmds = test_conf.as_dict(display_sensitive=True, raw=True, include_cmds=True)
conf_maintain_cmds = test_conf.as_dict(display_sensitive=True, raw=True, include_cmds=False)
assert 'sql_alchemy_conn' in conf_materialize_cmds['database']
assert 'sql_alchemy_conn_cmd' not in conf_materialize_cmds['database']
if conf_conn == test_conf.airflow_defaults['database']['sql_alchemy_conn']:
assert conf_materialize_cmds['database']['sql_alchemy_conn'] == 'my-super-secret-conn'
assert 'sql_alchemy_conn_cmd' in conf_maintain_cmds['database']
assert conf_maintain_cmds['database']['sql_alchemy_conn_cmd'] == 'echo -n my-super-secret-conn'
if conf_conn == test_conf.airflow_defaults['database']['sql_alchemy_conn']:
assert 'sql_alchemy_conn' not in conf_maintain_cmds['database']
else:
assert 'sql_alchemy_conn' in conf_maintain_cmds['database']
assert conf_maintain_cmds['database']['sql_alchemy_conn'] == conf_conn
@mock.patch.dict(
'os.environ', {"AIRFLOW__DATABASE__SQL_ALCHEMY_CONN_CMD": "echo -n 'postgresql://'"}, clear=True
)
def test_as_dict_respects_sensitive_cmds_from_env(self):
test_conf = copy.deepcopy(conf)
test_conf.read_string("")
conf_materialize_cmds = test_conf.as_dict(display_sensitive=True, raw=True, include_cmds=True)
assert 'sql_alchemy_conn' in conf_materialize_cmds['database']
assert 'sql_alchemy_conn_cmd' not in conf_materialize_cmds['database']
assert conf_materialize_cmds['database']['sql_alchemy_conn'] == 'postgresql://'
def test_gettimedelta(self):
test_config = '''
[invalid]
# non-integer value
key1 = str
# fractional value
key2 = 300.99
# too large value for C int
key3 = 999999999999999
[valid]
# negative value
key4 = -1
# zero
key5 = 0
# positive value
key6 = 300
[default]
# Equals to None
key7 =
'''
test_conf = AirflowConfigParser(default_config=test_config)
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to int. Please check "key1" key in "invalid" section. '
'Current value: "str".'
),
):
test_conf.gettimedelta("invalid", "key1")
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to int. Please check "key2" key in "invalid" section. '
'Current value: "300.99".'
),
):
test_conf.gettimedelta("invalid", "key2")
with pytest.raises(
AirflowConfigException,
match=re.escape(
'Failed to convert value to timedelta in `seconds`. '
'Python int too large to convert to C int. '
'Please check "key3" key in "invalid" section. Current value: "999999999999999".'
),
):
test_conf.gettimedelta("invalid", "key3")
assert isinstance(test_conf.gettimedelta('valid', 'key4'), datetime.timedelta)
assert test_conf.gettimedelta('valid', 'key4') == datetime.timedelta(seconds=-1)
assert isinstance(test_conf.gettimedelta('valid', 'key5'), datetime.timedelta)
assert test_conf.gettimedelta('valid', 'key5') == datetime.timedelta(seconds=0)
assert isinstance(test_conf.gettimedelta('valid', 'key6'), datetime.timedelta)
assert test_conf.gettimedelta('valid', 'key6') == datetime.timedelta(seconds=300)
assert isinstance(test_conf.gettimedelta('default', 'key7'), type(None))
assert test_conf.gettimedelta('default', 'key7') is None
class TestDeprecatedConf:
@conf_vars(
{
("celery", "worker_concurrency"): None,
("celery", "celeryd_concurrency"): None,
}
)
def test_deprecated_options(self):
# Guarantee we have a deprecated setting, so we test the deprecation
# lookup even if we remove this explicit fallback
with set_deprecated_options(
deprecated_options={('celery', 'worker_concurrency'): ('celery', 'celeryd_concurrency', '2.0.0')}
):
# Remove it so we are sure we use the right setting
conf.remove_option('celery', 'worker_concurrency')
with pytest.warns(DeprecationWarning):
with mock.patch.dict('os.environ', AIRFLOW__CELERY__CELERYD_CONCURRENCY="99"):
assert conf.getint('celery', 'worker_concurrency') == 99
with pytest.warns(DeprecationWarning), conf_vars({('celery', 'celeryd_concurrency'): '99'}):
assert conf.getint('celery', 'worker_concurrency') == 99
@conf_vars(
{
('logging', 'logging_level'): None,
('core', 'logging_level'): None,
}
)
def test_deprecated_options_with_new_section(self):
# Guarantee we have a deprecated setting, so we test the deprecation
# lookup even if we remove this explicit fallback
with set_deprecated_options(
deprecated_options={('logging', 'logging_level'): ('core', 'logging_level', '2.0.0')}
):
# Remove it so we are sure we use the right setting
conf.remove_option('core', 'logging_level')
conf.remove_option('logging', 'logging_level')
with pytest.warns(DeprecationWarning):
with mock.patch.dict('os.environ', AIRFLOW__CORE__LOGGING_LEVEL="VALUE"):
assert conf.get('logging', 'logging_level') == "VALUE"
with pytest.warns(DeprecationWarning), conf_vars({('core', 'logging_level'): 'VALUE'}):
assert conf.get('logging', 'logging_level') == "VALUE"
@conf_vars(
{
("celery", "result_backend"): None,
("celery", "celery_result_backend"): None,
("celery", "celery_result_backend_cmd"): None,
}
)
def test_deprecated_options_cmd(self):
# Guarantee we have a deprecated setting, so we test the deprecation
# lookup even if we remove this explicit fallback
with set_deprecated_options(
deprecated_options={('celery', "result_backend"): ('celery', 'celery_result_backend', '2.0.0')}
), set_sensitive_config_values(sensitive_config_values={('celery', 'celery_result_backend')}):
conf.remove_option('celery', 'result_backend')
with conf_vars({('celery', 'celery_result_backend_cmd'): '/bin/echo 99'}):
with pytest.warns(DeprecationWarning):
tmp = None
if 'AIRFLOW__CELERY__RESULT_BACKEND' in os.environ:
tmp = os.environ.pop('AIRFLOW__CELERY__RESULT_BACKEND')
assert conf.getint('celery', 'result_backend') == 99
if tmp:
os.environ['AIRFLOW__CELERY__RESULT_BACKEND'] = tmp
def test_deprecated_values_from_conf(self):
test_conf = AirflowConfigParser(
default_config="""
[core]
executor=SequentialExecutor
[database]
sql_alchemy_conn=sqlite://test
"""
)
# Guarantee we have deprecated settings, so we test the deprecation
# lookup even if we remove this explicit fallback
test_conf.deprecated_values = {
'core': {'hostname_callable': (re.compile(r':'), r'.', '2.1')},
}
test_conf.read_dict({'core': {'hostname_callable': 'airflow.utils.net:getfqdn'}})
with pytest.warns(FutureWarning):
test_conf.validate()
assert test_conf.get('core', 'hostname_callable') == 'airflow.utils.net.getfqdn'
@pytest.mark.parametrize(
"old, new",
[
(
("api", "auth_backend", "airflow.api.auth.backend.basic_auth"),
(
"api",
"auth_backends",
"airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session",
),
),
(
("core", "sql_alchemy_conn", "postgres+psycopg2://localhost/postgres"),
("database", "sql_alchemy_conn", "postgresql://localhost/postgres"),
),
],
)
def test_deprecated_env_vars_upgraded_and_removed(self, old, new):
test_conf = AirflowConfigParser(
default_config="""
[core]
executor=SequentialExecutor
[database]
sql_alchemy_conn=sqlite://test
"""
)
old_section, old_key, old_value = old
new_section, new_key, new_value = new
old_env_var = test_conf._env_var_name(old_section, old_key)
new_env_var = test_conf._env_var_name(new_section, new_key)
with pytest.warns(FutureWarning):
with unittest.mock.patch.dict('os.environ', **{old_env_var: old_value}):
# Can't start with the new env var existing...
os.environ.pop(new_env_var, None)
test_conf.validate()
assert test_conf.get(new_section, new_key) == new_value
# We also need to make sure the deprecated env var is removed
# so that any subprocesses don't use it in place of our updated
# value.
assert old_env_var not in os.environ
# and make sure we track the old value as well, under the new section/key
assert test_conf.upgraded_values[(new_section, new_key)] == old_value
@pytest.mark.parametrize(
"conf_dict",
[
{}, # Even if the section is absent from config file, environ still needs replacing.
{'core': {'hostname_callable': 'airflow.utils.net.getfqdn'}},
],
)
def test_deprecated_values_from_environ(self, conf_dict):
def make_config():
test_conf = AirflowConfigParser(
default_config="""
[core]
executor=SequentialExecutor
[database]
sql_alchemy_conn=sqlite://test
"""
)
# Guarantee we have a deprecated setting, so we test the deprecation
# lookup even if we remove this explicit fallback
test_conf.deprecated_values = {
'core': {'hostname_callable': (re.compile(r':'), r'.', '2.1')},
}
test_conf.read_dict(conf_dict)
test_conf.validate()
return test_conf
with pytest.warns(FutureWarning):
with unittest.mock.patch.dict(
'os.environ', AIRFLOW__CORE__HOSTNAME_CALLABLE='airflow.utils.net:getfqdn'
):
test_conf = make_config()
assert test_conf.get('core', 'hostname_callable') == 'airflow.utils.net.getfqdn'
with reset_warning_registry():
with warnings.catch_warnings(record=True) as warning: