Files
python-mistralclient/mistralclient/commands/v2/base.py
Lingxian Kong ccef0817d5 Introduce openstackclient plugin
Adds the code necessary for mistralclient to work as a plugin for
openstackclient.

Steps to test:
- Make sure Keystone service is installed and Mistral service is
  registered in Keystone, please refer to Mistral documentation here[1].
  The reason we need Keystone is because OpenStackClient always needs it
  for commands authentication.
- Install python-mistralclient.
- Install python-openstackclient, it will load Mistral commands via
  plugin mechanism.
- Config environment variables (something like OS_AUTH_URL, etc.).
- Run Mistral commands as you want, e.g. `openstack workflow list`.

TODO:
- update python-openstackclient documentation to let other projects know
  what objects our mistral project is using, to avoid potential
  conflicts in future.

[1]: http://docs.openstack.org/developer/mistral/guides/configuration_guide.html

Implements: blueprint mistral-osc-plugin
Change-Id: Ic099aaec88377a76a17700c33fed944e52ec5633
2015-11-23 21:15:35 +08:00

64 lines
1.7 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 abc
import textwrap
from cliff import lister
import six
@six.add_metaclass(abc.ABCMeta)
class MistralLister(lister.Lister):
@abc.abstractmethod
def _get_format_function(self):
raise NotImplementedError
@abc.abstractmethod
def _get_resources(self, parsed_args):
"""Gets a list of API resources (e.g. using client)."""
raise NotImplementedError
def _validate_parsed_args(self, parsed_args):
# No-op by default.
pass
def take_action(self, parsed_args):
self._validate_parsed_args(parsed_args)
f = self._get_format_function()
data = [f(r)[1] for r in self._get_resources(parsed_args)]
if data:
return f()[0], data
else:
return f()
def cut(string, length=25):
if string and len(string) > length:
return "%s..." % string[:length]
else:
return string
def wrap(string, width=25):
if string and len(string) > width:
return textwrap.fill(string, width)
else:
return string