forked from jxmorris12/language_tool_python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_cli.py
More file actions
171 lines (146 loc) · 5.13 KB
/
Copy pathtest_cli.py
File metadata and controls
171 lines (146 loc) · 5.13 KB
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
"""Integration tests for the CLI using real LanguageTool server instances."""
import io
import sys
from collections.abc import Generator
import pytest
import language_tool_python
from language_tool_python.__main__ import main
def main_with_stdin(argv: list[str], stdin: str) -> int:
"""Execute the main CLI with simulated stdin input.
:param argv: Command-line arguments to pass to the main function.
:param stdin: Input text to simulate as stdin.
:return: Exit code returned by the main function.
:rtype: int
"""
old_stdin = sys.stdin
sys.stdin = io.StringIO(stdin)
try:
return main(argv)
finally:
sys.stdin = old_stdin
@pytest.fixture(scope="module")
def remote_server() -> Generator[tuple[str, int], None, None]:
"""Fixture that provides a remote LanguageTool server for testing.
This fixture initializes a LanguageTool instance and yields its host and port,
ensuring proper cleanup after all tests in the module complete.
:return: A tuple containing the server host and port (host, port).
:rtype: Generator[Tuple[str, int], None, None]
"""
with language_tool_python.LanguageTool("en-US") as tool:
yield tool.host, tool.port
@pytest.mark.parametrize(
("argv", "stdin", "should_succeed"),
[
(["-l", "en-US", "-"], "This is okay.\n", True),
(["-l", "en-US", "-"], "This is noot okay.\n", False),
(
["-l", "en-US", "--enabled-only", "--enable=MORFOLOGIK_RULE_EN_US", "-"],
"This is okay.\n",
True,
),
(
["-l", "en-US", "--enabled-only", "--enable=MORFOLOGIK_RULE_EN_US", "-"],
"This is noot okay.\n",
False,
),
(["-l", "en-US", "-"], "These are “smart” quotes.\n", True),
(["-l", "en-US", "-"], 'These are "dumb" quotes.\n', True),
(
["-l", "en-US", "--enabled-only", "--enable=EN_QUOTES", "-"],
'These are "dumb" quotes.\n',
True,
),
(
["-l", "en-US", "--enabled-only", "--enable=EN_UNPAIRED_BRACKETS", "-"],
'These are "dumb" quotes.\n',
True,
),
(["-l", "en-US", "--ignore-lines=^#", "-"], '# These are "dumb".\n', True),
(
["-l", "en-US", "-D", "TYPOS", "-"],
"This is noot okay.\n",
True,
),
(
["-l", "en-US", "--disable-categories=TYPOS", "-"],
"This is noot okay.\n",
True,
),
(
["-l", "en-US", "-E", "TYPOS", "-"],
"This is okay.\n",
True,
),
(
["-l", "en-US", "--enabled-only", "-E", "TYPOS", "-"],
"This is noot okay.\n",
False,
),
(
["-l", "en-US", "--enabled-only", "-E", "TYPOS", "-"],
"This is okay.\n",
True,
),
],
)
def test_cli_exit_codes(
argv: list[str],
stdin: str,
should_succeed: bool,
) -> None:
"""Test the CLI exit codes with various command-line arguments and inputs.
This test verifies that the command-line interface returns the correct exit codes (0
for success, non-zero for errors) based on different configurations and input texts.
:param argv: Command-line arguments to pass to the CLI.
:param stdin: Input text to be checked for errors.
:param should_succeed: Expected outcome (True if no errors expected, False
otherwise).
:raises AssertionError: If the exit code does not match the expected outcome.
"""
code = main_with_stdin(argv, stdin)
if should_succeed:
assert code == 0
else:
assert code != 0
def test_cli_remote_ok(remote_server: tuple[str, int]) -> None:
"""Test the CLI with a remote server using valid input text.
This test verifies that the CLI correctly communicates with a remote LanguageTool
server and returns a success exit code when the input text contains no errors.
:param remote_server: Tuple containing the remote server host and port.
:raises AssertionError: If the exit code is not 0 (success).
"""
host, port = remote_server
code = main_with_stdin(
[
"-l",
"en-US",
"--remote-host",
host,
"--remote-port",
str(port),
"-",
],
"This is okay.\n",
)
assert code == 0
def test_cli_remote_error(remote_server: tuple[str, int]) -> None:
"""Test the CLI with a remote server using text containing errors.
This test verifies that the CLI correctly communicates with a remote LanguageTool
server and returns a non-zero exit code when the input text contains errors.
:param remote_server: Tuple containing the remote server host and port.
:raises AssertionError: If the exit code is 0 (should be non-zero for errors).
"""
host, port = remote_server
code = main_with_stdin(
[
"-l",
"en-US",
"--remote-host",
host,
"--remote-port",
str(port),
"-",
],
"This is noot okay.\n",
)
assert code != 0