Fixed issue where doc highlight could raise error with unclosed varia…

…ble.

robotframework-ls/src/robotframework_ls/impl/ast_utils.py

@@ -669,16 +669,18 @@ def tokenize_variables_from_name(name):
 
 def tokenize_variables(token: IRobotToken) -> Iterator[IRobotToken]:
  # May throw error if it's not OK.
- return token.tokenize_variables()
+ return iter(tuple(token.tokenize_variables()))
 
 
-def _tokenize_variables_even_when_invalid(token: IRobotToken, col: int):
+def _tokenize_variables_even_when_invalid(
+ token: IRobotToken, col: int
+) -> Iterator[IRobotToken]:
  """
  If Token.tokenize_variables() fails, this can still provide the variable under
  the given column by applying some heuristics to find open variables.
  """
  try:
- return tokenize_variables(token)
+ return iter(tuple(tokenize_variables(token)))
  except:
  pass
 
@@ -706,15 +708,18 @@ def _tokenize_variables_even_when_invalid(token: IRobotToken, col: int):
  break
  varname.append(c)
 
- return [
- Token(
- type=token.VARIABLE,
- value="".join(varname),
- lineno=token.lineno,
- col_offset=token.col_offset + open_at - 1,
- error=token.error,
- )
- ]
+ return iter(
+ [
+ Token(
+ type=token.VARIABLE,
+ value="".join(varname),
+ lineno=token.lineno,
+ col_offset=token.col_offset + open_at - 1,
+ error=token.error,
+ )
+ ]
+ )
+ return iter(())
 
 
 LIBRARY_IMPORT_CLASSES = ("LibraryImport",)

robotframework-ls/tests/robotframework_ls_tests/_resources/case_vars_file/case_vars_curdir.robot

@@ -0,0 +1,7 @@
+*** Settings ***
+Variables ${CURDIR}${/}variables${/}common variables.yaml
+
+
+*** Test Cases ***
+Test
+ Log ${COMMON_2} console=True

robotframework-ls/tests/robotframework_ls_tests/_resources/case_vars_file/variables/common variables.yaml

@@ -0,0 +1,2 @@
+COMMON_1: 10
+COMMON_2: 20

robotframework-ls/tests/robotframework_ls_tests/test_code_analysis.py

@@ -2217,3 +2217,10 @@ def test_variables_cls(workspace, libspec_manager, data_regression):
  doc = workspace.get_doc("case_vars_file_cls.robot", accept_from_file=True)
 
  _collect_errors(workspace, doc, data_regression, basename="no_error")
+
+
+def test_variables_curdir(workspace, libspec_manager, data_regression):
+ workspace.set_root("case_vars_file", libspec_manager=libspec_manager)
+ doc = workspace.get_doc("case_vars_curdir.robot", accept_from_file=True)
+
+ _collect_errors(workspace, doc, data_regression, basename="no_error")

robotframework-ls/tests/robotframework_ls_tests/test_document_highlight.py

@@ -344,3 +344,19 @@ def test_document_highlight_argument_in_caller(
  ),
  )
  )
+
+
+def test_document_highlight_unclosed_var(workspace, libspec_manager, data_regression):
+ from robotframework_ls.impl.completion_context import CompletionContext
+ from robotframework_ls.impl.doc_highlight import doc_highlight
+
+ workspace.set_root("case4", libspec_manager=libspec_manager)
+ doc = workspace.put_doc(
+ "my.robot",
+ """
+*** Settings ***
+Variables ${CURDIR}${/common vari""",
+ )
+ completion_context = CompletionContext(doc, workspace=workspace.ws)
+ result = doc_highlight(completion_context)
+ assert len(result) == 0