fdda862e7c
* A number of Mistral REST API endpoints support parameters that allow to filter colections. For example, we can pass do 'GET /v2/actions?name=in:std.' in a query string and Mistral will return only actions containing 'std.' in their name. This capability was missing in the client APIs, this patch adds corresponding parameters in the APIs for actions, workflows, executions (workflow executions) and tasks (task executions). TODO: - Add required tests Partially implements: blueprint mistral-client-api-filters Change-Id: Ic49f58626cf129f9c9399268c3cd12cc93eee039
129 lines
3.8 KiB
Python
129 lines
3.8 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 mistralclient.api import base
|
|
from mistralclient import utils
|
|
|
|
|
|
urlparse = six.moves.urllib.parse
|
|
|
|
|
|
class Workflow(base.Resource):
|
|
resource_name = 'Workflow'
|
|
|
|
|
|
class WorkflowManager(base.ResourceManager):
|
|
resource_class = Workflow
|
|
|
|
def create(self, definition, scope='private'):
|
|
self._ensure_not_empty(definition=definition)
|
|
|
|
# If the specified definition is actually a file, read in the
|
|
# definition file
|
|
definition = utils.get_contents_if_file(definition)
|
|
|
|
resp = self.http_client.post(
|
|
'/workflows?scope=%s' % scope,
|
|
definition,
|
|
headers={'content-type': 'text/plain'}
|
|
)
|
|
|
|
if resp.status_code != 201:
|
|
self._raise_api_exception(resp)
|
|
|
|
return [self.resource_class(self, resource_data)
|
|
for resource_data in base.extract_json(resp, 'workflows')]
|
|
|
|
def update(self, definition, scope='private', id=None):
|
|
self._ensure_not_empty(definition=definition)
|
|
|
|
url_pre = ('/workflows/%s' % id) if id else '/workflows'
|
|
|
|
# If the specified definition is actually a file, read in the
|
|
# definition file
|
|
definition = utils.get_contents_if_file(definition)
|
|
|
|
resp = self.http_client.put(
|
|
'%s?scope=%s' % (url_pre, scope),
|
|
definition,
|
|
headers={'content-type': 'text/plain'}
|
|
)
|
|
|
|
if resp.status_code != 200:
|
|
self._raise_api_exception(resp)
|
|
|
|
if id:
|
|
return self.resource_class(self, base.extract_json(resp, None))
|
|
|
|
return [self.resource_class(self, resource_data)
|
|
for resource_data in base.extract_json(resp, 'workflows')]
|
|
|
|
def list(self, marker='', limit=None, sort_keys='', sort_dirs='',
|
|
**filters):
|
|
qparams = {}
|
|
|
|
if marker:
|
|
qparams['marker'] = marker
|
|
|
|
if limit:
|
|
qparams['limit'] = limit
|
|
|
|
if sort_keys:
|
|
qparams['sort_keys'] = sort_keys
|
|
|
|
if sort_dirs:
|
|
qparams['sort_dirs'] = sort_dirs
|
|
|
|
for name, val in filters.items():
|
|
qparams[name] = val
|
|
|
|
query_string = ("?%s" % urlparse.urlencode(list(qparams.items()))
|
|
if qparams else "")
|
|
|
|
return self._list(
|
|
'/workflows%s' % query_string,
|
|
response_key='workflows',
|
|
)
|
|
|
|
def get(self, identifier):
|
|
self._ensure_not_empty(identifier=identifier)
|
|
|
|
return self._get('/workflows/%s' % identifier)
|
|
|
|
def delete(self, identifier):
|
|
self._ensure_not_empty(identifier=identifier)
|
|
|
|
self._delete('/workflows/%s' % identifier)
|
|
|
|
def validate(self, definition):
|
|
self._ensure_not_empty(definition=definition)
|
|
|
|
# If the specified definition is actually a file, read in the
|
|
# definition file
|
|
definition = utils.get_contents_if_file(definition)
|
|
|
|
resp = self.http_client.post(
|
|
'/workflows/validate',
|
|
definition,
|
|
headers={'content-type': 'text/plain'}
|
|
)
|
|
|
|
if resp.status_code != 200:
|
|
self._raise_api_exception(resp)
|
|
|
|
return base.extract_json(resp, None)
|