add tests for finding references

Author: d-biehl

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

@@ -17,7 +17,9 @@ Test Setup    Log To Console    hi from test setup
 
 *** Variables ***
 ${a var}    hello
+#^^^^^^^ simple variable
 ${LIB_ARG}    from lib
+#^^^^^^^ another simple var
 
 
 *** Test Cases ***
@@ -33,6 +35,8 @@ first
     BuiltIn.Log To Console    hi ${a var}
 #           ^^^^^^^^^^^^^^  multiple references with namespace
 #                                  ^^^^^  multiple variables
+    Log    ${A_VAR_FROM_RESOURE}
+#          ^^^^^^^^^^^^^^^^^^^^^ a var from resource
 
 second
     [Template]    Log To Console

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

@@ -0,0 +1,63 @@
+*** Settings ***
+Library         Collections
+#               ^^^^^^^^^^^ a built library
+Library         ${CURDIR}/lib/myvariables.py
+#               ^^^^^^^^^  Variable in library import path
+#                             ^^^^^^^^^^^^^^ a custom library with path
+Variables       ${CURDIR}/lib/myvariables.py
+#               ^^^^^^^^^  Variable in variables import path
+#                             ^^^^^^^^^^^^^^ a variable import
+Resource        ${CURDIR}/resources/firstresource.resource
+#               ^^^^^^^^^  Variable in resource import path
+Library         alibrary    a_param=from hello    WITH NAME    lib_hello
+#               ^^^^^^^^ a custom library
+Library         alibrary    a_param=${LIB_ARG}    WITH NAME    lib_var
+#                                   ^^^^^^^^^^  Variable in library params
+#               ^^^^^^^^ a same custom library
+Suite Setup    BuiltIn.Log To Console    hi from suite setup
+#                      ^^^^^^^^^^^^^^  suite fixture keyword call with namespace
+Test Setup    Log To Console    hi from test setup
+#             ^^^^^^^^^^^^^^  test fixture keyword call with namespace
+
+*** Variables ***
+${a var}    hello
+#^^^^^^^ simple variable
+${LIB_ARG}    from lib
+#^^^^^^^ another simple var
+
+
+*** Test Cases ***
+first
+    [Setup]    Log To Console    hi ${a var}
+#              ^^^^^^^^^^^^^^  fixture keyword call
+    [Teardown]    BuiltIn.Log To Console    hi ${a var}
+#                         ^^^^^^^^^^^^^^  fixture keyword call with namespace
+    Log    Hi ${a var}
+#   ^^^  simple keyword call
+    Log To Console    hi ${a var}
+#   ^^^^^^^^^^^^^^  multiple references
+    BuiltIn.Log To Console    hi ${a var}
+#           ^^^^^^^^^^^^^^  multiple references with namespace
+#                                  ^^^^^  multiple variables
+    Log    ${A_VAR_FROM_RESOURE}
+#          ^^^^^^^^^^^^^^^^^^^^^ a var from resource
+
+second
+    [Template]    Log To Console
+#                 ^^^^^^^^^^^^^^  template keyword
+    Hi
+    There
+
+third
+    [Template]    BuiltIn.Log To Console
+#                         ^^^^^^^^^^^^^^  template keyword with namespace
+    Hi
+    There
+
+forth
+    ${result}    lib_hello.A Library Keyword
+#   ^^^^^^^^^    Keyword assignement
+    Should Be Equal    ${result}   from hello
+    ${result}=    lib_var.A Library Keyword
+#   ^^^^^^^^^    Keyword assignment with equals sign
+    Should Be Equal    ${result}   ${LIB_ARG}

tests/robotcode/language_server/robotframework/parts/data/resources/firstresource.resource

@@ -1,3 +1,6 @@
+*** Variables ***
+${A_VAR_FROM_RESOURE}    hello from resource
+
 *** Keywords ***
 
 do something in a resource

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

@@ -0,0 +1,50 @@
+from pathlib import Path
+from typing import Optional
+
+import pytest
+from pytest_regressions.data_regression import DataRegressionFixture
+
+from robotcode.language_server.common.lsp_types import (
+    Location,
+    Position,
+    ReferenceContext,
+)
+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/references.robot")),
+    indirect=["test_document"],
+    ids=generate_test_id,
+)
+@pytest.mark.usefixtures("protocol")
+@pytest.mark.asyncio
+async def test(
+    data_regression: DataRegressionFixture,
+    protocol: RobotLanguageServerProtocol,
+    test_document: TextDocument,
+    data: GeneratedTestData,
+) -> None:
+    def split(location: Optional[Location]) -> Optional[Location]:
+        if location is None:
+            return None
+
+        return Location(location.uri, location.range)
+
+    result = await protocol.robot_references.collect(
+        protocol.robot_document_highlight,
+        test_document,
+        Position(line=data.line, character=data.character),
+        ReferenceContext(include_declaration=True),
+    )
+    data_regression.check({"data": data, "result": [split(v) for v in result] if result else result})