A pytest plugin for end-to-end testing of language servers
Project description
pytest-lsp: End-to-end testing of language servers with pytest
pytest-lsp
is a pytest plugin for writing end-to-end tests for language servers.
It works by running the language server in a subprocess and communicating with it over stdio, just like a real language client.
This also means pytest-lsp
can be used to test language servers written in any language - not just Python.
pytest-lsp
relies on the pygls
library for its language server protocol implementation.
See the documentation for details on getting started.
import sys
import pytest_lsp
from lsprotocol.types import (
CompletionParams,
InitializeParams,
Position,
TextDocumentIdentifier,
)
from pytest_lsp import (
ClientServerConfig,
LanguageClient,
client_capabilities,
)
@pytest_lsp.fixture(
config=ClientServerConfig(
server_command=[sys.executable, "-m", "esbonio"],
),
)
async def client(lsp_client: LanguageClient):
# Setup
response = await lsp_client.initialize_session(
InitializeParams(
capabilities=client_capabilities("visual-studio-code"),
root_uri="file:///path/to/test/project/root/",
)
)
yield
# Teardown
await lsp_client.shutdown_session()
async def test_completion(client: LanguageClient):
result = await client.text_document_completion_async(
params=CompletionParams(
position=Position(line=5, character=23),
text_document=TextDocumentIdentifier(
uri="file:///path/to/test/project/root/test_file.rst"
),
)
)
assert len(result.items) > 0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pytest_lsp-0.4.2.tar.gz
(26.0 kB
view hashes)
Built Distribution
pytest_lsp-0.4.2-py3-none-any.whl
(24.0 kB
view hashes)
Close
Hashes for pytest_lsp-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94d4f36cf8629da5ab7616b434beca07c542e0938ec3ad9dc171f2e7e0dfd1fc |
|
MD5 | 0c3cc62ab72f814b06522a3a56342c51 |
|
BLAKE2b-256 | 2c47d266cc1bf279a5efbd5edd7a2125ddbaef858ab3d13cdb94558ce1c0dd50 |