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
|
import os
import re
import sys
import termios
from contextlib import contextmanager
from functools import partial, wraps
from six import StringIO
from mock import patch
from spec import trap, Spec, eq_, skip
from invoke.platform import WINDOWS
support = os.path.join(os.path.dirname(__file__), '_support')
def skip_if_windows(fn):
@wraps(fn)
def wrapper(*args, **kwargs):
if WINDOWS:
skip()
return fn(*args, **kwargs)
return wrapper
@contextmanager
def sys_path(filepath=None):
sys.path.insert(0, filepath)
yield
sys.path.pop(0)
support_path = partial(sys_path, filepath=support)
def load(name):
with support_path():
return __import__(name)
class IntegrationSpec(Spec):
def setup(self):
self.old_environ = os.environ.copy()
os.chdir(support)
def teardown(self):
reset_cwd()
os.environ.clear()
os.environ.update(self.old_environ)
def reset_cwd():
# Chdir back to project root to avoid problems
os.chdir(os.path.join(os.path.dirname(__file__), '..'))
@contextmanager
def cd(where):
cwd = os.getcwd()
os.chdir(where)
try:
yield
finally:
os.chdir(cwd)
# Strings are easier to type & read than lists
def _dispatch(argstr, version=None):
from invoke.cli import dispatch
return dispatch(argstr.split(), version)
@trap
def _output_eq(args, stdout=None, stderr=None, code=0):
"""
dispatch() 'args', matching output to 'std(out|err)'.
Must give either or both of the output-expecting args.
"""
with expect_exit(code):
_dispatch("inv {0}".format(args))
if stdout is not None:
eq_(sys.stdout.getvalue(), stdout)
if stderr is not None:
eq_(sys.stderr.getvalue(), stderr)
@contextmanager
def expect_exit(code=0):
"""
Run a block of code expected to sys.exit(), ignoring the exit.
This is so we can readily test top level things like help output, listings,
etc.
"""
try:
yield
except SystemExit as e:
if e.code != code:
raise
@contextmanager
def mocked_run():
with patch('invoke.runners.Runner.run') as run:
yield run
def _assert_contains(haystack, needle, invert):
matched = re.search(needle, haystack, re.M)
if (invert and matched) or (not invert and not matched):
raise AssertionError("r'%s' %sfound in '%s'" % (
needle,
"" if invert else "not ",
haystack
))
assert_contains = partial(_assert_contains, invert=False)
assert_not_contains = partial(_assert_contains, invert=True)
def mock_subprocess(out='', err='', exit=0, isatty=None):
def decorator(f):
@wraps(f)
@patch('invoke.runners.Popen')
@patch('os.read')
@patch('os.isatty')
def wrapper(*args, **kwargs):
args = list(args)
Popen, read, os_isatty = args.pop(), args.pop(), args.pop()
process = Popen.return_value
process.returncode = exit
process.stdout.fileno.return_value = 1
process.stderr.fileno.return_value = 2
# If requested, mock isatty to fake out pty detection
if isatty is not None:
os_isatty.return_value = isatty
out_file = StringIO(out)
err_file = StringIO(err)
def fakeread(fileno, count):
fd = {1: out_file, 2: err_file}[fileno]
return fd.read(count)
read.side_effect = fakeread
f(*args, **kwargs)
return wrapper
return decorator
def mock_pty(out='', err='', exit=0, isatty=None, trailing_error=None):
def decorator(f):
# Boy this is dumb. Windoooooows >:(
ioctl_patch = lambda x: x
if not WINDOWS:
import fcntl
ioctl_patch = patch('invoke.runners.fcntl.ioctl',
wraps=fcntl.ioctl)
@wraps(f)
@patch('invoke.runners.pty')
@patch('invoke.runners.os')
@ioctl_patch
def wrapper(*args, **kwargs):
args = list(args)
pty, os, ioctl = args.pop(), args.pop(), args.pop()
# Don't actually fork, but pretend we did & that main thread is
# also the child (pid 0) to trigger execv call; & give 'parent fd'
# of 1 (stdout).
pty.fork.return_value = 0, 1
# We don't really need to care about waiting since not truly
# forking/etc, so here we just return a nonzero "pid" + dummy value
# (normally sent to WEXITSTATUS but we mock that anyway, so.)
os.waitpid.return_value = None, None
os.WEXITSTATUS.return_value = exit
# If requested, mock isatty to fake out pty detection
if isatty is not None:
os.isatty.return_value = isatty
out_file = StringIO(out)
err_file = StringIO(err)
def fakeread(fileno, count):
fd = {1: out_file, 2: err_file}[fileno]
ret = fd.read(count)
# If asked, fake a Linux-platform trailing I/O error.
if not ret and trailing_error:
raise trailing_error
return ret
os.read.side_effect = fakeread
f(*args, **kwargs)
# Short-circuit if we raised an error in fakeread()
if trailing_error:
return
# Sanity checks to make sure the stuff we mocked, actually got ran!
# TODO: inject our mocks back into the tests so they can make their
# own assertions if desired
pty.fork.assert_called_with()
# Test the 2nd call to ioctl; the 1st call is doing TIOGSWINSZ
eq_(ioctl.call_args_list[1][0][1], termios.TIOCSWINSZ)
for name in ('execv', 'waitpid', 'WEXITSTATUS'):
assert getattr(os, name).called
return wrapper
return decorator
|
