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
|
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright Buildbot Team Members
import sys
import twisted
from twisted.trial import reporter, unittest
from twisted.internet import utils
from buildbot.test.util.gpo import GetProcessOutputMixin, Expect
class TestGPOMixin(unittest.TestCase):
# these tests use self.patch, but the SkipTest exception gets eaten, so
# explicitly skip things here.
if twisted.version.major <= 9 and sys.version_info[:2] == (2,7):
skip = "unittest.TestCase.patch is not available"
def runTestMethod(self, method):
class TestCase(GetProcessOutputMixin, unittest.TestCase):
def setUp(self):
self.setUpGetProcessOutput()
def runTest(self):
return method(self)
self.testcase = TestCase()
result = reporter.TestResult()
self.testcase.run(result) # This blocks
return result
def assertTestFailure(self, result, expectedFailure):
self.assertEqual(result.errors, [])
self.assertEqual(len(result.failures), 1)
self.failUnless(result.failures[0][1].check(unittest.FailTest))
if expectedFailure:
self.assertSubstring(expectedFailure, result.failures[0][1].getErrorMessage())
def assertSuccessful(self, result):
if not result.wasSuccessful():
output = 'expected success'
if result.failures:
output += ('\ntest failed: %s' %
result.failures[0][1].getErrorMessage())
if result.errors:
output += ('\nerrors: %s' %
map(lambda x: x[1].value, result.errors))
raise self.failureException(output)
self.failUnless(result.wasSuccessful())
def test_patch(self):
original_getProcessOutput = utils.getProcessOutput
original_getProcessOutputAndValue = utils.getProcessOutputAndValue
def method(testcase):
testcase.expectCommands()
self.assertEqual(utils.getProcessOutput,
testcase.patched_getProcessOutput)
self.assertEqual(utils.getProcessOutputAndValue,
testcase.patched_getProcessOutputAndValue)
result = self.runTestMethod(method)
self.assertSuccessful(result)
self.assertEqual(utils.getProcessOutput,
original_getProcessOutput)
self.assertEqual(utils.getProcessOutputAndValue,
original_getProcessOutputAndValue)
def test_methodChaining(self):
expect = Expect('command')
self.assertEqual(expect, expect.exit(0))
self.assertEqual(expect, expect.stdout("output"))
self.assertEqual(expect, expect.stderr("error"))
def test_gpo_oneCommand(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
d = utils.getProcessOutput("command", ())
d.addCallback(self.assertEqual, '')
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_expectTwo_runOne(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
testcase.expectCommands(Expect("command2"))
d = utils.getProcessOutput("command", ())
d.addCallback(self.assertEqual, '')
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "assert all expected commands were run")
def test_gpo_wrongCommand(self):
def method(testcase):
testcase.expectCommands(Expect("command2"))
d = utils.getProcessOutput("command", ())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpo_wrongArgs(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg"))
d = utils.getProcessOutput("command", ("otherarg",))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpo_missingPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg").path("/home"))
d = utils.getProcessOutput("command", ("otherarg",))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpo_wrongPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg").path("/home"))
d = utils.getProcessOutput("command", ("otherarg",), path="/work")
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpo_notCurrentPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg"))
d = utils.getProcessOutput("command", ("otherarg",), path="/work")
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpo_errorOutput(self):
def method(testcase):
testcase.expectCommands(Expect("command").stderr("some test"))
d = testcase.assertFailure(utils.getProcessOutput("command", ()), [IOError])
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "got stderr: 'some test'")
def test_gpo_errorOutput_errtoo(self):
def method(testcase):
testcase.expectCommands(Expect("command").stderr("some test"))
d = utils.getProcessOutput("command", (), errortoo=True)
d.addCallback(testcase.assertEqual, "some test")
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_exitIgnored(self):
def method(testcase):
testcase.expectCommands(Expect("command").exit(1))
d = utils.getProcessOutput("command", ())
d.addCallback(self.assertEqual, '')
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_output(self):
def method(testcase):
testcase.expectCommands(Expect("command").stdout("stdout"))
d = utils.getProcessOutput("command", ())
d.addCallback(testcase.assertEqual, "stdout")
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_outputAndError(self):
def method(testcase):
testcase.expectCommands(Expect("command").stdout("stdout").stderr("stderr"))
d = utils.getProcessOutput("command", (), errortoo=True)
@d.addCallback
def cb(res):
testcase.assertSubstring("stdout", res)
testcase.assertSubstring("stderr", res)
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_environ_success(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
testcase.addGetProcessOutputExpectEnv({'key': 'value'})
d = utils.getProcessOutput("command", (), env={'key': 'value'})
d.addCallback(self.assertEqual, '')
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpo_environ_wrongValue(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
testcase.addGetProcessOutputExpectEnv({'key': 'value'})
d = utils.getProcessOutput("command", (), env={'key': 'wrongvalue'})
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "Expected environment to have key = 'value'")
def test_gpo_environ_missing(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
testcase.addGetProcessOutputExpectEnv({'key': 'value'})
d = utils.getProcessOutput("command", ())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "Expected environment to have key = 'value'")
def test_gpoav_oneCommand(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(self.assertEqual, ('','',0))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpoav_expectTwo_runOne(self):
def method(testcase):
testcase.expectCommands(Expect("command"))
testcase.expectCommands(Expect("command2"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(self.assertEqual, ('','',0))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "assert all expected commands were run")
def test_gpoav_wrongCommand(self):
def method(testcase):
testcase.expectCommands(Expect("command2"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpoav_wrongArgs(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg"))
d = utils.getProcessOutputAndValue("command", ("otherarg",))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpoav_missingPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg").path("/home"))
d = utils.getProcessOutputAndValue("command", ("otherarg",))
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpoav_wrongPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg").path("/home"))
d = utils.getProcessOutputAndValue("command", ("otherarg",), path="/work")
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpoav_notCurrentPath(self):
def method(testcase):
testcase.expectCommands(Expect("command", "arg"))
d = utils.getProcessOutputAndValue("command", ("otherarg",), path="/work")
d.addCallback(lambda _: testcase.assertAllCommandsRan())
return d
result = self.runTestMethod(method)
self.assertTestFailure(result, "unexpected command run")
def test_gpoav_errorOutput(self):
def method(testcase):
testcase.expectCommands(Expect("command").stderr("some test"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(self.assertEqual, ('','some test',0))
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpoav_exit(self):
def method(testcase):
testcase.expectCommands(Expect("command").exit(1))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(self.assertEqual, ('','',1))
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpoav_output(self):
def method(testcase):
testcase.expectCommands(Expect("command").stdout("stdout"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(testcase.assertEqual, ("stdout",'',0))
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
def test_gpoav_outputAndError(self):
def method(testcase):
testcase.expectCommands(Expect("command").stdout("stdout").stderr("stderr"))
d = utils.getProcessOutputAndValue("command", ())
d.addCallback(testcase.assertEqual, ("stdout",'stderr',0))
return d
result = self.runTestMethod(method)
self.assertSuccessful(result)
|
