Files
python-mistralclient/mistralclient/api/v2/executions.py
ali 23270d272a Add new CLI commands for sub-executions new API endpoints
*2 new CLI commands were added:

   - execution-get-sub-executions
       returns the sub-executions of a given execution id

   - task-get-sub-executions
       returns the sub-executions of a given task-execution id

 both commands have the options
  --errors_only: returns only the error routes
               - default is False
  --max_depth: the max depth for the returned executions
             - if a negative value is given, then the API will return
               all sub-executions
             - default is -1

Change-Id: Ifcd25cfdbfb99613ff1bdccf8b94b3929f02a71d
Implements: blueprint mistral-execution-origin
Signed-off-by: ali <ali.abdelal@nokia.com>
2020-01-28 07:14:47 +00:00

140 lines
4.0 KiB
Python

# Copyright 2014 - Mirantis, Inc.
# Copyright 2015 - StackStorm, 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.
import six
from oslo_serialization import jsonutils
from oslo_utils import uuidutils
from mistralclient.api import base
class Execution(base.Resource):
resource_name = 'Execution'
class ExecutionManager(base.ResourceManager):
resource_class = Execution
def create(self, workflow_identifier='', namespace='',
workflow_input=None, description='', source_execution_id=None,
**params):
self._ensure_not_empty(
workflow_identifier=workflow_identifier or source_execution_id
)
data = {'description': description}
if uuidutils.is_uuid_like(source_execution_id):
data.update({'source_execution_id': source_execution_id})
if workflow_identifier:
if uuidutils.is_uuid_like(workflow_identifier):
data.update({'workflow_id': workflow_identifier})
else:
data.update({'workflow_name': workflow_identifier})
if namespace:
data.update({'workflow_namespace': namespace})
if workflow_input:
if isinstance(workflow_input, six.string_types):
data.update({'input': workflow_input})
else:
data.update({'input': jsonutils.dumps(workflow_input)})
if params:
data.update({'params': jsonutils.dumps(params)})
return self._create('/executions', data)
def update(self, id, state, description=None, env=None):
data = {}
if state:
data['state'] = state
if description:
data['description'] = description
if env:
data['params'] = {'env': env}
return self._update('/executions/%s' % id, data)
def list(self, task=None, marker='', limit=None, sort_keys='',
sort_dirs='', fields='', **filters):
if task:
filters['task_execution_id'] = task
query_string = self._build_query_params(
marker=marker,
limit=limit,
sort_keys=sort_keys,
sort_dirs=sort_dirs,
fields=fields,
filters=filters
)
return self._list(
'/executions%s' % query_string,
response_key='executions',
)
def get(self, id):
self._ensure_not_empty(id=id)
return self._get('/executions/%s' % id)
def get_ex_sub_executions(self, id, errors_only='', max_depth=-1):
ex_sub_execs_path = '/executions/%s/executions%s'
params = '?max_depth=%s&errors_only=%s' % (max_depth, errors_only)
return self._list(
ex_sub_execs_path % (id, params),
response_key='executions'
)
def delete(self, id, force=None):
self._ensure_not_empty(id=id)
query_params = {}
if force:
query_params['force'] = True
query_string = self._build_query_params(filters=query_params)
self._delete('/executions/%s%s' % (id, query_string))
def get_report(self, id, errors_only=True, max_depth=None):
self._ensure_not_empty(id=id)
query_params = {}
if errors_only:
query_params['errors_only'] = True
if max_depth is not None:
query_params['max_depth'] = max_depth
query_string = self._build_query_params(filters=query_params)
resp = self.http_client.get(
'/executions/%s/report%s' % (id, query_string)
)
return resp.json()