GET entrypoint of a workflow from st2client

CHANGELOG.rst

@@ -11,6 +11,7 @@ Added
   ``url_hosts_blacklist`` and ``url_hosts_whitelist`` runner attribute. (new feature)
   #4757
 * Add ``user`` parameter to ``re_run`` method of st2client. #4785
+* Add ``get_entrypoint()`` method to ``ActionResourceManager`` attribute of st2client. #4791  
 
 Changed
 ~~~~~~~

st2client/st2client/client.py

@@ -25,6 +25,7 @@
 from st2client.models.core import ResourceManager
 from st2client.models.core import ActionAliasResourceManager
 from st2client.models.core import ActionAliasExecutionManager
+from st2client.models.core import ActionResourceManager
 from st2client.models.core import ExecutionResourceManager
 from st2client.models.core import InquiryResourceManager
 from st2client.models.core import TriggerInstanceResourceManager
@@ -118,7 +119,7 @@ def __init__(self, base_url=None, auth_url=None, api_url=None, stream_url=None,
             models.Token, self.endpoints['auth'], cacert=self.cacert, debug=self.debug)
         self.managers['RunnerType'] = ResourceManager(
             models.RunnerType, self.endpoints['api'], cacert=self.cacert, debug=self.debug)
-        self.managers['Action'] = ResourceManager(
+        self.managers['Action'] = ActionResourceManager(
             models.Action, self.endpoints['api'], cacert=self.cacert, debug=self.debug)
         self.managers['ActionAlias'] = ActionAliasResourceManager(
             models.ActionAlias, self.endpoints['api'], cacert=self.cacert, debug=self.debug)

st2client/st2client/models/action.py

@@ -33,6 +33,7 @@ class RunnerType(core.Resource):
 class Action(core.Resource):
     _plural = 'Actions'
     _repr_attributes = ['name', 'pack', 'enabled', 'runner_type']
+    _url_path = 'actions'
 
 
 class Execution(core.Resource):

st2client/st2client/models/core.py

@@ -376,6 +376,18 @@ def match_and_execute(self, instance, **kwargs):
         return instance
 
 
+class ActionResourceManager(ResourceManager):
+    @add_auth_token_to_kwargs_from_env
+    def get_entrypoint(self, ref_or_id, **kwargs):
+        url = '/%s/views/entry_point/%s' % (self.resource.get_url_path_name(), ref_or_id)
+
+        response = self.client.get(url, **kwargs)
+        if response.status_code != http_client.OK:
+            self.handle_error(response)
+
+        return response.text
+
+
 class ExecutionResourceManager(ResourceManager):
     @add_auth_token_to_kwargs_from_env
     def re_run(self, execution_id, parameters=None, tasks=None, no_reset=None, user=None, delay=0,

st2client/tests/unit/test_client_actions.py

@@ -0,0 +1,104 @@
+# 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
+
+import json
+import logging
+import mock
+import unittest2
+
+from tests import base
+
+from st2client import client
+from st2client.utils import httpclient
+
+
+LOG = logging.getLogger(__name__)
+
+
+EXECUTION = {
+    "id": 12345,
+    "action": {
+        "ref": "mock.foobar"
+    },
+    "status": "failed",
+    "result": "non-empty"
+}
+
+ENTRYPOINT = (
+    "version: 1.0"
+
+    "description: A basic workflow that runs an arbitrary linux command."
+
+    "input:"
+    "  - cmd"
+    "  - timeout"
+
+    "tasks:"
+    "  task1:"
+    "    action: core.local cmd=<% ctx(cmd) %> timeout=<% ctx(timeout) %>"
+    "    next:"
+    "      - when: <% succeeded() %>"
+    "        publish:"
+    "          - stdout: <% result().stdout %>"
+    "          - stderr: <% result().stderr %>"
+
+    "output:"
+    "  - stdout: <% ctx(stdout) %>"
+)
+
+
+class TestActionResourceManager(unittest2.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestActionResourceManager, cls).setUpClass()
+        cls.client = client.Client()
+
+    @mock.patch.object(
+        httpclient.HTTPClient, 'get',
+        mock.MagicMock(return_value=base.FakeResponse(json.dumps(ENTRYPOINT), 200, 'OK')))
+    def test_get_action_entry_point_by_ref(self):
+        actual_entrypoint = self.client.actions.get_entrypoint(EXECUTION['action']['ref'])
+        actual_entrypoint = json.loads(actual_entrypoint)
+
+        endpoint = '/actions/views/entry_point/%s' % EXECUTION['action']['ref']
+        httpclient.HTTPClient.get.assert_called_with(endpoint)
+
+        self.assertEqual(ENTRYPOINT, actual_entrypoint)
+
+    @mock.patch.object(
+        httpclient.HTTPClient, 'get',
+        mock.MagicMock(return_value=base.FakeResponse(json.dumps(ENTRYPOINT), 200, 'OK')))
+    def test_get_action_entry_point_by_id(self):
+        actual_entrypoint = self.client.actions.get_entrypoint(EXECUTION['id'])
+        actual_entrypoint = json.loads(actual_entrypoint)
+
+        endpoint = '/actions/views/entry_point/%s' % EXECUTION['id']
+        httpclient.HTTPClient.get.assert_called_with(endpoint)
+
+        self.assertEqual(ENTRYPOINT, actual_entrypoint)
+
+    @mock.patch.object(
+        httpclient.HTTPClient, 'get',
+        mock.MagicMock(return_value=base.FakeResponse(
+            json.dumps({}), 404, '404 Client Error: Not Found'
+        )))
+    def test_get_non_existent_action_entry_point(self):
+        with self.assertRaisesRegexp(Exception, '404 Client Error: Not Found'):
+            self.client.actions.get_entrypoint('nonexistentpack.nonexistentaction')
+
+        endpoint = '/actions/views/entry_point/%s' % 'nonexistentpack.nonexistentaction'
+        httpclient.HTTPClient.get.assert_called_with(endpoint)