Better message when dictionary (object) expected.

common-workflow-language · Jun 6, 2023 · c3c3e60 · c3c3e60
1 parent 027624d
commit c3c3e60
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/schema_salad/tests/test_cwl11.py b/schema_salad/tests/test_cwl11.py
@@ -67,9 +67,10 @@ def test_outputBinding(cwl_v1_2_schema: SchemaType) -> None:
 
 def test_yaml_tab_error(cwl_v1_2_schema: SchemaType) -> None:
     """Tabs in the file."""
+    res: Any = ""
     with pytest.raises(
         ValidationException,
         match=r".+found\s+character\s+'\\t'\s+that\s+cannot\s+start\s+any\s+token$",
     ):
         res = load_cwl(cwl_v1_2_schema, src="test_real_cwl/tabs_rna_seq_workflow.cwl")
-        print(res)
+    print(res)
diff --git a/schema_salad/tests/test_errors.py b/schema_salad/tests/test_errors.py
@@ -132,12 +132,12 @@ def test_error_message5() -> None:
 
     t = "test_schema/test5.cwl"
     match = r"""
-^.+test5\.cwl:2:1: Object\s+'.+test5\.cwl'\s+is\s+not valid because
-\s+tried 'Workflow'\s+but
-.+test5\.cwl:7:1:     the 'steps'\s+field\s+is\s+not\s+valid\s+because
-\s+tried array\s+of\s+<WorkflowStep>\s+but
-.+test5\.cwl:7:9:         item is\s+invalid\s+because
-\s+is not a\s+dict$"""[
+^.+test5\.cwl:2:1: Object\s+'.+test5\.cwl'\s+is\s+not\s+valid\s+because
+\s+tried\s+'Workflow'\s+but
+.+test5\.cwl:7:1:     the\s+'steps'\s+field\s+is\s+not\s+valid\s+because
+\s+tried\s+array\s+of\s+<WorkflowStep>\s+but
+.+test5\.cwl:7:9:         item\s+is\s+invalid\s+because
+\s+is\s+not\s+a\s+dict.\s+Expected\s+a\s+WorkflowStep\s+object.$"""[
         1:
     ]
     with pytest.raises(ValidationException, match=match):

diff --git a/schema_salad/validate.py b/schema_salad/validate.py
@@ -196,7 +196,7 @@ def validate_ex(
             raise ValidationException(
                 "the value {} is not a valid {}, expected {}{}".format(
                     vpformat(datum),
-                    expected_schema.name,
+                    friendly(expected_schema.name),
                     "one of " if len(expected_schema.symbols) > 1 else "",
                     "'" + "', '".join(expected_schema.symbols) + "'",
                 )
@@ -299,7 +299,9 @@ def validate_ex(
     if isinstance(expected_schema, avro.schema.RecordSchema):
         if not isinstance(datum, MutableMapping):
             if raise_ex:
-                raise ValidationException("is not a dict")
+                raise ValidationException(
+                    f"is not a dict. Expected a {friendly(expected_schema.name)} object."
+                )
             return False
 
         classmatch = None