Added tests for action errors -> HTTP codes

Author: rwb27

tests/conftest.py

@@ -5,7 +5,7 @@
 import pytest
 from apispec import APISpec
 from apispec.ext.marshmallow import MarshmallowPlugin
-from flask import Flask
+from flask import Flask, abort
 from flask.testing import FlaskClient
 from flask.views import MethodView
 from marshmallow import validate
@@ -188,7 +188,7 @@ class TestAction(ActionView):
         def post(self):
             return "POST"
 
-    thing.add_view(TestAction, "TestAction")
+    thing.add_view(TestAction, "/TestAction")
 
     class TestProperty(PropertyView):
         schema = {"count": fields.Integer()}
@@ -199,7 +199,7 @@ def get(self):
         def post(self, args):
             pass
 
-    thing.add_view(TestProperty, "TestProperty")
+    thing.add_view(TestProperty, "/TestProperty")
 
     class TestFieldProperty(PropertyView):
         schema = fields.String(validate=validate.OneOf(["one", "two"]))
@@ -210,7 +210,28 @@ def get(self):
         def post(self, args):
             pass
 
-    thing.add_view(TestFieldProperty, "TestFieldProperty")
+    thing.add_view(TestFieldProperty, "/TestFieldProperty")
+    
+    class FailAction(ActionView):
+        wait_for = 1.0
+        def post(self):
+            raise Exception("This action is meant to fail with an Exception")
+    
+    thing.add_view(FailAction, "/FailAction")
+
+    class AbortAction(ActionView):
+        wait_for = 1.0
+        def post(self):
+            abort(418, "I'm a teapot! This action should abort with an HTTP code 418")
+    
+    thing.add_view(AbortAction, "/AbortAction")
+
+    class ActionWithValidation(ActionView):
+        wait_for = 1.0
+        args = {"test_arg": fields.String(validate=validate.OneOf(["one", "two"]))}
+        def post(self):
+            return True
+    thing.add_view(ActionWithValidation, "/ActionWithValidation")
 
     return thing
 

tests/test_action_api.py

@@ -0,0 +1,50 @@
+import pytest
+import time
+import json
+
+from labthings import LabThing
+from labthings.views import ActionView
+
+@pytest.mark.filterwarnings("ignore:Exception in thread")
+def test_action_exception_handling(thing_with_some_views, client):
+    """Check errors in an Action are handled correctly
+
+    
+
+    `/FieldProperty` has a validation constraint - it
+    should return a "bad response" error if invoked with
+    anything other than 
+    """
+    # `/FailAction` raises an `Exception`.    
+    # This ought to return a 201 code representing the 
+    # action that was successfully started - but should 
+    # show that it failed through the "status" field.
+
+    # This is correct for the current (24/7/2021) behaviour
+    # but may want to change for the next version, e.g. 
+    # returning a 500 code.  For further discussion...
+    r = client.post("/FailAction")
+    assert r.status_code == 201
+    action = r.get_json()
+    assert action["status"] == "error"
+
+def test_action_abort_and_validation(thing_with_some_views, client):
+    """Check HTTPExceptions result in error codes.
+    
+    Subclasses of HTTPError should result in a non-200 return code, not
+    just failures.  This covers Marshmallow validation (400) and
+    use of `abort()`.
+    """
+    # `/AbortAction` should return a 418 error code
+    r = client.post("/AbortAction")
+    assert r.status_code == 418
+    
+def test_action_validate(thing_with_some_views, client):
+    # `/ActionWithValidation` should fail with a 400 error
+    # if `test_arg` is not either `one` or `two`
+    r = client.post("/ActionWithValidation", data=json.dumps({"test_arg":"one"}))
+    assert r.status_code in [200, 201]
+    r = client.post("/ActionWithValidation", data=json.dumps({"test_arg":"three"}))
+    assert r.status_code in [422]
+    
+