Give more informative validation errors

Author: jsignell

stactask/task.py

@@ -157,6 +157,8 @@ def items(self) -> ItemCollection:
 
     @classmethod
     def validate(cls, payload: Dict[str, Any]) -> bool:
+        """Validates the payload and returns True if valid. If invalid, raises
+        ``stactask.exceptions.FailedValidation`` or returns False."""
         # put validation logic on input Items and process definition here
         return True
 

tests/tasks.py

@@ -1,6 +1,7 @@
 from typing import Any, Dict, List
 
 from stactask import Task
+from stactask.exceptions import FailedValidation
 
 
 class NothingTask(Task):
@@ -17,7 +18,9 @@ class FailValidateTask(Task):
 
     @classmethod
     def validate(self, payload: Dict[str, Any]) -> bool:
-        return False
+        if payload:
+            raise FailedValidation("Extra context about what went wrong")
+        return True
 
     def process(self, **kwargs: Any) -> List[Dict[str, Any]]:
         return self.items_as_dicts

tests/test_task.py

@@ -41,7 +41,7 @@ def test_task_init(nothing_task: Task) -> None:
 
 
 def test_failed_validation(items: Dict[str, Any]) -> None:
-    with pytest.raises(FailedValidation):
+    with pytest.raises(FailedValidation, match="Extra context"):
         FailValidateTask(items)