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
|
#!/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 10091 2025-04-17 12:21:36Z milde $
"""
Test module for the command line interface.
"""
import difflib
from io import StringIO
import locale
from pathlib import Path
import os
import re
import sys
import unittest
if __name__ == '__main__':
# prepend the "docutils root" to the Python library path
# so we import the local `docutils` package.
sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
from docutils import __main__, core
# DATA_ROOT is ./test/data/ from the docutils root
DATA_ROOT = Path(__file__).parent / 'data'
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
# restore default locale settings:
if sys.platform != "win32":
locale.setlocale(locale.LC_MESSAGES, 'C')
locale.setlocale(locale.LC_TIME, 'C')
def get_help_text(self, prog, entry_point):
# call entry_point function and collect help text
sys.argv = [prog, '--help']
try:
entry_point()
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(
'error output. Default: '
f'{core.OptionParser.default_error_encoding}',
'error output. Default: utf-8')
return output
def test_main_help(self):
# collect help text
output = self.get_help_text('docutils', __main__.main)
# compare to stored version
docutils_txt = os.path.join(DATA_ROOT, 'help/docutils.rst')
expected = Path(docutils_txt).read_text(encoding='utf-8')
if expected != output:
print_mismatch(expected, output)
def test_rst2html_help(self):
# collect help text
output = self.get_help_text('rst2html', core.rst2html)
# compare to stored version
rst2html_txt = os.path.join(DATA_ROOT, 'help/rst2html.rst')
expected = Path(rst2html_txt).read_text(encoding='utf-8')
if expected != output:
print_mismatch(expected, output)
def test_rst2latex_help(self):
# collect help text
output = self.get_help_text('rst2latex', core.rst2latex)
# compare to stored version
rst2latex_txt = os.path.join(DATA_ROOT, 'help/rst2latex.rst')
expected = Path(rst2latex_txt).read_text(encoding='utf-8')
if expected != output:
print_mismatch(expected, output)
if __name__ == '__main__':
unittest.main()
|
