Files
python-mistralclient/mistralclient/commands/v2/tasks.py
Toure Dunnon 19639e339e mistral execution-list -f value should be empty
The '-f value' option in the CLI is intended to be used by scripting
etc. as it gives you the raw value. This can make life easier in bash.
However, if there are no results mistral will return <none> - this isn't
the raw value, and means you need to map it via case statement.

Related-Bug: 1691435

Change-Id: I246f772253e0fdb4dc8a82a4d4186b4bb6626981
2017-08-02 10:10:18 -04:00

223 lines
6.0 KiB
Python

# Copyright 2014 - Mirantis, Inc.
# Copyright 2015 - StackStorm, 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
import os.path
from osc_lib.command import command
from mistralclient.commands.v2 import base
from mistralclient import utils
LOG = logging.getLogger(__name__)
def format_list(task=None):
return format(task, lister=True)
def format(task=None, lister=False):
columns = (
'ID',
'Name',
'Workflow name',
'Execution ID',
'State',
'State info',
'Created at',
'Updated at'
)
if task:
state_info = (task.state_info if not lister
else base.cut(task.state_info))
data = (
task.id,
task.name,
task.workflow_name,
task.workflow_execution_id,
task.state,
state_info,
task.created_at,
task.updated_at or '<none>'
)
else:
data = (tuple('' for _ in range(len(columns))),)
return columns, data
class List(base.MistralLister):
"""List all tasks."""
def get_parser(self, prog_name):
parser = super(List, self).get_parser(prog_name)
parser.add_argument(
'workflow_execution',
nargs='?',
help='Workflow execution ID associated with list of Tasks.'
)
parser.add_argument(
'--filter',
dest='filters',
action='append',
help='Filters. Can be repeated.'
)
parser.add_argument(
'--limit',
type=int,
help='Maximum number of tasks to return in a single result. '
'limit is set to %s by default. Use --limit -1 to fetch the '
'full result set.' % base.DEFAULT_LIMIT,
nargs='?'
)
return parser
def _get_format_function(self):
return format_list
def _get_resources(self, parsed_args):
if parsed_args.limit is None:
parsed_args.limit = base.DEFAULT_LIMIT
LOG.info("limit is set to %s by default. Set "
"the limit explicitly using \'--limit\', if required. "
"Use \'--limit\' -1 to fetch the full result set.",
base.DEFAULT_LIMIT)
mistral_client = self.app.client_manager.workflow_engine
return mistral_client.tasks.list(
parsed_args.workflow_execution,
limit=parsed_args.limit,
**base.get_filters(parsed_args)
)
class Get(command.ShowOne):
"""Show specific task."""
def get_parser(self, prog_name):
parser = super(Get, self).get_parser(prog_name)
parser.add_argument('task', help='Task identifier')
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
execution = mistral_client.tasks.get(parsed_args.task)
return format(execution)
class GetResult(command.Command):
"""Show task output data."""
def get_parser(self, prog_name):
parser = super(GetResult, self).get_parser(prog_name)
parser.add_argument(
'id',
help='Task ID')
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
result = mistral_client.tasks.get(parsed_args.id).result
try:
result = json.loads(result)
result = json.dumps(result, indent=4) + "\n"
except Exception:
LOG.debug("Task result is not JSON.")
self.app.stdout.write(result or "\n")
class GetPublished(command.Command):
"""Show task published variables."""
def get_parser(self, prog_name):
parser = super(GetPublished, self).get_parser(prog_name)
parser.add_argument(
'id',
help='Task ID')
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
result = mistral_client.tasks.get(parsed_args.id).published
try:
result = json.loads(result)
result = json.dumps(result, indent=4) + "\n"
except Exception:
LOG.debug("Task result is not JSON.")
self.app.stdout.write(result or "\n")
class Rerun(command.ShowOne):
"""Rerun an existing task."""
def get_parser(self, prog_name):
parser = super(Rerun, self).get_parser(prog_name)
parser.add_argument(
'id',
help='Task identifier'
)
parser.add_argument(
'--resume',
action='store_true',
dest='resume',
default=False,
help=('rerun only failed or unstarted action '
'executions for with-items task')
)
parser.add_argument(
'-e',
'--env',
dest='env',
help='Environment variables'
)
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
env = (
utils.load_file(parsed_args.env)
if parsed_args.env and os.path.isfile(parsed_args.env)
else utils.load_content(parsed_args.env)
)
execution = mistral_client.tasks.rerun(
parsed_args.id,
reset=(not parsed_args.resume),
env=env
)
return format(execution)