Propagate import errors from resources

Author: d-biehl

CHANGELOG.md

@@ -29,6 +29,8 @@ All notable changes to the "robotcode" extension will be documented in this file
   - fixes: [#28](https://github.com/d-biehl/robotcode/issues/28)
 - Ignoring robotcode diagnostics
   - you can put a line comment to disable robotcode diagnostics (i.e errors or warnings) for a single line, like this:
+- Propagate import errors from resources
+  - errors like: `Resource file with 'Test Cases' section is invalid` are shown at import statement
 
   ```robotcode
   *** Test cases ***

robotcode/language_server/robotframework/configuration.py

@@ -20,6 +20,10 @@ class RobotConfig(ConfigBase):
     env: Dict[str, str] = field(default_factory=dict)
     variables: Dict[str, Any] = field(default_factory=dict)
     output_dir: Optional[str] = None
+    output_file: Optional[str] = None
+    log_file: Optional[str] = None
+    debug_file: Optional[str] = None
+    log_level: Optional[str] = None
 
 
 @config_section("robotcode.syntax")

robotcode/language_server/robotframework/diagnostics/imports_manager.py

@@ -23,8 +23,6 @@
     final,
 )
 
-from robotcode.language_server.robotframework.utils.robot_path import find_file_ex
-
 from ....utils.async_tools import Lock, async_tasking_event, create_sub_task
 from ....utils.logging import LoggingDescriptor
 from ....utils.path import path_is_relative_to
@@ -35,6 +33,7 @@
 from ...common.text_document import TextDocument
 from ..configuration import RobotConfig
 from ..utils.async_ast import walk
+from ..utils.robot_path import find_file_ex
 from ..utils.version import get_robot_version
 from .entities import CommandLineVariableDefinition, VariableDefinition
 

robotcode/language_server/robotframework/diagnostics/library_doc.py

@@ -1090,14 +1090,18 @@ def _find_library_internal(
     variables: Optional[Dict[str, Optional[Any]]] = None,
 ) -> Tuple[str, Any]:
 
+    from robot.errors import DataError
     from robot.libraries import STDLIBS
     from robot.utils.robotpath import find_file as robot_find_file
 
     _update_env(working_dir, pythonpath, environment)
 
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
-    name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+    try:
+        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+    except DataError as error:
+        raise DataError(f"Replacing variables from setting 'Library' failed: {error}")
 
     if name in STDLIBS:
         result = ROBOT_LIBRARY_PACKAGE + "." + name
@@ -1377,14 +1381,17 @@ def _find_variables_internal(
     command_line_variables: Optional[Dict[str, Optional[Any]]] = None,
     variables: Optional[Dict[str, Optional[Any]]] = None,
 ) -> Tuple[str, Any]:
-
+    from robot.errors import DataError
     from robot.utils.robotpath import find_file as robot_find_file
 
     _update_env(working_dir, pythonpath, environment)
 
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
 
-    name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+    try:
+        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+    except DataError as error:
+        raise DataError(f"Replacing variables from setting 'Variables' failed: {error}")
 
     result = name
 
@@ -1523,13 +1530,16 @@ def find_file(
     variables: Optional[Dict[str, Optional[Any]]] = None,
     file_type: str = "Resource",
 ) -> str:
+    from robot.errors import DataError
     from robot.utils.robotpath import find_file as robot_find_file
 
     _update_env(working_dir, pythonpath, environment)
 
     robot_variables = resolve_robot_variables(working_dir, base_dir, command_line_variables, variables)
-
-    name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=True)
+    try:
+        name = robot_variables.replace_string(name.replace("\\", "\\\\"), ignore_errors=False)
+    except DataError as error:
+        raise DataError(f"Replacing variables from setting '{file_type}' failed: {error}")
 
     return cast(str, robot_find_file(name, base_dir or ".", file_type))
 

robotcode/language_server/robotframework/diagnostics/namespace.py

@@ -2,6 +2,7 @@
 
 import ast
 import asyncio
+import enum
 import itertools
 import re
 import time
@@ -445,6 +446,13 @@ class VariablesEntry(LibraryEntry):
     variables: List[VariableDefinition] = field(default_factory=lambda: [])
 
 
+class DocumentType(enum.Enum):
+    UNKNOWN = "unknown"
+    GENERAL = "robot"
+    RESOURCE = "resource"
+    INIT = "init"
+
+
 class Namespace:
     _logger = LoggingDescriptor()
 
@@ -456,6 +464,7 @@ def __init__(
         source: str,
         invalidated_callback: Callable[[Namespace], None],
         document: Optional[TextDocument] = None,
+        document_type: Optional[DocumentType] = None,
     ) -> None:
         super().__init__()
 
@@ -467,6 +476,7 @@ def __init__(
         self.source = source
         self.invalidated_callback = invalidated_callback
         self._document = weakref.ref(document) if document is not None else None
+        self.document_type: Optional[DocumentType] = document_type
         self._libraries: OrderedDict[str, LibraryEntry] = OrderedDict()
         self._libraries_matchers: Optional[Dict[KeywordMatcher, LibraryEntry]] = None
         self._resources: OrderedDict[str, ResourceEntry] = OrderedDict()
@@ -587,7 +597,11 @@ async def get_library_doc(self) -> LibraryDoc:
             async with self._library_doc_lock:
                 if self._library_doc is None:
                     self._library_doc = await self.imports_manager.get_libdoc_from_model(
-                        self.model, self.source, model_type="RESOURCE", append_model_errors=False
+                        self.model,
+                        self.source,
+                        model_type="RESOURCE",
+                        append_model_errors=self.document_type is not None
+                        and self.document_type in [DocumentType.RESOURCE],
                     )
 
         return self._library_doc

robotcode/language_server/robotframework/parts/documents_cache.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import ast
-import enum
 import io
 import weakref
 from typing import (
@@ -27,7 +26,7 @@
 from ...common.text_document import TextDocument
 from ..configuration import RobotConfig
 from ..diagnostics.imports_manager import ImportsManager
-from ..diagnostics.namespace import Namespace
+from ..diagnostics.namespace import DocumentType, Namespace
 from ..utils.ast import Token
 
 if TYPE_CHECKING:
@@ -40,13 +39,6 @@ class UnknownFileTypeError(Exception):
     pass
 
 
-class DocumentType(enum.Enum):
-    UNKNOWN = "unknown"
-    GENERAL = "robot"
-    RESOURCE = "resource"
-    INIT = "init"
-
-
 class DocumentsCache(RobotLanguageServerProtocolPart):
     def __init__(self, parent: RobotLanguageServerProtocol) -> None:
         super().__init__(parent)
@@ -233,7 +225,7 @@ async def __get_namespace_for_document_type(
         def invalidate(namespace: Namespace) -> None:
             create_sub_task(self.__invalidate_namespace(namespace))
 
-        return Namespace(imports_manager, model, str(document.uri.to_path()), invalidate, document)
+        return Namespace(imports_manager, model, str(document.uri.to_path()), invalidate, document, document_type)
 
     @property
     async def default_imports_manager(self) -> ImportsManager: