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
|
#!/usr/bin/env python3
# :Copyright: © 2022 Günter Milde.
# :License: Released under the terms of the `2-Clause BSD license`_, in short:
#
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.
# This file is offered as-is, without any warranty.
#
# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause
# :Id: $Id: test_CLI.py 9072 2022-06-15 11:31:09Z milde $
"""
Test module for the command line interface.
"""
import difflib
from io import StringIO
import locale
import os
import re
import sys
import unittest
# import docutils
from docutils import __main__, frontend
def print_mismatch(expected, output):
diff = ''.join(difflib.unified_diff(
expected.splitlines(keepends=True),
output.splitlines(keepends=True),
'expected', 'output'))
raise AssertionError('Unexpected output:\n'+diff)
class CliTests(unittest.TestCase):
def setUp(self):
# save state
self.orig_argv = sys.argv
self.orig_stdout = sys.stdout
os.environ['DOCUTILSCONFIG'] = '' # don't read config files
sys.stdout = StringIO() # re-direct sys.stdout
def tearDown(self):
del(os.environ['DOCUTILSCONFIG'])
sys.stdout = self.orig_stdout
sys.argv = self.orig_argv
locale.setlocale(locale.LC_ALL, 'C') # restore default (C) locale
def test_main_help(self):
# collect help text
sys.argv = ['docutils', '--help']
try:
__main__.main()
except SystemExit:
pass
output = sys.stdout.getvalue()
# replace unpredictable paths (eventually wrapped)
output = re.sub(r'default:[^)]*[/\\][^)]*\)', 'default: [...])',
output, flags=re.DOTALL)
# normalise error encoding default
output = output.replace(
f'{frontend.OptionParser.default_error_encoding}:backslashreplace',
'utf-8:backslashreplace')
# compare to stored version
with open('data/help/docutils.txt', encoding='utf-8') as samplefile:
expected = samplefile.read()
if expected != output:
print_mismatch(expected, output)
if __name__ == '__main__':
unittest.main()
|
