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
|
"""
Test the base class for interactive test cases.
"""
import glob
from tests import mock
import os
import pytest
import shutil
from ..base.interactive import InteractiveTestCase
import tempfile
import unittest
import pyglet
from pyglet import window
from pyglet.gl import *
@pytest.mark.requires_user_action
class InteractiveTestCaseTest(InteractiveTestCase):
"""
Test the interactive test case base. Is an interactive test case itself, to be able to test it
properly.
"""
def setUp(self):
self._patchers = []
self._temporary_directories = []
def tearDown(self):
for patcher in self._patchers:
patcher.stop()
for directory in self._temporary_directories:
shutil.rmtree(directory)
def _patch_directory(self, target):
directory = tempfile.mkdtemp()
self._temporary_directories.append(directory)
patcher = mock.patch(target, directory)
self._patchers.append(patcher)
patcher.start()
return directory
def _patch_screenshot_paths(self):
self._session_screenshot_path = self._patch_directory('tests.base.interactive.session_screenshot_path')
self._committed_screenshot_path = self._patch_directory('tests.base.interactive.committed_screenshot_path')
def test_single_method(self):
class _Test(InteractiveTestCase):
test1_ran = False
def test_1(self):
_Test.test1_ran = True
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertTrue(_Test.test1_ran, 'Test should have run')
def test_multiple_methods(self):
class _Test(InteractiveTestCase):
test1_ran = False
test2_ran = False
def test_1(self):
_Test.test1_ran = True
def test_2(self):
_Test.test2_ran = True
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 2)
result = unittest.TestResult()
tests.run(result)
self.assertTrue(_Test.test1_ran, 'Test 1 should have run')
self.assertTrue(_Test.test2_ran, 'Test 2 should have run')
def test_user_verify_passed(self):
class _Test(InteractiveTestCase):
test1_ran = False
def test_1(self):
_Test.test1_ran = True
self.user_verify('Just press Enter', take_screenshot=False)
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertTrue(_Test.test1_ran, 'Test should have run')
self.assertEqual(len(result.failures), 0, 'Not expecting failures')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
self.user_verify('Did I ask you to press Enter?', take_screenshot=False)
def test_user_verify_failed(self):
class _Test(InteractiveTestCase):
test1_ran = False
def test_1(self):
_Test.test1_ran = True
self.user_verify('Enter "n" and then enter reason "abcd"', take_screenshot=False)
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertTrue(_Test.test1_ran, 'Test should have run')
self.assertEqual(len(result.failures), 1, 'Expected 1 test failure')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
self.assertIn('AssertionError: abcd', result.failures[0][1], 'Did not get failure message entered by user.')
def test_verify_commits_screenshot_on_user_passed(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Please choose yes (or press Enter)')
w.close()
self._patch_screenshot_paths()
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 0, 'Not expecting failures')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
files = glob.glob(os.path.join(self._committed_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not committed')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
@mock.patch('tests.interactive.interactive_test_base.interactive', False)
def test_screenshot_taken_but_not_committed_on_noninteractive_failure(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Empty window')
w.close()
self.fail('Test failed')
self._patch_screenshot_paths()
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 1, 'Expecting 1 failure')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
files = glob.glob(os.path.join(self._committed_screenshot_path, '*.png'))
self.assertEqual(len(files), 0, 'Screenshot should not have been comitted')
@mock.patch('tests.interactive.interactive_test_base.interactive', False)
@mock.patch('tests.interactive.interactive_test_base.allow_missing_screenshots', True)
def test_screenshot_taken_but_not_committed_on_noninteractive_pass(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Empty window')
w.close()
self._patch_screenshot_paths()
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 0, 'Not expecting failures')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
files = glob.glob(os.path.join(self._committed_screenshot_path, '*.png'))
self.assertEqual(len(files), 0, 'Screenshot should not have been comitted')
@mock.patch('tests.interactive.interactive_test_base.interactive', False)
def test_fails_on_missing_screenshot_on_noninteractive_pass(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Empty window')
w.close()
self._patch_screenshot_paths()
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 1, 'Expecting 1 failure')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
files = glob.glob(os.path.join(self._committed_screenshot_path, '*.png'))
self.assertEqual(len(files), 0, 'Screenshot should not have been comitted')
def test_screenshot_taken_but_not_committed_on_user_failure(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
try:
self.user_verify('Please select "n" and enter any reason')
finally:
w.close()
self._patch_screenshot_paths()
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 1, 'Expecting 1 failure')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
files = glob.glob(os.path.join(self._committed_screenshot_path, '*.png'))
self.assertEqual(len(files), 0, 'Screenshot should not have been committed')
@mock.patch('tests.interactive.interactive_test_base.interactive', False)
def test_screenshot_does_not_match(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(0, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Empty window')
w.close()
self._patch_screenshot_paths()
# Copy non matching screenshot
screenshot_name = 'tests.interactive.test_interactive_test_base._Test.test_1.001.png'
original_screenshot = os.path.join(os.path.dirname(__file__), '..', 'data', 'images', screenshot_name)
committed_screenshot = os.path.join(self._committed_screenshot_path, screenshot_name)
shutil.copy(original_screenshot, committed_screenshot)
# Start the test
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 1, 'Expecting 1 failure')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
# Verify committed image not changed
original_image = pyglet.image.load(original_screenshot)
committed_image = pyglet.image.load(committed_screenshot)
self.assert_image_equal(original_image, committed_image, msg='Committed image should not be overwritten')
@mock.patch('tests.interactive.interactive_test_base.interactive', False)
def test_screenshot_matches(self):
class _Test(InteractiveTestCase):
def test_1(self):
w = window.Window(200, 200)
w.switch_to()
glClearColor(1, 0, 1, 1)
glClear(GL_COLOR_BUFFER_BIT)
w.flip()
self.user_verify('Empty window')
w.close()
self._patch_screenshot_paths()
# Copy matching screenshot
screenshot_name = 'tests.interactive.test_interactive_test_base._Test.test_1.001.png'
original_screenshot = os.path.join(os.path.dirname(__file__), '..', 'data', 'images', screenshot_name)
committed_screenshot = os.path.join(self._committed_screenshot_path, screenshot_name)
shutil.copy(original_screenshot, committed_screenshot)
# Start the test
tests = unittest.defaultTestLoader.loadTestsFromTestCase(_Test)
self.assertIsNotNone(tests)
self.assertEqual(tests.countTestCases(), 1)
result = unittest.TestResult()
tests.run(result)
self.assertEqual(len(result.failures), 0, 'Not expecting failures')
self.assertEqual(len(result.errors), 0, 'Not expecting errors')
self.assertEqual(result.testsRun, 1, 'Expected 1 test run')
files = glob.glob(os.path.join(self._session_screenshot_path, '*.png'))
self.assertEqual(len(files), 1, 'Screenshot not stored in session directory')
self.assertIn('tests.interactive.test_interactive_test_base._Test.test_1.001.png', files[0])
|
