forked from microsoft/vscode-autopep8
/
test_formatting.py
264 lines (222 loc) · 8.7 KB
/
test_formatting.py
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
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
"""
Test for formatting over LSP.
"""
import pathlib
from hamcrest import assert_that, is_
from .lsp_test_client import constants, defaults, session, utils
FORMATTER = utils.get_server_info_defaults()
TIMEOUT = 10000 # 10 seconds
def test_formatting():
"""Test formatting a python file."""
FORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample1" / "sample.py"
UNFORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample1" / "sample.unformatted"
contents = UNFORMATTED_TEST_FILE_PATH.read_text()
lines = contents.splitlines(keepends=False)
actual = []
with utils.python_file(contents, UNFORMATTED_TEST_FILE_PATH.parent) as pf:
uri = utils.as_uri(str(pf))
with session.LspSession() as ls_session:
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": contents,
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by autopep8
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": len(lines), "character": 0},
},
"newText": FORMATTED_TEST_FILE_PATH.read_text(),
}
]
assert_that(actual, is_(expected))
def test_formatting_cell():
"""Test formating a python file."""
FORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample2" / "sample.formatted"
UNFORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample2" / "sample.unformatted"
contents = UNFORMATTED_TEST_FILE_PATH.read_text()
lines = contents.splitlines(keepends=False)
actual = []
# generate a fake cell uri
uri = (
utils.as_uri(UNFORMATTED_TEST_FILE_PATH.parent / "sample.ipynb").replace(
"file:", "vscode-notebook-cell:"
)
+ "#C00001"
)
with session.LspSession() as ls_session:
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": contents,
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by autopep8
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": len(lines), "character": 0},
},
"newText": FORMATTED_TEST_FILE_PATH.read_text(),
}
]
assert_that(actual, is_(expected))
def test_skipping_site_packages_files():
"""Test skipping formatting when the file is in site-packages"""
UNFORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample1" / "sample.unformatted"
with session.LspSession() as ls_session:
# Use any stdlib path here
uri = utils.as_uri(pathlib.__file__)
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": UNFORMATTED_TEST_FILE_PATH.read_text(encoding="utf-8"),
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by black
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = None
assert_that(actual, is_(expected))
def test_skipping_excluded_files():
"""Test skipping formatting when the file is in excluded pattern"""
UNFORMATTED_EXCLUDED_FILE_PATH = constants.TEST_DATA / "sample3" / "sample.unformatted"
with session.LspSession() as ls_session:
# Use any stdlib path here
uri = utils.as_uri(pathlib.__file__)
init_options = defaults.VSCODE_DEFAULT_INITIALIZE["initializationOptions"]
init_options["settings"][0]["args"] = ["--exclude='**/*.py'"]
ls_session.initialize(defaults.VSCODE_DEFAULT_INITIALIZE)
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": UNFORMATTED_EXCLUDED_FILE_PATH.read_text(encoding="utf-8"),
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by black
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = None
assert_that(actual, is_(expected))
def test_formatting_file_not_in_excluded_files():
"""Test formatting when the file is not in excluded pattern"""
FORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample4" / "sample.py"
UNFORMATTED_INCLUDED_FILE_PATH = constants.TEST_DATA / "sample4" / "sample.included.unformatted"
with session.LspSession() as ls_session:
# Use any stdlib path here
uri = utils.as_uri(pathlib.__file__)
init_options = defaults.VSCODE_DEFAULT_INITIALIZE["initializationOptions"]
init_options["settings"][0]["args"] = ["--exclude='**/*exclude'"]
ls_session.initialize(defaults.VSCODE_DEFAULT_INITIALIZE)
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": UNFORMATTED_INCLUDED_FILE_PATH.read_text(encoding="utf-8"),
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by black
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": len(lines), "character": 0},
},
"newText": FORMATTED_TEST_FILE_PATH.read_text(),
}
]
assert_that(actual, is_(expected))
def test_formatting_file_with_excluded_and_other_args():
"""Test formatting when we have more arguments specified"""
FORMATTED_TEST_FILE_PATH = constants.TEST_DATA / "sample4" / "sample.py"
UNFORMATTED_INCLUDED_FILE_PATH = constants.TEST_DATA / "sample4" / "sample.included.unformatted"
with session.LspSession() as ls_session:
# Use any stdlib path here
uri = utils.as_uri(pathlib.__file__)
init_options = defaults.VSCODE_DEFAULT_INITIALIZE["initializationOptions"]
init_options["settings"][0]["args"] = ["--exclude='**/*exclude'", "--aggressive"]
ls_session.initialize(defaults.VSCODE_DEFAULT_INITIALIZE)
ls_session.initialize()
ls_session.notify_did_open(
{
"textDocument": {
"uri": uri,
"languageId": "python",
"version": 1,
"text": UNFORMATTED_INCLUDED_FILE_PATH.read_text(encoding="utf-8"),
}
}
)
actual = ls_session.text_document_formatting(
{
"textDocument": {"uri": uri},
# `options` is not used by black
"options": {"tabSize": 4, "insertSpaces": True},
}
)
expected = [
{
"range": {
"start": {"line": 0, "character": 0},
"end": {"line": len(lines), "character": 0},
},
"newText": FORMATTED_TEST_FILE_PATH.read_text(),
}
]
assert_that(actual, is_(expected))