Merge pull request #19 from cloudblue/runner-improvements

ffaraoneim · web-flow · commit 3f1b67b48d3f · 2021-07-23T17:48:45.000+02:00
Runner improvements
diff --git a/connect/eaas/extension.py b/connect/eaas/extension.py
@@ -17,9 +17,9 @@ def __init__(self, status):
 
 class ProcessingResponse(_Response):
 
-    def __init__(self, status, countdown=0, output=None):
+    def __init__(self, status, countdown=30, output=None):
         super().__init__(status)
-        self.countdown = countdown
+        self.countdown = 30 if countdown < 30 else countdown
         self.output = output
 
     @classmethod
@@ -34,23 +34,40 @@ def skip(cls, output=None):
     def reschedule(cls, countdown=30):
         return cls(ResultType.RESCHEDULE, countdown=countdown)
 
+    @classmethod
+    def slow_process_reschedule(cls, countdown=300):
+        return cls(
+            ResultType.RESCHEDULE,
+            countdown=300 if countdown < 300 else countdown,
+        )
+
+    @classmethod
+    def fail(cls, output=None):
+        return cls(ResultType.FAIL, output=output)
+
 
 class ValidationResponse(_Response):
-    def __init__(self, status, data):
+    def __init__(self, status, data, output=None):
         super().__init__(status)
         self.data = data
+        self.output = output
 
     @classmethod
     def done(cls, data):
         return cls(ResultType.SUCCESS, data)
 
+    @classmethod
+    def fail(cls, data=None, output=None):
+        return cls(ResultType.FAIL, data=data, output=output)
+
 
 class _InteractiveTaskResponse(_Response):
-    def __init__(self, status, http_status, headers, body):
+    def __init__(self, status, http_status, headers, body, output):
         super().__init__(status)
         self.http_status = http_status
         self.headers = headers
         self.body = body
+        self.output = output
 
     @property
     def data(self):
@@ -62,7 +79,11 @@ def data(self):
 
     @classmethod
     def done(cls, http_status=200, headers=None, body=None):
-        return cls(ResultType.SUCCESS, http_status, headers, body)
+        return cls(ResultType.SUCCESS, http_status, headers, body, None)
+
+    @classmethod
+    def fail(cls, http_status=400, headers=None, body=None, output=None):
+        return cls(ResultType.FAIL, http_status, headers, body, output)
 
 
 class CustomEventResponse(_InteractiveTaskResponse):
diff --git a/connect/eaas/manager.py b/connect/eaas/manager.py
@@ -24,6 +24,7 @@
     ResultType,
     TaskCategory,
     TaskPayload,
+    TaskType,
 )
 from connect.eaas.extension import ProcessingResponse
 
@@ -226,13 +227,16 @@ async def build_bg_response(self, task_data, future):
             result = await asyncio.wait_for(future, timeout=BACKGROUND_TASK_MAX_EXECUTION_TIME)
         except Exception as e:
             logger.warning(f'Got exception during execution of task {task_data.task_id}: {e}')
+            self.worker.get_extension().logger.exception(
+                f'Unhandled exception during execution of task {task_data.task_id}',
+            )
             result_message.result = ResultType.RETRY
-            result_message.output = str(e)
+            result_message.output = str(e) or repr(e)
             return result_message
         logger.debug(f'result: {result}')
         result_message.result = result.status
 
-        if result.status == ResultType.SKIP:
+        if result.status in (ResultType.SKIP, ResultType.FAIL):
             result_message.output = result.output
 
         if result.status == ResultType.RESCHEDULE:
@@ -249,10 +253,24 @@ async def build_interactive_response(self, task_data, future):
             result = await asyncio.wait_for(future, timeout=INTERACTIVE_TASK_MAX_EXECUTION_TIME)
         except Exception as e:
             logger.warning(f'Got exception during execution of task {task_data.task_id}: {e}')
+            self.worker.get_extension().logger.exception(
+                f'Unhandled exception during execution of task {task_data.task_id}',
+            )
             result_message.result = ResultType.FAIL
-            result_message.output = str(e)
+            result_message.output = str(e) or repr(e)
+            if result_message.task_type in (
+                TaskType.PRODUCT_ACTION_EXECUTION,
+                TaskType.PRODUCT_CUSTOM_EVENT_PROCESSING,
+            ):
+                result_message.data = {
+                    'http_status': 400,
+                    'headers': None,
+                    'body': result_message.output,
+                }
+
             return result_message
 
         result_message.result = result.status
         result_message.data = result.data
+        result_message.output = result.output
         return result_message
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -35,14 +35,18 @@ async def _ws_server(handler):
 
 @pytest.fixture
 def extension_cls():
-    def _extension(method_name, result=None, async_impl=False):
+    def _extension(method_name, result=None, async_impl=False, exception=None):
         class TestExtension(Extension):
             pass
 
         def ext_method(self, request):
+            if exception:
+                raise exception
             return result or ProcessingResponse.done()
 
         async def async_ext_method(self, request):
+            if exception:
+                raise exception
             return result or ProcessingResponse.done()
 
         if async_impl:
diff --git a/tests/test_dataclasses.py b/tests/test_dataclasses.py
@@ -0,0 +1,54 @@
+from connect.eaas.dataclasses import (
+    CapabilitiesPayload,
+    ConfigurationPayload,
+    Message,
+    MessageType,
+
+)
+
+
+def test_capabilities_payload():
+    assert CapabilitiesPayload(
+        {'cap1': 'val1'},
+        'https://example.com/readme',
+        'https://example.com/changelog',
+    ).to_json() == {
+        'capabilities': {'cap1': 'val1'},
+        'readme_url': 'https://example.com/readme',
+        'changelog_url': 'https://example.com/changelog',
+    }
+
+
+def test_configuration_payload():
+    assert ConfigurationPayload(
+        {'conf1': 'val1'},
+        'logging-token',
+        'environ-type',
+        'log-level',
+        'runner-log-level',
+    ).to_json() == {
+        'configuration': {'conf1': 'val1'},
+        'logging_api_key': 'logging-token',
+        'environment_type': 'environ-type',
+        'log_level': 'log-level',
+        'runner_log_level': 'runner-log-level',
+    }
+
+
+def test_message_capabilities():
+    cap = CapabilitiesPayload(
+        {'cap1': 'val1'},
+        'https://example.com/readme',
+        'https://example.com/changelog',
+    )
+
+    msg = Message(
+        MessageType.CAPABILITIES,
+        cap.to_json(),
+    )
+    assert msg.data == cap
+
+    assert msg.to_json() == {
+        'message_type': MessageType.CAPABILITIES,
+        'data': cap.to_json(),
+    }
diff --git a/tests/test_extension.py b/tests/test_extension.py
@@ -1,3 +1,5 @@
+import pytest
+
 from connect.eaas.dataclasses import ResultType
 from connect.eaas.extension import (
     CustomEventResponse,
@@ -25,26 +27,73 @@ def test_result_skip_with_output():
     assert skip.output == 'output'
 
 
-def test_result_reschedule():
-    r = ProcessingResponse.reschedule(60)
+@pytest.mark.parametrize(
+    ('countdown', 'expected'),
+    (
+        (0, 30),
+        (-1, 30),
+        (1, 30),
+        (30, 30),
+        (31, 31),
+        (100, 100),
+    ),
+)
+def test_result_reschedule(countdown, expected):
+    r = ProcessingResponse.reschedule(countdown)
 
     assert r.status == ResultType.RESCHEDULE
-    assert r.countdown == 60
+    assert r.countdown == expected
+
+
+@pytest.mark.parametrize(
+    ('countdown', 'expected'),
+    (
+        (0, 300),
+        (-1, 300),
+        (1, 300),
+        (30, 300),
+        (300, 300),
+        (600, 600),
+    ),
+)
+def test_result_slow_reschedule(countdown, expected):
+    r = ProcessingResponse.slow_process_reschedule(countdown)
+
+    assert r.status == ResultType.RESCHEDULE
+    assert r.countdown == expected
+
+
+@pytest.mark.parametrize(
+    'response_cls',
+    (
+        ProcessingResponse, ValidationResponse,
+        CustomEventResponse, ProductActionResponse,
+    ),
+)
+def test_result_fail(response_cls):
+    r = response_cls.fail(output='reason of failure')
+
+    assert r.status == ResultType.FAIL
+    assert r.output == 'reason of failure'
 
 
 def test_custom_event():
     r = CustomEventResponse.done(headers={'X-Custom-Header': 'value'}, body='text')
 
     assert r.status == ResultType.SUCCESS
-    assert r.http_status == 200
-    assert r.headers == {'X-Custom-Header': 'value'}
-    assert r.body == 'text'
+    assert r.data == {
+        'http_status': 200,
+        'headers': {'X-Custom-Header': 'value'},
+        'body': 'text',
+    }
 
 
 def test_product_action():
     r = ProductActionResponse.done(headers={'X-Custom-Header': 'value'}, body='text')
 
     assert r.status == ResultType.SUCCESS
-    assert r.http_status == 200
-    assert r.headers == {'X-Custom-Header': 'value'}
-    assert r.body == 'text'
+    assert r.data == {
+        'http_status': 200,
+        'headers': {'X-Custom-Header': 'value'},
+        'body': 'text',
+    }
diff --git a/tests/test_manager.py b/tests/test_manager.py
