fix(diagnostics): correct overriding of imported variables in suite variables

fixes #424

Author: d-biehl

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

@@ -179,7 +179,8 @@ class VariableDefinitionType(Enum):
 @dataclass
 class VariableDefinition(SourceEntity):
     name: str
-    name_token: Optional[Token]
+    name_token: Optional[Token]  # TODO: this is not needed anymore, but kept for compatibility
+
     type: VariableDefinitionType = VariableDefinitionType.VARIABLE
 
     has_value: bool = field(default=False, compare=False)

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

@@ -39,6 +39,7 @@ class Error:
     INVALID_HEADER = "InvalidHeader"
     DEPRECATED_HEADER = "DeprecatedHeader"
     OVERRIDDEN_BY_COMMANDLINE = "OverriddenByCommandLine"
+    OVERRIDES_IMPORTED_VARIABLE = "OverridesImportedVariable"
     VARIABLE_ALREADY_DEFINED = "VariableAlreadyDefined"
     VARIABLE_OVERRIDDEN = "VariableOverridden"
     MODEL_ERROR = "ModelError"

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

@@ -1116,8 +1116,8 @@ def yield_variables(
                     else []
                 ),
                 [] if skip_global_variables or skip_commandline_variables else self.get_command_line_variables(),
-                [] if skip_global_variables else self.get_own_variables(),
                 [] if skip_global_variables else self.get_imported_variables(),
+                [] if skip_global_variables else self.get_own_variables(),
                 [] if skip_global_variables else self.get_builtin_variables(),
             )
         )

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

@@ -234,6 +234,27 @@ def _visit_Variable(self, node: Variable) -> None:  # noqa: N802
             )
 
             add_to_references = True
+
+            if existing_var is not None and existing_var.type == VariableDefinitionType.IMPORTED_VARIABLE:
+                self._append_diagnostics(
+                    r,
+                    "Overrides imported variable.",
+                    DiagnosticSeverity.WARNING,
+                    Error.OVERRIDES_IMPORTED_VARIABLE,
+                    related_information=[
+                        DiagnosticRelatedInformation(
+                            location=Location(
+                                uri=str(Uri.from_path(existing_var.source)),
+                                range=existing_var.range,
+                            ),
+                            message="Already defined here.",
+                        )
+                    ]
+                    if existing_var.source
+                    else None,
+                )
+                existing_var = None
+
             first_overidden_reference: Optional[VariableDefinition] = None
             if existing_var is not None:
                 self._variable_references[existing_var].add(Location(self._namespace.document_uri, r))