Add in special handling for $import in hints

Also see common-workflow-language/common-workflow-language#896
for details.

Closes #75

Author: Kaushik Ghose

benten/cwl/anytype.py

@@ -1,6 +1,7 @@
 #  Copyright (c) 2019 Seven Bridges. See LICENSE
 
 from .basetype import CWLBaseType, MapSubjectPredicate, TypeCheck
+from .importincludetype import CWLImportInclude
 
 import logging
 logger = logging.getLogger(__name__)
@@ -22,5 +23,9 @@ def all_possible_type_names(self):
         return list(self.type_dict.keys())
 
     def check(self, node, node_key: str=None, map_sp: MapSubjectPredicate=None) -> TypeCheck:
-        # Special treatment for the any type. It agrees to everything
-        return TypeCheck(self)
+        if isinstance(node, dict) and "$import" in node:
+            # Extra-special treatment for $imports
+            return TypeCheck(CWLImportInclude(key="$import", import_context=""))
+        else:
+            # Special treatment for the any type. It agrees to everything
+            return TypeCheck(self)

benten/cwl/lib.py

@@ -60,13 +60,23 @@ def __init__(self, node, key_field, problems):
                         self.as_dict[key] = _item
                         self.key_ids[key] = get_range_for_value(_item, key_field)
                         self.map_key_to_idx[key] = n
-                    else:
-                        problems += [
-                            Diagnostic(
-                                _range=get_range_for_value(node, n),
-                                message=f"Missing key field {key_field}",
-                                severity=DiagnosticSeverity.Error)
-                        ]
+                        continue
+
+                    # Exception to handle $import
+                    # see https://github.com/common-workflow-language/common-workflow-language/issues/896
+                    if "$import" in _item:
+                        key = "class"
+                        self.as_dict[key] = _item
+                        self.key_ids[key] = get_range_for_value(_item, "$import")
+                        self.map_key_to_idx[key] = n
+                        continue
+
+                    problems += [
+                        Diagnostic(
+                            _range=get_range_for_value(node, n),
+                            message=f"Missing key field {key_field}",
+                            severity=DiagnosticSeverity.Error)
+                    ]
 
     def get_range_for_id(self, key):
         if self.was_dict:

benten/version.py

@@ -1,3 +1,3 @@
 #  Copyright (c) 2019-2020 Seven Bridges. See LICENSE
 
-__version__ = "2020.02.05"
+__version__ = "2020.02.06"

tests/cwl/misc/cl-hints-import.cwl

@@ -0,0 +1,5 @@
+class: CommandLineTool
+cwlVersion: v1.0
+inputs: []
+hints:
+  - $import: does_not_exist.yml

tests/test_code_intelligence.py

@@ -138,3 +138,17 @@ def test_schemadef_include():
 
     type_error = next(p for p in doc.problems if p.range.start.line == 4)
     assert type_error.message.startswith("Expecting one of")
+
+
+def test_hints_imports():
+    this_path = current_path / "cwl" / "misc" / "cl-hints-import.cwl"
+    doc = load(doc_path=this_path, type_dicts=type_dicts)
+
+    assert len(doc.problems) == 1
+
+    missing_error = next(p for p in doc.problems if p.range.start.line == 4)
+    assert missing_error.message.startswith("Missing document:")
+
+    cmpl = doc.completion(Position(4, 20))
+    assert "cl-schemadef-import.cwl" in [c.label for c in cmpl]
+    # The completer should look for all files in the current directory