Merge branch 'topic/pylsp' into 'master'

Move more pylsp helpers to class methods for convenience

See merge request eng/ide/ada_language_server!1852

Author: eliericha

.gitignore

@@ -79,6 +79,7 @@ celerybeat-schedule
 .env
 
 # virtualenv
+.venv/
 venv/
 ENV/
 
@@ -103,4 +104,6 @@ testsuite/.als/inout.txt
 # Temporary testsuite's files and directories
 testsuite/ada_lsp/project_symlinks/link
 
-out
+# Temporary and output directories of e3-testsuite
+tmp/
+out/

testsuite/ada_lsp/called_by/test.py

@@ -1,52 +1,43 @@
-from drivers.lsp_python_driver import LSP, complex_test
-from drivers.lsp_ada_requests import (
-    didOpen_from_disk,
-    prepareCallHierarchy,
-    incomingCalls,
-    initialize,
-    initialized,
-    didChangeConfiguration,
-)
 import os
 
+from drivers.pylsp import URI, ALSLanguageClient, test
+from lsprotocol.types import ClientCapabilities, InitializedParams, InitializeParams
 
-# Use a complex_test rather than a simple_test
-# so we can inspect the results of initialize()
-@complex_test
-def test_called_by(wd) -> list[str] | None:
-    program = os.environ.get("ALS", "ada_language_server")
-    lsp = LSP(program, wd)
+
+# Use initialize=False so we can inspect the results of the initialize request
+@test(initialize=False)
+async def test_called_by(lsp: ALSLanguageClient) -> None:
     # Send the initialize request
-    response = lsp.send(initialize())
+    response = await lsp.initialize_session(
+        InitializeParams(ClientCapabilities(), root_uri=URI(os.getcwd()))
+    )
     # Verify that the right capability is advertised
-    response.assertField("capabilities.callHierarchyProvider", True)
+    lsp.assertEqual(response.capabilities.call_hierarchy_provider, True)
 
     # Send the initialized notification and the didChangeConfiguration notification
-    lsp.send(initialized())
-    lsp.send(didChangeConfiguration())
-    # Send a didOpen for main.adb
-    main_adb = os.path.join(wd, "main.adb")
-    p_adb = os.path.join(wd, "p.adb")
+    lsp.initialized(InitializedParams())
+    lsp.didChangeConfig({})
 
-    lsp.send(didOpen_from_disk(main_adb))
+    # Send a didOpen for main.adb
+    main_adb = lsp.didOpenFile("main.adb")
 
     # Send a textDocument/prepareCallHierarchy request
-    response = lsp.send(prepareCallHierarchy(main_adb, 3, 44))
-    response.assertLocationsList([("p.adb", 2)])
+    res1 = await lsp.prepareCallHierarchy(main_adb, 3, 44)
+    lsp.assertLocationsList(res1, [("p.adb", 2)])
 
     # Now send the callHierarchy/incomingCalls request
-    response = lsp.send(incomingCalls(p_adb, 2, 14))
+    p_adb = URI("p.adb")
+    res2 = await lsp.callHierarchyIncomingCalls(p_adb, 2, 14)
 
     # Expect these locations
-    response.assertLocationsList(
+    lsp.assertLocationsList(
+        res2,
         [
             ("main.adb", 10),
             ("main.adb", 14),
             ("p.adb", 2),
             ("main.adb", 2),
             ("p.ads", 1),
             ("p.adb", 8),
-        ]
+        ],
     )
-    lsp.shutdown()
-    return []

testsuite/ada_lsp/called_by/test.yaml

@@ -1,2 +1 @@
-title: 'called_by'
-driver: python
+driver: pylsp

testsuite/ada_lsp/called_by_dispatching/test.py

@@ -4,17 +4,15 @@
     URI,
     ALSLanguageClient,
     assertLocationsList,
-    didOpenTextDocumentParams,
     test,
 )
 
 
 @test()
 async def test_called_by(lsp: ALSLanguageClient):
     # Send a didOpen for main.adb
-    open_params, main_adb_uri = didOpenTextDocumentParams("main.adb")
+    main_adb_uri = lsp.didOpenFile("main.adb")
     root_ads_uri = URI("root.ads")
-    lsp.text_document_did_open(open_params)
 
     # Send a textDocument/prepareCallHierarchy request
     result1 = await lsp.prepareCallHierarchy(main_adb_uri, 7, 4)

testsuite/ada_lsp/formatting.errors_on_invalid_code/main.adb renamed to testsuite/ada_lsp/formatting_errors_on_invalid_code/main.adb

@@ -3,6 +3,8 @@
 return errors when the code is syntactically invalid.
 """
 
+import pygls.exceptions
+from drivers.pylsp import ALSLanguageClient, assertEqual, test
 from lsprotocol.types import (
     DidChangeConfigurationParams,
     DocumentFormattingParams,
@@ -12,20 +14,12 @@
     Range,
     TextDocumentIdentifier,
 )
-import pygls.exceptions
-from drivers.pylsp import (
-    ALSLanguageClient,
-    didOpenTextDocumentParams,
-    test,
-    assertEqual,
-)
 
 
 @test()
 async def test_called_by(lsp: ALSLanguageClient):
     # Send a didOpen for main.adb
-    open_params, main_adb_uri = didOpenTextDocumentParams("main.adb")
-    lsp.text_document_did_open(open_params)
+    main_adb_uri = lsp.didOpenFile("main.adb")
 
     # Test with GNATformat formatting backend
     lsp.workspace_did_change_configuration(

testsuite/ada_lsp/formatting.errors_on_invalid_code/p.gpr renamed to testsuite/ada_lsp/formatting_errors_on_invalid_code/p.gpr

@@ -10,35 +10,19 @@
 import sys
 import urllib
 import urllib.parse
-from pathlib import Path
-from typing import (
-    Any,
-    Awaitable,
-    Callable,
-    Literal,
-    Sequence,
-    Type,
-    TypedDict,
-)
 import uuid
 import warnings
+from pathlib import Path
+from typing import Any, Awaitable, Callable, Literal, Sequence, Type, TypedDict
 
 import attrs
 import lsprotocol.converters
 import lsprotocol.types
-from lsprotocol import types
-from pygls.client import JsonRPCClient
-from pygls.protocol import default_converter
-from pytest_lsp import (
-    ClientServerConfig,
-    LanguageClient,
-    LanguageClientProtocol,
-    LspSpecificationWarning,
-)
 from drivers import ALSTestDriver
 from e3.os.process import Run, command_line_image
 from e3.testsuite.driver.classic import ProcessResult, TestAbortWithFailure
 from e3.testsuite.result import TestStatus
+from lsprotocol import types
 from lsprotocol.types import (
     CallHierarchyIncomingCall,
     CallHierarchyIncomingCallsParams,
@@ -57,6 +41,14 @@
     TextDocumentItem,
     WorkDoneProgressEnd,
 )
+from pygls.client import JsonRPCClient
+from pygls.protocol import default_converter
+from pytest_lsp import (
+    ClientServerConfig,
+    LanguageClient,
+    LanguageClientProtocol,
+    LspSpecificationWarning,
+)
 
 LOG = logging.getLogger(__name__)
 logger = LOG
@@ -342,6 +334,21 @@ def didChangeConfig(self, settings: ALSSettings) -> None:
             DidChangeConfigurationParams(settings={"ada": settings})
         )
 
+    def didOpenFile(self, src_path: Path | str, language_id="ada", version=0) -> str:
+        """Send a textDocument/didOpen notification for a file on disk. The content of
+        the file is automatically read and sent in the notification. The URI is returned
+        for later use in other requests about the file.
+        """
+        uri = URI(src_path)
+
+        self.text_document_did_open(
+            DidOpenTextDocumentParams(
+                TextDocumentItem(uri, language_id, version, Path(src_path).read_text())
+            )
+        )
+
+        return uri
+
     def didOpenVirtual(
         self, uri: str | None = None, language_id="ada", version=0, text: str = ""
     ) -> str:
@@ -422,16 +429,42 @@ async def prepareCallHierarchy(
         self, uri: str, line_one_based: int, char_one_based: int
     ):
         return await self.text_document_prepare_call_hierarchy_async(
-            callHierarchyPrepareParams(uri, line_one_based, char_one_based)
+            CallHierarchyPrepareParams(
+                TextDocumentIdentifier(uri), Pos(line_one_based, char_one_based)
+            )
         )
 
     async def callHierarchyIncomingCalls(
-        self, uri: str, line_one_based: int, char_on_based: int
+        self, uri: str, line_one_based: int, char_one_based: int
     ):
+        rng = RangeZero(line_one_based, char_one_based)
         return await self.call_hierarchy_incoming_calls_async(
-            callHierarchyIncomingCallsParams(uri, line_one_based, char_on_based)
+            CallHierarchyIncomingCallsParams(
+                CallHierarchyItem(
+                    name="",
+                    kind=SymbolKind.Function,
+                    uri=uri,
+                    range=rng,
+                    selection_range=rng,
+                )
+            )
         )
 
+    def assertEqual(self, actual: Any, expected: Any) -> None:
+        """Raise an AssertionError if actual != expected."""
+        assertEqual(actual, expected)
+
+    def assertLocationsList(
+        self,
+        actual: Sequence[CallHierarchyItem | CallHierarchyIncomingCall],
+        expected: list[tuple[str, int]],
+    ) -> None:
+        """Assert the content of a list of results from a CallHierarchy or
+        CallHierarchyIncomingCall request. Expected results are given as a list of
+        (<basename>, <line-one-based>) tuples.
+        """
+        assertLocationsList(actual, expected)
+
 
 def als_client_factory() -> ALSLanguageClient:
     """This function is an ugly copy-paste of pytest_lsp.make_test_lsp_client. It is
@@ -750,16 +783,6 @@ def do_main():
     run_test_file(args.test_py_path)
 
 
-def callHierarchyPrepareParams(
-    src_uri: str, line_one_based: int, char_one_based: int
-) -> CallHierarchyPrepareParams:
-    """Shortcut for creating a CallHierarchyPrepareParams object."""
-    return CallHierarchyPrepareParams(
-        TextDocumentIdentifier(src_uri),
-        Pos(line_one_based, char_one_based),
-    )
-
-
 def Pos(line_one_based: int, char_one_based: int):
     """Shortcut for creating a Position object with ONE-BASED locations."""
     return Position(line_one_based - 1, char_one_based - 1)
@@ -773,24 +796,6 @@ def RangeZero(line_one_based: int, char_one_based: int):
     return Range(pos, pos)
 
 
-def callHierarchyIncomingCallsParams(
-    src_uri: str, line_one_based: int, char_one_based: int
-) -> CallHierarchyIncomingCallsParams:
-    """Shortcut for creating a CallHierarchyIncomingCallsParams object."""
-    rng = RangeZero(line_one_based, char_one_based)
-    param = CallHierarchyIncomingCallsParams(
-        item=CallHierarchyItem(
-            name="",
-            kind=SymbolKind.Function,
-            uri=src_uri,
-            range=rng,
-            selection_range=rng,
-        )
-    )
-
-    return param
-
-
 def didOpenTextDocumentParams(
     src_path: Path | str,
 ) -> tuple[DidOpenTextDocumentParams, str]:
@@ -810,7 +815,7 @@ def URI(src_path: Path | str) -> str:
     """Create a URI for the given file path."""
     src_abs = Path(src_path).resolve()
 
-    # Replace backslashs with forward slashes to avoid too much quoting in URIs
+    # Replace back slashes with forward slashes to avoid too much quoting in URIs
     src_abs_str = str(src_abs).replace("\\", "/")
 
     quoted = urllib.parse.quote(src_abs_str)