implement some unit tests for hover

Author: d-biehl

pyproject.toml

@@ -74,6 +74,8 @@ addopts = "-ra -vv"
 filterwarnings = "ignore:.*Using or importing the ABCs from 'collections' instead of from 'collections.abc'.*:DeprecationWarning"
 testpaths = ["tests"]
 junit_suite_name = "robotcode"
+log_cli = true
+log_cli_level = "DEBUG"
 
 [tool.isort]
 profile = "black"

robotcode/language_server/common/parts/workspace.py

@@ -387,13 +387,20 @@ async def add_file_watchers(
         else:
             self.did_change_watched_files.add(callback)  # type: ignore
 
-            await self.parent.register_capability(
-                entry.id,
-                "workspace/didChangeWatchedFiles",
-                DidChangeWatchedFilesRegistrationOptions(
-                    watchers=[FileSystemWatcher(glob_pattern=w.glob_pattern, kind=w.kind) for w in _watchers]
-                ),
-            )
+            if (
+                self.parent.client_capabilities
+                and self.parent.client_capabilities.workspace
+                and self.parent.client_capabilities.workspace.did_change_watched_files
+                and self.parent.client_capabilities.workspace.did_change_watched_files.dynamic_registration
+            ):
+                await self.parent.register_capability(
+                    entry.id,
+                    "workspace/didChangeWatchedFiles",
+                    DidChangeWatchedFilesRegistrationOptions(
+                        watchers=[FileSystemWatcher(glob_pattern=w.glob_pattern, kind=w.kind) for w in _watchers]
+                    ),
+                )
+            # TODO: implement own filewatcher if not supported by language server client
 
         def remove() -> None:
             if self._loop.is_running():
@@ -414,4 +421,11 @@ async def remove_file_watcher_entry(self, entry: FileWatcherEntry) -> None:
                 self.did_change_watched_files.remove(entry.call_childrens)
         elif len(entry.child_callbacks) == 0:
             self.did_change_watched_files.remove(entry.callback)  # type: ignore
-            await self.parent.unregister_capability(entry.id, "workspace/didChangeWatchedFiles")
+            if (
+                self.parent.client_capabilities
+                and self.parent.client_capabilities.workspace
+                and self.parent.client_capabilities.workspace.did_change_watched_files
+                and self.parent.client_capabilities.workspace.did_change_watched_files.dynamic_registration
+            ):
+                await self.parent.unregister_capability(entry.id, "workspace/didChangeWatchedFiles")
+            # TODO: implement own filewatcher if not supported by language server client

robotcode/utils/uri.py

@@ -100,9 +100,9 @@ def _to_path_str(self) -> str:
         if self._parts.scheme != "file":
             raise InvalidUriError(f"Invalid URI scheme '{str(self)}'.")
 
-        if netloc and path and self._parts.scheme == "file":
+        if netloc and self._parts.scheme == "file":
             # unc path: file://shares/c$/far/boo
-            value = "//{}{}".format(netloc, path)
+            value = "//{}{}".format(netloc, path or "")
 
         elif _RE_DRIVE_LETTER_PATH.match(path):
             # windows drive letter: file:///C:/far/boo

tests/language_server/test_window.py renamed to tests/language_server/common/__init__.py

@@ -0,0 +1,77 @@
+from pathlib import Path
+from typing import AsyncGenerator
+
+import pytest
+
+from robotcode.language_server.common.text_document import TextDocument
+from robotcode.language_server.common.types import (
+    ClientCapabilities,
+    MarkupContent,
+    MarkupKind,
+    Position,
+    Range,
+)
+from robotcode.language_server.robotframework.protocol import (
+    RobotLanguageServerProtocol,
+)
+from robotcode.language_server.robotframework.server import RobotLanguageServer
+
+
+@pytest.fixture
+async def protocol() -> AsyncGenerator[RobotLanguageServerProtocol, None]:
+    root_path = Path().resolve()
+    server = RobotLanguageServer()
+    try:
+        protocol = RobotLanguageServerProtocol(server)
+        await protocol._initialize(ClientCapabilities(), root_path=str(root_path), root_uri=root_path.as_uri())
+
+        yield protocol
+    finally:
+        server.close()
+
+
+@pytest.fixture
+async def test_document() -> AsyncGenerator[TextDocument, None]:
+    data = """\
+***Test Cases***
+first
+    Log  Hello
+"""
+    yield TextDocument(document_uri="file:///test.robot", language_id="robotframework", version=1, text=data)
+
+
+@pytest.mark.parametrize(
+    ("position",),
+    [
+        (Position(line=2, character=4),),
+        (Position(line=2, character=5),),
+        (Position(line=2, character=6),),
+    ],
+)
+@pytest.mark.asyncio
+async def test_hover_should_find_simple_keyword(
+    protocol: RobotLanguageServerProtocol, test_document: TextDocument, position: Position
+) -> None:
+
+    result = await protocol._robot_hover.collect(protocol.hover, test_document, position)
+    assert result
+    assert result.range == Range(start=Position(line=2, character=4), end=Position(line=2, character=7))
+    assert isinstance(result.contents, MarkupContent)
+    assert result.contents.kind == MarkupKind.MARKDOWN
+    assert "Log" in result.contents.value
+
+
+@pytest.mark.parametrize(
+    ("position",),
+    [
+        (Position(line=2, character=3),),
+        (Position(line=2, character=7),),
+    ],
+)
+@pytest.mark.asyncio
+async def test_hover_should_not_find_simple_keyword_on_boundaries(
+    protocol: RobotLanguageServerProtocol, test_document: TextDocument, position: Position
+) -> None:
+
+    result = await protocol._robot_hover.collect(protocol.hover, test_document, position)
+    assert result is None