-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_config.py
374 lines (309 loc) · 14.4 KB
/
test_config.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
try:
import configparser
except:
import ConfigParser as configparser
import copy
try:
from io import StringIO
except:
from StringIO import StringIO
import os
import shutil
import tempfile
import unittest
from green import config
from green.output import GreenStream
class ParseArguments(unittest.TestCase):
def test_target(self):
"""
The specified target gets parsed
"""
config.sys.argv = ['', 'target1', 'target2']
args = config.parseArguments()
self.assertEqual(args.targets, ['target1', 'target2'])
def test_absent(self):
"""
Arguments not specified on the command-line are not present in the args
object.
"""
config.sys.argv = ['', '--debug']
args = config.parseArguments()
self.assertEqual(getattr(args, 'debug', 'not there'), True)
self.assertEqual(getattr(args, 'verbose', 'not there'), 'not there')
self.assertEqual(getattr(args, 'targets', 'not there'), 'not there')
self.assertEqual(getattr(args, 'file_pattern', 'not there'), 'not there')
class ModifiedEnvironment(object):
"""
I am a context manager that sets up environment variables for a test case.
"""
def __init__(self, **kwargs):
self.prev = {}
self.excur = kwargs
for k in kwargs:
self.prev[k] = os.getenv(k)
def __enter__(self):
self.update_environment(self.excur)
def __exit__(self, type, value, traceback):
self.update_environment(self.prev)
def update_environment(self, d):
for k in d:
if d[k] is None:
if k in os.environ:
del os.environ[k]
else:
os.environ[k] = d[k]
class ConfigBase(unittest.TestCase):
"""
I am an abstract base class that creates and destroys configuration files
in a temporary directory with known values attached to self.
"""
def _write_file(self, path, lines):
f = open(path, 'w')
f.writelines([x + "\n" for x in lines])
f.close()
def setUp(self):
self.tmpd = tempfile.mkdtemp()
self.default_filename = os.path.join(self.tmpd, ".green")
self.default_logging = False
self.default_version = False
self.default_failfast = True
self.default_termcolor = True
self._write_file(self.default_filename,
["# this is a test config file for green",
"logging = {}".format(str(self.default_logging)),
"version = {}".format(str(self.default_version)),
"omit-patterns = {}".format(self.default_filename),
"failfast = {}".format(str(self.default_failfast)),
"termcolor = {}".format(str(self.default_termcolor)),
])
self.env_filename = os.path.join(self.tmpd, "green.env")
self.env_logging = True
self.env_no_skip_report = False
self._write_file(self.env_filename,
["# this is a test config file for green",
"logging = {}".format(str(self.env_logging)),
"omit-patterns = {}".format(self.env_filename),
"no-skip-report = {}".format(self.env_no_skip_report),
])
self.cmd_filename = os.path.join(self.tmpd, "green.cmd")
self.cmd_logging = False
self.cmd_run_coverage = False
self._write_file(self.cmd_filename,
["# this is a test config file for green",
"logging = {}".format(str(self.cmd_logging)),
"omit-patterns = {}".format(self.cmd_filename),
"run-coverage = {}".format(self.cmd_run_coverage),
])
def tearDown(self):
shutil.rmtree(self.tmpd)
class TestConfig(ConfigBase):
"""
All variations of config file parsing works as expected.
"""
def test_cmd_env_def(self):
"""
Setup: --config on cmd, $GREEN_CONFIG is set, $HOME/.green exists
Result: load --config
"""
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = config.getConfig(self.cmd_filename)
ae = self.assertEqual
ae(["green"], cfg.sections())
ae(self.cmd_filename, cfg.get("green", "omit-patterns"))
ae(self.cmd_run_coverage, cfg.getboolean("green", "run-coverage"))
ae(self.cmd_logging, cfg.getboolean("green", "logging"))
ae(self.env_no_skip_report, cfg.getboolean("green", "no-skip-report"))
ae(self.default_version, cfg.getboolean("green", "version"))
def test_cmd_env_nodef(self):
"""
Setup: --config on cmd, $GREEN_CONFIG is set, $HOME/.green does not
exist
Result: load --config
"""
os.unlink(self.default_filename)
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = config.getConfig(self.cmd_filename)
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.cmd_filename, cfg.get("green", "omit-patterns"))
ae(self.cmd_run_coverage, cfg.getboolean("green", "run-coverage"))
ae(self.cmd_logging, cfg.getboolean("green", "logging"))
ae(self.env_no_skip_report, cfg.getboolean("green", "no-skip-report"))
ar(configparser.NoOptionError, cfg.getboolean, "green", "version")
def test_cmd_noenv_def(self):
"""
Setup: --config on cmd, $GREEN_CONFIG unset, $HOME/.green exists
Result: load --config
"""
os.unlink(self.env_filename)
with ModifiedEnvironment(GREEN_CONFIG=None, HOME=self.tmpd):
cfg = config.getConfig(self.cmd_filename)
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.cmd_filename, cfg.get("green", "omit-patterns"))
ae(self.cmd_run_coverage, cfg.getboolean("green", "run-coverage"))
ae(self.cmd_logging, cfg.getboolean("green", "logging"))
ar(configparser.NoOptionError, cfg.getboolean, "green", "no-skip-report")
ae(self.default_version, cfg.getboolean("green", "version"))
def test_cmd_noenv_nodef(self):
"""
Setup: --config on cmd, $GREEN_CONFIG unset, $HOME/.green does not exist
Result: load --config
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
with ModifiedEnvironment(GREEN_CONFIG=None, HOME=self.tmpd):
cfg = config.getConfig(self.cmd_filename)
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.cmd_filename, cfg.get("green", "omit-patterns"))
ae(self.cmd_run_coverage, cfg.getboolean("green", "run-coverage"))
ae(self.cmd_logging, cfg.getboolean("green", "logging"))
ar(configparser.NoOptionError, cfg.getboolean, "green", "no-skip-report")
ar(configparser.NoOptionError, cfg.getboolean, "green", "version")
def test_nocmd_env_def(self):
"""
Setup: no --config option, $GREEN_CONFIG is set, $HOME/.green exists
Result: load $GREEN_CONFIG
"""
os.unlink(self.cmd_filename)
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = config.getConfig()
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.env_filename, cfg.get("green", "omit-patterns"))
ar(configparser.NoOptionError, cfg.get, "green", "run-coverage")
ae(self.env_logging, cfg.getboolean("green", "logging"))
ae(self.env_no_skip_report, cfg.getboolean("green", "no-skip-report"))
ae(self.default_version, cfg.getboolean("green", "version"))
def test_nocmd_env_nodef(self):
"""
Setup: no --config option, $GREEN_CONFIG is set, $HOME/.green does not
exist
Result: load $GREEN_CONFIG
"""
os.unlink(self.cmd_filename)
os.unlink(self.default_filename)
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = config.getConfig()
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.env_filename, cfg.get("green", "omit-patterns"))
ar(configparser.NoOptionError, cfg.get, "green", "run-coverage")
ae(self.env_logging, cfg.getboolean("green", "logging"))
ae(self.env_no_skip_report, cfg.getboolean("green", "no-skip-report"))
ar(configparser.NoOptionError, cfg.getboolean, "green", "version")
def test_nocmd_noenv_def(self):
"""
Setup: no --config option, $GREEN_CONFIG unset, $HOME/.green exists
Result: load $HOME/.green
"""
os.unlink(self.cmd_filename)
os.unlink(self.env_filename)
with ModifiedEnvironment(GREEN_CONFIG=None, HOME=self.tmpd):
cfg = config.getConfig()
ae = self.assertEqual
ar = self.assertRaises
ae(["green"], cfg.sections())
ae(self.default_filename, cfg.get("green", "omit-patterns"))
ar(configparser.NoOptionError, cfg.get, "green", "run-coverage")
ae(self.default_logging, cfg.getboolean("green", "logging"))
ar(configparser.NoOptionError, cfg.getboolean, "green", "no-skip-report")
ae(self.default_version, cfg.getboolean("green", "version"))
def test_nocmd_noenv_nodef(self):
"""
Setup: no --config option, $GREEN_CONFIG unset, no $HOME/.green
Result: empty config
"""
os.unlink(self.default_filename)
os.unlink(self.env_filename)
os.unlink(self.cmd_filename)
with ModifiedEnvironment(GREEN_CONFIG=None, HOME=self.tmpd):
cfg = config.getConfig()
ae = self.assertEqual
ar = self.assertRaises
ae([], cfg.sections())
ar(configparser.NoSectionError, cfg.get, "green", "omit-patterns")
ar(configparser.NoSectionError, cfg.get, "green", "run-coverage")
ar(configparser.NoSectionError, cfg.get, "green", "logging")
ar(configparser.NoSectionError, cfg.get, "green", "no-skip-report")
ar(configparser.NoSectionError, cfg.get, "green", "version")
class TestMergeConfig(ConfigBase):
"""
Merging config files and command-line arguments works as expected.
"""
def test_overwrite(self):
"""
Non-default command-line argument values overwrite config values.
"""
# This config environment should set the values we look at to False and
# a filename in omit-patterns
s = StringIO()
gs = GreenStream(s)
saved_stdout = config.sys.stdout
config.sys.stdout = gs
self.addCleanup(setattr, config.sys, 'stdout', saved_stdout)
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=self.tmpd):
new_args = copy.deepcopy(config.default_args)
new_args.omit_patterns = 'omitstuff'
new_args.run_coverage = True
new_args.logging = True
new_args.no_skip_report = True
new_args.version = True
new_args.config = self.cmd_filename
computed_args = config.mergeConfig(new_args, testing=True)
self.assertEqual(computed_args.omit_patterns, 'omitstuff')
self.assertEqual(computed_args.run_coverage, new_args.run_coverage)
self.assertEqual(computed_args.logging, new_args.logging)
self.assertEqual(computed_args.no_skip_report, new_args.no_skip_report)
self.assertEqual(computed_args.version, new_args.version)
def test_no_overwrite(self):
"""
Default unspecified command-line args do not overwrite config values.
"""
# This config environment should set logging to True
with ModifiedEnvironment(GREEN_CONFIG=self.env_filename, HOME=""):
# The default for logging in arguments is False
da = copy.deepcopy(config.default_args)
del(da.logging)
computed_args = config.mergeConfig(da, testing=True)
self.assertEqual(computed_args.logging, True)
def test_specified_command_line(self):
"""
Specified command-line arguments always overwrite config file values
"""
with ModifiedEnvironment(HOME=self.tmpd):
new_args = copy.deepcopy(config.default_args)
new_args.failfast = True # same as config, for sanity
new_args.logging = True # different than config, not default
del(new_args.version) # Not in arguments, should get config value
new_args.termcolor = False # override config, set back to default
computed_args = config.mergeConfig(new_args, testing=True)
self.assertEqual(computed_args.failfast, True)
self.assertEqual(computed_args.logging, True)
self.assertEqual(computed_args.version, False)
self.assertEqual(computed_args.termcolor, False)
def test_targets(self):
"""
The targets passed in make it through mergeConfig, and the specified
target gets parsed
"""
config.sys.argv = ['', 'target1', 'target2']
args = config.parseArguments()
args = config.mergeConfig(args)
self.assertEqual(args.targets, ['target1', 'target2'])
def test_forgotToUpdateMerge(self):
"""
mergeConfig raises an exception for unknown cmdline args
"""
orig_args = copy.deepcopy(config.default_args)
self.addCleanup(setattr, config, 'default_args', orig_args)
config.default_args.new_option = True
new_args = copy.deepcopy(config.default_args)
self.assertRaises(NotImplementedError, config.mergeConfig, new_args,
testing=True)