Files
python-mistralclient/mistralclient/commands/v2/actions.py
ali 67560c9ee7 fixed compatibility issues between mistral and client
removed the namespace field from the action formatter to fix
compatibility issues between the client and older versions
of mistral.

now the action-list command takes the namespace
(with --namespace) as an argument and returns a list of the
actions in that namespace.

the command without --namespace would return the actions
of the default namespace ''.

fixed issues with execution-list command, the field "nulls"
is removed if its empty

Change-Id: Ibf64ff8d841ea1192b410902589b0c690b0b2fca
Signed-off-by: ali <ali.abdelal@nokia.com>
2020-04-05 13:50:19 +00:00

299 lines
8.2 KiB
Python

# Copyright 2014 - Mirantis, Inc.
# Copyright 2020 Nokia Software.
# 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 argparse
from osc_lib.command import command
from mistralclient.commands.v2 import base
from mistralclient import utils
class ActionFormatter(base.MistralFormatter):
COLUMNS = [
('id', 'ID'),
('name', 'Name'),
('is_system', 'Is system'),
('input', 'Input'),
('description', 'Description'),
('tags', 'Tags'),
('created_at', 'Created at'),
('updated_at', 'Updated at'),
]
@staticmethod
def format(action=None, lister=False):
if action:
tags = getattr(action, 'tags', None) or []
input_ = action.input if not lister else base.cut(action.input)
desc = (action.description if not lister
else base.cut(action.description))
data = (
action.id,
action.name,
action.is_system,
input_,
desc,
base.wrap(', '.join(tags)) or '<none>',
action.created_at,
)
if hasattr(action, 'updated_at'):
data += (action.updated_at,)
else:
data += (None,)
else:
data = (tuple('' for _ in range(len(ActionFormatter.COLUMNS))),)
return ActionFormatter.headings(), data
class List(base.MistralLister):
"""List all actions."""
def _get_format_function(self):
return ActionFormatter.format_list
def get_parser(self, prog_name):
parser = super(List, self).get_parser(prog_name)
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace of the actions.",
)
return parser
def _get_resources(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
return mistral_client.actions.list(
marker=parsed_args.marker,
limit=parsed_args.limit,
sort_keys=parsed_args.sort_keys,
sort_dirs=parsed_args.sort_dirs,
fields=ActionFormatter.fields(),
namespace=parsed_args.namespace,
**base.get_filters(parsed_args)
)
class Get(command.ShowOne):
"""Show specific action."""
def get_parser(self, prog_name):
parser = super(Get, self).get_parser(prog_name)
parser.add_argument('action', help='Action (name or ID)')
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace to create the action within.",
)
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
action = mistral_client.actions.get(
parsed_args.action,
parsed_args.namespace)
return ActionFormatter.format(action)
class Create(base.MistralLister):
"""Create new action."""
def get_parser(self, prog_name):
parser = super(Create, self).get_parser(prog_name)
parser.add_argument(
'definition',
type=argparse.FileType('r'),
help='Action definition file'
)
parser.add_argument(
'--public',
action='store_true',
help='With this flag action will be marked as "public".'
)
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace to create the action within.",
)
return parser
def _validate_parsed_args(self, parsed_args):
if not parsed_args.definition:
raise RuntimeError("Provide action definition file.")
def _get_format_function(self):
return ActionFormatter.format_list
def _get_resources(self, parsed_args):
scope = 'public' if parsed_args.public else 'private'
mistral_client = self.app.client_manager.workflow_engine
return mistral_client.actions.create(
parsed_args.definition.read(),
namespace=parsed_args.namespace,
scope=scope
)
class Delete(command.Command):
"""Delete action."""
def get_parser(self, prog_name):
parser = super(Delete, self).get_parser(prog_name)
parser.add_argument(
'action',
nargs='+',
help='Name or ID of action(s).'
)
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace of the action(s).",
)
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
utils.do_action_on_many(
lambda s: mistral_client.actions.delete(
s,
namespace=parsed_args.namespace),
parsed_args.action,
"Request to delete action %s has been accepted.",
"Unable to delete the specified action(s)."
)
class Update(base.MistralLister):
"""Update action."""
def get_parser(self, prog_name):
parser = super(Update, self).get_parser(prog_name)
parser.add_argument(
'definition',
type=argparse.FileType('r'),
help='Action definition file'
)
parser.add_argument('--id', help='Action ID.')
parser.add_argument(
'--public',
action='store_true',
help='With this flag action will be marked as "public".'
)
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace of the action.",
)
return parser
def _get_format_function(self):
return ActionFormatter.format_list
def _get_resources(self, parsed_args):
scope = 'public' if parsed_args.public else 'private'
mistral_client = self.app.client_manager.workflow_engine
return mistral_client.actions.update(
parsed_args.definition.read(),
scope=scope,
id=parsed_args.id
)
class GetDefinition(command.Command):
"""Show action definition."""
def get_parser(self, prog_name):
parser = super(GetDefinition, self).get_parser(prog_name)
parser.add_argument('name', help='Action name')
parser.add_argument(
'--namespace',
nargs='?',
default='',
help="Namespace of the action.",
)
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
definition = mistral_client.actions.get(
parsed_args.name,
namespace=parsed_args.namespace).definition
self.app.stdout.write(definition or "\n")
class Validate(command.ShowOne):
"""Validate action."""
@staticmethod
def _format(result=None):
columns = ('Valid', 'Error')
if result:
data = (result.get('valid'), result.get('error'))
else:
data = (tuple('<none>' for _ in range(len(columns))),)
return columns, data
def get_parser(self, prog_name):
parser = super(Validate, self).get_parser(prog_name)
parser.add_argument(
'definition',
type=argparse.FileType('r'),
help='action definition file'
)
return parser
def take_action(self, parsed_args):
mistral_client = self.app.client_manager.workflow_engine
result = mistral_client.actions.validate(
parsed_args.definition.read()
)
return self._format(result)