pytest-lsp 0.0.6

Pytest plugin for end-to-end testing of language servers

pytest-lsp: End-to-end testing of language servers with pytest

This plugin is in very early development, it currently implements just enough to support the test suite of the esbonio language server.

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.

import sys
import pytest
import pytest_lsp
from pytest_lsp import ClientServerConfig


@pytest_lsp.fixture(
    scope='session', 
    config=ClientServerConfig(
        server_command=[sys.executable, "-m", "esbonio"],
        root_uri="file:///path/to/test/project/root/"
    ),
)
async def client():
    pass  


@pytest.mark.asyncio
async def test_completion(client):
    test_uri="file:///path/to/test/project/root/test_file.rst"
    result = await client.completion_request(test_uri, line=5, character=23)

    assert len(result.items) > 0