/
test_foo.py
315 lines (276 loc) · 12.5 KB
/
test_foo.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
# -*- coding: utf-8 -*-
"""
test_foo
~~~~~~~~
:copyright: (c) 2013 by Rafael Goncalves Martins
:license: BSD, see LICENSE for more details.
"""
import codecs
import mock
import os
import shutil
import sys
import sysconfig
import tempfile
import unittest
from argparse import Namespace
import foo
from foo import BashModule, Runner, main, re_parse_args
class BaseTestCase(unittest.TestCase):
def setUp(self):
self._log = mock.patch('foo.log')
self.log = self._log.start()
def tearDown(self):
self.log.stop()
class ReParseArgsTestCase(BaseTestCase):
def test_argument(self):
for arg in ['argument', 'arg-ument', 'arg_ument']:
rv = re_parse_args.match(arg)
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['argument'], arg)
self.assertIsNone(rv.groupdict()['key'])
self.assertIsNone(rv.groupdict()['key_name'])
self.assertIsNone(rv.groupdict()['value'])
self.assertIsNone(rv.groupdict()['lopt'])
self.assertIsNone(rv.groupdict()['ropt'])
def test_optional_argument(self):
for arg in ['argument', 'arg-ument', 'arg_ument']:
rv = re_parse_args.match('[%s]' % arg)
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['argument'], arg)
self.assertEquals(rv.groupdict()['lopt'], '[')
self.assertEquals(rv.groupdict()['ropt'], ']')
self.assertIsNone(rv.groupdict()['key'])
self.assertIsNone(rv.groupdict()['key_name'])
self.assertIsNone(rv.groupdict()['value'])
def test_key_value(self):
for k, v in [('key', 'value'), ('k-ey', 'value'),
('k_ey', 'value'), ('key', 'val-ue'),
('key', 'val_ue'), ('k-ey', 'val-ue'),
('k_ey', 'val_ue')]:
rv = re_parse_args.match('--%s=%s' % (k, v))
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['key_name'], k)
self.assertEquals(rv.groupdict()['key'], '--%s' % k)
self.assertEquals(rv.groupdict()['value'], v)
self.assertIsNone(rv.groupdict()['argument'])
self.assertIsNone(rv.groupdict()['lopt'])
self.assertIsNone(rv.groupdict()['ropt'])
def test_optional_key_value(self):
for k, v in [('key', 'value'), ('k-ey', 'value'),
('k_ey', 'value'), ('key', 'val-ue'),
('key', 'val_ue'), ('k-ey', 'val-ue'),
('k_ey', 'val_ue')]:
rv = re_parse_args.match('[--%s=%s]' % (k, v))
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['key_name'], k)
self.assertEquals(rv.groupdict()['key'], '--%s' % k)
self.assertEquals(rv.groupdict()['value'], v)
self.assertEquals(rv.groupdict()['lopt'], '[')
self.assertEquals(rv.groupdict()['ropt'], ']')
self.assertIsNone(rv.groupdict()['argument'])
def test_flag(self):
for flag in ['flag', 'fla_g', 'fla-g']:
rv = re_parse_args.match('--%s' % flag)
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['key_name'], flag)
self.assertEquals(rv.groupdict()['key'], '--%s' % flag)
self.assertIsNone(rv.groupdict()['argument'])
self.assertIsNone(rv.groupdict()['value'])
self.assertIsNone(rv.groupdict()['lopt'])
self.assertIsNone(rv.groupdict()['ropt'])
def test_optional_flag(self):
for flag in ['flag', 'fla_g', 'fla-g']:
rv = re_parse_args.match('[--%s]' % flag)
self.assertIsNotNone(rv)
self.assertEquals(rv.groupdict()['key_name'], flag)
self.assertEquals(rv.groupdict()['key'], '--%s' % flag)
self.assertEquals(rv.groupdict()['lopt'], '[')
self.assertEquals(rv.groupdict()['ropt'], ']')
self.assertIsNone(rv.groupdict()['argument'])
self.assertIsNone(rv.groupdict()['value'])
class BashModuleTestCase(BaseTestCase):
def setUp(self):
super(BaseTestCase, self).setUp()
self.tmpdir = tempfile.mkdtemp()
self.module = os.path.join(self.tmpdir, 'module')
def tearDown(self):
super(BaseTestCase, self).tearDown()
shutil.rmtree(self.tmpdir)
def test_get_metadata(self):
with codecs.open(self.module, 'w', 'utf-8') as fp:
print >> fp, 'FOO_LOL=asdf'
print >> fp, 'FOO_BAR="asdfa"'
print >> fp, 'FOO_XD=1234'
print >> fp, 'FOO_ASDF="1234"'
print >> fp, 'FOO_HEHE="${FOO_ASDF}"'
print >> fp, 'FOO_FUU=${FOO_BAR}'
print >> fp, 'FOO_DFGDS'
print >> fp, 'ASDF=XD'
print >> fp
print >> fp, 'main() { echo 1 }'
obj = BashModule(self.module)
meta = obj.get_metadata()
self.assertEquals(meta['lol'], 'asdf')
self.assertEquals(meta['bar'], 'asdfa')
self.assertEquals(meta['xd'], '1234')
self.assertEquals(meta['asdf'], '1234')
self.assertEquals(meta['hehe'], '1234')
self.assertEquals(meta['fuu'], 'asdfa')
self.assertEquals(len(meta), 6)
@mock.patch('foo.BashModule.get_metadata')
def test_build_argparse(self, get_metadata):
get_metadata.return_value = {'usage': ('foo --bar --baz=bah [asd] '
'[--asdf] [--lol=hehe]'),
'help': 'dummy', 'help_foo': 'foo1',
'help_bar': 'bar2', 'help_baz': 'baz3',
'help_asd': 'asd4', 'help_asdf': 'asdf5',
'help_lol': 'lol6'}
subparser = mock.Mock()
obj = BashModule(self.module)
parser = obj.build_argparse(subparser)
subparser.add_parser.assert_called_once_with('module', help='dummy')
self.assertEquals(parser.add_argument.call_args_list,
[mock.call('foo', help='foo1', nargs=1),
mock.call('--bar', required=True,
action='store_const', const='1',
help='bar2'),
mock.call('--baz', metavar='bah', required=True,
help='baz3'),
mock.call('asd', help='asd4', nargs='?'),
mock.call('--asdf', required=False,
action='store_const', const='1',
help='asdf5'),
mock.call('--lol', metavar='hehe', required=False,
help='lol6')])
parser.set_defaults.called_once_with(_module=obj)
@mock.patch('foo.BashModule.get_metadata')
def test_build_argparse_with_invalid_arg(self, get_metadata):
get_metadata.return_value = {'usage': ('foo1'),
'help': 'dummy', 'help_foo1': 'foo1'}
subparser = mock.Mock()
obj = BashModule(self.module)
with self.assertRaises(RuntimeError):
obj.build_argparse(subparser)
@mock.patch('foo.subprocess.Popen')
def test_run(self, Popen):
with codecs.open(self.module, 'w', 'utf-8') as fp:
print >> fp, 'main() { echo 1 }'
with mock.patch.dict('foo.os.environ',
{'PATH': '/', 'LC_ALL': 'en_US.utf8'},
clear=True):
obj = BashModule(self.module)
obj.run({'foo': 'bar', 'bar': ['baz'], 'lol': None})
script = Popen.call_args[0][0][2] # wtf?
for func in ['log_debug', 'log_info', 'log_warning', 'log_error',
'log_critical']:
self.assertIn('%s() {' % func, script)
self.assertIn(self.module, script)
env = Popen.call_args[1]['env']
self.assertEquals(env['PATH'], '/')
self.assertEquals(env['LC_ALL'], 'en_US.utf8')
self.assertEquals(env['FOO_ARG_FOO'], 'bar')
self.assertEquals(env['FOO_ARG_BAR'], 'baz')
self.assertEquals(env['FOO_ARG_LOL'], '')
self.assertEquals(len(env), 5)
class RunnerTestCase(BaseTestCase):
def setUp(self):
super(BaseTestCase, self).setUp()
self.tmpdir = tempfile.mkdtemp()
self.module = os.path.join(self.tmpdir, 'module')
def tearDown(self):
super(BaseTestCase, self).tearDown()
shutil.rmtree(self.tmpdir)
@mock.patch('foo.sysconfig.get_config_var')
@mock.patch('foo.os.path.expanduser')
def test_search_paths_not_created(self, expanduser, get_config_var):
expanduser.return_value = self.tmpdir
get_config_var.return_value = self.tmpdir
runner = Runner()
cwd = os.path.dirname(os.path.abspath(__file__))
self.assertEquals(runner.search_paths(),
[os.path.join(cwd, 'modules')])
@mock.patch('foo.os.path.isdir')
def test_search_paths(self, isdir):
isdir.return_value = True
runner = Runner()
cwd = os.path.dirname(os.path.abspath(foo.__file__))
_cwd = os.path.join(cwd, 'modules')
_user = os.path.join(os.path.expanduser('~'), '.local', 'libexec',
'foo-tools')
_egg = os.path.join(cwd, 'libexec', 'foo-tools')
_global = os.path.join(sysconfig.get_config_var('base'), 'libexec',
'foo-tools')
self.assertEquals(runner.search_paths(), [_user, _cwd, _egg, _global])
@mock.patch('foo.Runner.search_paths')
def test_modules(self, search_paths):
_subdir = os.path.join(self.tmpdir, 'modules')
if not os.path.isdir(_subdir):
os.makedirs(_subdir)
foo = os.path.join(self.tmpdir, 'foo')
with open(foo, 'w') as fp:
print >> fp
bar = os.path.join(self.tmpdir, 'bar')
with open(bar, 'w') as fp:
print >> fp
search_paths.return_value = [self.tmpdir, _subdir]
runner = Runner()
modules = runner.modules()
self.assertIn('foo', modules)
self.assertIn('bar', modules)
@mock.patch('foo.Runner.search_paths')
def test_duplicated_modules(self, search_paths):
_subdir = os.path.join(self.tmpdir, 'modules')
if not os.path.isdir(_subdir):
os.makedirs(_subdir)
foo = os.path.join(self.tmpdir, 'foo')
with open(foo, 'w') as fp:
print >> fp
foo1 = os.path.join(self.tmpdir, 'foo')
with open(foo1, 'w') as fp:
print >> fp
search_paths.return_value = [self.tmpdir, _subdir]
runner = Runner()
modules = runner.modules()
self.assertIn('foo', modules)
self.assertEquals(modules['foo'].fname, foo)
@mock.patch('foo.Runner.modules')
def test_run(self, modules):
module = mock.Mock()
modules.return_value = {'foo': module}
runner = Runner()
runner.parser = parser = mock.Mock()
parser.parse_args.return_value = Namespace(foo='bar', bar=['baz'],
_lol='hehe', xd=None,
log_level='NOTSET',
_module=module)
with mock.patch.object(sys, 'argv', ['foo', 'bar', '--traceback']):
runner.run()
module.build_argparse.assert_called_once_with(runner.subparser)
parser.parse_args.assert_called_once_with(['bar'])
module.run.assert_called_once_with({'bar': 'baz', 'foo': 'bar',
'log_level': '0', 'xd': ''})
class MainTestCase(BaseTestCase):
@mock.patch('foo.Runner')
def test_ok(self, Runner):
Runner.return_value = runner = mock.Mock()
runner.run.return_value = 0
self.assertEquals(main(), 0)
Runner.assert_called_once_with()
runner.run.assert_called_once_with()
@mock.patch('foo.Runner')
def test_with_exception(self, Runner):
Runner.return_value = runner = mock.Mock()
runner.run.side_effect = RuntimeError('foo')
runner.run.return_value = 0
self.assertEquals(main(), 1)
@mock.patch('foo.Runner')
def test_with_exception_reraised(self, Runner):
Runner.return_value = runner = mock.Mock()
runner.run.side_effect = RuntimeError('foo')
runner.run.return_value = 0
with mock.patch.object(sys, 'argv', ['foo', 'bar', '--traceback']):
with self.assertRaises(RuntimeError):
main()
if __name__ == '__main__':
unittest.main()