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
|
# Copyright (c) 2012-2016 Marc Abramowitz and ipdb development team
#
# This file is part of ipdb.
# Redistributable under the revised BSD license
# https://opensource.org/licenses/BSD-3-Clause
try:
import configparser
except:
import ConfigParser as configparser
import unittest
import os
import tempfile
import shutil
from ipdb.__main__ import (
get_config,
get_context_from_config,
)
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]
def write_lines_to_file(path, lines):
"""
Write `lines` to file at `path`.
:param path: Filesystem path to write.
:param lines: Sequence of text lines, without line endings.
:return: None.
"""
f = open(path, "w")
f.writelines([x + "\n" for x in lines])
f.close()
def set_config_files_fixture(testcase):
"""
Set a data fixture of configuration files for `testcase`.
"""
testcase.tmpd = tempfile.mkdtemp()
testcase.addCleanup(shutil.rmtree, testcase.tmpd)
# Set CWD to known empty directory so we don't pick up some other .ipdb
# file from the CWD tests are actually run from.
save_cwd = os.getcwd()
testcase.addCleanup(os.chdir, save_cwd)
cwd_dir = os.path.join(testcase.tmpd, "cwd")
os.mkdir(cwd_dir)
os.chdir(cwd_dir)
# This represents the $HOME config file, and doubles for the current
# working directory config file if we set CWD to testcase.tmpd
testcase.default_filename = os.path.join(testcase.tmpd, ".ipdb")
testcase.default_context = 10
write_lines_to_file(
testcase.default_filename,
[
"# this is a test config file for ipdb",
"context = {}".format(str(testcase.default_context)),
],
)
testcase.env_filename = os.path.join(testcase.tmpd, "ipdb.env")
testcase.env_context = 20
write_lines_to_file(
testcase.env_filename,
[
"# this is a test config file for ipdb",
"context = {}".format(str(testcase.env_context)),
],
)
testcase.setup_filename = os.path.join(cwd_dir, "setup.cfg")
testcase.setup_context = 25
write_lines_to_file(
testcase.setup_filename,
[
"[ipdb]",
"context = {}".format(str(testcase.setup_context)),
],
)
testcase.pyproject_filename = os.path.join(cwd_dir, "pyproject.toml")
testcase.pyproject_context = 30
write_lines_to_file(
testcase.pyproject_filename,
[
"[tool.ipdb]",
"context = {}".format(str(testcase.pyproject_context)),
],
)
class ConfigTest(unittest.TestCase):
"""
All variations of config file parsing works as expected.
"""
def setUp(self):
"""
Set fixtures for this test case.
"""
set_config_files_fixture(self)
def test_noenv_nodef_nosetup_pyproject(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb does not exist,
setup.cfg does not exist, pyproject.toml exists
Result: load pyproject.toml
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.pyproject_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_nodef_setup_pyproject(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb does not exist,
setup.cfg exists, pyproject.toml exists
Result: load $IPDB_CONFIG
"""
os.unlink(self.default_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_def_setup_pyproject(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb exists,
setup.cfg exists, pyproject.toml exists
Result: load $IPDB_CONFIG
"""
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_noenv_nodef_setup_pyproject(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb does not exist,
setup.cfg exists, pyproject.toml exists
Result: load pyproject.toml
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.pyproject_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_noenv_def_setup_pyproject(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb exists,
setup.cfg exists, pyproject.toml exists
Result: load .ipdb
"""
os.unlink(self.env_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.default_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_nodef_nosetup(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb does not exist,
setup.cfg does not exist, pyproject.toml does not exist
Result: load $IPDB_CONFIG
"""
os.unlink(self.default_filename)
os.unlink(self.pyproject_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename,
HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.getboolean, "ipdb", "version")
def test_noenv_def_nosetup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb exists,
setup.cfg does not exist, pyproject.toml does not exist
Result: load $HOME/.ipdb
"""
os.unlink(self.env_filename)
os.unlink(self.pyproject_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.default_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_noenv_nodef_nosetup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb does not
exist, setup.cfg does not exist, pyproject.toml does not exist
Result: load nothing
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
os.unlink(self.pyproject_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual([], cfg.sections())
def test_env_cwd(self):
"""
Setup: $IPDB_CONFIG is set, .ipdb in local dir,
setup.cfg does not exist, pyproject.toml does not exist
Result: load .ipdb
"""
os.chdir(self.tmpd) # setUp is already set to restore us to our pre-testing cwd
os.unlink(self.pyproject_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename,
HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_def_nosetup(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb exists,
setup.cfg does not exist, pyproject.toml does not exist
Result: load $IPDB_CONFIG
"""
os.unlink(self.pyproject_filename)
os.remove(self.setup_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename,
HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_noenv_def_setup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb exists,
setup.cfg exists, pyproject.toml does not exist
Result: load $HOME/.ipdb
"""
os.unlink(self.env_filename)
os.unlink(self.pyproject_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.default_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.getboolean, "ipdb", "version")
def test_noenv_nodef_setup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb does not exist,
setup.cfg exists, pyproject.toml does not exist
Result: load setup
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
os.unlink(self.pyproject_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.setup_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_def_setup(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb exists,
setup.cfg exists, pyproject.toml does not exist
Result: load $IPDB_CONFIG
"""
os.unlink(self.pyproject_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename,
HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
def test_env_nodef_setup(self):
"""
Setup: $IPDB_CONFIG is set, $HOME/.ipdb does not
exist, setup.cfg exists, pyproject.toml does not exist
Result: load $IPDB_CONFIG
"""
os.unlink(self.default_filename)
os.unlink(self.pyproject_filename)
with ModifiedEnvironment(IPDB_CONFIG=self.env_filename,
HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.env_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.getboolean, "ipdb", "version")
def test_noenv_def_setup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb exists,
setup.cfg exists, pyproject.toml does not exist
Result: load $HOME/.ipdb
"""
os.unlink(self.env_filename)
os.unlink(self.pyproject_filename)
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
cfg = get_config()
self.assertEqual(["ipdb"], cfg.sections())
self.assertEqual(self.default_context, cfg.getint("ipdb", "context"))
self.assertRaises(configparser.NoOptionError, cfg.get, "ipdb", "version")
class get_context_from_config_TestCase(unittest.TestCase):
"""
Test cases for function `get_context_from_config`.
"""
def setUp(self):
"""
Set fixtures for this test case.
"""
set_config_files_fixture(self)
def test_noenv_nodef_invalid_setup(self):
"""
Setup: $IPDB_CONFIG unset, $HOME/.ipdb does not exist,
setup.cfg does not exist, pyproject.toml content is invalid.
Result: Propagate exception from `get_config`.
"""
os.unlink(self.env_filename)
os.unlink(self.default_filename)
os.unlink(self.setup_filename)
write_lines_to_file(
self.pyproject_filename,
[
"[ipdb]",
"spam = abc",
],
)
try:
from tomllib import TOMLDecodeError
except ImportError:
try:
from tomli import TOMLDecodeError
except ImportError:
from toml.decoder import TomlDecodeError as TOMLDecodeError
with ModifiedEnvironment(IPDB_CONFIG=None, HOME=self.tmpd):
try:
get_context_from_config()
except TOMLDecodeError:
pass
else:
self.fail("Expected TomlDecodeError from invalid config file")
|
