add tests for folding range

Author: d-biehl

robotcode/language_server/robotframework/parts/folding_range.py

@@ -32,16 +32,15 @@ def __init__(self, parent: RobotFoldingRangeProtocolPart) -> None:
                 super().__init__()
                 self.parent = parent
                 self.line_folding_only = True
-                if self.parent.parent.client_capabilities is not None:
-                    if self.parent.parent.client_capabilities.text_document is not None:
-                        if self.parent.parent.client_capabilities.text_document.folding_range is not None:
-                            if (
-                                self.parent.parent.client_capabilities.text_document.folding_range.line_folding_only
-                                is not None
-                            ):
-                                self.line_folding_only = (
-                                    self.parent.parent.client_capabilities.text_document.folding_range.line_folding_only
-                                )
+                if (
+                    self.parent.parent.client_capabilities
+                    and self.parent.parent.client_capabilities.text_document
+                    and self.parent.parent.client_capabilities.text_document.folding_range
+                    and self.parent.parent.client_capabilities.text_document.folding_range.line_folding_only is not None
+                ):
+                    self.line_folding_only = (
+                        self.parent.parent.client_capabilities.text_document.folding_range.line_folding_only
+                    )
 
                 self.result: List[FoldingRange] = []
 
@@ -98,7 +97,7 @@ async def visit_Keyword(self, node: ast.AST) -> None:  # noqa: N802
                     self.__append(node, kind="keyword")
                     await self.generic_visit(node)
 
-            async def visit_ForLoop(self, node: ast.AST) -> None:  # noqa: N802
+            async def visit_ForLoop(self, node: ast.AST) -> None:  # noqa: N802, pragma: no cover
                 self.__append(node, kind="for_loop")
                 await self.generic_visit(node)
 

tests/robotcode/language_server/common/test_text_document.py

@@ -224,21 +224,3 @@ async def get_data(self, document: TextDocument, data: str) -> str:
     del dummy
 
     assert len(document._cache) == 0
-
-
-@pytest.mark.asyncio
-async def test_document_get_set_cache_with_lock_work() -> None:
-    text = """\
-first
-second
-third
-"""
-    prefix = "1"
-
-    async def get_data(document: TextDocument, data: str) -> str:
-        await document.remove_cache_entry(get_data)
-        return prefix + data
-
-    document = TextDocument(document_uri="file://test.robot", language_id="robotframework", version=1, text=text)
-
-    assert await document.get_cache(get_data, "data") == "1data"

tests/robotcode/language_server/robotframework/conftest.py

@@ -8,6 +8,7 @@
 from robotcode.language_server.common.lsp_types import (
     ClientCapabilities,
     ClientInfo,
+    FoldingRangeClientCapabilities,
     HoverClientCapabilities,
     InitializedParams,
     MarkupKind,
@@ -45,15 +46,18 @@ def event_loop() -> Generator[asyncio.AbstractEventLoop, None, None]:
 
 
 @pytest.fixture(scope="function")
-async def protocol(event_loop: asyncio.AbstractEventLoop) -> AsyncGenerator[RobotLanguageServerProtocol, None]:
+async def protocol(
+    event_loop: asyncio.AbstractEventLoop, request: Any
+) -> AsyncGenerator[RobotLanguageServerProtocol, None]:
     root_path = Path().resolve()
     server = RobotLanguageServer()
     try:
         protocol = RobotLanguageServerProtocol(server)
         await protocol._initialize(
             ClientCapabilities(
                 text_document=TextDocumentClientCapabilities(
-                    hover=HoverClientCapabilities(content_format=[MarkupKind.MARKDOWN, MarkupKind.PLAINTEXT])
+                    hover=HoverClientCapabilities(content_format=[MarkupKind.MARKDOWN, MarkupKind.PLAINTEXT]),
+                    folding_range=FoldingRangeClientCapabilities(range_limit=0, line_folding_only=False),
                 )
             ),
             root_path=str(root_path),

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

@@ -0,0 +1,46 @@
+*** Settings ***
+#^ Settings Start: any(e for e in result if e.start_line == line 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')
+#^ 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')
+    Log    Hello from testcase
+    a keyword
+    FOR    ${i}    IN    1    2    3
+#^ For Start: any(e for e in result if e.start_line == line and e.kind=='for')
+        IF    ${i}==1
+#^ If Start: any(e for e in result if e.start_line == line and e.kind=='if')
+            Log    "one"
+        ELSE IF    ${i}==2
+#^ If Start: any(e for e in result if e.start_line == line and e.kind=='if')
+            Log    "two"
+        ELSE
+#^ If Start: any(e for e in result if e.start_line == line and e.kind=='if')
+            Log    "more then two"
+        END
+#^ If End: any(e for e in result if e.end_line == line and e.kind=='if')
+
+        Log    ${i}
+
+    END
+#^ For End: any(e for e in result if e.end_line == line and e.kind=='for')
+
+*** Keywords ***
+#^ Test Cases End: any(e for e in result if e.end_line == line - 1 and e.kind=='section')
+#^ Testcase End: any(e for e in result if e.end_line == line - 1 and e.kind=='testcase')
+a keyword
+#^ Keyword Start: any(e for e in result if e.start_line == line and e.kind=='keyword')
+    Log    Hello from keyword
+
+*** Comments ***
+#^ Keyword End: any(e for e in result if e.end_line == line - 1 and e.kind=='keyword')
+#^ Comment Start: any(e for e in result if e.start_line == line and e.kind=='comment')
+this is a long long
+long long long
+long long comment section
+
+#^ Comment End: any(e for e in result if e.end_line == line + 1 and e.kind=='comment')

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

@@ -0,0 +1,45 @@
+import re
+from pathlib import Path
+
+import pytest
+
+from robotcode.language_server.common.lsp_types import FoldingRange
+from robotcode.language_server.common.text_document import TextDocument
+from robotcode.language_server.robotframework.protocol import (
+    RobotLanguageServerProtocol,
+)
+
+from ..tools import (
+    GeneratedTestData,
+    generate_test_id,
+    generate_tests_from_source_document,
+)
+
+
+@pytest.mark.parametrize(
+    ("test_document", "data"),
+    generate_tests_from_source_document(Path(Path(__file__).parent, "data/foldingrange.robot")),
+    indirect=["test_document"],
+    ids=generate_test_id,
+)
+@pytest.mark.asyncio
+async def test_foldingrange(
+    protocol: RobotLanguageServerProtocol,
+    test_document: TextDocument,
+    data: GeneratedTestData,
+) -> None:
+
+    result = await protocol._robot_folding_ranges.collect(protocol._robot_goto, test_document)
+
+    assert bool(
+        eval(
+            data.expression,
+            {
+                "re": re,
+                "FoldingRange": FoldingRange,
+                "result": result,
+                "line": data.line,
+                "character": data.character,
+            },
+        )
+    ), f"{data.expression} -> {repr(result)}"