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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
|
# Copyright 2017 Palantir Technologies, Inc.
import os
import pathlib
import pytest
from pylsp import uris
DOC_URI = uris.from_fs_path(__file__)
NOTEBOOK_URI = uris.from_fs_path("notebook_uri")
def path_as_uri(path):
return pathlib.Path(os.path.abspath(path)).as_uri()
def test_local(pylsp) -> None:
"""Since the workspace points to the test directory"""
assert pylsp.workspace.is_local()
def test_put_document(pylsp) -> None:
pylsp.workspace.put_document(DOC_URI, "content")
assert DOC_URI in pylsp.workspace._docs
def test_put_notebook_document(pylsp) -> None:
pylsp.workspace.put_notebook_document(DOC_URI, "jupyter-notebook", [])
assert DOC_URI in pylsp.workspace._docs
def test_put_cell_document(pylsp) -> None:
pylsp.workspace.put_cell_document(DOC_URI, NOTEBOOK_URI, "python", "content")
assert DOC_URI in pylsp.workspace._docs
def test_get_document(pylsp) -> None:
pylsp.workspace.put_document(DOC_URI, "TEXT")
assert pylsp.workspace.get_document(DOC_URI).source == "TEXT"
def test_get_missing_document(tmpdir, pylsp) -> None:
source = "TEXT"
doc_path = tmpdir.join("test_document.py")
doc_path.write(source)
doc_uri = uris.from_fs_path(str(doc_path))
assert pylsp.workspace.get_document(doc_uri).source == "TEXT"
def test_rm_document(pylsp) -> None:
pylsp.workspace.put_document(DOC_URI, "TEXT")
assert pylsp.workspace.get_document(DOC_URI).source == "TEXT"
pylsp.workspace.rm_document(DOC_URI)
assert pylsp.workspace.get_document(DOC_URI)._source is None
@pytest.mark.parametrize(
"metafiles", [("setup.py",), ("pyproject.toml",), ("setup.py", "pyproject.toml")]
)
def test_non_root_project(pylsp, metafiles) -> None:
repo_root = os.path.join(pylsp.workspace.root_path, "repo-root")
os.mkdir(repo_root)
project_root = os.path.join(repo_root, "project-root")
os.mkdir(project_root)
for metafile in metafiles:
with open(os.path.join(project_root, metafile), "w+", encoding="utf-8") as f:
f.write("# " + metafile)
test_uri = uris.from_fs_path(os.path.join(project_root, "hello/test.py"))
pylsp.workspace.put_document(test_uri, "assert True")
test_doc = pylsp.workspace.get_document(test_uri)
assert project_root in test_doc.sys_path()
def test_root_project_with_no_setup_py(pylsp) -> None:
"""Default to workspace root."""
workspace_root = pylsp.workspace.root_path
test_uri = uris.from_fs_path(os.path.join(workspace_root, "hello/test.py"))
pylsp.workspace.put_document(test_uri, "assert True")
test_doc = pylsp.workspace.get_document(test_uri)
assert workspace_root in test_doc.sys_path()
def test_multiple_workspaces_from_initialize(pylsp_w_workspace_folders) -> None:
pylsp, workspace_folders = pylsp_w_workspace_folders
assert len(pylsp.workspaces) == 2
folders_uris = [uris.from_fs_path(str(folder)) for folder in workspace_folders]
for folder_uri in folders_uris:
assert folder_uri in pylsp.workspaces
assert folders_uris[0] == pylsp.root_uri
# Create file in the first workspace folder.
file1 = workspace_folders[0].join("file1.py")
file1.write("import os")
msg1 = {"uri": path_as_uri(str(file1)), "version": 1, "text": "import os"}
pylsp.m_text_document__did_open(textDocument=msg1)
assert msg1["uri"] in pylsp.workspace._docs
assert msg1["uri"] in pylsp.workspaces[folders_uris[0]]._docs
# Create file in the second workspace folder.
file2 = workspace_folders[1].join("file2.py")
file2.write("import sys")
msg2 = {"uri": path_as_uri(str(file2)), "version": 1, "text": "import sys"}
pylsp.m_text_document__did_open(textDocument=msg2)
assert msg2["uri"] not in pylsp.workspace._docs
assert msg2["uri"] in pylsp.workspaces[folders_uris[1]]._docs
def test_multiple_workspaces(tmpdir, pylsp) -> None:
workspace1_dir = tmpdir.mkdir("workspace1")
workspace2_dir = tmpdir.mkdir("workspace2")
file1 = workspace1_dir.join("file1.py")
file2 = workspace2_dir.join("file1.py")
file1.write("import os")
file2.write("import sys")
msg = {"uri": path_as_uri(str(file1)), "version": 1, "text": "import os"}
pylsp.m_text_document__did_open(textDocument=msg)
assert msg["uri"] in pylsp.workspace._docs
added_workspaces = [
{"uri": path_as_uri(str(x))} for x in (workspace1_dir, workspace2_dir)
]
event = {"added": added_workspaces, "removed": []}
pylsp.m_workspace__did_change_workspace_folders(event)
for workspace in added_workspaces:
assert workspace["uri"] in pylsp.workspaces
workspace1_uri = added_workspaces[0]["uri"]
assert msg["uri"] not in pylsp.workspace._docs
assert msg["uri"] in pylsp.workspaces[workspace1_uri]._docs
msg = {"uri": path_as_uri(str(file2)), "version": 1, "text": "import sys"}
pylsp.m_text_document__did_open(textDocument=msg)
workspace2_uri = added_workspaces[1]["uri"]
assert msg["uri"] in pylsp.workspaces[workspace2_uri]._docs
event = {"added": [], "removed": [added_workspaces[0]]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert workspace1_uri not in pylsp.workspaces
def test_multiple_workspaces_wrong_removed_uri(pylsp, tmpdir) -> None:
workspace = {"uri": str(tmpdir.mkdir("Test123"))}
event = {"added": [], "removed": [workspace]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert workspace["uri"] not in pylsp.workspaces
def test_root_workspace_changed(pylsp, tmpdir) -> None:
test_uri = str(tmpdir.mkdir("Test123"))
pylsp.root_uri = test_uri
pylsp.workspace._root_uri = test_uri
workspace1 = {"uri": test_uri}
workspace2 = {"uri": str(tmpdir.mkdir("NewTest456"))}
event = {"added": [workspace2], "removed": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert workspace2["uri"] == pylsp.workspace._root_uri
assert workspace2["uri"] == pylsp.root_uri
def test_root_workspace_not_changed(pylsp, tmpdir) -> None:
# removed uri != root_uri
test_uri_1 = str(tmpdir.mkdir("Test12"))
pylsp.root_uri = test_uri_1
pylsp.workspace._root_uri = test_uri_1
workspace1 = {"uri": str(tmpdir.mkdir("Test1234"))}
workspace2 = {"uri": str(tmpdir.mkdir("NewTest456"))}
event = {"added": [workspace2], "removed": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert test_uri_1 == pylsp.workspace._root_uri
assert test_uri_1 == pylsp.root_uri
# empty 'added' list
test_uri_2 = str(tmpdir.mkdir("Test123"))
new_root_uri = workspace2["uri"]
pylsp.root_uri = test_uri_2
pylsp.workspace._root_uri = test_uri_2
workspace1 = {"uri": test_uri_2}
event = {"added": [], "removed": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert new_root_uri == pylsp.workspace._root_uri
assert new_root_uri == pylsp.root_uri
# empty 'removed' list
event = {"added": [workspace1], "removed": []}
pylsp.m_workspace__did_change_workspace_folders(event)
assert new_root_uri == pylsp.workspace._root_uri
assert new_root_uri == pylsp.root_uri
# 'added' list has no 'uri'
workspace2 = {"TESTuri": "Test1234"}
event = {"added": [workspace2], "removed": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
assert new_root_uri == pylsp.workspace._root_uri
assert new_root_uri == pylsp.root_uri
def test_root_workspace_removed(tmpdir, pylsp) -> None:
workspace1_dir = tmpdir.mkdir("workspace1")
workspace2_dir = tmpdir.mkdir("workspace2")
root_uri = pylsp.root_uri
# Add workspaces to the pylsp
added_workspaces = [
{"uri": path_as_uri(str(x))} for x in (workspace1_dir, workspace2_dir)
]
event = {"added": added_workspaces, "removed": []}
pylsp.m_workspace__did_change_workspace_folders(event)
# Remove the root workspace
removed_workspaces = [{"uri": root_uri}]
event = {"added": [], "removed": removed_workspaces}
pylsp.m_workspace__did_change_workspace_folders(event)
# Assert that the first of the workspaces (in alphabetical order) is now
# the root workspace
assert pylsp.root_uri == path_as_uri(str(workspace1_dir))
assert pylsp.workspace._root_uri == path_as_uri(str(workspace1_dir))
@pytest.mark.skipif(os.name == "nt", reason="Fails on Windows")
def test_workspace_loads_pycodestyle_config(pylsp, tmpdir) -> None:
workspace1_dir = tmpdir.mkdir("Test123")
pylsp.root_uri = str(workspace1_dir)
pylsp.workspace._root_uri = str(workspace1_dir)
# Test that project settings are loaded
workspace2_dir = tmpdir.mkdir("NewTest456")
cfg = workspace2_dir.join("pycodestyle.cfg")
cfg.write("[pycodestyle]\n" "max-line-length = 1000")
workspace1 = {"uri": str(workspace1_dir)}
workspace2 = {"uri": str(workspace2_dir)}
event = {"added": [workspace2], "removed": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
seetings = pylsp.workspaces[str(workspace2_dir)]._config.settings()
assert seetings["plugins"]["pycodestyle"]["maxLineLength"] == 1000
# Test that project settings prevail over server ones.
server_settings = {"pylsp": {"plugins": {"pycodestyle": {"maxLineLength": 10}}}}
pylsp.m_workspace__did_change_configuration(server_settings)
assert seetings["plugins"]["pycodestyle"]["maxLineLength"] == 1000
# Test switching to another workspace with different settings
workspace3_dir = tmpdir.mkdir("NewTest789")
cfg1 = workspace3_dir.join("pycodestyle.cfg")
cfg1.write("[pycodestyle]\n" "max-line-length = 20")
workspace3 = {"uri": str(workspace3_dir)}
event = {"added": [workspace3], "removed": [workspace2]}
pylsp.m_workspace__did_change_workspace_folders(event)
seetings = pylsp.workspaces[str(workspace3_dir)]._config.settings()
assert seetings["plugins"]["pycodestyle"]["maxLineLength"] == 20
def test_settings_of_added_workspace(pylsp, tmpdir) -> None:
test_uri = str(tmpdir.mkdir("Test123"))
pylsp.root_uri = test_uri
pylsp.workspace._root_uri = test_uri
# Set some settings for the server.
server_settings = {
"pylsp": {"plugins": {"jedi": {"environment": "/usr/bin/python3"}}}
}
pylsp.m_workspace__did_change_configuration(server_settings)
# Create a new workspace.
workspace1 = {"uri": str(tmpdir.mkdir("NewTest456"))}
event = {"added": [workspace1]}
pylsp.m_workspace__did_change_workspace_folders(event)
# Assert settings are inherited from the server config.
workspace1_object = pylsp.workspaces[workspace1["uri"]]
workspace1_jedi_settings = workspace1_object._config.plugin_settings("jedi")
assert workspace1_jedi_settings == server_settings["pylsp"]["plugins"]["jedi"]
def test_no_progress_without_capability(workspace, consumer) -> None:
workspace._config.capabilities["window"] = {"workDoneProgress": False}
with workspace.report_progress("some_title"):
pass
assert len(consumer.call_args_list) == 0
def test_progress_simple(workspace, consumer) -> None:
workspace._config.capabilities["window"] = {"workDoneProgress": True}
with workspace.report_progress("some_title"):
pass
init_call, *progress_calls = consumer.call_args_list
assert init_call[0][0]["method"] == "window/workDoneProgress/create"
# same method for all calls
assert all(
call[0][0]["method"] == "$/progress" for call in progress_calls
), consumer.call_args_list
# same token used in all calls
assert (
len(
{call[0][0]["params"]["token"] for call in progress_calls}
| {init_call[0][0]["params"]["token"]}
)
== 1
)
assert [call[0][0]["params"]["value"] for call in progress_calls] == [
{"kind": "begin", "title": "some_title"},
{"kind": "end"},
]
@pytest.mark.parametrize("exc", [Exception("something"), TimeoutError()])
def test_progress_initialization_fails_but_is_skipped(
workspace, consumer, endpoint, exc
) -> None:
def failing_token_initialization(self, *_args, **_kwargs):
raise exc
endpoint._dispatcher.m_window__work_done_progress__create = (
failing_token_initialization
)
workspace._config.capabilities["window"] = {"workDoneProgress": True}
with workspace.report_progress("some_title", skip_token_initialization=True):
pass
# we only see the failing token initialization call, no other calls
progress_calls = consumer.call_args_list
assert all(call[0][0]["method"] == "$/progress" for call in progress_calls)
assert len({call[0][0]["params"]["token"] for call in progress_calls}) == 1
assert [call[0][0]["params"]["value"] for call in progress_calls] == [
{"kind": "begin", "title": "some_title"},
{"kind": "end"},
]
def test_progress_with_percent(workspace, consumer) -> None:
workspace._config.capabilities["window"] = {"workDoneProgress": True}
with workspace.report_progress(
"some_title", "initial message", percentage=1
) as progress_message:
progress_message("ten", 10)
progress_message("fifty", 50)
progress_message("ninety", 90)
init_call, *progress_calls = consumer.call_args_list
assert init_call[0][0]["method"] == "window/workDoneProgress/create"
# same method for all progress calls
assert all(call[0][0]["method"] == "$/progress" for call in progress_calls)
# same token used in all calls
assert (
len(
{call[0][0]["params"]["token"] for call in progress_calls}
| {init_call[0][0]["params"]["token"]}
)
== 1
)
assert [call[0][0]["params"]["value"] for call in progress_calls] == [
{
"kind": "begin",
"message": "initial message",
"percentage": 1,
"title": "some_title",
},
{"kind": "report", "message": "ten", "percentage": 10},
{"kind": "report", "message": "fifty", "percentage": 50},
{"kind": "report", "message": "ninety", "percentage": 90},
{"kind": "end"},
]
def test_progress_with_exception(workspace, consumer) -> None:
workspace._config.capabilities["window"] = {"workDoneProgress": True}
class DummyError(Exception):
pass
try:
with workspace.report_progress("some_title"):
raise DummyError("something")
except DummyError:
# we're using a specific exception class here so
# any other exceptions happening in progress
# reporting would correctly be raised in the
# test.
pass
init_call, *progress_calls = consumer.call_args_list
assert init_call[0][0]["method"] == "window/workDoneProgress/create"
# same method for all calls
assert all(call[0][0]["method"] == "$/progress" for call in progress_calls)
# same token used in all calls
assert (
len(
{call[0][0]["params"]["token"] for call in progress_calls}
| {init_call[0][0]["params"]["token"]}
)
== 1
)
assert [call[0][0]["params"]["value"] for call in progress_calls] == [
{"kind": "begin", "title": "some_title"},
{"kind": "end"},
]
|