parameterize conftest protocol to be able to test lsp protocol with different clientcapabilities

Author: d-biehl

robotcode/language_server/common/lsp_types.py

@@ -17,7 +17,7 @@
 from ..text_document import TextDocument
 
 if TYPE_CHECKING:
-    from ..protocol import LanguageServerProtocol
+    from ..protocol import LanguageServerProtocol  # pragma: no cover
 
 from .protocol_part import LanguageServerProtocolPart
 
@@ -30,7 +30,7 @@ def __init__(self, parent: LanguageServerProtocol) -> None:
         super().__init__(parent)
 
     @async_tasking_event
-    async def collect(sender, document: TextDocument) -> Optional[List[FoldingRange]]:
+    async def collect(sender, document: TextDocument) -> Optional[List[FoldingRange]]:  # pragma: no cover
         ...
 
     def extend_capabilities(self, capabilities: ServerCapabilities) -> None:

robotcode/language_server/common/parts/folding_range.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import importlib
 import importlib.util
 import io
@@ -205,7 +207,7 @@ class KeywordArgumentDoc(Model):
     types: Optional[Any] = None
 
     @staticmethod
-    def from_robot(arg: Any) -> "KeywordArgumentDoc":
+    def from_robot(arg: Any) -> KeywordArgumentDoc:
         from robot.running.arguments.argumentspec import ArgInfo
 
         robot_arg = cast(ArgInfo, arg)

robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -9,7 +9,7 @@
 from ...common.text_document import TextDocument
 
 if TYPE_CHECKING:
-    from ..protocol import RobotLanguageServerProtocol
+    from ..protocol import RobotLanguageServerProtocol  # pragma: no cover
 
 from .protocol_part import RobotLanguageServerProtocolPart
 

robotcode/language_server/robotframework/parts/folding_range.py

@@ -1,4 +1,5 @@
 import asyncio
+import dataclasses
 from pathlib import Path
 from typing import Any, AsyncGenerator, Generator, cast
 
@@ -25,6 +26,7 @@
 )
 from robotcode.language_server.robotframework.server import RobotLanguageServer
 from robotcode.utils.dataclasses import as_dict
+from tests.robotcode.language_server.robotframework.tools import generate_test_id
 
 
 @pytest.fixture(scope="function")
@@ -36,20 +38,26 @@ def event_loop() -> Generator[asyncio.AbstractEventLoop, None, None]:
         loop.close()
 
 
-@pytest.fixture(scope="function")
-async def protocol(
-    event_loop: asyncio.AbstractEventLoop, request: Any
-) -> AsyncGenerator[RobotLanguageServerProtocol, None]:
+@pytest.fixture(scope="function", ids=generate_test_id)
+@pytest.mark.usefixtures("event_loop")
+async def protocol(request: Any) -> AsyncGenerator[RobotLanguageServerProtocol, None]:
     root_path = Path().resolve()
     server = RobotLanguageServer()
     try:
+        client_capas = ClientCapabilities(
+            text_document=TextDocumentClientCapabilities(
+                hover=HoverClientCapabilities(content_format=[MarkupKind.MARKDOWN, MarkupKind.PLAINTEXT]),
+                folding_range=FoldingRangeClientCapabilities(range_limit=0, line_folding_only=False),
+            )
+        )
+
         protocol = RobotLanguageServerProtocol(server)
         await protocol._initialize(
-            ClientCapabilities(
-                text_document=TextDocumentClientCapabilities(
-                    hover=HoverClientCapabilities(content_format=[MarkupKind.MARKDOWN, MarkupKind.PLAINTEXT]),
-                    folding_range=FoldingRangeClientCapabilities(range_limit=0, line_folding_only=False),
-                )
+            dataclasses.replace(
+                client_capas,
+                **(
+                    {k: v for k, v in vars(request.param).items() if v is not None} if hasattr(request, "param") else {}
+                ),
             ),
             root_path=str(root_path),
             root_uri=root_path.as_uri(),
@@ -77,7 +85,8 @@ async def protocol(
 
 
 @pytest.fixture(scope="function")
-async def test_document(event_loop: asyncio.AbstractEventLoop, request: Any) -> AsyncGenerator[TextDocument, None]:
+@pytest.mark.usefixtures("event_loop")
+async def test_document(request: Any) -> AsyncGenerator[TextDocument, None]:
     data_path = Path(request.param)
     data = data_path.read_text()
 

tests/robotcode/language_server/robotframework/conftest.py

@@ -1,10 +1,10 @@
 *** Settings ***
-#^ Settings Start: any(e for e in result if e.start_line == line and e.kind=='section')
+#^ Settings Start: any(e for e in result if e.start_line == line and (e.start_character is None or e.start_character==0) and e.kind=='section')
 Documentation       Hallo Welt
 ...                 was geht
 
 *** Test Cases ***
-#^ Variables End: any(e for e in result if e.end_line == line - 1 and e.kind=='section')
+#^ Settings End: any(e for e in result if e.end_line == line - 1 and (e.end_character is None or e.end_character>0) and e.kind=='section')
 #^ Test Cases Start: any(e for e in result if e.start_line == line and e.kind=='section')
 First
 #^ Testcase Start: any(e for e in result if e.start_line == line and e.kind=='testcase')

tests/robotcode/language_server/robotframework/parts/data/foldingrange.robot

@@ -1,9 +1,15 @@
 import re
 from pathlib import Path
+from typing import Any, Generator, Iterable, Tuple, Union
 
 import pytest
 
-from robotcode.language_server.common.lsp_types import FoldingRange
+from robotcode.language_server.common.lsp_types import (
+    ClientCapabilities,
+    FoldingRange,
+    FoldingRangeClientCapabilities,
+    TextDocumentClientCapabilities,
+)
 from robotcode.language_server.common.text_document import TextDocument
 from robotcode.language_server.robotframework.protocol import (
     RobotLanguageServerProtocol,
@@ -16,10 +22,32 @@
 )
 
 
+def prepend_protocol_data(
+    protocol: Iterable[Any], data: Iterable[Union[Tuple[Any, Path, GeneratedTestData], Any]]
+) -> Generator[Union[Tuple[Any, Path, GeneratedTestData], Any], None, None]:
+    for p in protocol:
+        for d in data:
+            yield (p, *d)
+
+
 @pytest.mark.parametrize(
-    ("test_document", "data"),
-    generate_tests_from_source_document(Path(Path(__file__).parent, "data/foldingrange.robot")),
-    indirect=["test_document"],
+    ("protocol", "test_document", "data"),
+    prepend_protocol_data(
+        [
+            ClientCapabilities(
+                text_document=TextDocumentClientCapabilities(
+                    folding_range=FoldingRangeClientCapabilities(line_folding_only=True),
+                )
+            ),
+            ClientCapabilities(
+                text_document=TextDocumentClientCapabilities(
+                    folding_range=FoldingRangeClientCapabilities(line_folding_only=False),
+                )
+            ),
+        ],
+        list(generate_tests_from_source_document(Path(Path(__file__).parent, "data/foldingrange.robot"))),
+    ),
+    indirect=["protocol", "test_document"],
     ids=generate_test_id,
 )
 @pytest.mark.asyncio

tests/robotcode/language_server/robotframework/parts/test_foldingrange.py

@@ -1,3 +1,4 @@
+import dataclasses
 import re
 from pathlib import Path
 from typing import Any, Generator, NamedTuple, Tuple, Union
@@ -54,7 +55,8 @@ def generate_tests_from_source_document(
 def generate_test_id(params: Any) -> Any:
     if isinstance(params, GeneratedTestData):
         return f"{params.line}-{params.character}-{params.name}"
-
+    if dataclasses.is_dataclass(params):
+        return repr(params)
     if isinstance(params, Path):
         return params.name