Merge pull request #4833 from StackStorm/orquesta-task-retry

m4dcoder · web-flow · commit b763c7195951 · 2019-12-17T12:19:38.000+08:00
Add support for orquesta task retry
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,7 @@ Added
   parameters to be supplied to the action on every execution of the alias. #4786
 * Add ``get_entrypoint()`` method to ``ActionResourceManager`` attribute of st2client.
   #4791
+* Add support for orquesta task retry. (new feature)
 
 Changed
 ~~~~~~~
diff --git a/contrib/examples/actions/orquesta-task-retry-exhausted.yaml b/contrib/examples/actions/orquesta-task-retry-exhausted.yaml
@@ -0,0 +1,6 @@
+---
+name: orquesta-task-retry-exhausted
+description: A workflow demonstrating what happens when task retries are exhausted.
+runner_type: orquesta
+entry_point: workflows/orquesta-task-retry-exhausted.yaml
+enabled: true
diff --git a/contrib/examples/actions/orquesta-task-retry.yaml b/contrib/examples/actions/orquesta-task-retry.yaml
@@ -0,0 +1,6 @@
+---
+name: orquesta-task-retry
+description: A workflow demonstrating how to use task retry.
+runner_type: orquesta
+entry_point: workflows/orquesta-task-retry.yaml
+enabled: true
diff --git a/contrib/examples/actions/workflows/orquesta-task-retry-exhausted.yaml b/contrib/examples/actions/workflows/orquesta-task-retry-exhausted.yaml
@@ -0,0 +1,37 @@
+version: 1.0
+
+description: >
+  A sample workflow that illustrates what happens when the task retries are exhausted. In this
+  example, the workflow will loop until the file /tmp/done exists. A parallel task will wait for
+  some time before creating the file. When completed, /tmp/done will be deleted. In this case
+  where the retry will be exhausted, the wait will exit before the temp file is created and the
+  workflow will fail as a result.
+
+vars:
+  - file: /tmp/<% str(random(1000000, 9999999)) %>
+
+tasks:
+  init:
+    action: core.local cmd="rm -rf <% ctx().file %>"
+    next:
+      - when: <% succeeded() %>
+        do: check, create
+
+  check:
+    action: core.local
+    input:
+      cmd: >
+        echo 'Do something useful here.';
+        if [ ! -e <% ctx().file %> ]; then exit 1; fi
+    retry:
+      when: <% failed() %>
+      count: 2
+    next:
+      - when: <% succeeded() %>
+        do: delete
+
+  create:
+    action: core.local cmd="sleep 3; touch <% ctx().file %>"
+
+  delete:
+    action: core.local cmd="rm -f <% ctx().file %>"
diff --git a/contrib/examples/actions/workflows/orquesta-task-retry.yaml b/contrib/examples/actions/workflows/orquesta-task-retry.yaml
@@ -0,0 +1,35 @@
+version: 1.0
+
+description: >
+  A sample workflow that illustrates the use of task retry to rerun task on error. In this example,
+  the workflow will loop until the file /tmp/done exists. A parallel task will wait for some time
+  before creating the file. When completed, /tmp/done will be deleted.
+
+vars:
+  - file: /tmp/<% str(random(1000000, 9999999)) %>
+
+tasks:
+  init:
+    action: core.local cmd="rm -rf <% ctx().file %>"
+    next:
+      - when: <% succeeded() %>
+        do: check, create
+
+  check:
+    action: core.local
+    input:
+      cmd: >
+        echo 'Do something useful here.';
+        if [ ! -e <% ctx().file %> ]; then exit 1; fi
+    retry:
+      count: 3
+      delay: 1
+    next:
+      - when: <% succeeded() %>
+        do: delete
+
+  create:
+    action: core.local cmd="sleep 3; touch <% ctx().file %>"
+
+  delete:
+    action: core.local cmd="rm -f <% ctx().file %>"
diff --git a/contrib/runners/orquesta_runner/in-requirements.txt b/contrib/runners/orquesta_runner/in-requirements.txt
@@ -1 +1 @@
-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta
+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta
diff --git a/contrib/runners/orquesta_runner/requirements.txt b/contrib/runners/orquesta_runner/requirements.txt
@@ -5,4 +5,4 @@
 # If you want to update depdencies for a single component, modify the
 # in-requirements.txt for that component and then run 'make requirements' to
 # update the component requirements.txt
-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta
+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta
diff --git a/requirements.txt b/requirements.txt
@@ -14,7 +14,7 @@ cryptography==2.8
 eventlet==0.25.1
 flex==6.14.0
 git+https://github.com/StackStorm/logshipper.git@stackstorm_patched#egg=logshipper
-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta
+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta
 git+https://github.com/StackStorm/python-mistralclient.git#egg=python-mistralclient
 git+https://github.com/StackStorm/st2-auth-backend-flat-file.git@master#egg=st2-auth-backend-flat-file
 gitpython==2.1.11
diff --git a/st2common/in-requirements.txt b/st2common/in-requirements.txt
@@ -9,7 +9,7 @@ jsonschema
 kombu
 mongoengine
 networkx
-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta
+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta
 oslo.config
 paramiko
 pyyaml
diff --git a/st2common/requirements.txt b/st2common/requirements.txt
@@ -10,7 +10,7 @@ apscheduler==3.6.3
 cryptography==2.8
 eventlet==0.25.1
 flex==6.14.0
-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta
+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta
 gitpython==2.1.11
 greenlet==0.4.15
 ipaddr
diff --git a/st2tests/integration/orquesta/test_wiring_task_retry.py b/st2tests/integration/orquesta/test_wiring_task_retry.py
@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2019 Extreme Networks, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import
+
+from integration.orquesta import base
+
+from st2common.constants import action as ac_const
+
+
+class TaskRetryWiringTest(base.TestWorkflowExecution):
+
+    def test_task_retry(self):
+        wf_name = 'examples.orquesta-task-retry'
+
+        ex = self._execute_workflow(wf_name)
+        ex = self._wait_for_completion(ex)
+
+        self.assertEqual(ex.status, ac_const.LIVEACTION_STATUS_SUCCEEDED)
+
+        # Assert there are retries for the task.
+        task_exs = [
+            task_ex for task_ex in self._get_children(ex)
+            if task_ex.context.get('orquesta', {}).get('task_name', '') == 'check'
+        ]
+
+        self.assertGreater(len(task_exs), 1)
+
+    def test_task_retry_exhausted(self):
+        wf_name = 'examples.orquesta-task-retry-exhausted'
+
+        ex = self._execute_workflow(wf_name)
+        ex = self._wait_for_completion(ex)
+
+        # Assert the workflow has failed.
+        self.assertEqual(ex.status, ac_const.LIVEACTION_STATUS_FAILED)
+
+        # Assert the task has exhausted the number of retries
+        task_exs = [
+            task_ex for task_ex in self._get_children(ex)
+            if task_ex.context.get('orquesta', {}).get('task_name', '') == 'check'
+        ]
+
+        self.assertListEqual(['failed'] * 3, [task_ex.status for task_ex in task_exs])
+
+        # Assert the task following the retry task is not run.
+        task_exs = [
+            task_ex for task_ex in self._get_children(ex)
+            if task_ex.context.get('orquesta', {}).get('task_name', '') == 'delete'
+        ]
+
+        self.assertEqual(len(task_exs), 0)

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-git+https://github.com/StackStorm/orquesta.git@c80b139d8bbd7d59ccdc0461564e6a754066adaa#egg=orquesta`
	`1`	`+git+https://github.com/StackStorm/orquesta.git@9706dc1f13a44deadb6cefc8e92c83caad591127#egg=orquesta`