python-mistralclient/mistralclient/utils.py
Daryl Mowrer 72a6bc1ad1 Change the mistralclient for Mistral action pack
The purpose of this patch is to make the new Mistral action pack
actions more useful when they are coded in a workflow or workbook.

The new Mistral action pack actions are executed by calling the
appropriate python-mistralclient API methods. The API methods to
create/update/validate the workbook/workflow/action/environment
resources do not read the definitions/environments from files as the
CLI commands do. They require the actual definition/environement be
passed in as an argument. This can lead to problems when trying to
use the Mistral action pack actions from within a workflow or
workbook.

For example, the workflow create/update/validate methods all take a
definition argument. The mistralclient APIs are currently coded to
take the actual definition, and not the definition file name as the
CLI does. This leads to problems when coding the
mistral.workflows_create action in a workflow for example. If the
actual definition is passed into the action in the workflow YAML, any
YAQL expressions in the workflow being created by that action get
evaluated when read, and are not stored in the database as desired.
This essentially makes it useless unless the workflow you are
creating does not contain any YAQL. That is unrealistic.

This patch enhances those methods of the mistralclient so that they
can take either the actual definition, or the definition file name or
file URI. This allows the action to be coded in a workflow in a way
similar to the CLI by allowing the definition file name, or file URI
to be specified instead of the actual definition. The change allows
either the actual definition or the definition file name, or file
URI to be specified when calling the affected mistralclient API
methods. No changes to the API signatures are required. Each method
affected will determine if the value passed in is a definition file
name or file URI, or the actual definition.

New unit test cases were also added for these changes.

Change-Id: I9ca07bedf685839db130693a7aa6e091a9b8c4ad
Implements: blueprint mistral-mistral-actions
2016-02-26 11:58:13 -06:00

82 lines
2.4 KiB
Python

# Copyright 2015 - Huawei Technologies Co. Ltd
# 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 json
import os
import yaml
from six.moves.urllib import parse
from six.moves.urllib import request
from mistralclient import exceptions
def do_action_on_many(action, resources, success_msg, error_msg):
"""Helper to run an action on many resources."""
failure_flag = False
for resource in resources:
try:
action(resource)
print(success_msg % resource)
except Exception as e:
failure_flag = True
print(e)
if failure_flag:
raise exceptions.MistralClientException(error_msg)
def load_content(content):
if content is None or content == '':
return dict()
try:
data = yaml.safe_load(content)
except Exception:
data = json.loads(content)
return data
def load_file(path):
with open(path, 'r') as f:
return load_content(f.read())
def get_contents_if_file(contents_or_file_name):
"""Get the contents of a file.
If the value passed in is a file name or file URI, return the
contents. If not, or there is an error reading the file contents,
return the value passed in as the contents.
For example, a workflow definition will be returned if either the
workflow definition file name, or file URI are passed in, or the
actual workflow definition itself is passed in.
"""
try:
if parse.urlparse(contents_or_file_name).scheme:
definition_url = contents_or_file_name
else:
path = os.path.abspath(contents_or_file_name)
definition_url = parse.urljoin(
'file:',
request.pathname2url(path)
)
return request.urlopen(definition_url).read().decode('utf8')
except Exception:
return contents_or_file_name