forked from fabric/fabric
-
Notifications
You must be signed in to change notification settings - Fork 0
/
utils.py
277 lines (224 loc) · 8.2 KB
/
utils.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
from __future__ import with_statement
from StringIO import StringIO # No need for cStringIO at this time
from contextlib import contextmanager
from copy import deepcopy
from fudge.patcher import with_patched_object
from functools import wraps, partial
from types import StringTypes
import copy
import getpass
import os
import re
import shutil
import sys
import tempfile
from fudge import Fake, patched_context, clear_expectations, with_patched_object
from nose.tools import raises
from nose import SkipTest
from fabric.context_managers import settings
from fabric.state import env, output
from fabric.sftp import SFTP
import fabric.network
from fabric.network import normalize, to_dict
from server import PORT, PASSWORDS, USER, HOST
class FabricTest(object):
"""
Nose-oriented test runner which wipes state.env and provides file helpers.
"""
def setup(self):
# Clear Fudge mock expectations
clear_expectations()
# Copy env, output for restoration in teardown
self.previous_env = copy.deepcopy(env)
# Deepcopy doesn't work well on AliasDicts; but they're only one layer
# deep anyways, so...
self.previous_output = output.items()
# Allow hooks from subclasses here for setting env vars (so they get
# purged correctly in teardown())
self.env_setup()
# Temporary local file dir
self.tmpdir = tempfile.mkdtemp()
def set_network(self):
env.update(to_dict('%s@%s:%s' % (USER, HOST, PORT)))
def env_setup(self):
# Set up default networking for test server
env.disable_known_hosts = True
self.set_network()
env.password = PASSWORDS[USER]
# Command response mocking is easier without having to account for
# shell wrapping everywhere.
env.use_shell = False
def teardown(self):
env.clear() # In case tests set env vars that didn't exist previously
env.update(self.previous_env)
output.update(self.previous_output)
shutil.rmtree(self.tmpdir)
# Clear Fudge mock expectations...again
clear_expectations()
def path(self, *path_parts):
return os.path.join(self.tmpdir, *path_parts)
def mkfile(self, path, contents):
dest = self.path(path)
with open(dest, 'w') as fd:
fd.write(contents)
return dest
def exists_remotely(self, path):
return SFTP(env.host_string).exists(path)
def exists_locally(self, path):
return os.path.exists(path)
class CarbonCopy(StringIO):
"""
A StringIO capable of multiplexing its writes to other buffer objects.
"""
def __init__(self, buffer='', cc=None):
"""
If ``cc`` is given and is a file-like object or an iterable of same,
it/they will be written to whenever this StringIO instance is written
to.
"""
StringIO.__init__(self, buffer)
if cc is None:
cc = []
elif hasattr(cc, 'write'):
cc = [cc]
self.cc = cc
def write(self, s):
StringIO.write(self, s)
for writer in self.cc:
writer.write(s)
def mock_streams(which):
"""
Replaces a stream with a ``StringIO`` during the test, then restores after.
Must specify which stream (stdout, stderr, etc) via string args, e.g.::
@mock_streams('stdout')
def func():
pass
@mock_streams('stderr')
def func():
pass
@mock_streams('both')
def func()
pass
If ``'both'`` is specified, not only will both streams be replaced with
StringIOs, but a new combined-streams output (another StringIO) will appear
at ``sys.stdall``. This StringIO will resemble what a user sees at a
terminal, i.e. both streams intermingled.
"""
both = (which == 'both')
stdout = (which == 'stdout') or both
stderr = (which == 'stderr') or both
def mocked_streams_decorator(func):
@wraps(func)
def inner_wrapper(*args, **kwargs):
if both:
sys.stdall = StringIO()
fake_stdout = CarbonCopy(cc=sys.stdall)
fake_stderr = CarbonCopy(cc=sys.stdall)
else:
fake_stdout, fake_stderr = StringIO(), StringIO()
if stdout:
my_stdout, sys.stdout = sys.stdout, fake_stdout
if stderr:
my_stderr, sys.stderr = sys.stderr, fake_stderr
try:
ret = func(*args, **kwargs)
finally:
if stdout:
sys.stdout = my_stdout
if stderr:
sys.stderr = my_stderr
if both:
del sys.stdall
return inner_wrapper
return mocked_streams_decorator
def password_response(password, times_called=None, silent=True):
"""
Context manager which patches ``getpass.getpass`` to return ``password``.
``password`` may be a single string or an iterable of strings:
* If single string, given password is returned every time ``getpass`` is
called.
* If iterable, iterated over for each call to ``getpass``, after which
``getpass`` will error.
If ``times_called`` is given, it is used to add a ``Fake.times_called``
clause to the mock object, e.g. ``.times_called(1)``. Specifying
``times_called`` alongside an iterable ``password`` list is unsupported
(see Fudge docs on ``Fake.next_call``).
If ``silent`` is True, no prompt will be printed to ``sys.stderr``.
"""
fake = Fake('getpass', callable=True)
# Assume stringtype or iterable, turn into mutable iterable
if isinstance(password, StringTypes):
passwords = [password]
else:
passwords = list(password)
# Optional echoing of prompt to mimic real behavior of getpass
# NOTE: also echo a newline if the prompt isn't a "passthrough" from the
# server (as it means the server won't be sending its own newline for us).
echo = lambda x, y: y.write(x + ("\n" if x != " " else ""))
# Always return first (only?) password right away
fake = fake.returns(passwords.pop(0))
if not silent:
fake = fake.calls(echo)
# If we had >1, return those afterwards
for pw in passwords:
fake = fake.next_call().returns(pw)
if not silent:
fake = fake.calls(echo)
# Passthrough times_called
if times_called:
fake = fake.times_called(times_called)
return patched_context(getpass, 'getpass', fake)
def _assert_contains(needle, haystack, 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 line_prefix(prefix, string):
"""
Return ``string`` with all lines prefixed by ``prefix``.
"""
return "\n".join(prefix + x for x in string.splitlines())
def eq_(result, expected, msg=None):
"""
Shadow of the Nose builtin which presents easier to read multiline output.
"""
params = {'expected': expected, 'result': result}
aka = """
--------------------------------- aka -----------------------------------------
Expected:
%(expected)r
Got:
%(result)r
""" % params
default_msg = """
Expected:
%(expected)s
Got:
%(result)s
""" % params
if (repr(result) != str(result)) or (repr(expected) != str(expected)):
default_msg += aka
assert result == expected, msg or default_msg
def eq_contents(path, text):
with open(path) as fd:
eq_(text, fd.read())
def support(path):
return os.path.join(os.path.dirname(__file__), 'support', path)
fabfile = support
@contextmanager
def path_prefix(module):
i = 0
sys.path.insert(i, os.path.dirname(module))
yield
sys.path.pop(i)
def aborts(func):
return raises(SystemExit)(mock_streams('stderr')(func))
def _patched_input(func, fake):
return func(sys.modules['__builtin__'], 'raw_input', fake)
patched_input = partial(_patched_input, patched_context)
with_patched_input = partial(_patched_input, with_patched_object)