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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import subprocess
import sys
import unittest
from unittest import mock
import fixtures
from autopage.tests import sinks
import autopage
class PagedStreamTest(fixtures.TestWithFixtures):
def setUp(self):
out = sinks.TTYFixture()
self.useFixture(out)
self.stream = out.stream
self.useFixture(fixtures.MonkeyPatch('sys.stdout', self.stream))
popen = fixtures.MockPatch('subprocess.Popen')
self.useFixture(popen)
self.popen = popen.mock
def test_defaults(self):
ap = autopage.AutoPager(line_buffering=False)
with mock.patch.object(ap, '_pager_env') as get_env, \
mock.patch.object(ap, '_pager_cmd') as cmd:
stream = ap._paged_stream()
self.popen.assert_called_once_with(
cmd.return_value,
env=get_env.return_value,
bufsize=-1,
universal_newlines=True,
encoding='UTF-8',
errors='strict',
stdin=subprocess.PIPE,
stdout=None)
self.assertIs(stream, self.popen.return_value.stdin)
def test_line_buffering(self):
ap = autopage.AutoPager(line_buffering=True)
stream = ap._paged_stream()
self.popen.assert_called_once_with(
mock.ANY,
env=mock.ANY,
bufsize=1,
universal_newlines=True,
encoding=mock.ANY,
errors=mock.ANY,
stdin=subprocess.PIPE,
stdout=None)
self.assertIs(stream, self.popen.return_value.stdin)
def test_errors(self):
ap = autopage.AutoPager(errors=autopage.ErrorStrategy.NAME_REPLACE)
stream = ap._paged_stream()
self.popen.assert_called_once_with(
mock.ANY,
env=mock.ANY,
bufsize=mock.ANY,
universal_newlines=mock.ANY,
encoding=mock.ANY,
errors='namereplace',
stdin=subprocess.PIPE,
stdout=None)
self.assertIs(stream, self.popen.return_value.stdin)
def test_explicit_stdout_stream(self):
ap = autopage.AutoPager(self.stream)
stream = ap._paged_stream()
self.popen.assert_called_once_with(
mock.ANY,
env=mock.ANY,
bufsize=mock.ANY,
universal_newlines=mock.ANY,
encoding=mock.ANY,
errors=mock.ANY,
stdin=subprocess.PIPE,
stdout=None)
self.assertIs(stream, self.popen.return_value.stdin)
def test_explicit_stream(self):
with sinks.TTYFixture() as tty:
ap = autopage.AutoPager(tty.stream)
stream = ap._paged_stream()
self.popen.assert_called_once_with(
mock.ANY,
env=mock.ANY,
bufsize=mock.ANY,
universal_newlines=mock.ANY,
encoding=mock.ANY,
errors=mock.ANY,
stdin=subprocess.PIPE,
stdout=tty.stream)
self.assertIs(stream, self.popen.return_value.stdin)
class ToTerminalTest(unittest.TestCase):
def test_pty(self):
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
self.assertTrue(ap.to_terminal())
def test_stringio(self):
with sinks.BufferFixture() as out:
ap = autopage.AutoPager(out.stream)
self.assertFalse(ap.to_terminal())
def test_file(self):
with sinks.TempFixture() as out:
ap = autopage.AutoPager(out.stream)
self.assertFalse(ap.to_terminal())
def test_default_pty(self):
with sinks.TTYFixture() as out:
with fixtures.MonkeyPatch('sys.stdout', out.stream):
ap = autopage.AutoPager()
self.assertTrue(ap.to_terminal())
def test_default_file(self):
with sinks.TempFixture() as out:
with fixtures.MonkeyPatch('sys.stdout', out.stream):
ap = autopage.AutoPager()
self.assertFalse(ap.to_terminal())
def test_launch_pager(self):
ap = autopage.AutoPager()
with mock.patch.object(ap, 'to_terminal', return_value=True), \
mock.patch.object(ap, '_paged_stream') as page, \
mock.patch.object(ap, '_reconfigure_output_stream') as reconf:
with ap as stream:
page.assert_called_once()
self.assertIs(page.return_value, stream)
reconf.assert_not_called()
def test_launch_pager_fail(self):
outstream = mock.Mock()
ap = autopage.AutoPager(outstream)
with mock.patch.object(ap, 'to_terminal', return_value=True), \
mock.patch.object(ap, '_paged_stream',
side_effect=OSError) as page, \
mock.patch.object(ap, '_reconfigure_output_stream') as reconf:
with ap as stream:
page.assert_called_once()
reconf.assert_called_once()
self.assertIs(outstream, stream)
def test_no_pager(self):
outstream = mock.Mock()
ap = autopage.AutoPager(outstream)
with mock.patch.object(ap, 'to_terminal', return_value=False), \
mock.patch.object(ap, '_paged_stream') as page, \
mock.patch.object(ap, '_reconfigure_output_stream') as reconf:
with ap as stream:
page.assert_not_called()
self.assertIs(outstream, stream)
reconf.assert_called_once()
class ExitCodeTest(fixtures.TestWithFixtures):
def setUp(self):
out = sinks.BufferFixture()
self.useFixture(out)
self.ap = autopage.AutoPager(out.stream)
def test_success(self):
with self.ap:
pass
self.assertEqual(0, self.ap.exit_code())
def test_pager_broken_pipe_flush(self):
flush = mock.MagicMock(side_effect=BrokenPipeError)
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
with fixtures.MockPatch('subprocess.Popen') as popen:
with sinks.BufferFixture() as pager_in:
popen.mock.return_value.stdin = pager_in.stream
with ap as stream:
stream.write('foo')
stream.close = flush
self.assertEqual(141, ap.exit_code())
def test_no_pager_broken_pipe_flush(self):
flush = mock.MagicMock(side_effect=BrokenPipeError)
with self.ap as stream:
stream.write('foo')
stream.flush = flush
self.assertEqual(141, self.ap.exit_code())
def test_broken_pipe(self):
with self.ap:
raise BrokenPipeError
self.assertEqual(141, self.ap.exit_code())
def test_exception(self):
class MyException(Exception):
pass
def run():
with self.ap:
raise MyException
self.assertRaises(MyException, run)
self.assertEqual(1, self.ap.exit_code())
def test_base_exception(self):
class MyBaseException(BaseException):
pass
def run():
with self.ap:
raise MyBaseException
self.assertRaises(MyBaseException, run)
self.assertEqual(1, self.ap.exit_code())
def test_interrupt(self):
def run():
with self.ap:
raise KeyboardInterrupt
self.assertRaises(KeyboardInterrupt, run)
self.assertEqual(130, self.ap.exit_code())
def test_system_exit(self):
def run():
with self.ap:
raise SystemExit(42)
self.assertRaises(SystemExit, run)
self.assertEqual(42, self.ap.exit_code())
class CleanupTest(unittest.TestCase):
def test_no_pager_stream_not_closed(self):
flush = mock.MagicMock()
with sinks.BufferFixture() as out:
with autopage.AutoPager(out.stream) as stream:
stream.flush = flush
stream.write('foo')
self.assertFalse(out.stream.closed)
flush.assert_called_once()
def test_no_pager_broken_pipe(self):
flush = mock.MagicMock(side_effect=BrokenPipeError)
with sinks.BufferFixture() as out:
with autopage.AutoPager(out.stream) as stream:
stream.flush = flush
stream.write('foo')
self.assertTrue(out.stream.closed)
flush.assert_called_once()
def test_no_pager_broken_pipe_flush(self):
flush = mock.MagicMock(side_effect=BrokenPipeError)
with sinks.BufferFixture() as out:
with autopage.AutoPager(out.stream) as stream:
stream.write('foo')
stream.flush = flush
self.assertTrue(out.stream.closed)
flush.assert_called_once()
def test_no_pager_stream_closed(self):
with sinks.BufferFixture() as out:
with autopage.AutoPager(out.stream) as stream:
stream.write('foo')
stream.close()
# Calling flush() on a closed stream raises an exception for
# real streams (but not for StringIO).
stream.flush = mock.MagicMock(side_effect=ValueError)
self.assertTrue(out.stream.closed)
def test_pager_stream_not_closed(self):
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
with fixtures.MockPatch('subprocess.Popen') as popen:
with sinks.BufferFixture() as pager_in:
popen.mock.return_value.stdin = pager_in.stream
with ap as stream:
self.assertIs(pager_in.stream, stream)
self.assertTrue(pager_in.stream.closed)
def test_pager_stream_not_closed_interrupt(self):
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
with fixtures.MockPatch('subprocess.Popen') as popen:
with sinks.BufferFixture() as pager_in:
popen.mock.return_value.stdin = pager_in.stream
def run():
with ap as stream:
self.assertIs(pager_in.stream, stream)
raise KeyboardInterrupt
self.assertRaises(KeyboardInterrupt, run)
self.assertTrue(pager_in.stream.closed)
def test_pager_broken_pipe(self):
flush = mock.MagicMock(side_effect=BrokenPipeError)
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
with fixtures.MockPatch('subprocess.Popen') as popen:
with sinks.BufferFixture() as pager_in:
popen.mock.return_value.stdin = pager_in.stream
pager_in.stream.flush = flush
with ap as stream:
self.assertIs(pager_in.stream, stream)
self.assertTrue(pager_in.stream.closed)
popen.mock.return_value.wait.assert_called_once()
def test_pager_stream_closed(self):
with sinks.TTYFixture() as out:
ap = autopage.AutoPager(out.stream)
with fixtures.MockPatch('subprocess.Popen') as popen:
with sinks.BufferFixture() as pager_in:
popen.mock.return_value.stdin = pager_in.stream
with ap as stream:
self.assertIs(pager_in.stream, stream)
stream.close()
popen.mock.return_value.wait.assert_called_once()
class StreamConfigureTest(fixtures.TestWithFixtures):
def setUp(self):
out = sinks.TempFixture()
self.useFixture(out)
self.stream = out.stream
self.default_lb = self.stream.line_buffering
self.default_errors = self.stream.errors
self.encoding = self.stream.encoding
def test_line_buffering_on(self):
ap = autopage.AutoPager(self.stream, line_buffering=True)
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertTrue(ap._out.line_buffering)
self.assertEqual(self.default_errors, ap._out.errors)
self.assertEqual(self.encoding, ap._out.encoding)
self.assertIs(True, ap._line_buffering())
self.assertEqual(self.default_errors, ap._errors())
def test_line_buffering_off(self):
ap = autopage.AutoPager(self.stream, line_buffering=False)
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertFalse(ap._out.line_buffering)
self.assertEqual(self.default_errors, ap._out.errors)
self.assertEqual(self.encoding, ap._out.encoding)
self.assertIs(False, ap._line_buffering())
self.assertEqual(self.default_errors, ap._errors())
def test_stdout_line_buffering_on(self):
with fixtures.MonkeyPatch('sys.stdout', self.stream):
ap = autopage.AutoPager(line_buffering=True)
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertTrue(sys.stdout.line_buffering)
self.assertEqual(self.default_errors, sys.stdout.errors)
self.assertEqual(self.encoding, sys.stdout.encoding)
def test_errors(self):
ap = autopage.AutoPager(self.stream,
errors=autopage.ErrorStrategy.NAME_REPLACE)
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertEqual(self.default_lb, ap._out.line_buffering)
self.assertEqual('namereplace', ap._out.errors)
self.assertNotEqual(self.default_errors, ap._out.errors)
self.assertEqual(self.encoding, ap._out.encoding)
self.assertEqual('namereplace', ap._errors())
self.assertEqual(self.default_lb, ap._line_buffering())
def test_errors_string(self):
ap = autopage.AutoPager(self.stream,
errors='namereplace')
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertEqual(self.default_lb, ap._out.line_buffering)
self.assertEqual('namereplace', ap._out.errors)
self.assertNotEqual(self.default_errors, ap._out.errors)
self.assertEqual(self.encoding, ap._out.encoding)
self.assertEqual('namereplace', ap._errors())
self.assertEqual(self.default_lb, ap._line_buffering())
def test_errors_bogus_string(self):
self.assertRaises(ValueError,
autopage.AutoPager,
self.stream, errors='panic')
def test_line_buffering_on_errors(self):
ap = autopage.AutoPager(self.stream,
line_buffering=True,
errors=autopage.ErrorStrategy.NAME_REPLACE)
ap._reconfigure_output_stream()
self.addCleanup(ap._out.close)
self.assertTrue(ap._out.line_buffering)
self.assertEqual('namereplace', ap._out.errors)
self.assertNotEqual(self.default_errors, ap._out.errors)
self.assertEqual(self.encoding, ap._out.encoding)
self.assertIs(True, ap._line_buffering())
self.assertEqual('namereplace', ap._errors())
|
