fix: correct analyzing of variables in WhileHeader options

Author: d-biehl

packages/robot/src/robotcode/robot/diagnostics/namespace_analyzer.py

@@ -294,7 +294,7 @@ def _visit_Variable(self, node: Variable) -> None:  # noqa: N802
     if get_robot_version() >= (7, 0):
 
         def visit_Var(self, node: Statement) -> None:  # noqa: N802
-            self._visit_statement(node)
+            self._analyze_statement_variables(node)
 
             variable = node.get_token(Token.VARIABLE)
             if variable is None:
@@ -348,13 +348,15 @@ def visit_Var(self, node: Statement) -> None:  # noqa: N802
                 pass
 
     def visit_Statement(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
-    def _visit_statement(self, node: Statement, severity: DiagnosticSeverity = DiagnosticSeverity.ERROR) -> None:
+    def _analyze_statement_variables(
+        self, node: Statement, severity: DiagnosticSeverity = DiagnosticSeverity.ERROR
+    ) -> None:
         for token in node.get_tokens(Token.ARGUMENT):
             self._analyze_token_variables(token, severity)
 
-    def _visit_expression_statement(
+    def _analyze_statement_expression_variables(
         self, node: Statement, severity: DiagnosticSeverity = DiagnosticSeverity.ERROR
     ) -> None:
 
@@ -367,7 +369,7 @@ def _visit_settings_statement(
     ) -> None:
         self._in_setting = True
         try:
-            self._visit_statement(node, severity)
+            self._analyze_statement_variables(node, severity)
         finally:
             self._in_setting = False
 
@@ -921,7 +923,7 @@ def visit_Fixture(self, node: Fixture) -> None:  # noqa: N802
 
         if keyword_token is not None and keyword_token.value and keyword_token.value.upper() not in ("", "NONE"):
             self._analyze_token_variables(keyword_token)
-            self._visit_statement(node)
+            self._analyze_statement_variables(node)
 
             self._analyze_keyword_call(
                 node,
@@ -977,7 +979,7 @@ def visit_KeywordCall(self, node: KeywordCall) -> None:  # noqa: N802
             return
 
         self._analyze_token_variables(keyword_token)
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         self._analyze_keyword_call(
             node,
@@ -1202,12 +1204,12 @@ def _analyze_assign_statement(self, node: Statement) -> None:
                 pass
 
     def visit_InlineIfHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_expression_statement(node)
+        self._analyze_statement_expression_variables(node)
 
         self._analyze_assign_statement(node)
 
     def visit_ForHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         variables = node.get_tokens(Token.VARIABLE)
         for variable in variables:
@@ -1243,7 +1245,8 @@ def visit_ForHeader(self, node: Statement) -> None:  # noqa: N802
                         )
 
     def visit_ExceptHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
+        self._analyze_option_token_variables(node)
 
         variable_token = node.get_token(Token.VARIABLE)
 
@@ -1299,7 +1302,7 @@ def _format_template(self, template: str, arguments: Tuple[str, ...]) -> Tuple[s
         return "".join(temp), ()
 
     def visit_TemplateArguments(self, node: TemplateArguments) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         template = self._template or self._test_template
         if template is not None and template.value is not None and template.value.upper() not in ("", "NONE"):
@@ -1339,10 +1342,10 @@ def visit_TemplateArguments(self, node: TemplateArguments) -> None:  # noqa: N80
         self.generic_visit(node)
 
     def visit_DefaultTags(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node, DiagnosticSeverity.HINT)
+        self._analyze_statement_variables(node, DiagnosticSeverity.HINT)
 
     def visit_ForceTags(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node, DiagnosticSeverity.HINT)
+        self._analyze_statement_variables(node, DiagnosticSeverity.HINT)
 
         if get_robot_version() >= (6, 0):
             tag = node.get_token(Token.FORCE_TAGS)
@@ -1356,7 +1359,7 @@ def visit_ForceTags(self, node: Statement) -> None:  # noqa: N802
                 )
 
     def visit_TestTags(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node, DiagnosticSeverity.HINT)
+        self._analyze_statement_variables(node, DiagnosticSeverity.HINT)
 
         if get_robot_version() >= (6, 0):
             tag = node.get_token(Token.FORCE_TAGS)
@@ -1376,7 +1379,7 @@ def visit_DocumentationOrMetadata(self, node: Statement) -> None:  # noqa: N802
         self._visit_settings_statement(node, DiagnosticSeverity.HINT)
 
     def visit_Timeout(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node, DiagnosticSeverity.HINT)
+        self._analyze_statement_variables(node, DiagnosticSeverity.HINT)
 
     def visit_SingleValue(self, node: Statement) -> None:  # noqa: N802
         self._visit_settings_statement(node, DiagnosticSeverity.HINT)
@@ -1402,7 +1405,7 @@ def visit_Tags(self, node: Statement) -> None:  # noqa: N802
                     )
 
     def visit_SectionHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         if get_robot_version() >= (7, 0):
             token = node.get_token(*Token.HEADER_TOKENS)
@@ -1425,7 +1428,7 @@ def visit_SectionHeader(self, node: Statement) -> None:  # noqa: N802
                 )
 
     def visit_ReturnSetting(self, node: Statement) -> None:  # noqa: N802
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         if get_robot_version() >= (7, 0):
             token = node.get_token(Token.RETURN_SETTING)
@@ -1456,7 +1459,7 @@ def visit_VariablesImport(self, node: VariablesImport) -> None:  # noqa: N802
             return
 
         self._analyze_token_variables(name_token)
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         found = False
         entries = self._namespace.get_import_entries()
@@ -1485,7 +1488,7 @@ def visit_ResourceImport(self, node: ResourceImport) -> None:  # noqa: N802
             return
 
         self._analyze_token_variables(name_token)
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         found = False
         entries = self._namespace.get_import_entries()
@@ -1513,7 +1516,7 @@ def visit_LibraryImport(self, node: LibraryImport) -> None:  # noqa: N802
             return
 
         self._analyze_token_variables(name_token)
-        self._visit_statement(node)
+        self._analyze_statement_variables(node)
 
         found = False
         entries = self._namespace.get_import_entries()
@@ -1533,8 +1536,11 @@ def visit_LibraryImport(self, node: LibraryImport) -> None:  # noqa: N802
                     break
 
     def visit_WhileHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_expression_statement(node)
+        self._analyze_statement_expression_variables(node)
+
+        self._analyze_option_token_variables(node)
 
+    def _analyze_option_token_variables(self, node: Statement) -> None:
         for token in node.get_tokens(Token.OPTION):
             if token.value and "=" in token.value:
                 name, value = token.value.split("=", 1)
@@ -1543,10 +1549,10 @@ def visit_WhileHeader(self, node: Statement) -> None:  # noqa: N802
                 self._analyze_token_variables(value_token)
 
     def visit_IfHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_expression_statement(node)
+        self._analyze_statement_expression_variables(node)
 
     def visit_IfElseHeader(self, node: Statement) -> None:  # noqa: N802
-        self._visit_expression_statement(node)
+        self._analyze_statement_expression_variables(node)
 
     def _find_variable(self, name: str) -> Optional[VariableDefinition]:
         if name[:2] == "%{" and name[-1] == "}":

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-258-021-an_argument].out

@@ -0,0 +1,14 @@
+data: !GeneratedTestData
+  character: 21
+  line: 258
+  name: an argument
+result:
+- !Location
+  range:
+    end:
+      character: 26
+      line: 258
+    start:
+      character: 21
+      line: 258
+  uri: tests/references.robot

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-258-024-an_argument].out

@@ -0,0 +1,14 @@
+data: !GeneratedTestData
+  character: 24
+  line: 258
+  name: an argument
+result:
+- !Location
+  range:
+    end:
+      character: 26
+      line: 258
+    start:
+      character: 21
+      line: 258
+  uri: tests/references.robot

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-258-027-an_argument].out

@@ -0,0 +1,5 @@
+data: !GeneratedTestData
+  character: 27
+  line: 258
+  name: an argument
+result: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-014-local_variable_usage].out

@@ -0,0 +1,5 @@
+data: !GeneratedTestData
+  character: 14
+  line: 261
+  name: local variable usage
+result: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-019-argument_usage].out

@@ -0,0 +1,5 @@
+data: !GeneratedTestData
+  character: 19
+  line: 261
+  name: argument usage
+result: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-021-argument_usage].out

@@ -0,0 +1,5 @@
+data: !GeneratedTestData
+  character: 21
+  line: 261
+  name: argument usage
+result: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-023-argument_usage].out

@@ -0,0 +1,5 @@
+data: !GeneratedTestData
+  character: 23
+  line: 261
+  name: argument usage
+result: null

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-036-argument_usage_in_while_option].out

@@ -0,0 +1,23 @@
+data: !GeneratedTestData
+  character: 36
+  line: 261
+  name: argument usage in while option
+result:
+- !Location
+  range:
+    end:
+      character: 40
+      line: 258
+    start:
+      character: 33
+      line: 258
+  uri: tests/references.robot
+- !Location
+  range:
+    end:
+      character: 43
+      line: 261
+    start:
+      character: 36
+      line: 261
+  uri: tests/references.robot

tests/robotcode/language_server/robotframework/parts/_regtest_outputs/rf41/test_references.test[references.robot-261-039-argument_usage_in_while_option].out

@@ -0,0 +1,23 @@
+data: !GeneratedTestData
+  character: 39
+  line: 261
+  name: argument usage in while option
+result:
+- !Location
+  range:
+    end:
+      character: 40
+      line: 258
+    start:
+      character: 33
+      line: 258
+  uri: tests/references.robot
+- !Location
+  range:
+    end:
+      character: 43
+      line: 261
+    start:
+      character: 36
+      line: 261
+  uri: tests/references.robot