Files
python-mistralclient/mistralclient/commands/v2/executions.py
LingxianKong 66b3faabc0 Add description param for execution create/update
With this patch, users could do the following:

mistral exeuction-create wf -d my_first_executio
mistral execution-update d8922ca3-7908-4267-af03-bfad3d95fae2 -d
my_second_execution

However, state and description can't be updated at the same time, since
there is no such scenario and avoid the implementation complexity.

Add some tests accordingly.

Change-Id: Ie10339e5da486a4e2a3e5d31557016be8b3f4fc6
Implements: blueprint workflow-execution-description-support
2015-06-23 17:15:00 +08:00

253 lines
6.5 KiB
Python

# Copyright 2014 - Mirantis, Inc.
# All Rights Reserved
#
# 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 logging
from cliff import command
from cliff import show
from mistralclient.api.v2 import executions
from mistralclient.commands.v2 import base
from mistralclient import utils
LOG = logging.getLogger(__name__)
def format_list(execution=None):
return format(execution, lister=True)
def format(execution=None, lister=False):
columns = (
'ID',
'Workflow',
'Description',
'State',
'State info',
'Created at',
'Updated at'
)
# TODO(nmakhotkin) Add parent task id when it's implemented in API.
if execution:
state_info = (execution.state_info if not lister
else base.cut(execution.state_info))
data = (
execution.id,
execution.workflow_name,
execution.description,
execution.state,
state_info,
execution.created_at,
execution.updated_at or '<none>'
)
else:
data = (tuple('<none>' for _ in range(len(columns))),)
return columns, data
class List(base.MistralLister):
"""List all executions."""
def _get_format_function(self):
return format_list
def _get_resources(self, parsed_args):
return executions.ExecutionManager(self.app.client).list()
class Get(show.ShowOne):
"""Show specific execution."""
def get_parser(self, prog_name):
parser = super(Get, self).get_parser(prog_name)
parser.add_argument('id', help='Execution identifier')
return parser
def take_action(self, parsed_args):
execution = executions.ExecutionManager(self.app.client).get(
parsed_args.id)
return format(execution)
class Create(show.ShowOne):
"""Create new execution."""
def get_parser(self, prog_name):
parser = super(Create, self).get_parser(prog_name)
parser.add_argument(
'workflow_name',
help='Workflow name'
)
parser.add_argument(
'workflow_input',
nargs='?',
help='Workflow input'
)
parser.add_argument(
'params',
nargs='?',
help='Workflow additional parameters'
)
parser.add_argument(
'-d',
'--description',
dest='description',
default='',
help='Execution description'
)
return parser
def take_action(self, parsed_args):
if parsed_args.workflow_input:
try:
wf_input = json.loads(parsed_args.workflow_input)
except:
wf_input = json.load(open(parsed_args.workflow_input))
else:
wf_input = {}
if parsed_args.params:
try:
params = json.loads(parsed_args.params)
except:
params = json.load(open(parsed_args.params))
else:
params = {}
execution = executions.ExecutionManager(self.app.client).create(
parsed_args.workflow_name,
wf_input,
parsed_args.description,
**params)
return format(execution)
class Delete(command.Command):
"""Delete execution."""
def get_parser(self, prog_name):
parser = super(Delete, self).get_parser(prog_name)
parser.add_argument(
'id',
nargs='+',
help='Id of execution identifier(s).'
)
return parser
def take_action(self, parsed_args):
exe_mgr = executions.ExecutionManager(self.app.client)
utils.do_action_on_many(
lambda s: exe_mgr.delete(s),
parsed_args.id,
"Request to delete execution %s has been accepted.",
"Unable to delete the specified execution(s)."
)
class Update(show.ShowOne):
"""Update execution."""
def get_parser(self, prog_name):
parser = super(Update, self).get_parser(prog_name)
parser.add_argument(
'id',
help='Execution identifier'
)
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument(
'-s',
'--state',
dest='state',
choices=['RUNNING', 'PAUSED', 'SUCCESS', 'ERROR'],
help='Execution state'
)
group.add_argument(
'-d',
'--description',
dest='description',
help='Execution description'
)
return parser
def take_action(self, parsed_args):
execution = executions.ExecutionManager(self.app.client).update(
parsed_args.id,
parsed_args.state,
parsed_args.description)
return format(execution)
class GetInput(command.Command):
"""Show execution input data."""
def get_parser(self, prog_name):
parser = super(GetInput, self).get_parser(prog_name)
parser.add_argument('id', help='Execution ID')
return parser
def take_action(self, parsed_args):
ex_input = executions.ExecutionManager(self.app.client).get(
parsed_args.id).input
try:
ex_input = json.loads(ex_input)
ex_input = json.dumps(ex_input, indent=4) + "\n"
except:
LOG.debug("Execution input is not JSON.")
self.app.stdout.write(ex_input or "\n")
class GetOutput(command.Command):
"""Show execution output data."""
def get_parser(self, prog_name):
parser = super(GetOutput, self).get_parser(prog_name)
parser.add_argument('id', help='Execution ID')
return parser
def take_action(self, parsed_args):
output = executions.ExecutionManager(self.app.client).get(
parsed_args.id).output
try:
output = json.loads(output)
output = json.dumps(output, indent=4) + "\n"
except:
LOG.debug("Execution output is not JSON.")
self.app.stdout.write(output or "\n")