fix tox python3 overrides

We want to default to running all tox environments under python 3, so
set the basepython value in each environment.

We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.

We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.

Change-Id: I8b2f1a62f8c9ca04d6c63f4a4ad22ec445bad88b
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

.gitignore

@@ -24,6 +24,7 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+cover
 .tox
 nosetests.xml
 .testrepository

.gitreview

@@ -2,4 +2,3 @@
 host=review.openstack.org
 port=29418
 project=openstack/python-karborclient.git
-defaultbranch=stable/newton

.zuul.yaml

@@ -0,0 +1,7 @@
+- project:
+    check:
+      jobs:
+        - openstack-tox-lower-constraints
+    gate:
+      jobs:
+        - openstack-tox-lower-constraints

CONTRIBUTING.rst

@@ -1,14 +1,14 @@
 If you would like to contribute to the development of OpenStack, you must
 follow the steps in this page:
 
-   http://docs.openstack.org/infra/manual/developers.html
+   https://docs.openstack.org/infra/manual/developers.html
 
 If you already have a good understanding of how the system works and your
 OpenStack accounts are set up, you can skip to the development workflow
 section of this documentation to learn how changes to OpenStack should be
 submitted for review via the Gerrit tool:
 
-   http://docs.openstack.org/infra/manual/developers.html#development-workflow
+   https://docs.openstack.org/infra/manual/developers.html#development-workflow
 
 Pull requests submitted through GitHub will be ignored.
 

HACKING.rst

@@ -1,4 +1,4 @@
 Style Commandments
 ===============================================
 
-Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
+Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

MANIFEST.in

@@ -1,6 +0,0 @@
-include AUTHORS
-include ChangeLog
-exclude .gitignore
-exclude .gitreview
-
-global-exclude *.pyc

README.rst

@@ -1,18 +1,28 @@
+========================
+Team and repository tags
+========================
+
+.. image:: https://governance.openstack.org/tc/badges/python-karborclient.svg
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
+
+.. Change things from this point on
+
+======
 Karbor
 ======
 
 .. image:: https://img.shields.io/pypi/v/python-karborclient.svg
-    :target: https://pypi.python.org/pypi/python-karborclient/
+    :target: https://pypi.org/project/python-karborclient/
     :alt: Latest Version
 
 .. image:: https://img.shields.io/pypi/dm/python-karborclient.svg
-    :target: https://pypi.python.org/pypi/python-karborclient/
+    :target: https://pypi.org/project/python-karborclient/
     :alt: Downloads
 
 
 Karbor Mission Statement
 
-* Formalize Application Data Protection in OpenStack (APIs, Services, Plugins, …)
+* Formalize Application Data Protection in OpenStack (APIs, Services, Plugins, ...)
 * Be able to protect Any Resource in OpenStack(as well as their dependencies)
 * Allow Diversity of vendor solutions, capabilities and implementations
   without compromising usability
@@ -25,12 +35,14 @@ Karbor Mission Statement
 * `Specs`_
 * `How to Contribute`_
 
-.. _PyPi: https://pypi.python.org/pypi/python-karborclient
+.. _PyPi: https://pypi.org/project/python-karborclient
+
 .. _Launchpad project: https://launchpad.net/python-karborclient
 .. _Blueprints: https://blueprints.launchpad.net/python-karborclient
 .. _Bugs: https://bugs.launchpad.net/python-karborclient
 .. _Source: https://git.openstack.org/cgit/openstack/python-karborclient
-.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html
+.. _Specs: https://docs.openstack.org/karbor/latest/specs/index.html
+.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
 
 
 Python Karborclient
@@ -38,6 +50,7 @@ Python Karborclient
 python-karborclient is a client library for karbor built on the karbor API.
 It provides a Python API (the ``karborclient`` module) and a command-line tool
 (``karbor``).
+
 Project Resources
 -----------------
 
@@ -51,7 +64,7 @@ Project status, bugs, and blueprints are tracked on Launchpad:
 
 Developer documentation can be found here:
 
-  http://docs.openstack.org/developer/karbor
+  https://docs.openstack.org/karbor/latest/
 
 Additional resources are linked from the project wiki page:
 

doc/requirements.txt

@@ -0,0 +1,5 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+openstackdocstheme>=1.18.1 # Apache-2.0

doc/source/conf.py

@@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'openstackdocstheme'
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -55,9 +55,15 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 # html_theme_path = ["."]
-# html_theme = '_theme'
+html_theme = 'openstackdocs'
 # html_static_path = ['static']
 
+# openstackdocstheme options
+repository_name = 'openstack/python-karborclient'
+bug_project = 'python-karborclient'
+bug_tag = ''
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
 

doc/source/contributing.rst

@@ -1,4 +0,0 @@
-============
-Contributing
-============
-.. include:: ../../CONTRIBUTING.rst

doc/source/contributor/index.rst

@@ -0,0 +1,16 @@
+============
+Contributing
+============
+
+General Info
+------------
+
+.. include:: ../../../CONTRIBUTING.rst
+
+Approved Specs
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
+   ../specs/index

doc/source/index.rst

@@ -1,20 +1,20 @@
 Welcome to karborclient's documentation!
-========================================================
+========================================
 
-Contents:
+Contents
+--------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    readme
-   installation
-   usage
-   contributing
+   install/index
+   user/index
+   contributor/index
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 

doc/source/readme.rst

@@ -1 +1,5 @@
+============
+Introduction
+============
+
 .. include:: ../../README.rst

doc/source/specs/index.rst

@@ -0,0 +1,13 @@
+Specs
+=====
+
+This section contains detailed specification documents for
+different features inside Karbor Client.
+
+Approved Specs
+--------------
+
+.. toctree::
+    :maxdepth: 1
+
+    karbor-support-in-python-openstackclient

doc/source/specs/karbor-support-in-python-openstackclient.rst

@@ -0,0 +1,166 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+========================================
+Karbor support in python-openstackclient
+========================================
+
+Implement a new set of karbor commands as python-openstackclient plugins.
+
+Launchpad Blueprint:
+https://blueprints.launchpad.net/python-karborclient/+spec/karbor-support-python-openstackclient
+
+
+Problem Description
+===================
+
+python-openstackclient is becoming the default command line client for many
+OpenStack projects. Karbor would benefit from implementing all of its client
+commands as a single python-openstackclient plugin implemented in the
+python-karborclient repository.
+
+Proposed Change
+===============
+
+The intent of this spec is to identify the commands to be implemented and
+establish conventions for command and argument names. This spec is not
+intended to be a full and correct specification of command and argument names.
+The details can be left to the code reviews for the commands themselves.
+
+The following conventions will be adopted for command names:
+
+* As the ``OpenStackClient`` convention, the command name shall always take
+  the following form:
+
+.. code-block:: bash
+
+    openstack [<global-options>] <object-1> <action> [<object-2>] \
+              [command-arguments]
+
+
+As a example:
+The following ``karbor`` commands about plan will be implemented for ``openstack``
+initially suggesting these command names:
+
+.. code-block:: bash
+
+    karbor plan-create <name> <provider_id> <resources>
+    openstack data protection plan create <name> <provider_id> <resources>
+
+    karbor plan-delete <plan>
+    openstack data protection plan delete <plan>
+
+    karbor plan-list
+    openstack data protection plan list
+
+    karbor plan-show <plan>
+    openstack data protection plan show <plan>
+
+    karbor plan-update <name> <resources> <status>
+    openstack data protection plan update <name> <resources> <status>
+
+
+Configuration
+-------------
+
+None
+
+Database
+--------
+
+None
+
+Public API
+----------
+
+None
+
+Public API Security
+-------------------
+
+None
+
+Python API
+----------
+
+None
+
+CLI (python-karborclient)
+-------------------------
+
+A new directory named osc will be created under /karborclient/osc
+for the ``OpenStackClient`` plugin and the commands mentioned above.
+
+Internal API
+------------
+
+None
+
+Guest Agent
+-----------
+
+None
+
+Alternatives
+------------
+
+None
+
+Dashboard Impact (UX)
+=====================
+
+None
+
+Implementation
+==============
+
+Assignee(s)
+-----------
+
+Primary assignee:
+  chenying
+
+
+Milestones
+----------
+
+
+Work Items
+----------
+
+CLI commands as stated above.
+Unit tests
+
+Upgrade Implications
+====================
+
+None
+
+Dependencies
+============
+
+python-openstackclient
+osc-lib
+
+Testing
+=======
+
+Unit tests will be located in: /karborclient/tests/unit/osc/
+
+Documentation Impact
+====================
+
+OpenStack Client adoption list will be updated to include python-karborclient.
+
+References
+==========
+
+https://docs.openstack.org/python-openstackclient/latest/
+
+Appendix
+========
+
+None

doc/source/user/index.rst

@@ -1,6 +1,6 @@
-========
+=====
 Usage
-========
+=====
 
 To use karborclient in a project::
 

karborclient/client.py

@@ -1,18 +1,20 @@
-#    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.
-from karborclient.common import utils
-
-
-def Client(version, *args, **kwargs):
-    module = utils.import_versioned_module(version, 'client')
-    client_class = getattr(module, 'Client')
-    return client_class(*args, **kwargs)
+#    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.
+from oslo_utils import importutils
+
+
+def Client(version, *args, **kwargs):
+    module = importutils.import_versioned_module(
+        'karborclient', version, 'client'
+    )
+    client_class = getattr(module, 'Client')
+    return client_class(*args, **kwargs)

karborclient/common/apiclient/auth.py

@@ -1,218 +1,218 @@
-# Copyright 2013 OpenStack Foundation
-# Copyright 2013 Spanish National Research Council.
-# 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.
-
-# E0202: An attribute inherited from %s hide this method
-# pylint: disable=E0202
-
-import abc
-import argparse
-import os
-
-import six
-from stevedore import extension
-
-from karborclient.common.apiclient import exceptions
-
-
-_discovered_plugins = {}
-
-
-def discover_auth_systems():
-    """Discover the available auth-systems.
-
-    This won't take into account the old style auth-systems.
-    """
-    global _discovered_plugins
-    _discovered_plugins = {}
-
-    def add_plugin(ext):
-        _discovered_plugins[ext.name] = ext.plugin
-
-    ep_namespace = "karborclient.common.apiclient.auth"
-    mgr = extension.ExtensionManager(ep_namespace)
-    mgr.map(add_plugin)
-
-
-def load_auth_system_opts(parser):
-    """Load options needed by the available auth-systems into a parser.
-
-    This function will try to populate the parser with options from the
-    available plugins.
-    """
-    group = parser.add_argument_group("Common auth options")
-    BaseAuthPlugin.add_common_opts(group)
-    for name, auth_plugin in six.iteritems(_discovered_plugins):
-        group = parser.add_argument_group(
-            "Auth-system '%s' options" % name,
-            conflict_handler="resolve")
-        auth_plugin.add_opts(group)
-
-
-def load_plugin(auth_system):
-    try:
-        plugin_class = _discovered_plugins[auth_system]
-    except KeyError:
-        raise exceptions.AuthSystemNotFound(auth_system)
-    return plugin_class(auth_system=auth_system)
-
-
-def load_plugin_from_args(args):
-    """Load required plugin and populate it with options.
-
-    Try to guess auth system if it is not specified. Systems are tried in
-    alphabetical order.
-
-    :type args: argparse.Namespace
-    :raises: AuthPluginOptionsMissing
-    """
-    auth_system = args.os_auth_system
-    if auth_system:
-        plugin = load_plugin(auth_system)
-        plugin.parse_opts(args)
-        plugin.sufficient_options()
-        return plugin
-
-    for plugin_auth_system in sorted(six.iterkeys(_discovered_plugins)):
-        plugin_class = _discovered_plugins[plugin_auth_system]
-        plugin = plugin_class()
-        plugin.parse_opts(args)
-        try:
-            plugin.sufficient_options()
-        except exceptions.AuthPluginOptionsMissing:
-            continue
-        return plugin
-    raise exceptions.AuthPluginOptionsMissing(["auth_system"])
-
-
-@six.add_metaclass(abc.ABCMeta)
-class BaseAuthPlugin(object):
-    """Base class for authentication plugins.
-
-    An authentication plugin needs to override at least the authenticate
-    method to be a valid plugin.
-    """
-
-    auth_system = None
-    opt_names = []
-    common_opt_names = [
-        "auth_system",
-        "username",
-        "password",
-        "tenant_name",
-        "token",
-        "auth_url",
-    ]
-
-    def __init__(self, auth_system=None, **kwargs):
-        self.auth_system = auth_system or self.auth_system
-        self.opts = dict((name, kwargs.get(name))
-                         for name in self.opt_names)
-
-    @staticmethod
-    def _parser_add_opt(parser, opt):
-        """Add an option to parser in two variants.
-
-        :param opt: option name (with underscores)
-        """
-        dashed_opt = opt.replace("_", "-")
-        env_var = "OS_%s" % opt.upper()
-        arg_default = os.environ.get(env_var, "")
-        arg_help = "Defaults to env[%s]." % env_var
-        parser.add_argument(
-            "--os-%s" % dashed_opt,
-            metavar="<%s>" % dashed_opt,
-            default=arg_default,
-            help=arg_help)
-        parser.add_argument(
-            "--os_%s" % opt,
-            metavar="<%s>" % dashed_opt,
-            help=argparse.SUPPRESS)
-
-    @classmethod
-    def add_opts(cls, parser):
-        """Populate the parser with the options for this plugin."""
-        for opt in cls.opt_names:
-            # use `BaseAuthPlugin.common_opt_names` since it is never
-            # changed in child classes
-            if opt not in BaseAuthPlugin.common_opt_names:
-                cls._parser_add_opt(parser, opt)
-
-    @classmethod
-    def add_common_opts(cls, parser):
-        """Add options that are common for several plugins."""
-        for opt in cls.common_opt_names:
-            cls._parser_add_opt(parser, opt)
-
-    @staticmethod
-    def get_opt(opt_name, args):
-        """Return option name and value.
-
-        :param opt_name: name of the option, e.g., "username"
-        :param args: parsed arguments
-        """
-        return (opt_name, getattr(args, "os_%s" % opt_name, None))
-
-    def parse_opts(self, args):
-        """Parse the actual auth-system options if any.
-
-        This method is expected to populate the attribute `self.opts` with a
-        dict containing the options and values needed to make authentication.
-        """
-        self.opts.update(dict(self.get_opt(opt_name, args)
-                              for opt_name in self.opt_names))
-
-    def authenticate(self, http_client):
-        """Authenticate using plugin defined method.
-
-        The method usually analyses `self.opts` and performs
-        a request to authentication server.
-
-        :param http_client: client object that needs authentication
-        :type http_client: HTTPClient
-        :raises: AuthorizationFailure
-        """
-        self.sufficient_options()
-        self._do_authenticate(http_client)
-
-    @abc.abstractmethod
-    def _do_authenticate(self, http_client):
-        """Protected method for authentication."""
-
-    def sufficient_options(self):
-        """Check if all required options are present.
-
-        :raises: AuthPluginOptionsMissing
-        """
-        missing = [opt
-                   for opt in self.opt_names
-                   if not self.opts.get(opt)]
-        if missing:
-            raise exceptions.AuthPluginOptionsMissing(missing)
-
-    @abc.abstractmethod
-    def token_and_endpoint(self, endpoint_type, service_type):
-        """Return token and endpoint.
-
-        :param service_type: Service type of the endpoint
-        :type service_type: string
-        :param endpoint_type: Type of endpoint.
-                              Possible values: public or publicURL,
-                              internal or internalURL,
-                              admin or adminURL
-        :type endpoint_type: string
-        :returns: tuple of token and endpoint strings
-        :raises: EndpointException
-        """
+# Copyright 2013 OpenStack Foundation
+# Copyright 2013 Spanish National Research Council.
+# 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.
+
+# E0202: An attribute inherited from %s hide this method
+# pylint: disable=E0202
+
+import abc
+import argparse
+import os
+
+import six
+from stevedore import extension
+
+from karborclient.common.apiclient import exceptions
+
+
+_discovered_plugins = {}
+
+
+def discover_auth_systems():
+    """Discover the available auth-systems.
+
+    This won't take into account the old style auth-systems.
+    """
+    global _discovered_plugins
+    _discovered_plugins = {}
+
+    def add_plugin(ext):
+        _discovered_plugins[ext.name] = ext.plugin
+
+    ep_namespace = "karborclient.common.apiclient.auth"
+    mgr = extension.ExtensionManager(ep_namespace)
+    mgr.map(add_plugin)
+
+
+def load_auth_system_opts(parser):
+    """Load options needed by the available auth-systems into a parser.
+
+    This function will try to populate the parser with options from the
+    available plugins.
+    """
+    group = parser.add_argument_group("Common auth options")
+    BaseAuthPlugin.add_common_opts(group)
+    for name, auth_plugin in _discovered_plugins.items():
+        group = parser.add_argument_group(
+            "Auth-system '%s' options" % name,
+            conflict_handler="resolve")
+        auth_plugin.add_opts(group)
+
+
+def load_plugin(auth_system):
+    try:
+        plugin_class = _discovered_plugins[auth_system]
+    except KeyError:
+        raise exceptions.AuthSystemNotFound(auth_system)
+    return plugin_class(auth_system=auth_system)
+
+
+def load_plugin_from_args(args):
+    """Load required plugin and populate it with options.
+
+    Try to guess auth system if it is not specified. Systems are tried in
+    alphabetical order.
+
+    :type args: argparse.Namespace
+    :raises: AuthPluginOptionsMissing
+    """
+    auth_system = args.os_auth_system
+    if auth_system:
+        plugin = load_plugin(auth_system)
+        plugin.parse_opts(args)
+        plugin.sufficient_options()
+        return plugin
+
+    for plugin_auth_system in sorted(six.iterkeys(_discovered_plugins)):
+        plugin_class = _discovered_plugins[plugin_auth_system]
+        plugin = plugin_class()
+        plugin.parse_opts(args)
+        try:
+            plugin.sufficient_options()
+        except exceptions.AuthPluginOptionsMissing:
+            continue
+        return plugin
+    raise exceptions.AuthPluginOptionsMissing(["auth_system"])
+
+
+@six.add_metaclass(abc.ABCMeta)
+class BaseAuthPlugin(object):
+    """Base class for authentication plugins.
+
+    An authentication plugin needs to override at least the authenticate
+    method to be a valid plugin.
+    """
+
+    auth_system = None
+    opt_names = []
+    common_opt_names = [
+        "auth_system",
+        "username",
+        "password",
+        "tenant_name",
+        "token",
+        "auth_url",
+    ]
+
+    def __init__(self, auth_system=None, **kwargs):
+        self.auth_system = auth_system or self.auth_system
+        self.opts = dict((name, kwargs.get(name))
+                         for name in self.opt_names)
+
+    @staticmethod
+    def _parser_add_opt(parser, opt):
+        """Add an option to parser in two variants.
+
+        :param opt: option name (with underscores)
+        """
+        dashed_opt = opt.replace("_", "-")
+        env_var = "OS_%s" % opt.upper()
+        arg_default = os.environ.get(env_var, "")
+        arg_help = "Defaults to env[%s]." % env_var
+        parser.add_argument(
+            "--os-%s" % dashed_opt,
+            metavar="<%s>" % dashed_opt,
+            default=arg_default,
+            help=arg_help)
+        parser.add_argument(
+            "--os_%s" % opt,
+            metavar="<%s>" % dashed_opt,
+            help=argparse.SUPPRESS)
+
+    @classmethod
+    def add_opts(cls, parser):
+        """Populate the parser with the options for this plugin."""
+        for opt in cls.opt_names:
+            # use `BaseAuthPlugin.common_opt_names` since it is never
+            # changed in child classes
+            if opt not in BaseAuthPlugin.common_opt_names:
+                cls._parser_add_opt(parser, opt)
+
+    @classmethod
+    def add_common_opts(cls, parser):
+        """Add options that are common for several plugins."""
+        for opt in cls.common_opt_names:
+            cls._parser_add_opt(parser, opt)
+
+    @staticmethod
+    def get_opt(opt_name, args):
+        """Return option name and value.
+
+        :param opt_name: name of the option, e.g., "username"
+        :param args: parsed arguments
+        """
+        return (opt_name, getattr(args, "os_%s" % opt_name, None))
+
+    def parse_opts(self, args):
+        """Parse the actual auth-system options if any.
+
+        This method is expected to populate the attribute `self.opts` with a
+        dict containing the options and values needed to make authentication.
+        """
+        self.opts.update(dict(self.get_opt(opt_name, args)
+                              for opt_name in self.opt_names))
+
+    def authenticate(self, http_client):
+        """Authenticate using plugin defined method.
+
+        The method usually analyses `self.opts` and performs
+        a request to authentication server.
+
+        :param http_client: client object that needs authentication
+        :type http_client: HTTPClient
+        :raises: AuthorizationFailure
+        """
+        self.sufficient_options()
+        self._do_authenticate(http_client)
+
+    @abc.abstractmethod
+    def _do_authenticate(self, http_client):
+        """Protected method for authentication."""
+
+    def sufficient_options(self):
+        """Check if all required options are present.
+
+        :raises: AuthPluginOptionsMissing
+        """
+        missing = [opt
+                   for opt in self.opt_names
+                   if not self.opts.get(opt)]
+        if missing:
+            raise exceptions.AuthPluginOptionsMissing(missing)
+
+    @abc.abstractmethod
+    def token_and_endpoint(self, endpoint_type, service_type):
+        """Return token and endpoint.
+
+        :param service_type: Service type of the endpoint
+        :type service_type: string
+        :param endpoint_type: Type of endpoint.
+                              Possible values: public or publicURL,
+                              internal or internalURL,
+                              admin or adminURL
+        :type endpoint_type: string
+        :returns: tuple of token and endpoint strings
+        :raises: EndpointException
+        """

karborclient/common/apiclient/client.py

@@ -1,363 +1,363 @@
-# Copyright 2010 Jacob Kaplan-Moss
-# Copyright 2011 OpenStack Foundation
-# Copyright 2011 Piston Cloud Computing, Inc.
-# Copyright 2013 Alessio Ababilov
-# Copyright 2013 Grid Dynamics
-# Copyright 2013 OpenStack Foundation
-# 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.
-
-"""
-OpenStack Client interface. Handles the REST calls and responses.
-"""
-
-# E0202: An attribute inherited from %s hide this method
-# pylint: disable=E0202
-
-try:
-    import simplejson as json
-except ImportError:
-    import json
-
-import time
-
-from oslo_log import log as logging
-from oslo_utils import importutils
-import requests
-
-from karborclient.i18n import _
-from karborclient.openstack.common.apiclient import exceptions
-
-
-_logger = logging.getLogger(__name__)
-
-
-class HTTPClient(object):
-    """This client handles sending HTTP requests to OpenStack servers.
-
-    Features:
-
-    - share authentication information between several clients to different
-      services (e.g., for compute and image clients);
-    - reissue authentication request for expired tokens;
-    - encode/decode JSON bodies;
-    - raise exceptions on HTTP errors;
-    - pluggable authentication;
-    - store authentication information in a keyring;
-    - store time spent for requests;
-    - register clients for particular services, so one can use
-      `http_client.identity` or `http_client.compute`;
-    - log requests and responses in a format that is easy to copy-and-paste
-      into terminal and send the same request with curl.
-    """
-
-    user_agent = "karborclient.common.apiclient"
-
-    def __init__(self,
-                 auth_plugin,
-                 region_name=None,
-                 endpoint_type="publicURL",
-                 original_ip=None,
-                 verify=True,
-                 cert=None,
-                 timeout=None,
-                 timings=False,
-                 keyring_saver=None,
-                 debug=False,
-                 user_agent=None,
-                 http=None):
-        self.auth_plugin = auth_plugin
-
-        self.endpoint_type = endpoint_type
-        self.region_name = region_name
-
-        self.original_ip = original_ip
-        self.timeout = timeout
-        self.verify = verify
-        self.cert = cert
-
-        self.keyring_saver = keyring_saver
-        self.debug = debug
-        self.user_agent = user_agent or self.user_agent
-
-        self.times = []  # [("item", starttime, endtime), ...]
-        self.timings = timings
-
-        # requests within the same session can reuse TCP connections from pool
-        self.http = http or requests.Session()
-
-        self.cached_token = None
-
-    def _http_log_req(self, method, url, kwargs):
-        if not self.debug:
-            return
-
-        string_parts = [
-            "curl -i",
-            "-X '%s'" % method,
-            "'%s'" % url,
-        ]
-
-        for element in kwargs['headers']:
-            header = "-H '%s: %s'" % (element, kwargs['headers'][element])
-            string_parts.append(header)
-
-        _logger.debug("REQ: %s" % " ".join(string_parts))
-        if 'data' in kwargs:
-            _logger.debug("REQ BODY: %s\n" % (kwargs['data']))
-
-    def _http_log_resp(self, resp):
-        if not self.debug:
-            return
-        _logger.debug(
-            "RESP: [%s] %s\n",
-            resp.status_code,
-            resp.headers)
-        if resp._content_consumed:
-            _logger.debug(
-                "RESP BODY: %s\n",
-                resp.text)
-
-    def serialize(self, kwargs):
-        if kwargs.get('json') is not None:
-            kwargs['headers']['Content-Type'] = 'application/json'
-            kwargs['data'] = json.dumps(kwargs['json'])
-        try:
-            del kwargs['json']
-        except KeyError:
-            pass
-
-    def get_timings(self):
-        return self.times
-
-    def reset_timings(self):
-        self.times = []
-
-    def request(self, method, url, **kwargs):
-        """Send an http request with the specified characteristics.
-
-        Wrapper around `requests.Session.request` to handle tasks such as
-        setting headers, JSON encoding/decoding, and error handling.
-
-        :param method: method of HTTP request
-        :param url: URL of HTTP request
-        :param kwargs: any other parameter that can be passed to
-             requests.Session.request (such as `headers`) or `json`
-             that will be encoded as JSON and used as `data` argument
-        """
-        kwargs.setdefault("headers", kwargs.get("headers", {}))
-        kwargs["headers"]["User-Agent"] = self.user_agent
-        if self.original_ip:
-            kwargs["headers"]["Forwarded"] = "for=%s;by=%s" % (
-                self.original_ip, self.user_agent)
-        if self.timeout is not None:
-            kwargs.setdefault("timeout", self.timeout)
-        kwargs.setdefault("verify", self.verify)
-        if self.cert is not None:
-            kwargs.setdefault("cert", self.cert)
-        self.serialize(kwargs)
-
-        self._http_log_req(method, url, kwargs)
-        if self.timings:
-            start_time = time.time()
-        resp = self.http.request(method, url, **kwargs)
-        if self.timings:
-            self.times.append(("%s %s" % (method, url),
-                               start_time, time.time()))
-        self._http_log_resp(resp)
-
-        if resp.status_code >= 400:
-            _logger.debug(
-                "Request returned failure status: %s",
-                resp.status_code)
-            raise exceptions.from_response(resp, method, url)
-
-        return resp
-
-    @staticmethod
-    def concat_url(endpoint, url):
-        """Concatenate endpoint and final URL.
-
-        E.g., "http://keystone/v2.0/" and "/tokens" are concatenated to
-        "http://keystone/v2.0/tokens".
-
-        :param endpoint: the base URL
-        :param url: the final URL
-        """
-        return "%s/%s" % (endpoint.rstrip("/"), url.strip("/"))
-
-    def client_request(self, client, method, url, **kwargs):
-        """Send an http request using `client`'s endpoint and specified `url`.
-
-        If request was rejected as unauthorized (possibly because the token is
-        expired), issue one authorization attempt and send the request once
-        again.
-
-        :param client: instance of BaseClient descendant
-        :param method: method of HTTP request
-        :param url: URL of HTTP request
-        :param kwargs: any other parameter that can be passed to
-            `HTTPClient.request`
-        """
-
-        filter_args = {
-            "endpoint_type": client.endpoint_type or self.endpoint_type,
-            "service_type": client.service_type,
-        }
-        token, endpoint = (self.cached_token, client.cached_endpoint)
-        just_authenticated = False
-        if not (token and endpoint):
-            try:
-                token, endpoint = self.auth_plugin.token_and_endpoint(
-                    **filter_args)
-            except exceptions.EndpointException:
-                pass
-            if not (token and endpoint):
-                self.authenticate()
-                just_authenticated = True
-                token, endpoint = self.auth_plugin.token_and_endpoint(
-                    **filter_args)
-                if not (token and endpoint):
-                    raise exceptions.AuthorizationFailure(
-                        _("Cannot find endpoint or token for request"))
-
-        old_token_endpoint = (token, endpoint)
-        kwargs.setdefault("headers", {})["X-Auth-Token"] = token
-        self.cached_token = token
-        client.cached_endpoint = endpoint
-        # Perform the request once. If we get Unauthorized, then it
-        # might be because the auth token expired, so try to
-        # re-authenticate and try again. If it still fails, bail.
-        try:
-            return self.request(
-                method, self.concat_url(endpoint, url), **kwargs)
-        except exceptions.Unauthorized as unauth_ex:
-            if just_authenticated:
-                raise
-            self.cached_token = None
-            client.cached_endpoint = None
-            self.authenticate()
-            try:
-                token, endpoint = self.auth_plugin.token_and_endpoint(
-                    **filter_args)
-            except exceptions.EndpointException:
-                raise unauth_ex
-            if (not (token and endpoint) or
-                    old_token_endpoint == (token, endpoint)):
-                raise unauth_ex
-            self.cached_token = token
-            client.cached_endpoint = endpoint
-            kwargs["headers"]["X-Auth-Token"] = token
-            return self.request(
-                method, self.concat_url(endpoint, url), **kwargs)
-
-    def add_client(self, base_client_instance):
-        """Add a new instance of :class:`BaseClient` descendant.
-
-        `self` will store a reference to `base_client_instance`.
-
-        Example:
-
-        >>> def test_clients():
-        ...     from keystoneclient.auth import keystone
-        ...     from karborclient.common.apiclient import client
-        ...     auth = keystone.KeystoneAuthPlugin(
-        ...         username="user", password="pass", tenant_name="tenant",
-        ...         auth_url="http://auth:5000/v2.0")
-        ...     openstack_client = client.HTTPClient(auth)
-        ...     # create nova client
-        ...     from novaclient.v1_1 import client
-        ...     client.Client(openstack_client)
-        ...     # create keystone client
-        ...     from keystoneclient.v2_0 import client
-        ...     client.Client(openstack_client)
-        ...     # use them
-        ...     openstack_client.identity.tenants.list()
-        ...     openstack_client.compute.servers.list()
-        """
-        service_type = base_client_instance.service_type
-        if service_type and not hasattr(self, service_type):
-            setattr(self, service_type, base_client_instance)
-
-    def authenticate(self):
-        self.auth_plugin.authenticate(self)
-        # Store the authentication results in the keyring for later requests
-        if self.keyring_saver:
-            self.keyring_saver.save(self)
-
-
-class BaseClient(object):
-    """Top-level object to access the OpenStack API.
-
-    This client uses :class:`HTTPClient` to send requests. :class:`HTTPClient`
-    will handle a bunch of issues such as authentication.
-    """
-
-    service_type = None
-    endpoint_type = None  # "publicURL" will be used
-    cached_endpoint = None
-
-    def __init__(self, http_client, extensions=None):
-        self.http_client = http_client
-        http_client.add_client(self)
-
-        # Add in any extensions...
-        if extensions:
-            for extension in extensions:
-                if extension.manager_class:
-                    setattr(self, extension.name,
-                            extension.manager_class(self))
-
-    def client_request(self, method, url, **kwargs):
-        return self.http_client.client_request(
-            self, method, url, **kwargs)
-
-    def head(self, url, **kwargs):
-        return self.client_request("HEAD", url, **kwargs)
-
-    def get(self, url, **kwargs):
-        return self.client_request("GET", url, **kwargs)
-
-    def post(self, url, **kwargs):
-        return self.client_request("POST", url, **kwargs)
-
-    def put(self, url, **kwargs):
-        return self.client_request("PUT", url, **kwargs)
-
-    def delete(self, url, **kwargs):
-        return self.client_request("DELETE", url, **kwargs)
-
-    def patch(self, url, **kwargs):
-        return self.client_request("PATCH", url, **kwargs)
-
-    @staticmethod
-    def get_class(api_name, version, version_map):
-        """Returns the client class for the requested API version
-
-        :param api_name: the name of the API, e.g. 'compute', 'image', etc
-        :param version: the requested API version
-        :param version_map: a dict of client classes keyed by version
-        :rtype: a client class for the requested API version
-        """
-        try:
-            client_path = version_map[str(version)]
-        except (KeyError, ValueError):
-            msg = _("Invalid %(api_name)s client version '%(version)s'. "
-                    "Must be one of: %(version_map)s") % {
-                        'api_name': api_name,
-                        'version': version,
-                        'version_map': ', '.join(version_map.keys())}
-            raise exceptions.UnsupportedVersion(msg)
-
-        return importutils.import_class(client_path)
+# Copyright 2010 Jacob Kaplan-Moss
+# Copyright 2011 OpenStack Foundation
+# Copyright 2011 Piston Cloud Computing, Inc.
+# Copyright 2013 Alessio Ababilov
+# Copyright 2013 Grid Dynamics
+# Copyright 2013 OpenStack Foundation
+# 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.
+
+"""
+OpenStack Client interface. Handles the REST calls and responses.
+"""
+
+# E0202: An attribute inherited from %s hide this method
+# pylint: disable=E0202
+
+try:
+    import simplejson as json
+except ImportError:
+    import json
+
+import time
+
+from oslo_log import log as logging
+from oslo_utils import importutils
+import requests
+
+from karborclient.i18n import _
+from karborclient.openstack.common.apiclient import exceptions
+
+
+_logger = logging.getLogger(__name__)
+
+
+class HTTPClient(object):
+    """This client handles sending HTTP requests to OpenStack servers.
+
+    Features:
+
+    - share authentication information between several clients to different
+      services (e.g., for compute and image clients);
+    - reissue authentication request for expired tokens;
+    - encode/decode JSON bodies;
+    - raise exceptions on HTTP errors;
+    - pluggable authentication;
+    - store authentication information in a keyring;
+    - store time spent for requests;
+    - register clients for particular services, so one can use
+      `http_client.identity` or `http_client.compute`;
+    - log requests and responses in a format that is easy to copy-and-paste
+      into terminal and send the same request with curl.
+    """
+
+    user_agent = "karborclient.common.apiclient"
+
+    def __init__(self,
+                 auth_plugin,
+                 region_name=None,
+                 endpoint_type="publicURL",
+                 original_ip=None,
+                 verify=True,
+                 cert=None,
+                 timeout=None,
+                 timings=False,
+                 keyring_saver=None,
+                 debug=False,
+                 user_agent=None,
+                 http=None):
+        self.auth_plugin = auth_plugin
+
+        self.endpoint_type = endpoint_type
+        self.region_name = region_name
+
+        self.original_ip = original_ip
+        self.timeout = timeout
+        self.verify = verify
+        self.cert = cert
+
+        self.keyring_saver = keyring_saver
+        self.debug = debug
+        self.user_agent = user_agent or self.user_agent
+
+        self.times = []  # [("item", starttime, endtime), ...]
+        self.timings = timings
+
+        # requests within the same session can reuse TCP connections from pool
+        self.http = http or requests.Session()
+
+        self.cached_token = None
+
+    def _http_log_req(self, method, url, kwargs):
+        if not self.debug:
+            return
+
+        string_parts = [
+            "curl -i",
+            "-X '%s'" % method,
+            "'%s'" % url,
+        ]
+
+        for element in kwargs['headers']:
+            header = "-H '%s: %s'" % (element, kwargs['headers'][element])
+            string_parts.append(header)
+
+        _logger.debug("REQ: %s" % " ".join(string_parts))
+        if 'data' in kwargs:
+            _logger.debug("REQ BODY: %s\n" % (kwargs['data']))
+
+    def _http_log_resp(self, resp):
+        if not self.debug:
+            return
+        _logger.debug(
+            "RESP: [%s] %s\n",
+            resp.status_code,
+            resp.headers)
+        if resp._content_consumed:
+            _logger.debug(
+                "RESP BODY: %s\n",
+                resp.text)
+
+    def serialize(self, kwargs):
+        if kwargs.get('json') is not None:
+            kwargs['headers']['Content-Type'] = 'application/json'
+            kwargs['data'] = json.dumps(kwargs['json'])
+        try:
+            del kwargs['json']
+        except KeyError:
+            pass
+
+    def get_timings(self):
+        return self.times
+
+    def reset_timings(self):
+        self.times = []
+
+    def request(self, method, url, **kwargs):
+        """Send an http request with the specified characteristics.
+
+        Wrapper around `requests.Session.request` to handle tasks such as
+        setting headers, JSON encoding/decoding, and error handling.
+
+        :param method: method of HTTP request
+        :param url: URL of HTTP request
+        :param kwargs: any other parameter that can be passed to
+             requests.Session.request (such as `headers`) or `json`
+             that will be encoded as JSON and used as `data` argument
+        """
+        kwargs.setdefault("headers", kwargs.get("headers", {}))
+        kwargs["headers"]["User-Agent"] = self.user_agent
+        if self.original_ip:
+            kwargs["headers"]["Forwarded"] = "for=%s;by=%s" % (
+                self.original_ip, self.user_agent)
+        if self.timeout is not None:
+            kwargs.setdefault("timeout", self.timeout)
+        kwargs.setdefault("verify", self.verify)
+        if self.cert is not None:
+            kwargs.setdefault("cert", self.cert)
+        self.serialize(kwargs)
+
+        self._http_log_req(method, url, kwargs)
+        if self.timings:
+            start_time = time.time()
+        resp = self.http.request(method, url, **kwargs)
+        if self.timings:
+            self.times.append(("%s %s" % (method, url),
+                               start_time, time.time()))
+        self._http_log_resp(resp)
+
+        if resp.status_code >= 400:
+            _logger.debug(
+                "Request returned failure status: %s",
+                resp.status_code)
+            raise exceptions.from_response(resp, method, url)
+
+        return resp
+
+    @staticmethod
+    def concat_url(endpoint, url):
+        """Concatenate endpoint and final URL.
+
+        E.g., "http://keystone/v2.0/" and "/tokens" are concatenated to
+        "http://keystone/v2.0/tokens".
+
+        :param endpoint: the base URL
+        :param url: the final URL
+        """
+        return "%s/%s" % (endpoint.rstrip("/"), url.strip("/"))
+
+    def client_request(self, client, method, url, **kwargs):
+        """Send an http request using `client`'s endpoint and specified `url`.
+
+        If request was rejected as unauthorized (possibly because the token is
+        expired), issue one authorization attempt and send the request once
+        again.
+
+        :param client: instance of BaseClient descendant
+        :param method: method of HTTP request
+        :param url: URL of HTTP request
+        :param kwargs: any other parameter that can be passed to
+            `HTTPClient.request`
+        """
+
+        filter_args = {
+            "endpoint_type": client.endpoint_type or self.endpoint_type,
+            "service_type": client.service_type,
+        }
+        token, endpoint = (self.cached_token, client.cached_endpoint)
+        just_authenticated = False
+        if not (token and endpoint):
+            try:
+                token, endpoint = self.auth_plugin.token_and_endpoint(
+                    **filter_args)
+            except exceptions.EndpointException:
+                pass
+            if not (token and endpoint):
+                self.authenticate()
+                just_authenticated = True
+                token, endpoint = self.auth_plugin.token_and_endpoint(
+                    **filter_args)
+                if not (token and endpoint):
+                    raise exceptions.AuthorizationFailure(
+                        _("Cannot find endpoint or token for request"))
+
+        old_token_endpoint = (token, endpoint)
+        kwargs.setdefault("headers", {})["X-Auth-Token"] = token
+        self.cached_token = token
+        client.cached_endpoint = endpoint
+        # Perform the request once. If we get Unauthorized, then it
+        # might be because the auth token expired, so try to
+        # re-authenticate and try again. If it still fails, bail.
+        try:
+            return self.request(
+                method, self.concat_url(endpoint, url), **kwargs)
+        except exceptions.Unauthorized as unauth_ex:
+            if just_authenticated:
+                raise
+            self.cached_token = None
+            client.cached_endpoint = None
+            self.authenticate()
+            try:
+                token, endpoint = self.auth_plugin.token_and_endpoint(
+                    **filter_args)
+            except exceptions.EndpointException:
+                raise unauth_ex
+            if (not (token and endpoint) or
+                    old_token_endpoint == (token, endpoint)):
+                raise unauth_ex
+            self.cached_token = token
+            client.cached_endpoint = endpoint
+            kwargs["headers"]["X-Auth-Token"] = token
+            return self.request(
+                method, self.concat_url(endpoint, url), **kwargs)
+
+    def add_client(self, base_client_instance):
+        """Add a new instance of :class:`BaseClient` descendant.
+
+        `self` will store a reference to `base_client_instance`.
+
+        Example:
+
+        >>> def test_clients():
+        ...     from keystoneclient.auth import keystone
+        ...     from karborclient.common.apiclient import client
+        ...     auth = keystone.KeystoneAuthPlugin(
+        ...         username="user", password="pass", tenant_name="tenant",
+        ...         auth_url="http://auth:5000/v2.0")
+        ...     openstack_client = client.HTTPClient(auth)
+        ...     # create nova client
+        ...     from novaclient.v1_1 import client
+        ...     client.Client(openstack_client)
+        ...     # create keystone client
+        ...     from keystoneclient.v2_0 import client
+        ...     client.Client(openstack_client)
+        ...     # use them
+        ...     openstack_client.identity.tenants.list()
+        ...     openstack_client.compute.servers.list()
+        """
+        service_type = base_client_instance.service_type
+        if service_type and not hasattr(self, service_type):
+            setattr(self, service_type, base_client_instance)
+
+    def authenticate(self):
+        self.auth_plugin.authenticate(self)
+        # Store the authentication results in the keyring for later requests
+        if self.keyring_saver:
+            self.keyring_saver.save(self)
+
+
+class BaseClient(object):
+    """Top-level object to access the OpenStack API.
+
+    This client uses :class:`HTTPClient` to send requests. :class:`HTTPClient`
+    will handle a bunch of issues such as authentication.
+    """
+
+    service_type = None
+    endpoint_type = None  # "publicURL" will be used
+    cached_endpoint = None
+
+    def __init__(self, http_client, extensions=None):
+        self.http_client = http_client
+        http_client.add_client(self)
+
+        # Add in any extensions...
+        if extensions:
+            for extension in extensions:
+                if extension.manager_class:
+                    setattr(self, extension.name,
+                            extension.manager_class(self))
+
+    def client_request(self, method, url, **kwargs):
+        return self.http_client.client_request(
+            self, method, url, **kwargs)
+
+    def head(self, url, **kwargs):
+        return self.client_request("HEAD", url, **kwargs)
+
+    def get(self, url, **kwargs):
+        return self.client_request("GET", url, **kwargs)
+
+    def post(self, url, **kwargs):
+        return self.client_request("POST", url, **kwargs)
+
+    def put(self, url, **kwargs):
+        return self.client_request("PUT", url, **kwargs)
+
+    def delete(self, url, **kwargs):
+        return self.client_request("DELETE", url, **kwargs)
+
+    def patch(self, url, **kwargs):
+        return self.client_request("PATCH", url, **kwargs)
+
+    @staticmethod
+    def get_class(api_name, version, version_map):
+        """Returns the client class for the requested API version
+
+        :param api_name: the name of the API, e.g. 'compute', 'image', etc
+        :param version: the requested API version
+        :param version_map: a dict of client classes keyed by version
+        :rtype: a client class for the requested API version
+        """
+        try:
+            client_path = version_map[str(version)]
+        except (KeyError, ValueError):
+            msg = _("Invalid %(api_name)s client version '%(version)s'. "
+                    "Must be one of: %(version_map)s") % {
+                        'api_name': api_name,
+                        'version': version,
+                        'version_map': ', '.join(version_map.keys())}
+            raise exceptions.UnsupportedVersion(msg)
+
+        return importutils.import_class(client_path)

karborclient/common/apiclient/exceptions.py

@@ -1,463 +1,462 @@
-# Copyright 2011 Nebula, Inc.
-# Copyright 2013 Alessio Ababilov
-# Copyright 2013 OpenStack Foundation
-# 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.
-
-"""
-Exception definitions.
-"""
-
-import inspect
-import sys
-
-import six
-
-from karborclient.i18n import _
-
-
-class ClientException(Exception):
-    """The base exception class for all exceptions this library raises."""
-    pass
-
-
-class MissingArgs(ClientException):
-    """Supplied arguments are not sufficient for calling a function."""
-    def __init__(self, missing):
-        self.missing = missing
-        msg = _("Missing arguments: %s") % ", ".join(missing)
-        super(MissingArgs, self).__init__(msg)
-
-
-class ValidationError(ClientException):
-    """Error in validation on API client side."""
-    pass
-
-
-class UnsupportedVersion(ClientException):
-    """User is trying to use an unsupported version of the API."""
-    pass
-
-
-class CommandError(ClientException):
-    """Error in CLI tool."""
-    pass
-
-
-class AuthorizationFailure(ClientException):
-    """Cannot authorize API client."""
-    pass
-
-
-class ConnectionRefused(ClientException):
-    """Cannot connect to API service."""
-    pass
-
-
-class AuthPluginOptionsMissing(AuthorizationFailure):
-    """Auth plugin misses some options."""
-    def __init__(self, opt_names):
-        super(AuthPluginOptionsMissing, self).__init__(
-            _("Authentication failed. Missing options: %s") %
-            ", ".join(opt_names))
-        self.opt_names = opt_names
-
-
-class AuthSystemNotFound(AuthorizationFailure):
-    """User has specified an AuthSystem that is not installed."""
-    def __init__(self, auth_system):
-        super(AuthSystemNotFound, self).__init__(
-            _("AuthSystemNotFound: %s") % repr(auth_system))
-        self.auth_system = auth_system
-
-
-class NoUniqueMatch(ClientException):
-    """Multiple entities found instead of one."""
-    pass
-
-
-class EndpointException(ClientException):
-    """Something is rotten in Service Catalog."""
-    pass
-
-
-class EndpointNotFound(EndpointException):
-    """Could not find requested endpoint in Service Catalog."""
-    pass
-
-
-class AmbiguousEndpoints(EndpointException):
-    """Found more than one matching endpoint in Service Catalog."""
-    def __init__(self, endpoints=None):
-        super(AmbiguousEndpoints, self).__init__(
-            _("AmbiguousEndpoints: %s") % repr(endpoints))
-        self.endpoints = endpoints
-
-
-class HttpError(ClientException):
-    """The base exception class for all HTTP exceptions."""
-    http_status = 0
-    message = _("HTTP Error")
-
-    def __init__(self, message=None, details=None,
-                 response=None, request_id=None,
-                 url=None, method=None, http_status=None):
-        self.http_status = http_status or self.http_status
-        self.message = message or self.message
-        self.details = details
-        self.request_id = request_id
-        self.response = response
-        self.url = url
-        self.method = method
-        formatted_string = "%s (HTTP %s)" % (self.message, self.http_status)
-        if request_id:
-            formatted_string += " (Request-ID: %s)" % request_id
-        super(HttpError, self).__init__(formatted_string)
-
-
-class HTTPRedirection(HttpError):
-    """HTTP Redirection."""
-    message = _("HTTP Redirection")
-
-
-class HTTPClientError(HttpError):
-    """Client-side HTTP error.
-
-    Exception for cases in which the client seems to have erred.
-    """
-    message = _("HTTP Client Error")
-
-
-class HttpServerError(HttpError):
-    """Server-side HTTP error.
-
-    Exception for cases in which the server is aware that it has
-    erred or is incapable of performing the request.
-    """
-    message = _("HTTP Server Error")
-
-
-class MultipleChoices(HTTPRedirection):
-    """HTTP 300 - Multiple Choices.
-
-    Indicates multiple options for the resource that the client may follow.
-    """
-
-    http_status = 300
-    message = _("Multiple Choices")
-
-
-class BadRequest(HTTPClientError):
-    """HTTP 400 - Bad Request.
-
-    The request cannot be fulfilled due to bad syntax.
-    """
-    http_status = 400
-    message = _("Bad Request")
-
-
-class Unauthorized(HTTPClientError):
-    """HTTP 401 - Unauthorized.
-
-    Similar to 403 Forbidden, but specifically for use when authentication
-    is required and has failed or has not yet been provided.
-    """
-    http_status = 401
-    message = _("Unauthorized")
-
-
-class PaymentRequired(HTTPClientError):
-    """HTTP 402 - Payment Required.
-
-    Reserved for future use.
-    """
-    http_status = 402
-    message = _("Payment Required")
-
-
-class Forbidden(HTTPClientError):
-    """HTTP 403 - Forbidden.
-
-    The request was a valid request, but the server is refusing to respond
-    to it.
-    """
-    http_status = 403
-    message = _("Forbidden")
-
-
-class NotFound(HTTPClientError):
-    """HTTP 404 - Not Found.
-
-    The requested resource could not be found but may be available again
-    in the future.
-    """
-    http_status = 404
-    message = _("Not Found")
-
-
-class MethodNotAllowed(HTTPClientError):
-    """HTTP 405 - Method Not Allowed.
-
-    A request was made of a resource using a request method not supported
-    by that resource.
-    """
-    http_status = 405
-    message = _("Method Not Allowed")
-
-
-class NotAcceptable(HTTPClientError):
-    """HTTP 406 - Not Acceptable.
-
-    The requested resource is only capable of generating content not
-    acceptable according to the Accept headers sent in the request.
-    """
-    http_status = 406
-    message = _("Not Acceptable")
-
-
-class ProxyAuthenticationRequired(HTTPClientError):
-    """HTTP 407 - Proxy Authentication Required.
-
-    The client must first authenticate itself with the proxy.
-    """
-    http_status = 407
-    message = _("Proxy Authentication Required")
-
-
-class RequestTimeout(HTTPClientError):
-    """HTTP 408 - Request Timeout.
-
-    The server timed out waiting for the request.
-    """
-    http_status = 408
-    message = _("Request Timeout")
-
-
-class Conflict(HTTPClientError):
-    """HTTP 409 - Conflict.
-
-    Indicates that the request could not be processed because of conflict
-    in the request, such as an edit conflict.
-    """
-    http_status = 409
-    message = _("Conflict")
-
-
-class Gone(HTTPClientError):
-    """HTTP 410 - Gone.
-
-    Indicates that the resource requested is no longer available and will
-    not be available again.
-    """
-    http_status = 410
-    message = _("Gone")
-
-
-class LengthRequired(HTTPClientError):
-    """HTTP 411 - Length Required.
-
-    The request did not specify the length of its content, which is
-    required by the requested resource.
-    """
-    http_status = 411
-    message = _("Length Required")
-
-
-class PreconditionFailed(HTTPClientError):
-    """HTTP 412 - Precondition Failed.
-
-    The server does not meet one of the preconditions that the requester
-    put on the request.
-    """
-    http_status = 412
-    message = _("Precondition Failed")
-
-
-class RequestEntityTooLarge(HTTPClientError):
-    """HTTP 413 - Request Entity Too Large.
-
-    The request is larger than the server is willing or able to process.
-    """
-    http_status = 413
-    message = _("Request Entity Too Large")
-
-    def __init__(self, *args, **kwargs):
-        try:
-            self.retry_after = int(kwargs.pop('retry_after'))
-        except (KeyError, ValueError):
-            self.retry_after = 0
-
-        super(RequestEntityTooLarge, self).__init__(*args, **kwargs)
-
-
-class RequestUriTooLong(HTTPClientError):
-    """HTTP 414 - Request-URI Too Long.
-
-    The URI provided was too long for the server to process.
-    """
-    http_status = 414
-    message = _("Request-URI Too Long")
-
-
-class UnsupportedMediaType(HTTPClientError):
-    """HTTP 415 - Unsupported Media Type.
-
-    The request entity has a media type which the server or resource does
-    not support.
-    """
-    http_status = 415
-    message = _("Unsupported Media Type")
-
-
-class RequestedRangeNotSatisfiable(HTTPClientError):
-    """HTTP 416 - Requested Range Not Satisfiable.
-
-    The client has asked for a portion of the file, but the server cannot
-    supply that portion.
-    """
-    http_status = 416
-    message = _("Requested Range Not Satisfiable")
-
-
-class ExpectationFailed(HTTPClientError):
-    """HTTP 417 - Expectation Failed.
-
-    The server cannot meet the requirements of the Expect request-header field.
-    """
-    http_status = 417
-    message = _("Expectation Failed")
-
-
-class UnprocessableEntity(HTTPClientError):
-    """HTTP 422 - Unprocessable Entity.
-
-    The request was well-formed but was unable to be followed due to semantic
-    errors.
-    """
-    http_status = 422
-    message = _("Unprocessable Entity")
-
-
-class InternalServerError(HttpServerError):
-    """HTTP 500 - Internal Server Error.
-
-    A generic error message, given when no more specific message is suitable.
-    """
-    http_status = 500
-    message = _("Internal Server Error")
-
-
-# NotImplemented is a python keyword.
-class HttpNotImplemented(HttpServerError):
-    """HTTP 501 - Not Implemented.
-
-    The server either does not recognize the request method, or it lacks
-    the ability to fulfill the request.
-    """
-    http_status = 501
-    message = _("Not Implemented")
-
-
-class BadGateway(HttpServerError):
-    """HTTP 502 - Bad Gateway.
-
-    The server was acting as a gateway or proxy and received an invalid
-    response from the upstream server.
-    """
-    http_status = 502
-    message = _("Bad Gateway")
-
-
-class ServiceUnavailable(HttpServerError):
-    """HTTP 503 - Service Unavailable.
-
-    The server is currently unavailable.
-    """
-    http_status = 503
-    message = _("Service Unavailable")
-
-
-class GatewayTimeout(HttpServerError):
-    """HTTP 504 - Gateway Timeout.
-
-    The server was acting as a gateway or proxy and did not receive a timely
-    response from the upstream server.
-    """
-    http_status = 504
-    message = _("Gateway Timeout")
-
-
-class HttpVersionNotSupported(HttpServerError):
-    """HTTP 505 - HttpVersion Not Supported.
-
-    The server does not support the HTTP protocol version used in the request.
-    """
-    http_status = 505
-    message = _("HTTP Version Not Supported")
-
-
-# _code_map contains all the classes that have http_status attribute.
-_code_map = dict(
-    (getattr(obj, 'http_status', None), obj)
-    for name, obj in six.iteritems(vars(sys.modules[__name__]))
-    if inspect.isclass(obj) and getattr(obj, 'http_status', False)
-)
-
-
-def from_response(response, method, url):
-    """Returns an instance of :class:`HttpError` or subclass based on response.
-
-    :param response: instance of `requests.Response` class
-    :param method: HTTP method used for request
-    :param url: URL used for request
-    """
-
-    req_id = response.headers.get("x-openstack-request-id")
-    # NOTE(hdd) true for older versions of nova and cinder
-    if not req_id:
-        req_id = response.headers.get("x-compute-request-id")
-    kwargs = {
-        "http_status": response.status_code,
-        "response": response,
-        "method": method,
-        "url": url,
-        "request_id": req_id,
-    }
-    if "retry-after" in response.headers:
-        kwargs["retry_after"] = response.headers["retry-after"]
-
-    content_type = response.headers.get("Content-Type", "")
-    if content_type.startswith("application/json"):
-        try:
-            body = response.json()
-        except ValueError:
-            pass
-        else:
-            if isinstance(body, dict):
-                error = list(body.values())[0]
-                kwargs["message"] = error.get("message")
-                kwargs["details"] = error.get("details")
-    elif content_type.startswith("text/"):
-        kwargs["details"] = response.text
-
-    try:
-        cls = _code_map[response.status_code]
-    except KeyError:
-        if 500 <= response.status_code < 600:
-            cls = HttpServerError
-        elif 400 <= response.status_code < 500:
-            cls = HTTPClientError
-        else:
-            cls = HttpError
-    return cls(**kwargs)
+# Copyright 2011 Nebula, Inc.
+# Copyright 2013 Alessio Ababilov
+# Copyright 2013 OpenStack Foundation
+# 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.
+
+"""
+Exception definitions.
+"""
+
+import inspect
+import sys
+
+
+from karborclient.i18n import _
+
+
+class ClientException(Exception):
+    """The base exception class for all exceptions this library raises."""
+    pass
+
+
+class MissingArgs(ClientException):
+    """Supplied arguments are not sufficient for calling a function."""
+    def __init__(self, missing):
+        self.missing = missing
+        msg = _("Missing arguments: %s") % ", ".join(missing)
+        super(MissingArgs, self).__init__(msg)
+
+
+class ValidationError(ClientException):
+    """Error in validation on API client side."""
+    pass
+
+
+class UnsupportedVersion(ClientException):
+    """User is trying to use an unsupported version of the API."""
+    pass
+
+
+class CommandError(ClientException):
+    """Error in CLI tool."""
+    pass
+
+
+class AuthorizationFailure(ClientException):
+    """Cannot authorize API client."""
+    pass
+
+
+class ConnectionRefused(ClientException):
+    """Cannot connect to API service."""
+    pass
+
+
+class AuthPluginOptionsMissing(AuthorizationFailure):
+    """Auth plugin misses some options."""
+    def __init__(self, opt_names):
+        super(AuthPluginOptionsMissing, self).__init__(
+            _("Authentication failed. Missing options: %s") %
+            ", ".join(opt_names))
+        self.opt_names = opt_names
+
+
+class AuthSystemNotFound(AuthorizationFailure):
+    """User has specified an AuthSystem that is not installed."""
+    def __init__(self, auth_system):
+        super(AuthSystemNotFound, self).__init__(
+            _("AuthSystemNotFound: %s") % repr(auth_system))
+        self.auth_system = auth_system
+
+
+class NoUniqueMatch(ClientException):
+    """Multiple entities found instead of one."""
+    pass
+
+
+class EndpointException(ClientException):
+    """Something is rotten in Service Catalog."""
+    pass
+
+
+class EndpointNotFound(EndpointException):
+    """Could not find requested endpoint in Service Catalog."""
+    pass
+
+
+class AmbiguousEndpoints(EndpointException):
+    """Found more than one matching endpoint in Service Catalog."""
+    def __init__(self, endpoints=None):
+        super(AmbiguousEndpoints, self).__init__(
+            _("AmbiguousEndpoints: %s") % repr(endpoints))
+        self.endpoints = endpoints
+
+
+class HttpError(ClientException):
+    """The base exception class for all HTTP exceptions."""
+    http_status = 0
+    message = _("HTTP Error")
+
+    def __init__(self, message=None, details=None,
+                 response=None, request_id=None,
+                 url=None, method=None, http_status=None):
+        self.http_status = http_status or self.http_status
+        self.message = message or self.message
+        self.details = details
+        self.request_id = request_id
+        self.response = response
+        self.url = url
+        self.method = method
+        formatted_string = "%s (HTTP %s)" % (self.message, self.http_status)
+        if request_id:
+            formatted_string += " (Request-ID: %s)" % request_id
+        super(HttpError, self).__init__(formatted_string)
+
+
+class HTTPRedirection(HttpError):
+    """HTTP Redirection."""
+    message = _("HTTP Redirection")
+
+
+class HTTPClientError(HttpError):
+    """Client-side HTTP error.
+
+    Exception for cases in which the client seems to have erred.
+    """
+    message = _("HTTP Client Error")
+
+
+class HttpServerError(HttpError):
+    """Server-side HTTP error.
+
+    Exception for cases in which the server is aware that it has
+    erred or is incapable of performing the request.
+    """
+    message = _("HTTP Server Error")
+
+
+class MultipleChoices(HTTPRedirection):
+    """HTTP 300 - Multiple Choices.
+
+    Indicates multiple options for the resource that the client may follow.
+    """
+
+    http_status = 300
+    message = _("Multiple Choices")
+
+
+class BadRequest(HTTPClientError):
+    """HTTP 400 - Bad Request.
+
+    The request cannot be fulfilled due to bad syntax.
+    """
+    http_status = 400
+    message = _("Bad Request")
+
+
+class Unauthorized(HTTPClientError):
+    """HTTP 401 - Unauthorized.
+
+    Similar to 403 Forbidden, but specifically for use when authentication
+    is required and has failed or has not yet been provided.
+    """
+    http_status = 401
+    message = _("Unauthorized")
+
+
+class PaymentRequired(HTTPClientError):
+    """HTTP 402 - Payment Required.
+
+    Reserved for future use.
+    """
+    http_status = 402
+    message = _("Payment Required")
+
+
+class Forbidden(HTTPClientError):
+    """HTTP 403 - Forbidden.
+
+    The request was a valid request, but the server is refusing to respond
+    to it.
+    """
+    http_status = 403
+    message = _("Forbidden")
+
+
+class NotFound(HTTPClientError):
+    """HTTP 404 - Not Found.
+
+    The requested resource could not be found but may be available again
+    in the future.
+    """
+    http_status = 404
+    message = _("Not Found")
+
+
+class MethodNotAllowed(HTTPClientError):
+    """HTTP 405 - Method Not Allowed.
+
+    A request was made of a resource using a request method not supported
+    by that resource.
+    """
+    http_status = 405
+    message = _("Method Not Allowed")
+
+
+class NotAcceptable(HTTPClientError):
+    """HTTP 406 - Not Acceptable.
+
+    The requested resource is only capable of generating content not
+    acceptable according to the Accept headers sent in the request.
+    """
+    http_status = 406
+    message = _("Not Acceptable")
+
+
+class ProxyAuthenticationRequired(HTTPClientError):
+    """HTTP 407 - Proxy Authentication Required.
+
+    The client must first authenticate itself with the proxy.
+    """
+    http_status = 407
+    message = _("Proxy Authentication Required")
+
+
+class RequestTimeout(HTTPClientError):
+    """HTTP 408 - Request Timeout.
+
+    The server timed out waiting for the request.
+    """
+    http_status = 408
+    message = _("Request Timeout")
+
+
+class Conflict(HTTPClientError):
+    """HTTP 409 - Conflict.
+
+    Indicates that the request could not be processed because of conflict
+    in the request, such as an edit conflict.
+    """
+    http_status = 409
+    message = _("Conflict")
+
+
+class Gone(HTTPClientError):
+    """HTTP 410 - Gone.
+
+    Indicates that the resource requested is no longer available and will
+    not be available again.
+    """
+    http_status = 410
+    message = _("Gone")
+
+
+class LengthRequired(HTTPClientError):
+    """HTTP 411 - Length Required.
+
+    The request did not specify the length of its content, which is
+    required by the requested resource.
+    """
+    http_status = 411
+    message = _("Length Required")
+
+
+class PreconditionFailed(HTTPClientError):
+    """HTTP 412 - Precondition Failed.
+
+    The server does not meet one of the preconditions that the requester
+    put on the request.
+    """
+    http_status = 412
+    message = _("Precondition Failed")
+
+
+class RequestEntityTooLarge(HTTPClientError):
+    """HTTP 413 - Request Entity Too Large.
+
+    The request is larger than the server is willing or able to process.
+    """
+    http_status = 413
+    message = _("Request Entity Too Large")
+
+    def __init__(self, *args, **kwargs):
+        try:
+            self.retry_after = int(kwargs.pop('retry_after'))
+        except (KeyError, ValueError):
+            self.retry_after = 0
+
+        super(RequestEntityTooLarge, self).__init__(*args, **kwargs)
+
+
+class RequestUriTooLong(HTTPClientError):
+    """HTTP 414 - Request-URI Too Long.
+
+    The URI provided was too long for the server to process.
+    """
+    http_status = 414
+    message = _("Request-URI Too Long")
+
+
+class UnsupportedMediaType(HTTPClientError):
+    """HTTP 415 - Unsupported Media Type.
+
+    The request entity has a media type which the server or resource does
+    not support.
+    """
+    http_status = 415
+    message = _("Unsupported Media Type")
+
+
+class RequestedRangeNotSatisfiable(HTTPClientError):
+    """HTTP 416 - Requested Range Not Satisfiable.
+
+    The client has asked for a portion of the file, but the server cannot
+    supply that portion.
+    """
+    http_status = 416
+    message = _("Requested Range Not Satisfiable")
+
+
+class ExpectationFailed(HTTPClientError):
+    """HTTP 417 - Expectation Failed.
+
+    The server cannot meet the requirements of the Expect request-header field.
+    """
+    http_status = 417
+    message = _("Expectation Failed")
+
+
+class UnprocessableEntity(HTTPClientError):
+    """HTTP 422 - Unprocessable Entity.
+
+    The request was well-formed but was unable to be followed due to semantic
+    errors.
+    """
+    http_status = 422
+    message = _("Unprocessable Entity")
+
+
+class InternalServerError(HttpServerError):
+    """HTTP 500 - Internal Server Error.
+
+    A generic error message, given when no more specific message is suitable.
+    """
+    http_status = 500
+    message = _("Internal Server Error")
+
+
+# NotImplemented is a python keyword.
+class HttpNotImplemented(HttpServerError):
+    """HTTP 501 - Not Implemented.
+
+    The server either does not recognize the request method, or it lacks
+    the ability to fulfill the request.
+    """
+    http_status = 501
+    message = _("Not Implemented")
+
+
+class BadGateway(HttpServerError):
+    """HTTP 502 - Bad Gateway.
+
+    The server was acting as a gateway or proxy and received an invalid
+    response from the upstream server.
+    """
+    http_status = 502
+    message = _("Bad Gateway")
+
+
+class ServiceUnavailable(HttpServerError):
+    """HTTP 503 - Service Unavailable.
+
+    The server is currently unavailable.
+    """
+    http_status = 503
+    message = _("Service Unavailable")
+
+
+class GatewayTimeout(HttpServerError):
+    """HTTP 504 - Gateway Timeout.
+
+    The server was acting as a gateway or proxy and did not receive a timely
+    response from the upstream server.
+    """
+    http_status = 504
+    message = _("Gateway Timeout")
+
+
+class HttpVersionNotSupported(HttpServerError):
+    """HTTP 505 - HttpVersion Not Supported.
+
+    The server does not support the HTTP protocol version used in the request.
+    """
+    http_status = 505
+    message = _("HTTP Version Not Supported")
+
+
+# _code_map contains all the classes that have http_status attribute.
+_code_map = dict(
+    (getattr(obj, 'http_status', None), obj)
+    for name, obj in vars(sys.modules[__name__]).items()
+    if inspect.isclass(obj) and getattr(obj, 'http_status', False)
+)
+
+
+def from_response(response, method, url):
+    """Returns an instance of :class:`HttpError` or subclass based on response.
+
+    :param response: instance of `requests.Response` class
+    :param method: HTTP method used for request
+    :param url: URL used for request
+    """
+
+    req_id = response.headers.get("x-openstack-request-id")
+    # NOTE(hdd) true for older versions of nova and cinder
+    if not req_id:
+        req_id = response.headers.get("x-compute-request-id")
+    kwargs = {
+        "http_status": response.status_code,
+        "response": response,
+        "method": method,
+        "url": url,
+        "request_id": req_id,
+    }
+    if "retry-after" in response.headers:
+        kwargs["retry_after"] = response.headers["retry-after"]
+
+    content_type = response.headers.get("Content-Type", "")
+    if content_type.startswith("application/json"):
+        try:
+            body = response.json()
+        except ValueError:
+            pass
+        else:
+            if isinstance(body, dict):
+                error = list(body.values())[0]
+                kwargs["message"] = error.get("message")
+                kwargs["details"] = error.get("details")
+    elif content_type.startswith("text/"):
+        kwargs["details"] = response.text
+
+    try:
+        cls = _code_map[response.status_code]
+    except KeyError:
+        if 500 <= response.status_code < 600:
+            cls = HttpServerError
+        elif 400 <= response.status_code < 500:
+            cls = HTTPClientError
+        else:
+            cls = HttpError
+    return cls(**kwargs)

karborclient/common/apiclient/fake_client.py

@@ -1,177 +1,177 @@
-# Copyright 2013 OpenStack Foundation
-# 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.
-
-"""
-A fake server that "responds" to API methods with pre-canned responses.
-
-All of these responses come from the spec, so if for some reason the spec's
-wrong the tests might raise AssertionError. I've indicated in comments the
-places where actual behavior differs from the spec.
-"""
-
-# W0102: Dangerous default value %s as argument
-# pylint: disable=W0102
-
-import json
-
-import requests
-import six
-from six.moves.urllib import parse
-
-from karborclient.common.apiclient import client
-
-
-def assert_has_keys(dct, required=None, optional=None):
-    if required is None:
-        required = []
-    if optional is None:
-        optional = []
-    for k in required:
-        try:
-            assert k in dct
-        except AssertionError:
-            extra_keys = set(dct.keys()).difference(set(required + optional))
-            raise AssertionError("found unexpected keys: %s" %
-                                 list(extra_keys))
-
-
-class TestResponse(requests.Response):
-    """Wrap requests.Response and provide a convenient initialization."""
-
-    def __init__(self, data):
-        super(TestResponse, self).__init__()
-        self._content_consumed = True
-        if isinstance(data, dict):
-            self.status_code = data.get('status_code', 200)
-            # Fake the text attribute to streamline Response creation
-            text = data.get('text', "")
-            if isinstance(text, (dict, list)):
-                self._content = json.dumps(text)
-                default_headers = {
-                    "Content-Type": "application/json",
-                }
-            else:
-                self._content = text
-                default_headers = {}
-            if six.PY3 and isinstance(self._content, six.string_types):
-                self._content = self._content.encode('utf-8', 'strict')
-            self.headers = data.get('headers') or default_headers
-        else:
-            self.status_code = data
-
-    def __eq__(self, other):
-        return (self.status_code == other.status_code and
-                self.headers == other.headers and
-                self._content == other._content)
-
-    def __ne__(self, other):
-        return not self.__eq__(other)
-
-
-class FakeHTTPClient(client.HTTPClient):
-
-    def __init__(self, *args, **kwargs):
-        self.callstack = []
-        self.fixtures = kwargs.pop("fixtures", None) or {}
-        if not args and "auth_plugin" not in kwargs:
-            args = (None, )
-        super(FakeHTTPClient, self).__init__(*args, **kwargs)
-
-    def assert_called(self, method, url, body=None, pos=-1):
-        """Assert than an API method was just called."""
-        expected = (method, url)
-        called = self.callstack[pos][0:2]
-        assert self.callstack, \
-            "Expected %s %s but no calls were made." % expected
-
-        assert expected == called, 'Expected %s %s; got %s %s' % \
-            (expected + called)
-
-        if body is not None:
-            if self.callstack[pos][3] != body:
-                raise AssertionError('%r != %r' %
-                                     (self.callstack[pos][3], body))
-
-    def assert_called_anytime(self, method, url, body=None):
-        """Assert than an API method was called anytime in the test."""
-        expected = (method, url)
-
-        assert self.callstack, \
-            "Expected %s %s but no calls were made." % expected
-
-        found = False
-        entry = None
-        for entry in self.callstack:
-            if expected == entry[0:2]:
-                found = True
-                break
-
-        assert found, 'Expected %s %s; got %s' % \
-            (method, url, self.callstack)
-        if body is not None:
-            assert entry[3] == body, "%s != %s" % (entry[3], body)
-
-        self.callstack = []
-
-    def clear_callstack(self):
-        self.callstack = []
-
-    def authenticate(self):
-        pass
-
-    def client_request(self, client, method, url, **kwargs):
-        # Check that certain things are called correctly
-        if method in ["GET", "DELETE"]:
-            assert "json" not in kwargs
-
-        # Note the call
-        self.callstack.append(
-            (method,
-             url,
-             kwargs.get("headers") or {},
-             kwargs.get("json") or kwargs.get("data")))
-        try:
-            fixture = self.fixtures[url][method]
-        except KeyError:
-            pass
-        else:
-            return TestResponse({"headers": fixture[0],
-                                 "text": fixture[1]})
-
-        # Call the method
-        args = parse.parse_qsl(parse.urlparse(url)[4])
-        kwargs.update(args)
-        munged_url = url.rsplit('?', 1)[0]
-        munged_url = munged_url.strip('/').replace('/', '_').replace('.', '_')
-        munged_url = munged_url.replace('-', '_')
-
-        callback = "%s_%s" % (method.lower(), munged_url)
-
-        if not hasattr(self, callback):
-            raise AssertionError('Called unknown API method: %s %s, '
-                                 'expected fakes method name: %s' %
-                                 (method, url, callback))
-
-        resp = getattr(self, callback)(**kwargs)
-        if len(resp) == 3:
-            status, headers, body = resp
-        else:
-            status, body = resp
-            headers = {}
-        return TestResponse({
-            "status_code": status,
-            "text": body,
-            "headers": headers,
-        })
+# Copyright 2013 OpenStack Foundation
+# 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.
+
+"""
+A fake server that "responds" to API methods with pre-canned responses.
+
+All of these responses come from the spec, so if for some reason the spec's
+wrong the tests might raise AssertionError. I've indicated in comments the
+places where actual behavior differs from the spec.
+"""
+
+# W0102: Dangerous default value %s as argument
+# pylint: disable=W0102
+
+import json
+
+import requests
+import six
+from six.moves.urllib import parse
+
+from karborclient.common.apiclient import client
+
+
+def assert_has_keys(dct, required=None, optional=None):
+    if required is None:
+        required = []
+    if optional is None:
+        optional = []
+    for k in required:
+        try:
+            assert k in dct
+        except AssertionError:
+            extra_keys = set(dct.keys()).difference(set(required + optional))
+            raise AssertionError("found unexpected keys: %s" %
+                                 list(extra_keys))
+
+
+class TestResponse(requests.Response):
+    """Wrap requests.Response and provide a convenient initialization."""
+
+    def __init__(self, data):
+        super(TestResponse, self).__init__()
+        self._content_consumed = True
+        if isinstance(data, dict):
+            self.status_code = data.get('status_code', 200)
+            # Fake the text attribute to streamline Response creation
+            text = data.get('text', "")
+            if isinstance(text, (dict, list)):
+                self._content = json.dumps(text)
+                default_headers = {
+                    "Content-Type": "application/json",
+                }
+            else:
+                self._content = text
+                default_headers = {}
+            if six.PY3 and isinstance(self._content, six.string_types):
+                self._content = self._content.encode('utf-8', 'strict')
+            self.headers = data.get('headers') or default_headers
+        else:
+            self.status_code = data
+
+    def __eq__(self, other):
+        return (self.status_code == other.status_code and
+                self.headers == other.headers and
+                self._content == other._content)
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+
+class FakeHTTPClient(client.HTTPClient):
+
+    def __init__(self, *args, **kwargs):
+        self.callstack = []
+        self.fixtures = kwargs.pop("fixtures", None) or {}
+        if not args and "auth_plugin" not in kwargs:
+            args = (None, )
+        super(FakeHTTPClient, self).__init__(*args, **kwargs)
+
+    def assert_called(self, method, url, body=None, pos=-1):
+        """Assert than an API method was just called."""
+        expected = (method, url)
+        called = self.callstack[pos][0:2]
+        assert self.callstack, \
+            "Expected %s %s but no calls were made." % expected
+
+        assert expected == called, 'Expected %s %s; got %s %s' % \
+            (expected + called)
+
+        if body is not None:
+            if self.callstack[pos][3] != body:
+                raise AssertionError('%r != %r' %
+                                     (self.callstack[pos][3], body))
+
+    def assert_called_anytime(self, method, url, body=None):
+        """Assert than an API method was called anytime in the test."""
+        expected = (method, url)
+
+        assert self.callstack, \
+            "Expected %s %s but no calls were made." % expected
+
+        found = False
+        entry = None
+        for entry in self.callstack:
+            if expected == entry[0:2]:
+                found = True
+                break
+
+        assert found, 'Expected %s %s; got %s' % \
+            (method, url, self.callstack)
+        if body is not None:
+            assert entry[3] == body, "%s != %s" % (entry[3], body)
+
+        self.callstack = []
+
+    def clear_callstack(self):
+        self.callstack = []
+
+    def authenticate(self):
+        pass
+
+    def client_request(self, client, method, url, **kwargs):
+        # Check that certain things are called correctly
+        if method in ["GET", "DELETE"]:
+            assert "json" not in kwargs
+
+        # Note the call
+        self.callstack.append(
+            (method,
+             url,
+             kwargs.get("headers") or {},
+             kwargs.get("json") or kwargs.get("data")))
+        try:
+            fixture = self.fixtures[url][method]
+        except KeyError:
+            pass
+        else:
+            return TestResponse({"headers": fixture[0],
+                                 "text": fixture[1]})
+
+        # Call the method
+        args = parse.parse_qsl(parse.urlparse(url)[4])
+        kwargs.update(args)
+        munged_url = url.rsplit('?', 1)[0]
+        munged_url = munged_url.strip('/').replace('/', '_').replace('.', '_')
+        munged_url = munged_url.replace('-', '_')
+
+        callback = "%s_%s" % (method.lower(), munged_url)
+
+        if not hasattr(self, callback):
+            raise AssertionError('Called unknown API method: %s %s, '
+                                 'expected fakes method name: %s' %
+                                 (method, url, callback))
+
+        resp = getattr(self, callback)(**kwargs)
+        if len(resp) == 3:
+            status, headers, body = resp
+        else:
+            status, body = resp
+            headers = {}
+        return TestResponse({
+            "status_code": status,
+            "text": body,
+            "headers": headers,
+        })

karborclient/common/http.py

@@ -18,7 +18,7 @@ import hashlib
 import os
 import socket
 
-import keystoneclient.adapter as keystone_adapter
+import keystoneauth1.adapter as keystone_adapter
 from oslo_log import log as logging
 from oslo_serialization import jsonutils
 from oslo_utils import encodeutils
@@ -299,7 +299,7 @@ class HTTPClient(object):
 
 
 class SessionClient(keystone_adapter.Adapter):
-    """karbor specific keystoneclient Adapter.
+    """karbor specific keystoneauth Adapter.
 
     """
 

karborclient/common/utils.py

@@ -12,6 +12,7 @@
 
 from __future__ import print_function
 
+import json
 import os
 import sys
 
@@ -19,7 +20,6 @@ import six
 import uuid
 
 from oslo_utils import encodeutils
-from oslo_utils import importutils
 
 import prettytable
 
@@ -43,19 +43,12 @@ def env(*vars, **kwargs):
     returns the default defined in kwargs.
     """
     for v in vars:
-        value = os.environ.get(v, None)
+        value = os.environ.get(v)
         if value:
             return value
     return kwargs.get('default', '')
 
 
-def import_versioned_module(version, submodule=None):
-    module = 'karborclient.v%s' % version
-    if submodule:
-        module = '.'.join((module, submodule))
-    return importutils.import_module(module)
-
-
 def _print(pt, order):
     if sys.version_info >= (3, 0):
         print(pt.get_string(sortby=order))
@@ -112,7 +105,7 @@ def print_list(objs, fields, exclude_unavailable=False, formatters=None,
         fields.remove(f)
 
     pt = prettytable.PrettyTable((f for f in fields), caching=False)
-    pt.aligns = ['l' for f in fields]
+    pt.align = 'l'
     for row in rows:
         pt.add_row(row)
 
@@ -123,17 +116,40 @@ def print_list(objs, fields, exclude_unavailable=False, formatters=None,
     _print(pt, order_by)
 
 
-def print_dict(d, property="Property"):
+def print_dict(d, property="Property", dict_format_list=None,
+               json_format_list=None):
     pt = prettytable.PrettyTable([property, 'Value'], caching=False)
-    pt.aligns = ['l', 'l']
-    for r in six.iteritems(d):
+    pt.align = 'l'
+    for r in d.items():
         r = list(r)
         if isinstance(r[1], six.string_types) and "\r" in r[1]:
             r[1] = r[1].replace("\r", " ")
+        if dict_format_list is not None and r[0] in dict_format_list:
+            r[1] = dict_prettyprint(r[1])
+        if json_format_list is not None and r[0] in json_format_list:
+            r[1] = json_prettyprint(r[1])
         pt.add_row(r)
     _print(pt, property)
 
 
+def dict_prettyprint(val):
+    """dict pretty print formatter.
+
+    :param val: dict.
+    :return: formatted json string.
+    """
+    return json.dumps(val, indent=2, sort_keys=True)
+
+
+def json_prettyprint(val):
+    """json pretty print formatter.
+
+    :param val: json string.
+    :return: formatted json string.
+    """
+    return val and json.dumps(json.loads(val), indent=2, sort_keys=True)
+
+
 def find_resource(manager, name_or_id, *args, **kwargs):
     """Helper for the _find_* methods."""
     # first try to get entity as integer id

karborclient/i18n.py

@@ -1,34 +1,28 @@
-#    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.
-
-"""oslo.i18n integration module.
-
-See http://docs.openstack.org/developer/oslo.i18n/usage.html
-
-"""
-
-import oslo_i18n
-
-_translators = oslo_i18n.TranslatorFactory(domain='karborclient')
-
-# The primary translation function using the well-known name "_"
-_ = _translators.primary
-
-# Translators for log levels.
-#
-# The abbreviated names are meant to reflect the usual use of a short
-# name like '_'. The "L" is for "log" and the other letter comes from
-# the level.
-_LI = _translators.log_info
-_LW = _translators.log_warning
-_LE = _translators.log_error
-_LC = _translators.log_critical
+#    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.
+
+"""oslo.i18n integration module.
+
+See https://docs.openstack.org/oslo.i18n/latest/user/usage.html
+
+"""
+
+import oslo_i18n
+
+_translators = oslo_i18n.TranslatorFactory(domain='karborclient')
+
+# The primary translation function using the well-known name "_"
+_ = _translators.primary
+
+
+def get_available_languages():
+    return oslo_i18n.get_available_languages('karborclient')

karborclient/osc/plugin.py

@@ -0,0 +1,56 @@
+#   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 logging
+
+from osc_lib import utils
+
+LOG = logging.getLogger(__name__)
+
+DEFAULT_DATA_PROTECTION_API_VERSION = '1'
+API_VERSION_OPTION = 'os_data_protection_api_version'
+API_NAME = 'data_protection'
+API_VERSIONS = {
+    '1': 'karborclient.v1.client.Client',
+}
+
+
+def make_client(instance):
+    """Returns a data protection service client"""
+    data_protection_client = utils.get_client_class(
+        API_NAME,
+        instance._api_version[API_NAME],
+        API_VERSIONS)
+    LOG.debug('Instantiating data protection client: %s',
+              data_protection_client)
+    client = data_protection_client(
+        auth=instance.auth,
+        session=instance.session,
+        service_type="data-protect"
+    )
+
+    return client
+
+
+def build_option_parser(parser):
+    """Hook to add global options"""
+    parser.add_argument(
+        '--os-data-protection-api-version',
+        metavar='<data-protection-api-version>',
+        default=utils.env(
+            'OS_DATA_PROTECTION_API_VERSION',
+            default=DEFAULT_DATA_PROTECTION_API_VERSION),
+        help='Data protection API version, default=' +
+             DEFAULT_DATA_PROTECTION_API_VERSION +
+             ' (Env: OS_DATA_PROTECTION_API_VERSION)')
+    return parser

karborclient/osc/v1/checkpoints.py

@@ -0,0 +1,221 @@
+#    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.
+
+"""Data protection V1 checkpoint action implementations"""
+
+import json
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+from karborclient import utils
+
+
+def format_checkpoint(checkpoint_info):
+    if 'protection_plan' in checkpoint_info:
+        plan = checkpoint_info['protection_plan']
+        checkpoint_info['protection_plan'] = "Name: %s\nId: %s" % (
+            plan['name'], plan['id'])
+    if 'resource_graph' in checkpoint_info:
+        checkpoint_info['resource_graph'] = json.dumps(json.loads(
+            checkpoint_info['resource_graph']), indent=2, sort_keys=True)
+    checkpoint_info.pop("links", None)
+
+
+class ListCheckpoints(command.Lister):
+    _description = _("List checkpoints.")
+
+    log = logging.getLogger(__name__ + ".ListCheckpoints")
+
+    def get_parser(self, prog_name):
+        parser = super(ListCheckpoints, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('ID of provider.'),
+        )
+        parser.add_argument(
+            '--plan_id',
+            metavar='<plan_id>',
+            default=None,
+            help=_('Filters results by a plan ID. Default=None.'),
+        )
+        parser.add_argument(
+            '--start_date',
+            type=str,
+            metavar='<start_date>',
+            default=None,
+            help=_('Filters results by a start date("Y-m-d"). Default=None.'),
+        )
+        parser.add_argument(
+            '--end_date',
+            type=str,
+            metavar='<end_date>',
+            default=None,
+            help=_('Filters results by a end date("Y-m-d"). Default=None.'),
+        )
+        parser.add_argument(
+            '--project_id',
+            metavar='<project_id>',
+            default=None,
+            help=_('Filters results by a project ID. Default=None.'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<checkpoint>',
+            help=_('The last checkpoint ID of the previous page.'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-checkpoints>',
+            help=_('Maximum number of checkpoints to display.'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc), "
+                   "multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+
+        search_opts = {
+            'plan_id': parsed_args.plan_id,
+            'start_date': parsed_args.start_date,
+            'end_date': parsed_args.end_date,
+            'project_id': parsed_args.project_id,
+        }
+
+        data = data_protection_client.checkpoints.list(
+            provider_id=parsed_args.provider_id, search_opts=search_opts,
+            marker=parsed_args.marker, limit=parsed_args.limit,
+            sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Project id', 'Status', 'Protection plan',
+                          'Metadata', 'Created at']
+
+        def plan_formatter(plan):
+            return "Name: %s\nId: %s" % (plan['name'],
+                                         plan['id'])
+        formatters = {"Protection plan": plan_formatter}
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers, formatters=formatters
+                ) for s in data))
+
+
+class ShowCheckpoint(command.ShowOne):
+    _description = "Shows checkpoint details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowCheckpoint, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar="<provider_id>",
+            help=_('Id of provider.')
+        )
+        parser.add_argument(
+            'checkpoint_id',
+            metavar="<checkpoint_id>",
+            help=_('Id of checkpoint.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        checkpoint = client.checkpoints.get(parsed_args.provider_id,
+                                            parsed_args.checkpoint_id)
+        format_checkpoint(checkpoint._info)
+        return zip(*sorted(checkpoint._info.items()))
+
+
+class CreateCheckpoint(command.ShowOne):
+    _description = "Creates a checkpoint"
+
+    def get_parser(self, prog_name):
+        parser = super(CreateCheckpoint, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('ID of provider.')
+        )
+        parser.add_argument(
+            'plan_id',
+            metavar='<plan_id>',
+            help=_('ID of plan.')
+        )
+        parser.add_argument(
+            '--extra_info',
+            type=str,
+            nargs='*',
+            metavar='<key=value>',
+            default=None,
+            help=_('The extra info of a checkpoint.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        checkpoint_extra_info = None
+        if parsed_args.extra_info is not None:
+            checkpoint_extra_info = utils.extract_extra_info(parsed_args)
+        checkpoint = client.checkpoints.create(parsed_args.provider_id,
+                                               parsed_args.plan_id,
+                                               checkpoint_extra_info)
+        format_checkpoint(checkpoint._info)
+        return zip(*sorted(checkpoint._info.items()))
+
+
+class DeleteCheckpoint(command.Command):
+    _description = "Delete checkpoint"
+
+    log = logging.getLogger(__name__ + ".DeleteCheckpoint")
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteCheckpoint, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('Id of provider.')
+        )
+        parser.add_argument(
+            'checkpoint',
+            metavar='<checkpoint>',
+            nargs="+",
+            help=_('Id of checkpoint.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        failure_count = 0
+        for checkpoint_id in parsed_args.checkpoint:
+            try:
+                client.checkpoints.delete(parsed_args.provider_id,
+                                          checkpoint_id)
+            except exceptions.NotFound:
+                failure_count += 1
+                self.log.error(
+                    "Failed to delete '{0}'; checkpoint not found".
+                    format(checkpoint_id))
+        if failure_count == len(parsed_args.checkpoint):
+            raise exceptions.CommandError(
+                "Unable to find and delete any of the "
+                "specified checkpoint.")

karborclient/osc/v1/operation_logs.py

@@ -0,0 +1,111 @@
+#    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.
+
+"""Data protection V1 operation_log action implementations"""
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.i18n import _
+
+
+class ListOperationLogs(command.Lister):
+    _description = _("List operation_logs.")
+
+    log = logging.getLogger(__name__ + ".ListOperationLogs")
+
+    def get_parser(self, prog_name):
+        parser = super(ListOperationLogs, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
+        parser.add_argument(
+            '--status',
+            metavar='<status>',
+            help=_('Filter results by status'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<operation_log>',
+            help=_('The last operation_log ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-operation_logs>',
+            help=_('Maximum number of operation_logs to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc), "
+                   "multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by a project(admin only)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'status': parsed_args.status,
+        }
+
+        data = data_protection_client.operation_logs.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Operation Type', 'Checkpoint id',
+                          'Plan Id', 'Provider id', 'Restore Id',
+                          'Scheduled Operation Id', 'Status',
+                          'Started At', 'Ended At', 'Error Info',
+                          'Extra Info']
+
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class ShowOperationLog(command.ShowOne):
+    _description = "Shows operation_log details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowOperationLog, self).get_parser(prog_name)
+        parser.add_argument(
+            'operation_log',
+            metavar="<operation_log>",
+            help=_('The UUID of the operation_log.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        operation_log = osc_utils.find_resource(client.operation_logs,
+                                                parsed_args.operation_log)
+
+        operation_log._info.pop("links", None)
+        return zip(*sorted(operation_log._info.items()))

karborclient/osc/v1/plans.py

@@ -0,0 +1,274 @@
+#    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.
+
+"""Data protection V1 plan action implementations"""
+
+import json
+from oslo_utils import uuidutils
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+from karborclient import utils
+
+
+def format_plan(plan_info):
+    for key in ('resources', 'parameters'):
+        if key not in plan_info:
+            continue
+        plan_info[key] = json.dumps(plan_info[key], indent=2, sort_keys=True)
+    plan_info.pop("links", None)
+
+
+class ListPlans(command.Lister):
+    _description = _("List plans.")
+
+    log = logging.getLogger(__name__ + ".ListPlans")
+
+    def get_parser(self, prog_name):
+        parser = super(ListPlans, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_('Filter results by plan name'),
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<description>',
+            help=_('Filter results by plan description'),
+        )
+        parser.add_argument(
+            '--status',
+            metavar='<status>',
+            help=_('Filter results by status'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<plan>',
+            help=_('The last plan ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-plans>',
+            help=_('Maximum number of plans to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc) "
+                   "(default: name:asc), multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by a project(admin only)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'name': parsed_args.name,
+            'description': parsed_args.description,
+            'status': parsed_args.status,
+        }
+
+        data = data_protection_client.plans.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Name', 'Description', 'Provider id', 'Status']
+
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class ShowPlan(command.ShowOne):
+    _description = "Shows plan details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowPlan, self).get_parser(prog_name)
+        parser.add_argument(
+            'plan',
+            metavar="<plan>",
+            help=_('The UUID of the plan.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        plan = osc_utils.find_resource(client.plans, parsed_args.plan)
+
+        format_plan(plan._info)
+        return zip(*sorted(plan._info.items()))
+
+
+class CreatePlan(command.ShowOne):
+    _description = "Creates a plan"
+
+    def get_parser(self, prog_name):
+        parser = super(CreatePlan, self).get_parser(prog_name)
+        parser.add_argument(
+            'name',
+            metavar='<name>',
+            help=_('The name of the plan.')
+        )
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('The UUID of the provider.')
+        )
+        parser.add_argument(
+            'resources',
+            metavar='<id=type=name=extra_info,id=type=name=extra_info>',
+            help=_('Resource in list must be a dict when creating'
+                   ' a plan. The keys of resource are id ,type, name and '
+                   'extra_info. The extra_info field is optional.')
+        )
+        parser.add_argument(
+            '--parameters-json',
+            type=str,
+            dest='parameters_json',
+            metavar='<parameters>',
+            default=None,
+            help=_('Plan parameters in json format.')
+        )
+        parser.add_argument(
+            '--parameters',
+            action='append',
+            metavar='resource_type=<type>[,resource_id=<id>,key=val,...]',
+            default=[],
+            help=_('Plan parameters, may be specified multiple times. '
+                   'resource_type: type of resource to apply parameters. '
+                   'resource_id: limit the parameters to a specific resource. '
+                   'Other keys and values: according to provider\'s protect '
+                   'schema.')
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<description>',
+            help=_('The description of the plan.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        if not uuidutils.is_uuid_like(parsed_args.provider_id):
+            raise exceptions.CommandError(
+                "Invalid provider id provided.")
+        plan_resources = utils.extract_resources(parsed_args)
+        utils.check_resources(client, plan_resources)
+        plan_parameters = utils.extract_parameters(parsed_args)
+        plan = client.plans.create(parsed_args.name, parsed_args.provider_id,
+                                   plan_resources, plan_parameters,
+                                   description=parsed_args.description)
+
+        format_plan(plan._info)
+        return zip(*sorted(plan._info.items()))
+
+
+class UpdatePlan(command.ShowOne):
+    _description = "Update a plan"
+
+    def get_parser(self, prog_name):
+        parser = super(UpdatePlan, self).get_parser(prog_name)
+        parser.add_argument(
+            "plan_id",
+            metavar="<PLAN ID>",
+            help=_("Id of plan to update.")
+        )
+        parser.add_argument(
+            "--name",
+            metavar="<name>",
+            help=_("A name to which the plan will be renamed.")
+        )
+        parser.add_argument(
+            "--resources",
+            metavar="<id=type=name,id=type=name>",
+            help=_("Resources to which the plan will be updated.")
+        )
+        parser.add_argument(
+            "--status",
+            metavar="<suspended|started>",
+            help=_("status to which the plan will be updated.")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        data = {}
+        if parsed_args.name is not None:
+            data['name'] = parsed_args.name
+        if parsed_args.resources is not None:
+            plan_resources = utils.extract_resources(parsed_args)
+            data['resources'] = plan_resources
+        if parsed_args.status is not None:
+            data['status'] = parsed_args.status
+        try:
+            plan = osc_utils.find_resource(client.plans,
+                                           parsed_args.plan_id)
+            plan = client.plans.update(plan.id, data)
+        except exceptions.NotFound:
+            raise exceptions.CommandError(
+                "Plan %s not found" % parsed_args.plan_id)
+        else:
+            format_plan(plan._info)
+            return zip(*sorted(plan._info.items()))
+
+
+class DeletePlan(command.Command):
+    _description = "Delete plan"
+
+    def get_parser(self, prog_name):
+        parser = super(DeletePlan, self).get_parser(prog_name)
+        parser.add_argument(
+            'plan',
+            metavar='<plan>',
+            nargs="+",
+            help=_('ID of plan.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        failure_count = 0
+        for plan_id in parsed_args.plan:
+            try:
+                plan = osc_utils.find_resource(client.plans, plan_id)
+                client.plans.delete(plan.id)
+            except exceptions.NotFound:
+                failure_count += 1
+                print("Failed to delete '{0}'; plan not "
+                      "found".format(plan_id))
+        if failure_count == len(parsed_args.plan):
+            raise exceptions.CommandError(
+                "Unable to find and delete any of the "
+                "specified plan.")

karborclient/osc/v1/protectables.py

@@ -0,0 +1,196 @@
+#    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.
+
+"""Data protection V1 protectables action implementations"""
+
+import functools
+import json
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.i18n import _
+from karborclient import utils
+
+
+class ListProtectables(command.Lister):
+    _description = _("List protectable types.")
+
+    log = logging.getLogger(__name__ + ".ListProtectables")
+
+    def get_parser(self, prog_name):
+        parser = super(ListProtectables, self).get_parser(prog_name)
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+
+        data = data_protection_client.protectables.list()
+
+        column_headers = ['Protectable type']
+
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class ShowProtectable(command.ShowOne):
+    _description = "Shows protectable type details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowProtectable, self).get_parser(prog_name)
+        parser.add_argument(
+            'protectable_type',
+            metavar="<protectable_type>",
+            help=_('Protectable type.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        protectable = osc_utils.find_resource(client.protectables,
+                                              parsed_args.protectable_type)
+
+        protectable._info.pop("links", None)
+        if 'dependent_types' in protectable._info:
+            protectable._info['dependent_types'] = "\n".join(
+                protectable._info['dependent_types'])
+        return zip(*sorted(protectable._info.items()))
+
+
+class ListProtectableInstances(command.Lister):
+    _description = _("List protectable instances.")
+
+    log = logging.getLogger(__name__ + ".ListProtectableInstances")
+
+    def get_parser(self, prog_name):
+        parser = super(ListProtectableInstances, self).get_parser(prog_name)
+        parser.add_argument(
+            'protectable_type',
+            metavar="<protectable_type>",
+            help=_('Type of protectable.')
+        )
+        parser.add_argument(
+            '--type',
+            metavar="<type>",
+            default=None,
+            help=_('Filters results by protectable type. Default=None.')
+        )
+        parser.add_argument(
+            '--marker',
+            metavar="<protectable_instance>",
+            default=None,
+            help=_('The last protectable instance ID of the previous page.')
+        )
+        parser.add_argument(
+            '--limit',
+            metavar="<num-protectable_instances>",
+            default=None,
+            help=_('Maximum number of protectable instances to display.')
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc), "
+                   "multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--parameters',
+            type=str,
+            nargs='*',
+            metavar="<key=value>",
+            default=None,
+            help=_('List instances by parameters key and value pair. '
+                   'Default=None.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+
+        search_opts = {
+            'type': parsed_args.type,
+            'parameters': (utils.extract_instances_parameters(parsed_args)
+                           if parsed_args.parameters else None),
+        }
+
+        data = data_protection_client.protectables.list_instances(
+            parsed_args.protectable_type, search_opts=search_opts,
+            marker=parsed_args.marker, limit=parsed_args.limit,
+            sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Type', 'Name', 'Dependent resources',
+                          'Extra info']
+
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        formatters = {
+            "Extra info": json_dumps,
+            "Dependent resources": json_dumps,
+        }
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers, formatters=formatters,
+                ) for s in data))
+
+
+class ShowProtectableInstance(command.ShowOne):
+    _description = "Shows protectable instance details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowProtectableInstance, self).get_parser(prog_name)
+        parser.add_argument(
+            'protectable_type',
+            metavar="<protectable_type>",
+            help=_('Protectable type.')
+        )
+        parser.add_argument(
+            'protectable_id',
+            metavar="<protectable_id>",
+            help=_('Protectable instance id.')
+        )
+        parser.add_argument(
+            '--parameters',
+            type=str,
+            nargs='*',
+            metavar="<key=value>",
+            default=None,
+            help=_('Show a instance by parameters key and value pair. '
+                   'Default=None.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+
+        search_opts = {
+            'parameters': (utils.extract_instances_parameters(parsed_args)
+                           if parsed_args.parameters else None),
+        }
+
+        instance = client.protectables.get_instance(
+            parsed_args.protectable_type,
+            parsed_args.protectable_id,
+            search_opts=search_opts)
+
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        instance._info.pop("links", None)
+        for key in ('extra_info', 'dependent_resources'):
+            if key not in instance._info:
+                continue
+            instance._info[key] = json_dumps(instance._info[key])
+
+        return zip(*sorted(instance._info.items()))

karborclient/osc/v1/providers.py

@@ -0,0 +1,104 @@
+#    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.
+
+"""Data protection V1 provider action implementations"""
+
+import functools
+import json
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.i18n import _
+
+
+class ListProviders(command.Lister):
+    _description = _("List providers.")
+
+    log = logging.getLogger(__name__ + ".ListProviders")
+
+    def get_parser(self, prog_name):
+        parser = super(ListProviders, self).get_parser(prog_name)
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_('Filters results by a name. Default=None.'),
+        )
+        parser.add_argument(
+            '--description',
+            metavar='<description>',
+            help=_('Filters results by a description. Default=None.'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<provider>',
+            help=_('The last provider ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-providers>',
+            help=_('Maximum number of providers to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc) "
+                   "(default: name:asc), multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+
+        search_opts = {
+            'name': parsed_args.name,
+            'description': parsed_args.description,
+        }
+
+        data = data_protection_client.providers.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Name', 'Description']
+
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class ShowProvider(command.ShowOne):
+    _description = "Shows provider details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowProvider, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider',
+            metavar="<provider>",
+            help=_('The UUID of the provider.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        provider = osc_utils.find_resource(client.providers,
+                                           parsed_args.provider)
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        provider._info.pop("links", None)
+        if 'extended_info_schema' in provider._info:
+            provider._info['extended_info_schema'] = json_dumps(
+                provider._info['extended_info_schema'])
+        return zip(*sorted(provider._info.items()))

karborclient/osc/v1/quota_classes.py

@@ -0,0 +1,75 @@
+#    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.
+
+"""Data protection V1 quota classes action implementations"""
+
+from osc_lib.command import command
+
+
+def quota_class_set_pretty_show(quota_classes):
+    """Convert quotas class object to dict and display."""
+
+    new_quota_classes = []
+    for quota_k, quota_v in sorted(quota_classes.to_dict().items()):
+        if isinstance(quota_v, dict):
+            quota_v = '\n'.join(
+                ['%s = %s' % (k, v) for k, v in sorted(quota_v.items())])
+        new_quota_classes.append((quota_k, quota_v))
+
+    return new_quota_classes
+
+
+class ShowQuotaClasses(command.ShowOne):
+    _description = "Shows Quota classes."
+
+    def get_parser(self, prog_name):
+        parser = super(ShowQuotaClasses, self).get_parser(prog_name)
+        parser.add_argument(
+            'class_name',
+            metavar='<class_name>',
+            help='Name of quota class to list the quotas for.')
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        result = client.quota_classes.get(parsed_args.class_name)
+        quota_classes = quota_class_set_pretty_show(result)
+        return zip(*sorted(quota_classes))
+
+
+class UpdateQuotaClasses(command.ShowOne):
+    _description = "Update the quotas for a quota class (Admin only)."
+
+    def get_parser(self, prog_name):
+        parser = super(UpdateQuotaClasses, self).get_parser(prog_name)
+        parser.add_argument(
+            'class_name',
+            metavar='<class_name>',
+            help='Name of quota class to set the quotas for.')
+        parser.add_argument(
+            '--plans',
+            metavar='<plans>',
+            type=int,
+            default=None,
+            help='New value for the "plans" quota.')
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        class_name = parsed_args.class_name
+        data = {
+            "plans": parsed_args.plans,
+        }
+        result = client.quota_classes.update(class_name, data)
+        quota_classes = quota_class_set_pretty_show(result)
+
+        return zip(*sorted(quota_classes))

karborclient/osc/v1/quotas.py

@@ -0,0 +1,108 @@
+#    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.
+
+"""Data protection V1 quotas action implementations"""
+
+from osc_lib.command import command
+
+
+def quota_set_pretty_show(quotas):
+    """Convert quotas object to dict and display."""
+
+    new_quotas = []
+    for quota_k, quota_v in sorted(quotas.to_dict().items()):
+        if isinstance(quota_v, dict):
+            quota_v = '\n'.join(
+                ['%s = %s' % (k, v) for k, v in sorted(quota_v.items())])
+        new_quotas.append((quota_k, quota_v))
+
+    return new_quotas
+
+
+class ShowQuotas(command.ShowOne):
+    _description = "Shows Quotas"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowQuotas, self).get_parser(prog_name)
+        parser.add_argument(
+            '--tenant',
+            metavar='<tenant>',
+            default=None,
+            help='ID of tenant to list the quotas for.')
+        parser.add_argument(
+            '--detail',
+            action='store_true',
+            help='Optional flag to indicate whether to show quota in detail. '
+                 'Default false.')
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        project_id = parsed_args.tenant or client.http_client.get_project_id()
+        kwargs = {
+            "project_id": project_id,
+            "detail": parsed_args.detail,
+        }
+        result = client.quotas.get(**kwargs)
+        quotas = quota_set_pretty_show(result)
+        return zip(*sorted(quotas))
+
+
+class ShowDefaultQuotas(command.ShowOne):
+    _description = "Shows default Quotas"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowDefaultQuotas, self).get_parser(prog_name)
+        parser.add_argument(
+            '--tenant',
+            metavar='<tenant>',
+            default=None,
+            help='ID of tenant to list the quotas for.')
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        project_id = parsed_args.tenant or client.http_client.get_project_id()
+
+        result = client.quotas.defaults(project_id)
+        quotas = quota_set_pretty_show(result)
+
+        return zip(*sorted(quotas))
+
+
+class UpdateQuotas(command.ShowOne):
+    _description = "Updates Quotas"
+
+    def get_parser(self, prog_name):
+        parser = super(UpdateQuotas, self).get_parser(prog_name)
+        parser.add_argument(
+            'tenant',
+            metavar='<tenant>',
+            help='ID of tenant to set the quotas for.')
+        parser.add_argument(
+            '--plans',
+            metavar='<plans>',
+            type=int,
+            default=None,
+            help='New value for the "plans" quota.')
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        project_id = parsed_args.tenant
+        data = {
+            "plans": parsed_args.plans,
+        }
+        result = client.quotas.update(project_id, data)
+        quotas = quota_set_pretty_show(result)
+
+        return zip(*sorted(quotas))

karborclient/osc/v1/restores.py

@@ -0,0 +1,212 @@
+#    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.
+
+"""Data protection V1 restore action implementations"""
+
+import functools
+import json
+
+from oslo_utils import uuidutils
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+from karborclient import utils
+
+
+def format_restore(restore_info):
+    for key in ('parameters', 'resources_status',
+                'resources_reason'):
+        if key not in restore_info:
+            continue
+        restore_info[key] = json.dumps(restore_info[key],
+                                       indent=2, sort_keys=True)
+    restore_info.pop("links", None)
+
+
+class ListRestores(command.Lister):
+    _description = _("List restores.")
+
+    log = logging.getLogger(__name__ + ".ListRestores")
+
+    def get_parser(self, prog_name):
+        parser = super(ListRestores, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
+        parser.add_argument(
+            '--status',
+            metavar='<status>',
+            help=_('Filter results by status'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<restore>',
+            help=_('The last restore ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-restores>',
+            help=_('Maximum number of restores to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc), "
+                   "multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by a project(admin only)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'status': parsed_args.status,
+        }
+
+        data = data_protection_client.restores.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Project id', 'Provider id', 'Checkpoint id',
+                          'Restore target', 'Parameters', 'Status']
+
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        formatters = {
+            "Parameters": json_dumps,
+        }
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers, formatters=formatters,
+                ) for s in data))
+
+
+class ShowRestore(command.ShowOne):
+    _description = "Shows restore details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowRestore, self).get_parser(prog_name)
+        parser.add_argument(
+            'restore',
+            metavar="<restore>",
+            help=_('The UUID of the restore.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        restore = osc_utils.find_resource(client.restores, parsed_args.restore)
+
+        format_restore(restore._info)
+        return zip(*sorted(restore._info.items()))
+
+
+class CreateRestore(command.ShowOne):
+    _description = "Creates a restore"
+
+    def get_parser(self, prog_name):
+        parser = super(CreateRestore, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('The UUID of the provider.')
+        )
+        parser.add_argument(
+            'checkpoint_id',
+            metavar='<checkpoint_id>',
+            help=_('The UUID of the checkpoint.')
+        )
+        parser.add_argument(
+            '--restore_target',
+            metavar='<restore_target>',
+            help=_('The target of the restore operation.')
+        )
+        parser.add_argument(
+            '--restore_username',
+            metavar='<restore_username>',
+            default=None,
+            help=_('Username to restore target.')
+        )
+        parser.add_argument(
+            '--restore_password',
+            metavar='<restore_password>',
+            default=None,
+            help=_('Password to restore target.')
+        )
+        parser.add_argument(
+            '--parameters-json',
+            type=str,
+            dest='parameters_json',
+            metavar='<parameters>',
+            default=None,
+            help=_('Restore parameters in json format.')
+        )
+        parser.add_argument(
+            '--parameters',
+            action='append',
+            metavar='resource_type=<type>[,resource_id=<id>,key=val,...]',
+            default=[],
+            help=_("Restore parameters, may be specified multiple times. "
+                   "resource_type: type of resource to apply parameters. "
+                   "resource_id: limit the parameters to a specific resource. "
+                   "Other keys and values: according to provider\'s "
+                   "restore schema.")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        if not uuidutils.is_uuid_like(parsed_args.provider_id):
+            raise exceptions.CommandError(
+                "Invalid provider id provided.")
+        if not uuidutils.is_uuid_like(parsed_args.checkpoint_id):
+            raise exceptions.CommandError(
+                "Invalid checkpoint id provided.")
+
+        restore_parameters = utils.extract_parameters(parsed_args)
+        restore_auth = None
+        if parsed_args.restore_target is not None:
+            if parsed_args.restore_username is None:
+                raise exceptions.CommandError(
+                    "Must specify username for restore_target.")
+            if parsed_args.restore_password is None:
+                raise exceptions.CommandError(
+                    "Must specify password for restore_target.")
+            restore_auth = {
+                'type': 'password',
+                'username': parsed_args.restore_username,
+                'password': parsed_args.restore_password,
+            }
+        restore = client.restores.create(parsed_args.provider_id,
+                                         parsed_args.checkpoint_id,
+                                         parsed_args.restore_target,
+                                         restore_parameters, restore_auth)
+        format_restore(restore._info)
+        return zip(*sorted(restore._info.items()))

karborclient/osc/v1/scheduled_operations.py

@@ -0,0 +1,220 @@
+#    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.
+
+"""Data protection V1 scheduled_operations action implementations"""
+
+import functools
+import json
+import six
+
+from oslo_utils import uuidutils
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+
+
+def format_scheduledoperation(scheduledoperation_info):
+    for key in ('operation_definition', ):
+        if key not in scheduledoperation_info:
+            continue
+        scheduledoperation_info[key] = json.dumps(scheduledoperation_info[key],
+                                                  indent=2, sort_keys=True)
+    scheduledoperation_info.pop("links", None)
+
+
+class ListScheduledOperations(command.Lister):
+    _description = _("List scheduled_operations.")
+
+    log = logging.getLogger(__name__ + ".ListScheduledOperations")
+
+    def get_parser(self, prog_name):
+        parser = super(ListScheduledOperations, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Shows details for all tenants. Admin only.'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            help=_('Filters results by a name. Default=None.'),
+        )
+        parser.add_argument(
+            '--operation_type',
+            metavar='<operation_type>',
+            default=None,
+            help=_('Filters results by a type. Default=None.'),
+        )
+        parser.add_argument(
+            '--trigger_id',
+            metavar='<trigger_id>',
+            default=None,
+            help=_('Filters results by a trigger id. Default=None.'),
+        )
+        parser.add_argument(
+            '--operation_definition',
+            metavar='<operation_definition>',
+            default=None,
+            help=_('Filters results by a operation definition. Default=None.'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<scheduled_operations>',
+            help=_('The last scheduled_operations ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-scheduled_operations>',
+            help=_('Maximum number of scheduled_operations to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc) "
+                   "(default: name:asc), multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by a project(admin only)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'name': parsed_args.name,
+            'operation_type': parsed_args.operation_type,
+            'trigger_id': parsed_args.trigger_id,
+            'operation_definition': parsed_args.operation_definition,
+        }
+
+        data = data_protection_client.scheduled_operations.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Name', 'Operation Type', 'Trigger Id',
+                          'Operation Definition']
+
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        formatters = {
+            "Operation Definition": json_dumps,
+        }
+        return (column_headers,
+                list(osc_utils.get_item_properties(
+                    s, column_headers, formatters=formatters,
+                ) for s in data))
+
+
+class ShowScheduledOperation(command.ShowOne):
+    _description = "Shows scheduled_operation details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowScheduledOperation, self).get_parser(prog_name)
+        parser.add_argument(
+            'scheduledoperation',
+            metavar="<scheduledoperation>",
+            help=_('The UUID of the scheduledoperation.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        so = osc_utils.find_resource(client.scheduled_operations,
+                                     parsed_args.scheduledoperation)
+
+        format_scheduledoperation(so._info)
+        return zip(*sorted(six.iteritems(so._info)))
+
+
+class CreateScheduledOperation(command.ShowOne):
+    _description = "Creates a scheduled operation"
+
+    def get_parser(self, prog_name):
+        parser = super(CreateScheduledOperation, self).get_parser(prog_name)
+        parser.add_argument(
+            'name',
+            metavar='<name>',
+            help=_('The name of the scheduled operation.')
+        )
+        parser.add_argument(
+            'operation_type',
+            metavar='<operation_type>',
+            help=_('Operation Type of scheduled operation.')
+        )
+        parser.add_argument(
+            'trigger_id',
+            metavar='<trigger_id>',
+            help=_('Trigger id of scheduled operation.')
+        )
+        parser.add_argument(
+            'operation_definition',
+            metavar='<key=value,key=value>',
+            help=_('Operation definition of scheduled operation.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        if not uuidutils.is_uuid_like(parsed_args.trigger_id):
+            raise exceptions.CommandError(
+                "Invalid trigger id provided.")
+        so = client.scheduled_operations.create(
+            parsed_args.name, parsed_args.operation_type,
+            parsed_args.trigger_id, parsed_args.operation_definition)
+
+        format_scheduledoperation(so._info)
+        return zip(*sorted(six.iteritems(so._info)))
+
+
+class DeleteScheduledOperation(command.Command):
+    _description = "Delete scheduled operation"
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteScheduledOperation, self).get_parser(prog_name)
+        parser.add_argument(
+            'scheduledoperation',
+            metavar='<scheduledoperation>',
+            nargs="+",
+            help=_('ID of scheduled operation.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        failure_count = 0
+        for so_id in parsed_args.scheduledoperation:
+            try:
+                so = osc_utils.find_resource(client.scheduled_operations,
+                                             so_id)
+                client.scheduled_operations.delete(so.id)
+            except exceptions.NotFound:
+                failure_count += 1
+                print("Failed to delete '%s'; scheduled operation "
+                      "not found" % so_id)
+        if failure_count == len(parsed_args.scheduledoperation):
+            raise exceptions.CommandError(
+                "Unable to find and delete any of the "
+                "specified scheduled operation.")

karborclient/osc/v1/services.py

@@ -0,0 +1,99 @@
+#    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.
+
+"""Data protection V1 os-services action implementations"""
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.i18n import _
+
+
+class ListServices(command.Lister):
+    _description = _("List services.")
+
+    log = logging.getLogger(__name__ + ".ListServices")
+
+    def get_parser(self, prog_name):
+        parser = super(ListServices, self).get_parser(prog_name)
+        parser.add_argument(
+            '--host',
+            metavar='<host>',
+            help=_('Filter results by host'),
+        )
+        parser.add_argument(
+            '--binary',
+            metavar='<binary>',
+            help=_('Filter results by binary'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        data = data_protection_client.services.list(
+            host=parsed_args.host,
+            binary=parsed_args.binary
+        )
+
+        column_headers = ["Id", "Binary", "Host", "Status", "State",
+                          "Updated_at", "Disabled Reason"]
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class EnableService(command.ShowOne):
+    _description = _('Enable service')
+
+    def get_parser(self, prog_name):
+        parser = super(EnableService, self).get_parser(prog_name)
+        parser.add_argument(
+            'service_id',
+            metavar='<service_id>',
+            help=_('The ID of the service.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        service = client.services.enable(parsed_args.service_id)
+        return zip(*sorted(service._info.items()))
+
+
+class DisableService(command.ShowOne):
+    _description = _('Disable service')
+
+    def get_parser(self, prog_name):
+        parser = super(DisableService, self).get_parser(prog_name)
+        parser.add_argument(
+            'service_id',
+            metavar='<service_id>',
+            help=_('The ID of the service.'),
+        )
+        parser.add_argument(
+            '--reason',
+            metavar='<reason>',
+            help=_('Reason for disabling the service.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        if parsed_args.reason:
+            service = client.services.disable_log_reason(
+                parsed_args.service_id, parsed_args.reason)
+        else:
+            service = client.services.disable(parsed_args.service_id)
+        return zip(*sorted(service._info.items()))

karborclient/osc/v1/triggers.py

@@ -0,0 +1,229 @@
+#    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.
+
+"""Data protection V1 triggers action implementations"""
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+from karborclient import utils
+
+
+class ListTriggers(command.Lister):
+    _description = _("List triggers.")
+
+    log = logging.getLogger(__name__ + ".ListTriggers")
+
+    def get_parser(self, prog_name):
+        parser = super(ListTriggers, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Shows details for all tenants. Admin only.'),
+        )
+        parser.add_argument(
+            '--name',
+            metavar='<name>',
+            default=None,
+            help=_('Filters results by a name. Default=None.'),
+        )
+        parser.add_argument(
+            '--type',
+            metavar='<type>',
+            default=None,
+            help=_('Filters results by a type. Default=None.'),
+        )
+        parser.add_argument(
+            '--properties',
+            metavar='<properties>',
+            default=None,
+            help=_('Filters results by a properties. Default=None.'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<trigger>',
+            help=_('The last trigger ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-triggers>',
+            help=_('Maximum number of triggers to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc) "
+                   "(default: name:asc), multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Display information from single tenant (Admin only).')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'name': parsed_args.name,
+            'type': parsed_args.type,
+            'properties': parsed_args.properties,
+        }
+
+        data = data_protection_client.triggers.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Name', 'Type', 'Properties']
+
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers
+                ) for s in data))
+
+
+class ShowTrigger(command.ShowOne):
+    _description = "Shows trigger details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowTrigger, self).get_parser(prog_name)
+        parser.add_argument(
+            'trigger',
+            metavar="<trigger>",
+            help=_('The UUID of the trigger.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        trigger = osc_utils.find_resource(client.triggers, parsed_args.trigger)
+
+        trigger._info.pop("links", None)
+        return zip(*sorted(trigger._info.items()))
+
+
+class CreateTrigger(command.ShowOne):
+    _description = "Creates a trigger"
+
+    def get_parser(self, prog_name):
+        parser = super(CreateTrigger, self).get_parser(prog_name)
+        parser.add_argument(
+            'name',
+            metavar='<name>',
+            help=_('The name of the trigger.')
+        )
+        parser.add_argument(
+            'type',
+            metavar='<type>',
+            help=_('Type of trigger.')
+        )
+        parser.add_argument(
+            'properties',
+            metavar='<key=value,key=value>',
+            help=_('Properties of trigger.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        trigger = client.triggers.create(parsed_args.name, parsed_args.type,
+                                         parsed_args.properties)
+
+        trigger._info.pop("links", None)
+        return zip(*sorted(trigger._info.items()))
+
+
+class UpdateTrigger(command.ShowOne):
+    _description = "Update a trigger"
+
+    def get_parser(self, prog_name):
+        parser = super(UpdateTrigger, self).get_parser(prog_name)
+        parser.add_argument(
+            "trigger_id",
+            metavar="<TRIGGER ID>",
+            help=_("Id of trigger to update.")
+        )
+        parser.add_argument(
+            "--name",
+            metavar="<name>",
+            help=_("A name to which the trigger will be renamed.")
+        )
+        parser.add_argument(
+            "--properties",
+            metavar="<key=value,key=value>",
+            help=_("Properties of trigger which will be updated.")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        data = {}
+        if parsed_args.name is not None:
+            data['name'] = parsed_args.name
+        if parsed_args.properties is not None:
+            trigger_properties = utils.extract_properties(parsed_args)
+            data['properties'] = trigger_properties
+        try:
+            trigger = osc_utils.find_resource(client.triggers,
+                                              parsed_args.trigger_id)
+            trigger = client.triggers.update(trigger.id, data)
+        except exceptions.NotFound:
+            raise exceptions.CommandError(
+                "Trigger %s not found" % parsed_args.trigger_id)
+        else:
+            trigger._info.pop("links", None)
+            return zip(*sorted(trigger._info.items()))
+
+
+class DeleteTrigger(command.Command):
+    _description = "Delete trigger"
+
+    log = logging.getLogger(__name__ + ".DeleteTrigger")
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteTrigger, self).get_parser(prog_name)
+        parser.add_argument(
+            'trigger',
+            metavar='<trigger>',
+            nargs="+",
+            help=_('ID of trigger.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        failure_count = 0
+        for trigger_id in parsed_args.trigger:
+            try:
+                trigger = osc_utils.find_resource(client.triggers, trigger_id)
+                client.triggers.delete(trigger.id)
+            except exceptions.NotFound:
+                failure_count += 1
+                self.log.error(
+                    "Failed to delete '{0}'; trigger not found".
+                    format(trigger_id))
+        if failure_count == len(parsed_args.trigger):
+            raise exceptions.CommandError(
+                "Unable to find and delete any of the "
+                "specified trigger.")

karborclient/osc/v1/verifications.py

@@ -0,0 +1,182 @@
+#    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.
+
+"""Data protection V1 verification action implementations"""
+
+import functools
+import json
+
+from oslo_utils import uuidutils
+
+from osc_lib.command import command
+from osc_lib import utils as osc_utils
+from oslo_log import log as logging
+
+from karborclient.common.apiclient import exceptions
+from karborclient.i18n import _
+from karborclient import utils
+
+
+def format_verification(verification_info):
+    for key in ('parameters', 'resources_status',
+                'resources_reason'):
+        if key not in verification_info:
+            continue
+        verification_info[key] = json.dumps(verification_info[key],
+                                            indent=2, sort_keys=True)
+    verification_info.pop("links", None)
+
+
+class ListVerifications(command.Lister):
+    _description = _("List verifications.")
+
+    log = logging.getLogger(__name__ + ".ListVerifications")
+
+    def get_parser(self, prog_name):
+        parser = super(ListVerifications, self).get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
+        parser.add_argument(
+            '--status',
+            metavar='<status>',
+            help=_('Filter results by status'),
+        )
+        parser.add_argument(
+            '--marker',
+            metavar='<verification>',
+            help=_('The last verification ID of the previous page'),
+        )
+        parser.add_argument(
+            '--limit',
+            type=int,
+            metavar='<num-verifications>',
+            help=_('Maximum number of verifications to display'),
+        )
+        parser.add_argument(
+            '--sort',
+            metavar="<key>[:<direction>]",
+            default=None,
+            help=_("Sort output by selected keys and directions(asc or desc), "
+                   "multiple keys and directions can be "
+                   "specified separated by comma"),
+        )
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by a project(admin only)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        self.log.debug("take_action(%s)", parsed_args)
+        data_protection_client = self.app.client_manager.data_protection
+        all_projects = bool(parsed_args.project) or parsed_args.all_projects
+
+        search_opts = {
+            'all_tenants': all_projects,
+            'project_id': parsed_args.project,
+            'status': parsed_args.status,
+        }
+
+        data = data_protection_client.verifications.list(
+            search_opts=search_opts, marker=parsed_args.marker,
+            limit=parsed_args.limit, sort=parsed_args.sort)
+
+        column_headers = ['Id', 'Project id', 'Provider id', 'Checkpoint id',
+                          'Parameters', 'Status']
+
+        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        formatters = {
+            "Parameters": json_dumps,
+        }
+        return (column_headers,
+                (osc_utils.get_item_properties(
+                    s, column_headers, formatters=formatters,
+                ) for s in data))
+
+
+class ShowVerification(command.ShowOne):
+    _description = "Shows verification details"
+
+    def get_parser(self, prog_name):
+        parser = super(ShowVerification, self).get_parser(prog_name)
+        parser.add_argument(
+            'verification',
+            metavar="<verification>",
+            help=_('The UUID of the verification.')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        verification = osc_utils.find_resource(client.verifications,
+                                               parsed_args.verification)
+
+        format_verification(verification._info)
+        return zip(*sorted(verification._info.items()))
+
+
+class CreateVerification(command.ShowOne):
+    _description = "Creates a verification"
+
+    def get_parser(self, prog_name):
+        parser = super(CreateVerification, self).get_parser(prog_name)
+        parser.add_argument(
+            'provider_id',
+            metavar='<provider_id>',
+            help=_('The UUID of the provider.')
+        )
+        parser.add_argument(
+            'checkpoint_id',
+            metavar='<checkpoint_id>',
+            help=_('The UUID of the checkpoint.')
+        )
+        parser.add_argument(
+            '--parameters-json',
+            type=str,
+            dest='parameters_json',
+            metavar='<parameters>',
+            default=None,
+            help=_('Verification parameters in json format.')
+        )
+        parser.add_argument(
+            '--parameters',
+            action='append',
+            metavar='resource_type=<type>[,resource_id=<id>,key=val,...]',
+            default=[],
+            help=_("Verification parameters, may be specified multiple times. "
+                   "resource_type: type of resource to apply parameters. "
+                   "resource_id: limit the parameters to a specific resource. "
+                   "Other keys and values: according to provider\'s "
+                   "verification schema.")
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.data_protection
+        if not uuidutils.is_uuid_like(parsed_args.provider_id):
+            raise exceptions.CommandError(
+                "Invalid provider id provided.")
+        if not uuidutils.is_uuid_like(parsed_args.checkpoint_id):
+            raise exceptions.CommandError(
+                "Invalid checkpoint id provided.")
+
+        verification_parameters = utils.extract_parameters(parsed_args)
+        verification = client.verifications.create(parsed_args.provider_id,
+                                                   parsed_args.checkpoint_id,
+                                                   verification_parameters)
+        format_verification(verification._info)
+        return zip(*sorted(verification._info.items()))

karborclient/shell.py

@@ -17,17 +17,19 @@ Command-line interface to the karbor Project.
 from __future__ import print_function
 
 import argparse
+import copy
 import sys
 
-from keystoneclient.auth.identity.generic import password
-from keystoneclient.auth.identity.generic import token
-from keystoneclient.auth.identity import v3 as identity
-from keystoneclient import discover
-from keystoneclient import exceptions as ks_exc
-from keystoneclient import session as ksession
+from keystoneauth1 import discover
+from keystoneauth1 import exceptions as ks_exc
+from keystoneauth1.identity.generic import password
+from keystoneauth1.identity.generic import token
+from keystoneauth1 import loading
 from oslo_log import handlers
 from oslo_log import log as logging
 from oslo_utils import encodeutils
+from oslo_utils import importutils
+
 import six
 import six.moves.urllib.parse as urlparse
 
@@ -42,13 +44,20 @@ logger = logging.getLogger(__name__)
 
 class KarborShell(object):
 
-    def _append_global_identity_args(self, parser):
-        # Register the CLI arguments that have moved to the session object.
-        ksession.Session.register_cli_options(parser)
+    def _append_global_identity_args(self, parser, argv):
+        loading.register_session_argparse_arguments(parser)
+        # Peek into argv to see if os-auth-token (or the deprecated
+        # os_auth_token) or the new os-token or the environment variable
+        # OS_AUTH_TOKEN were given. In which case, the token auth plugin is
+        # what the user wants. Else, we'll default to password.
+        default_auth_plugin = 'password'
+        token_opts = ['os-token', 'os-auth-token', 'os_auth-token']
+        if argv and any(i in token_opts for i in argv):
+            default_auth_plugin = 'token'
+        loading.register_auth_argparse_arguments(
+            parser, argv, default=default_auth_plugin)
 
-        identity.Password.register_argparse_arguments(parser)
-
-    def get_base_parser(self):
+    def get_base_parser(self, argv):
 
         parser = argparse.ArgumentParser(
             prog='karbor',
@@ -97,11 +106,11 @@ class KarborShell(object):
                                  'API response, '
                                  'defaults to system socket timeout.')
 
-        parser.add_argument('--os-tenant-id',
+        parser.add_argument('--os_tenant_id',
                             default=utils.env('OS_TENANT_ID'),
                             help='Defaults to env[OS_TENANT_ID].')
 
-        parser.add_argument('--os-tenant-name',
+        parser.add_argument('--os_tenant_name',
                             default=utils.env('OS_TENANT_NAME'),
                             help='Defaults to env[OS_TENANT_NAME].')
 
@@ -141,32 +150,23 @@ class KarborShell(object):
                             action='store_true',
                             help='Send os-username and os-password to karbor.')
 
-        self._append_global_identity_args(parser)
+        self._append_global_identity_args(parser, argv)
 
         return parser
 
-    def get_subcommand_parser(self, version):
-        parser = self.get_base_parser()
+    def get_subcommand_parser(self, version, argv=None):
+        parser = self.get_base_parser(argv)
 
         self.subcommands = {}
         subparsers = parser.add_subparsers(metavar='<subcommand>')
-        submodule = utils.import_versioned_module(version, 'shell')
+        submodule = importutils.import_versioned_module(
+            'karborclient', version, 'shell'
+        )
         self._find_actions(subparsers, submodule)
         self._find_actions(subparsers, self)
 
-        self._add_bash_completion_subparser(subparsers)
-
         return parser
 
-    def _add_bash_completion_subparser(self, subparsers):
-        subparser = subparsers.add_parser(
-            'bash_completion',
-            add_help=False,
-            formatter_class=HelpFormatter
-        )
-        self.subcommands['bash_completion'] = subparser
-        subparser.set_defaults(func=self.do_bash_completion)
-
     def _find_actions(self, subparsers, actions_module):
         for attr in (a for a in dir(actions_module) if a.startswith('do_')):
             # I prefer to be hypen-separated instead of underscores.
@@ -193,7 +193,7 @@ class KarborShell(object):
         v2_auth_url = None
         v3_auth_url = None
         try:
-            ks_discover = discover.Discover(session=session, auth_url=auth_url)
+            ks_discover = discover.Discover(session=session, url=auth_url)
             v2_auth_url = ks_discover.url_for('2.0')
             v3_auth_url = ks_discover.url_for('3.0')
         except ks_exc.ClientException as e:
@@ -285,16 +285,17 @@ class KarborShell(object):
 
     def main(self, argv):
         # Parse args once to find version
-        parser = self.get_base_parser()
-        (options, args) = parser.parse_known_args(argv)
+        base_argv = copy.deepcopy(argv)
+        parser = self.get_base_parser(argv)
+        (options, args) = parser.parse_known_args(base_argv)
         self._setup_logging(options.debug)
 
         # build available subcommands based on version
         api_version = options.karbor_api_version
-        subcommand_parser = self.get_subcommand_parser(api_version)
+        subcommand_parser = self.get_subcommand_parser(api_version, argv)
         self.parser = subcommand_parser
 
-        keystone_session = None
+        ks_session = None
         keystone_auth = None
 
         # Handle top-level --help/-h before attempting to parse
@@ -362,12 +363,12 @@ class KarborShell(object):
                 kwargs['region_name'] = args.os_region_name
         else:
             # Create a keystone session and keystone auth
-            keystone_session = ksession.Session.load_from_cli_options(args)
+            ks_session = loading.load_session_from_argparse_arguments(args)
             project_id = args.os_project_id or args.os_tenant_id
             project_name = args.os_project_name or args.os_tenant_name
 
             keystone_auth = self._get_keystone_auth(
-                keystone_session,
+                ks_session,
                 args.os_auth_url,
                 username=args.os_username,
                 user_id=args.os_user_id,
@@ -384,12 +385,12 @@ class KarborShell(object):
             service_type = args.os_service_type or 'data-protect'
 
             endpoint = keystone_auth.get_endpoint(
-                keystone_session,
+                ks_session,
                 service_type=service_type,
                 region_name=args.os_region_name)
 
             kwargs = {
-                'session': keystone_session,
+                'session': ks_session,
                 'auth': keystone_auth,
                 'service_type': service_type,
                 'endpoint_type': endpoint_type,
@@ -413,7 +414,6 @@ class KarborShell(object):
                 options.add(option)
 
         commands.remove('bash-completion')
-        commands.remove('bash_completion')
         print(' '.join(commands | options))
 
     @utils.arg('command', metavar='<subcommand>', nargs='?',

karborclient/tests/unit/base.py

@@ -44,11 +44,11 @@ class TestResponse(requests.Response):
         self._text = None
         super(TestResponse, self)
         if isinstance(data, dict):
-            self.status_code = data.get('status_code', None)
-            self.headers = data.get('headers', None)
+            self.status_code = data.get('status_code')
+            self.headers = data.get('headers')
             self.reason = data.get('reason', '')
             # Fake the text attribute to streamline Response creation
-            self._text = data.get('text', None)
+            self._text = data.get('text')
         else:
             self.status_code = data
 

karborclient/tests/unit/osc/v1/__init__.py

@@ -0,0 +1 @@
+__author__ = 'c00179918'

karborclient/tests/unit/osc/v1/fakes.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2015 Mirantis 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 mock
+from osc_lib.tests import utils
+
+
+class TestDataProtection(utils.TestCommand):
+
+    def setUp(self):
+        super(TestDataProtection, self).setUp()
+
+        self.app.client_manager.data_protection = mock.Mock()
+        self.app.client_manager.network = mock.Mock()
+        self.app.client_manager.compute = mock.Mock()
+        self.app.client_manager.volume = mock.Mock()

karborclient/tests/unit/osc/v1/test_checkpoints.py

@@ -0,0 +1,160 @@
+# 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 copy
+import json
+
+from karborclient.osc.v1 import checkpoints as osc_checkpoints
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import checkpoints
+
+
+CHECKPOINT_INFO = {
+    "id": "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+    "project_id": "e486a2f49695423ca9c47e589b948108",
+    "status": "available",
+    "protection_plan": {
+        "id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb",
+        "name": "My application",
+        "provider_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+        "resources": [{
+            "id": "99777fdd-8a5b-45ab-ba2c-52420008103f",
+            "type": "OS::Glance::Image",
+            "name": "cirros-0.3.4-x86_64-uec"}]
+    },
+    "resource_graph": json.dumps(
+        "[{'0x0': ['OS::Glance::Image', "
+        "'99777fdd-8a5b-45ab-ba2c-52420008103f', "
+        "'cirros-0.3.4-x86_64-uec']}, [[['0x0']]]]"
+    ),
+}
+
+
+class TestCheckpoints(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestCheckpoints, self).setUp()
+        cm = self.app.client_manager
+        self.checkpoints_mock = cm.data_protection.checkpoints
+        self.checkpoints_mock.reset_mock()
+
+
+class TestListCheckpoints(TestCheckpoints):
+    def setUp(self):
+        super(TestListCheckpoints, self).setUp()
+        self.checkpoints_mock.list.return_value = [checkpoints.Checkpoint(
+            None, copy.deepcopy(CHECKPOINT_INFO))]
+
+        # Command to test
+        self.cmd = osc_checkpoints.ListCheckpoints(self.app, None)
+
+    def test_checkpoints_list(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Project id', 'Status', 'Protection plan', 'Metadata',
+             'Created at'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [(
+            "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+            "e486a2f49695423ca9c47e589b948108",
+            "available",
+            "Name: %(name)s\nId: %(id)s" % {
+                "id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb",
+                "name": "My application",
+            },
+            '',
+            '')]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestCreateCheckpoint(TestCheckpoints):
+    def setUp(self):
+        super(TestCreateCheckpoint, self).setUp()
+        self.checkpoints_mock.create.return_value = checkpoints.Checkpoint(
+            None, copy.deepcopy(CHECKPOINT_INFO))
+        # Command to test
+        self.cmd = osc_checkpoints.CreateCheckpoint(self.app, None)
+
+    def test_checkpoint_create(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   '3523a271-68aa-42f5-b9ba-56e5200a2ebb']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('plan_id', '3523a271-68aa-42f5-b9ba-56e5200a2ebb')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.checkpoints_mock.create.assert_called_once_with(
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            '3523a271-68aa-42f5-b9ba-56e5200a2ebb',
+            None)
+
+
+class TestShowCheckpoint(TestCheckpoints):
+    def setUp(self):
+        super(TestShowCheckpoint, self).setUp()
+        self.checkpoints_mock.get.return_value = checkpoints.Checkpoint(
+            None, copy.deepcopy(CHECKPOINT_INFO))
+        # Command to test
+        self.cmd = osc_checkpoints.ShowCheckpoint(self.app, None)
+
+    def test_checkpoint_show(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   'dcb20606-ad71-40a3-80e4-ef0fafdad0c3']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('checkpoint_id',
+                       'dcb20606-ad71-40a3-80e4-ef0fafdad0c3')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.checkpoints_mock.get.assert_called_once_with(
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            'dcb20606-ad71-40a3-80e4-ef0fafdad0c3')
+
+
+class TestDeleteCheckpoint(TestCheckpoints):
+    def setUp(self):
+        super(TestDeleteCheckpoint, self).setUp()
+        self.checkpoints_mock.get.return_value = checkpoints.Checkpoint(
+            None, copy.deepcopy(CHECKPOINT_INFO))
+        # Command to test
+        self.cmd = osc_checkpoints.DeleteCheckpoint(self.app, None)
+
+    def test_checkpoint_delete(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   'dcb20606-ad71-40a3-80e4-ef0fafdad0c3']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('checkpoint',
+                       ['dcb20606-ad71-40a3-80e4-ef0fafdad0c3'])]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.checkpoints_mock.delete.assert_called_once_with(
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            'dcb20606-ad71-40a3-80e4-ef0fafdad0c3')

karborclient/tests/unit/osc/v1/test_operation_logs.py

@@ -0,0 +1,128 @@
+# 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 copy
+
+from karborclient.osc.v1 import operation_logs as osc_operation_logs
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import operation_logs
+
+
+OPERATIONLOG_INFO = {
+    "id": "22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+    "project_id": "e486a2f49695423ca9c47e589b948108",
+    "operation_type": "protect",
+    "checkpoint_id": "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+    "plan_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+    "provider_id": "23902b02-5666-4ee6-8dfe-962ac09c3994",
+    "restore_id": None,
+    "scheduled_operation_id": "23902b02-5666-4ee6-8dfe-962ac09c3991",
+    "started_at": "2015-08-27T09:50:58-05:00",
+    "ended_at": "2015-08-27T10:50:58-05:00",
+    "status": "protecting",
+    "error_info": "Could not access bank",
+    "extra_info": None
+}
+
+
+class TestOperationLogs(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestOperationLogs, self).setUp()
+        self.operation_logs_mock = (
+            self.app.client_manager.data_protection.operation_logs)
+        self.operation_logs_mock.reset_mock()
+
+
+class TestListOperationLogs(TestOperationLogs):
+    def setUp(self):
+        super(TestListOperationLogs, self).setUp()
+        self.operation_logs_mock.list.return_value = [
+            operation_logs.OperationLog(None,
+                                        copy.deepcopy(OPERATIONLOG_INFO))]
+
+        # Command to test
+        self.cmd = osc_operation_logs.ListOperationLogs(self.app, None)
+
+    def test_operation_logs_list(self):
+        arglist = ['--status', 'success']
+        verifylist = [('status', 'success')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Operation Type', 'Checkpoint id', 'Plan Id',
+             'Provider id', 'Restore Id', 'Scheduled Operation Id',
+             'Status', 'Started At', 'Ended At', 'Error Info',
+             'Extra Info'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+                          "protect",
+                          "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+                          "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+                          "23902b02-5666-4ee6-8dfe-962ac09c3994",
+                          None,
+                          "23902b02-5666-4ee6-8dfe-962ac09c3991",
+                          "protecting",
+                          "2015-08-27T09:50:58-05:00",
+                          "2015-08-27T10:50:58-05:00",
+                          "Could not access bank",
+                          None)]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestShowOperationLog(TestOperationLogs):
+    def setUp(self):
+        super(TestShowOperationLog, self).setUp()
+        self._oplog_info = copy.deepcopy(OPERATIONLOG_INFO)
+        self.operation_logs_mock.get.return_value = (
+            operation_logs.OperationLog(None, self._oplog_info))
+
+        # Command to test
+        self.cmd = osc_operation_logs.ShowOperationLog(self.app, None)
+
+    def test_operation_log_show(self):
+        arglist = ['22b82aa7-9179-4c71-bba2-caf5c0e68db7']
+        verifylist = [('operation_log',
+                       '22b82aa7-9179-4c71-bba2-caf5c0e68db7')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'checkpoint_id', 'ended_at', 'error_info', 'extra_info',
+            'id', 'operation_type', 'plan_id', 'project_id',
+            'provider_id', 'restore_id', 'scheduled_operation_id',
+            'started_at', 'status')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._oplog_info['checkpoint_id'], data[0])
+        self.assertEqual(self._oplog_info['ended_at'], data[1])
+        self.assertEqual(self._oplog_info['error_info'], data[2])
+        self.assertEqual(self._oplog_info['extra_info'], data[3])
+        self.assertEqual(self._oplog_info['id'], data[4])
+        self.assertEqual(self._oplog_info['operation_type'], data[5])
+        self.assertEqual(self._oplog_info['plan_id'], data[6])
+        self.assertEqual(self._oplog_info['project_id'], data[7])
+        self.assertEqual(self._oplog_info['provider_id'], data[8])
+        self.assertEqual(self._oplog_info['restore_id'], data[9])
+        self.assertEqual(self._oplog_info['scheduled_operation_id'], data[10])
+        self.assertEqual(self._oplog_info['started_at'], data[11])
+        self.assertEqual(self._oplog_info['status'], data[12])

karborclient/tests/unit/osc/v1/test_plans.py

@@ -0,0 +1,183 @@
+# 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 copy
+
+from karborclient.osc.v1 import plans as osc_plans
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import plans
+
+
+PLAN_INFO = {
+    "status": "suspended",
+    "provider_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+    "description": "",
+    "parameters": {},
+    "id": "204c825e-eb2f-4609-95ab-70b3caa43ac8",
+    "resources": [{
+        'type': 'OS::Cinder::Volume',
+        'id': '71bfe64a-e0b9-4a91-9e15-a7fc9ab31b14',
+        'name': 'testsinglevolume'}],
+    "name": "OS Volume protection plan."
+}
+
+
+class TestPlans(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestPlans, self).setUp()
+        self.plans_mock = self.app.client_manager.data_protection.plans
+        self.plans_mock.reset_mock()
+
+
+class TestListPlans(TestPlans):
+    def setUp(self):
+        super(TestListPlans, self).setUp()
+        self.plans_mock.list.return_value = [plans.Plan(
+            None, copy.deepcopy(PLAN_INFO))]
+
+        # Command to test
+        self.cmd = osc_plans.ListPlans(self.app, None)
+
+    def test_plans_list(self):
+        arglist = ['--status', 'suspended']
+        verifylist = [('status', 'suspended')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Name', 'Description', 'Provider id', 'Status'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("204c825e-eb2f-4609-95ab-70b3caa43ac8",
+                          "OS Volume protection plan.",
+                          "",
+                          "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+                          "suspended")]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestCreatePlan(TestPlans):
+    def setUp(self):
+        super(TestCreatePlan, self).setUp()
+        self.plans_mock.create.return_value = plans.Plan(
+            None, copy.deepcopy(PLAN_INFO))
+        # Command to test
+        self.cmd = osc_plans.CreatePlan(self.app, None)
+
+    def test_plan_create(self):
+        arglist = ['OS Volume protection plan.',
+                   'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   "'71bfe64a-e0b9-4a91-9e15-a7fc9ab31b14'="
+                   "'OS::Cinder::Volume'='testsinglevolume'"]
+        verifylist = [('name', 'OS Volume protection plan.'),
+                      ('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('resources', "'71bfe64a-e0b9-4a91-9e15-a7fc9ab31b14'="
+                                    "'OS::Cinder::Volume'='testsinglevolume'")]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.plans_mock.create.assert_called_once_with(
+            'OS Volume protection plan.',
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            [{'id': "'71bfe64a-e0b9-4a91-9e15-a7fc9ab31b14'",
+              'type': "'OS::Cinder::Volume'",
+              'name': "'testsinglevolume'"}],
+            {}, description=None)
+
+
+class TestUpdatePlan(TestPlans):
+    def setUp(self):
+        super(TestUpdatePlan, self).setUp()
+        self.plans_mock.get.return_value = plans.Plan(
+            None, copy.deepcopy(PLAN_INFO))
+        self.plans_mock.update.return_value = plans.Plan(
+            None, copy.deepcopy(PLAN_INFO))
+        # Command to test
+        self.cmd = osc_plans.UpdatePlan(self.app, None)
+
+    def test_plan_update(self):
+        arglist = ['204c825e-eb2f-4609-95ab-70b3caa43ac8',
+                   '--status', 'started']
+        verifylist = [('plan_id', '204c825e-eb2f-4609-95ab-70b3caa43ac8'),
+                      ('status', 'started')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.plans_mock.update.assert_called_once_with(
+            '204c825e-eb2f-4609-95ab-70b3caa43ac8',
+            {'status': 'started'})
+
+
+class TestDeletePlan(TestPlans):
+    def setUp(self):
+        super(TestDeletePlan, self).setUp()
+        self.plans_mock.get.return_value = plans.Plan(
+            None, copy.deepcopy(PLAN_INFO))
+        # Command to test
+        self.cmd = osc_plans.DeletePlan(self.app, None)
+
+    def test_plan_delete(self):
+        arglist = ['204c825e-eb2f-4609-95ab-70b3caa43ac8']
+        verifylist = [('plan', ['204c825e-eb2f-4609-95ab-70b3caa43ac8'])]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.plans_mock.delete.assert_called_once_with(
+            '204c825e-eb2f-4609-95ab-70b3caa43ac8')
+
+
+class TestShowPlan(TestPlans):
+    def setUp(self):
+        super(TestShowPlan, self).setUp()
+        self._plan_info = copy.deepcopy(PLAN_INFO)
+        self.plans_mock.get.return_value = plans.Plan(
+            None, self._plan_info)
+
+        # Command to test
+        self.cmd = osc_plans.ShowPlan(self.app, None)
+
+    def test_plan_show(self):
+        arglist = ['204c825e-eb2f-4609-95ab-70b3caa43ac8']
+        verifylist = [('plan', '204c825e-eb2f-4609-95ab-70b3caa43ac8')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'description', 'id', 'name', 'parameters', 'provider_id',
+            'resources', 'status')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._plan_info['description'], data[0])
+        self.assertEqual(self._plan_info['id'], data[1])
+        self.assertEqual(self._plan_info['name'], data[2])
+        self.assertEqual(self._plan_info['parameters'], data[3])
+        self.assertEqual(self._plan_info['provider_id'], data[4])
+        self.assertEqual(self._plan_info['resources'], data[5])
+        self.assertEqual(self._plan_info['status'], data[6])

karborclient/tests/unit/osc/v1/test_protectables.py

@@ -0,0 +1,163 @@
+# 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 copy
+
+from karborclient.osc.v1 import protectables as osc_protectables
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import protectables
+
+
+PROTECTABLE_LIST_INFO = {
+    "protectable_type": [
+        "OS::Keystone::Project",
+        "OS::Cinder::Volume",
+        "OS::Glance::Image",
+        "OS::Nova::Server"
+    ]
+}
+
+PROTECTABLE_SHOW_INFO = {
+    "name": "OS::Nova::Server",
+    "dependent_types": [
+        "OS::Cinder::Volume",
+        "OS::Glance::Image"
+    ]
+}
+
+PROTECTABLE_INSTANCE_LIST_INFO = {
+    "id": "25336116-f38e-4c22-81ad-e9b7bd71ba51",
+    "type": "OS::Cinder::Volume",
+    "name": "System volume",
+    "extra_info": {
+        "availability_zone": "az1"
+    }
+}
+
+PROTECTABLE_INSTANCE_SHOW_INFO = {
+    "id": "cb4ef2ff-10f5-46c9-bce4-cf7a49c65a01",
+    "type": "OS::Nova::Server",
+    "name": "My VM",
+    "dependent_resources": [{
+        "id": "99777fdd-8a5b-45ab-ba2c-52420008103f",
+        "type": "OS::Glance::Image",
+        "name": "cirros-0.3.4-x86_64-uec"}]
+}
+
+
+class TestProtectables(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestProtectables, self).setUp()
+        cm = self.app.client_manager
+        self.protectables_mock = cm.data_protection.protectables
+        self.protectables_mock.reset_mock()
+
+
+class TestListProtectables(TestProtectables):
+    def setUp(self):
+        super(TestListProtectables, self).setUp()
+        self.protectables_mock.list.return_value = [protectables.Protectable(
+            None, copy.deepcopy(PROTECTABLE_LIST_INFO))]
+
+        # Command to test
+        self.cmd = osc_protectables.ListProtectables(self.app, None)
+
+    def test_protectables_list(self):
+        arglist = []
+        verifylist = []
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Protectable type'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [(['OS::Keystone::Project',
+                           'OS::Cinder::Volume',
+                           'OS::Glance::Image',
+                           'OS::Nova::Server'],)]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestShowProtectable(TestProtectables):
+    def setUp(self):
+        super(TestShowProtectable, self).setUp()
+        self.protectables_mock.get.return_value = protectables.Protectable(
+            None, copy.deepcopy(PROTECTABLE_SHOW_INFO))
+        # Command to test
+        self.cmd = osc_protectables.ShowProtectable(self.app, None)
+
+    def test_protectable_show(self):
+        arglist = ['OS::Nova::Server']
+        verifylist = [('protectable_type', 'OS::Nova::Server')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.protectables_mock.get.assert_called_once_with(
+            'OS::Nova::Server')
+
+
+class TestListProtectableInstances(TestProtectables):
+    def setUp(self):
+        super(TestListProtectableInstances, self).setUp()
+        pm = self.protectables_mock
+        pm.list_instances.return_value = [protectables.Instances(
+            None, copy.deepcopy(PROTECTABLE_INSTANCE_LIST_INFO)), ]
+        # Command to test
+        self.cmd = osc_protectables.ListProtectableInstances(self.app, None)
+
+    def test_protectable_instances_list(self):
+        arglist = ['OS::Cinder::Volume']
+        verifylist = [('protectable_type', 'OS::Cinder::Volume')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.protectables_mock.list_instances.assert_called_once_with(
+            'OS::Cinder::Volume', limit=None, marker=None,
+            search_opts={'type': None, 'parameters': None},
+            sort=None)
+
+
+class TestShowProtectableInstance(TestProtectables):
+    def setUp(self):
+        super(TestShowProtectableInstance, self).setUp()
+        pm = self.protectables_mock
+        pm.get_instance.return_value = protectables.Instances(
+            None, copy.deepcopy(PROTECTABLE_INSTANCE_SHOW_INFO))
+        # Command to test
+        self.cmd = osc_protectables.ShowProtectableInstance(self.app, None)
+
+    def test_protectable_instance_show(self):
+        arglist = ['OS::Nova::Server', 'cb4ef2ff-10f5-46c9-bce4-cf7a49c65a01']
+        verifylist = [('protectable_type', 'OS::Nova::Server'),
+                      ('protectable_id',
+                       'cb4ef2ff-10f5-46c9-bce4-cf7a49c65a01')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.protectables_mock.get_instance.assert_called_once_with(
+            'OS::Nova::Server', 'cb4ef2ff-10f5-46c9-bce4-cf7a49c65a01',
+            search_opts={'parameters': None})

karborclient/tests/unit/osc/v1/test_providers.py

@@ -0,0 +1,144 @@
+# 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 copy
+
+from karborclient.osc.v1 import providers as osc_providers
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import providers
+
+
+PROVIDER_INFO = {
+    "id": "2220f8b1-975d-4621-a872-fa9afb43cb6c",
+    "name": "OS Infra Provider",
+    "description": "provider description",
+    "extended_info_schema": {
+        "options_schema": {
+            "OS::Cinder::Volume": {
+                "required": [
+                    "backup_mode"
+                ],
+                "type": "object",
+                "properties": {
+                    "backup_mode": {
+                        "default": "auto",
+                        "enum": [
+                            "full",
+                            "incremental",
+                            "auto"
+                        ],
+                        "type": "string",
+                        "description": "The backup mode.",
+                        "title": "Backup Mode"
+                    }
+                },
+                "title": "Cinder Protection Options"
+            }
+        },
+        "saved_info_schema": {
+            "OS::Cinder::Volume": {
+                "required": [
+                    "name"
+                ],
+                "type": "object",
+                "properties": {
+                    "name": {
+                        "type": "string",
+                        "description": "The name for this backup.",
+                        "title": "Name"
+                    }
+                },
+                "title": "Cinder Protection Saved Info"
+            }
+        },
+        "restore_schema": {
+            "OS::Cinder::Volume": {
+                "type": "object",
+                "properties": {
+                    "restore_name": {
+                        "type": "string",
+                        "description": "The name of the restored volume.",
+                        "title": "Restore Name"
+                    }
+                },
+                "title": "Cinder Protection Restore"
+            }
+        }
+    }
+}
+
+
+class TestProviders(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestProviders, self).setUp()
+        self.providers_mock = self.app.client_manager.data_protection.providers
+        self.providers_mock.reset_mock()
+
+
+class TestListProviders(TestProviders):
+    def setUp(self):
+        super(TestListProviders, self).setUp()
+        self.providers_mock.list.return_value = [providers.Provider(
+            None, copy.deepcopy(PROVIDER_INFO))]
+
+        # Command to test
+        self.cmd = osc_providers.ListProviders(self.app, None)
+
+    def test_providers_list(self):
+        arglist = ['--name', 'OS Infra Provider']
+        verifylist = [('name', 'OS Infra Provider')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Name', 'Description'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("2220f8b1-975d-4621-a872-fa9afb43cb6c",
+                          "OS Infra Provider",
+                          "provider description")]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestShowProvider(TestProviders):
+    def setUp(self):
+        super(TestShowProvider, self).setUp()
+        self._provider_info = copy.deepcopy(PROVIDER_INFO)
+        self.providers_mock.get.return_value = providers.Provider(
+            None, self._provider_info)
+
+        # Command to test
+        self.cmd = osc_providers.ShowProvider(self.app, None)
+
+    def test_provider_show(self):
+        arglist = ['2220f8b1-975d-4621-a872-fa9afb43cb6c']
+        verifylist = [('provider', '2220f8b1-975d-4621-a872-fa9afb43cb6c')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'description', 'extended_info_schema', 'id', 'name')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._provider_info['description'], data[0])
+        self.assertEqual(self._provider_info['extended_info_schema'], data[1])
+        self.assertEqual(self._provider_info['id'], data[2])
+        self.assertEqual(self._provider_info['name'], data[3])

karborclient/tests/unit/osc/v1/test_quota_classes.py

@@ -0,0 +1,77 @@
+# 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 copy
+
+from karborclient.osc.v1 import quota_classes as osc_quota_classes
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import quota_classes
+
+
+QUOTA_CLASSES_INFO = {
+    "id": "default",
+    "plans": "40"
+}
+
+
+class TestQuotaClasses(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestQuotaClasses, self).setUp()
+        self.quotas_mock = (
+            self.app.client_manager.data_protection.quota_classes)
+        self.quotas_mock.reset_mock()
+
+
+class TestUpdateQuotaClasses(TestQuotaClasses):
+    def setUp(self):
+        super(TestUpdateQuotaClasses, self).setUp()
+        self.quotas_mock.update.return_value = quota_classes.QuotaClass(
+            None, copy.deepcopy(QUOTA_CLASSES_INFO))
+        self.cmd = osc_quota_classes.UpdateQuotaClasses(self.app, None)
+
+    def test_quota_classes_update(self):
+        arglist = ['--plans',
+                   '40', 'default']
+        verifylist = [('plans', 40),
+                      ('class_name',
+                       'default')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.quotas_mock.update.assert_called_once_with(
+            'default',
+            {'plans': 40})
+
+
+class TestShowQuotaClasses(TestQuotaClasses):
+    def setUp(self):
+        super(TestShowQuotaClasses, self).setUp()
+        self._quota_info = copy.deepcopy(QUOTA_CLASSES_INFO)
+        self.quotas_mock.get.return_value = quota_classes.QuotaClass(
+            None, copy.deepcopy(QUOTA_CLASSES_INFO))
+
+        self.cmd = osc_quota_classes.ShowQuotaClasses(self.app, None)
+
+    def test_quota_classes_show(self):
+        arglist = ['default']
+        verifylist = [('class_name', 'default')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.assertEqual(('id', 'plans'), columns)
+        self.assertEqual(('default', '40'),
+                         data)

karborclient/tests/unit/osc/v1/test_quotas.py

@@ -0,0 +1,76 @@
+# 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 copy
+
+from karborclient.osc.v1 import quotas as osc_quotas
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import quotas
+
+
+QUOTA_INFO = {
+    "id": "73f74f90a1754bd7ad658afb3272323f",
+    "plans": "40"
+}
+
+
+class TestQuotas(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestQuotas, self).setUp()
+        self.quotas_mock = self.app.client_manager.data_protection.quotas
+        self.quotas_mock.reset_mock()
+
+
+class TestUpdateQuotas(TestQuotas):
+    def setUp(self):
+        super(TestUpdateQuotas, self).setUp()
+        self.quotas_mock.update.return_value = quotas.Quota(
+            None, copy.deepcopy(QUOTA_INFO))
+        self.cmd = osc_quotas.UpdateQuotas(self.app, None)
+
+    def test_quotas_update(self):
+        arglist = ['--plans',
+                   '40', '73f74f90a1754bd7ad658afb3272323f']
+        verifylist = [('plans', 40),
+                      ('tenant',
+                       '73f74f90a1754bd7ad658afb3272323f')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.quotas_mock.update.assert_called_once_with(
+            '73f74f90a1754bd7ad658afb3272323f',
+            {'plans': 40})
+
+
+class TestShowQuotas(TestQuotas):
+    def setUp(self):
+        super(TestShowQuotas, self).setUp()
+        self._quota_info = copy.deepcopy(QUOTA_INFO)
+        self.quotas_mock.get.return_value = quotas.Quota(
+            None, copy.deepcopy(QUOTA_INFO))
+
+        self.cmd = osc_quotas.ShowQuotas(self.app, None)
+
+    def test_quota_show(self):
+        arglist = []
+        verifylist = []
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.assertEqual(('id', 'plans'), columns)
+        self.assertEqual(('73f74f90a1754bd7ad658afb3272323f', '40'),
+                         data)

karborclient/tests/unit/osc/v1/test_restores.py

@@ -0,0 +1,138 @@
+# 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 copy
+import json
+
+from karborclient.osc.v1 import restores as osc_restores
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import restores
+
+
+RESTORE_INFO = {
+    "id": "22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+    "project_id": "e486a2f49695423ca9c47e589b948108",
+    "provider_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+    "checkpoint_id": "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+    "restore_target": "",
+    "parameters": {},
+    "restore_auth": {},
+    "resources_status": {},
+    "resources_reason": {},
+    "status": "success"
+}
+
+
+class TestRestores(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestRestores, self).setUp()
+        self.restores_mock = self.app.client_manager.data_protection.restores
+        self.restores_mock.reset_mock()
+
+
+class TestListRestores(TestRestores):
+    def setUp(self):
+        super(TestListRestores, self).setUp()
+        self.restores_mock.list.return_value = [restores.Restore(
+            None, copy.deepcopy(RESTORE_INFO))]
+
+        # Command to test
+        self.cmd = osc_restores.ListRestores(self.app, None)
+
+    def test_restores_list(self):
+        arglist = ['--status', 'success']
+        verifylist = [('status', 'success')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Project id', 'Provider id', 'Checkpoint id',
+             'Restore target', 'Parameters', 'Status'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+                          "e486a2f49695423ca9c47e589b948108",
+                          "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+                          "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+                          "",
+                          json.dumps({}),
+                          "success")]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestCreateRestore(TestRestores):
+    def setUp(self):
+        super(TestCreateRestore, self).setUp()
+        self.restores_mock.create.return_value = restores.Restore(
+            None, copy.deepcopy(RESTORE_INFO))
+        # Command to test
+        self.cmd = osc_restores.CreateRestore(self.app, None)
+
+    def test_restore_create(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   'dcb20606-ad71-40a3-80e4-ef0fafdad0c3']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('checkpoint_id',
+                       'dcb20606-ad71-40a3-80e4-ef0fafdad0c3')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.restores_mock.create.assert_called_once_with(
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            'dcb20606-ad71-40a3-80e4-ef0fafdad0c3',
+            None, {}, None)
+
+
+class TestShowRestore(TestRestores):
+    def setUp(self):
+        super(TestShowRestore, self).setUp()
+        self._restore_info = copy.deepcopy(RESTORE_INFO)
+        self.restores_mock.get.return_value = restores.Restore(
+            None, self._restore_info)
+
+        # Command to test
+        self.cmd = osc_restores.ShowRestore(self.app, None)
+
+    def test_restore_show(self):
+        arglist = ['22b82aa7-9179-4c71-bba2-caf5c0e68db7']
+        verifylist = [('restore', '22b82aa7-9179-4c71-bba2-caf5c0e68db7')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'checkpoint_id', 'id', 'parameters', 'project_id',
+            'provider_id', 'resources_reason', 'resources_status',
+            'restore_auth', 'restore_target', 'status')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._restore_info['checkpoint_id'], data[0])
+        self.assertEqual(self._restore_info['id'], data[1])
+        self.assertEqual(self._restore_info['parameters'], data[2])
+        self.assertEqual(self._restore_info['project_id'], data[3])
+        self.assertEqual(self._restore_info['provider_id'], data[4])
+        self.assertEqual(self._restore_info['resources_reason'], data[5])
+        self.assertEqual(self._restore_info['resources_status'], data[6])
+        self.assertEqual(self._restore_info['restore_auth'], data[7])
+        self.assertEqual(self._restore_info['restore_target'], data[8])
+        self.assertEqual(self._restore_info['status'], data[9])

karborclient/tests/unit/osc/v1/test_scheduledoperations.py

@@ -0,0 +1,173 @@
+# 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 copy
+import json
+
+from karborclient.osc.v1 import scheduled_operations as osc_so
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import scheduled_operations
+
+
+SCHEDULEDOPERATION_INFO = {
+    "id": "1a2c0c3d-f402-4cd8-b5db-82e85cb51fad",
+    "name": "My scheduled operation",
+    "description": "It will run everyday",
+    "operation_type": "protect",
+    "trigger_id": "23902b02-5666-4ee6-8dfe-962ac09c3995",
+    "operation_definition": {
+        "provider_id": "2a9ce1f3-cc1a-4516-9435-0ebb13caa399",
+        "plan_id": "2a9ce1f3-cc1a-4516-9435-0ebb13caa398"
+    },
+    "enabled": 1
+}
+
+
+class TestScheduledOperations(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestScheduledOperations, self).setUp()
+        self.so_mock = self.app.client_manager.data_protection.\
+            scheduled_operations
+        self.so_mock.reset_mock()
+
+
+class TestListScheduledOperations(TestScheduledOperations):
+    def setUp(self):
+        super(TestListScheduledOperations, self).setUp()
+        self.so_mock.list.return_value = [
+            scheduled_operations.ScheduledOperation(
+                None, copy.deepcopy(SCHEDULEDOPERATION_INFO))
+        ]
+
+        # Command to test
+        self.cmd = osc_so.ListScheduledOperations(self.app, None)
+
+    def test_scheduled_operations_list(self):
+        arglist = ['--name', 'My scheduled operation']
+        verifylist = [('name', 'My scheduled operation')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Name', 'Operation Type', 'Trigger Id',
+             'Operation Definition'])
+        self.assertEqual(expected_columns, columns)
+
+        operation_definition = {
+            "provider_id": "2a9ce1f3-cc1a-4516-9435-0ebb13caa399",
+            "plan_id": "2a9ce1f3-cc1a-4516-9435-0ebb13caa398"
+        }
+
+        # Check that data is correct
+        expected_data = [("1a2c0c3d-f402-4cd8-b5db-82e85cb51fad",
+                          "My scheduled operation",
+                          "protect",
+                          "23902b02-5666-4ee6-8dfe-962ac09c3995",
+                          json.dumps(operation_definition,
+                                     indent=2, sort_keys=True)
+                          )]
+        self.assertEqual(expected_data, data)
+
+
+class TestCreateScheduledOperation(TestScheduledOperations):
+    def setUp(self):
+        super(TestCreateScheduledOperation, self).setUp()
+        self.so_mock.create.return_value = scheduled_operations.\
+            ScheduledOperation(None, copy.deepcopy(SCHEDULEDOPERATION_INFO))
+        # Command to test
+        self.cmd = osc_so.CreateScheduledOperation(self.app, None)
+
+    def test_scheduled_operation_create(self):
+        arglist = ['My scheduled operation',
+                   'protect',
+                   "23902b02-5666-4ee6-8dfe-962ac09c3995",
+                   "'provider_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa399,"
+                   "plan_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa398'"]
+        verifylist = [('name', 'My scheduled operation'),
+                      ('operation_type', 'protect'),
+                      ('trigger_id', "23902b02-5666-4ee6-8dfe-962ac09c3995"),
+                      ('operation_definition',
+                       "'provider_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa399,"
+                       "plan_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa398'")]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.so_mock.create.assert_called_once_with(
+            'My scheduled operation',
+            'protect',
+            '23902b02-5666-4ee6-8dfe-962ac09c3995',
+            "'provider_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa399,"
+            "plan_id=2a9ce1f3-cc1a-4516-9435-0ebb13caa398'")
+
+
+class TestDeleteScheduledOperation(TestScheduledOperations):
+    def setUp(self):
+        super(TestDeleteScheduledOperation, self).setUp()
+        self.so_mock.get.return_value = scheduled_operations.\
+            ScheduledOperation(None, copy.deepcopy(SCHEDULEDOPERATION_INFO))
+        # Command to test
+        self.cmd = osc_so.DeleteScheduledOperation(self.app, None)
+
+    def test_scheduled_operation_delete(self):
+        arglist = ['1a2c0c3d-f402-4cd8-b5db-82e85cb51fad']
+        verifylist = [('scheduledoperation',
+                       ['1a2c0c3d-f402-4cd8-b5db-82e85cb51fad'])]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.so_mock.delete.assert_called_once_with(
+            '1a2c0c3d-f402-4cd8-b5db-82e85cb51fad')
+
+
+class TestShowScheduledOperation(TestScheduledOperations):
+    def setUp(self):
+        super(TestShowScheduledOperation, self).setUp()
+        self._schedop_info = copy.deepcopy(SCHEDULEDOPERATION_INFO)
+        self.so_mock.get.return_value = scheduled_operations.\
+            ScheduledOperation(None, self._schedop_info)
+
+        # Command to test
+        self.cmd = osc_so.ShowScheduledOperation(self.app, None)
+
+    def test_scheduled_operation_show(self):
+        arglist = ['1a2c0c3d-f402-4cd8-b5db-82e85cb51fad']
+        verifylist = [('scheduledoperation',
+                       '1a2c0c3d-f402-4cd8-b5db-82e85cb51fad')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'description', 'enabled', 'id', 'name', 'operation_definition',
+            'operation_type', 'trigger_id')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._schedop_info['description'], data[0])
+        self.assertEqual(self._schedop_info['enabled'], data[1])
+        self.assertEqual(self._schedop_info['id'], data[2])
+        self.assertEqual(self._schedop_info['name'], data[3])
+        self.assertEqual(self._schedop_info['operation_definition'], data[4])
+        self.assertEqual(self._schedop_info['operation_type'], data[5])
+        self.assertEqual(self._schedop_info['trigger_id'], data[6])

karborclient/tests/unit/osc/v1/test_services.py

@@ -0,0 +1,101 @@
+# 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 copy
+
+from karborclient.osc.v1 import services as osc_services
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import services
+
+SERVICE_INFO = {
+    "status": "enabled",
+    "binary": "karbor-operationengine",
+    "state": "up",
+    "updated_at": "2017-10-25T07:06:58.000000",
+    "host": "fake_host",
+    "disabled_reason": None,
+    "id": 1
+}
+
+
+class TestServices(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestServices, self).setUp()
+        self.services_mock = self.app.client_manager.data_protection.services
+        self.services_mock.reset_mock()
+
+
+class TestListServices(TestServices):
+    def setUp(self):
+        super(TestListServices, self).setUp()
+        self.services_mock.list.return_value = [
+            services.Service(None, copy.deepcopy(SERVICE_INFO))]
+        self.cmd = osc_services.ListServices(self.app, None)
+
+    def test_services_list(self):
+        arg_list = ['--host', 'fake_host']
+        verify_list = [('host', 'fake_host')]
+
+        parsed_args = self.check_parser(self.cmd, arg_list, verify_list)
+        columns, data = self.cmd.take_action(parsed_args)
+        expected_columns = (["Id", "Binary", "Host", "Status", "State",
+                             "Updated_at", "Disabled Reason"])
+        self.assertEqual(expected_columns, columns)
+        expected_data = [(1,
+                          "karbor-operationengine",
+                          "fake_host",
+                          "enabled",
+                          "up",
+                          "2017-10-25T07:06:58.000000",
+                          None
+                          )]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestEnableService(TestServices):
+    def setUp(self):
+        super(TestEnableService, self).setUp()
+        self.services_mock.enable.return_value = services.Service(
+            None, copy.deepcopy(SERVICE_INFO))
+        self.cmd = osc_services.EnableService(self.app, None)
+
+    def test_enable_service(self):
+        arg_list = ['1']
+        verify_list = [('service_id', '1')]
+        parsed_args = self.check_parser(self.cmd, arg_list, verify_list)
+        self.cmd.take_action(parsed_args)
+        self.services_mock.enable.assert_called_once_with('1')
+
+
+class TestDisableService(TestServices):
+    def setUp(self):
+        super(TestDisableService, self).setUp()
+        self.services_mock.disable.return_value = services.Service(
+            None, copy.deepcopy(SERVICE_INFO))
+        self.services_mock.disable_log_reason.return_value = services.Service(
+            None, copy.deepcopy(SERVICE_INFO))
+        self.cmd = osc_services.DisableService(self.app, None)
+
+    def test_disable_service(self):
+        arg_list = ['1']
+        verify_list = [('service_id', '1')]
+        parsed_args = self.check_parser(self.cmd, arg_list, verify_list)
+        self.cmd.take_action(parsed_args)
+        self.services_mock.disable.assert_called_once_with('1')
+
+    def test_disable_service_with_reason(self):
+        arg_list = ['1', '--reason', 'fake_reason']
+        verify_list = [('service_id', '1'), ('reason', 'fake_reason')]
+        parsed_args = self.check_parser(self.cmd, arg_list, verify_list)
+        self.cmd.take_action(parsed_args)
+        self.services_mock.disable_log_reason.assert_called_once_with(
+            '1', 'fake_reason')

karborclient/tests/unit/osc/v1/test_triggers.py

@@ -0,0 +1,189 @@
+# 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 copy
+
+from karborclient.osc.v1 import triggers as osc_triggers
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import triggers
+
+
+TRIGGER_INFO = {
+    "id": "2a9ce1f3-cc1a-4516-9435-0ebb13caa398",
+    "name": "My backup trigger",
+    "type": "time",
+    "properties": {
+        "format": "calendar",
+        "pattern": "BEGIN:VEVENT\\nRRULE:FREQ=HOURLY;INTERVAL=1;\\nEND:VEVENT",
+        "start_time": "2015-12-17T08:30:00",
+        "end_time": "2016-03-17T08:30:00",
+        "window": "3600"
+    }
+}
+
+
+class TestTriggers(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestTriggers, self).setUp()
+        self.triggers_mock = self.app.client_manager.data_protection.triggers
+        self.triggers_mock.reset_mock()
+
+
+class TestListTriggers(TestTriggers):
+    def setUp(self):
+        super(TestListTriggers, self).setUp()
+        self.triggers_mock.list.return_value = [triggers.Trigger(
+            None, copy.deepcopy(TRIGGER_INFO))]
+
+        # Command to test
+        self.cmd = osc_triggers.ListTriggers(self.app, None)
+
+    def test_triggers_list(self):
+        arglist = ['--name', 'My backup trigger']
+        verifylist = [('name', 'My backup trigger')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            ['Id', 'Name', 'Type', 'Properties'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("2a9ce1f3-cc1a-4516-9435-0ebb13caa398",
+                          "My backup trigger",
+                          "time",
+                          {"format": "calendar",
+                           "pattern": "BEGIN:VEVENT\\nRRULE:FREQ=HOURLY;INTERVAL=1;\\nEND:VEVENT",  # noqa
+                           "start_time": "2015-12-17T08:30:00",
+                           "end_time": "2016-03-17T08:30:00",
+                           "window": "3600"})]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestCreateTrigger(TestTriggers):
+    def setUp(self):
+        super(TestCreateTrigger, self).setUp()
+        self.triggers_mock.create.return_value = triggers.Trigger(
+            None, copy.deepcopy(TRIGGER_INFO))
+        # Command to test
+        self.cmd = osc_triggers.CreateTrigger(self.app, None)
+
+    def test_trigger_create(self):
+        arglist = ['My backup trigger',
+                   'time',
+                   "'format'='calendar',"
+                   "'pattern'='BEGIN:VEVENT\\nRRULE:FREQ=HOURLY;INTERVAL=1;\\nEND:VEVENT',"  # noqa
+                   "'start_time'='2015-12-17T08:30:00',"
+                   "'end_time'='2016-03-17T08:30:00',"
+                   "'window'='3600'"]
+        verifylist = [('name', 'My backup trigger'),
+                      ('type', 'time'),
+                      ('properties', "'format'='calendar',"
+                                     "'pattern'='BEGIN:VEVENT\\nRRULE:FREQ=HOURLY;INTERVAL=1;\\nEND:VEVENT',"  # noqa
+                                     "'start_time'='2015-12-17T08:30:00',"
+                                     "'end_time'='2016-03-17T08:30:00',"
+                                     "'window'='3600'")]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.triggers_mock.create.assert_called_once_with(
+            'My backup trigger',
+            'time',
+            "'format'='calendar',"
+            "'pattern'='BEGIN:VEVENT\\nRRULE:FREQ=HOURLY;INTERVAL=1;\\nEND:VEVENT',"  # noqa
+            "'start_time'='2015-12-17T08:30:00',"
+            "'end_time'='2016-03-17T08:30:00',"
+            "'window'='3600'")
+
+
+class TestUpdateTrigger(TestTriggers):
+    def setUp(self):
+        super(TestUpdateTrigger, self).setUp()
+        self.triggers_mock.get.return_value = triggers.Trigger(
+            None, copy.deepcopy(TRIGGER_INFO))
+        self.triggers_mock.update.return_value = triggers.Trigger(
+            None, copy.deepcopy(TRIGGER_INFO))
+        # Command to test
+        self.cmd = osc_triggers.UpdateTrigger(self.app, None)
+
+    def test_trigger_update(self):
+        arglist = ['2a9ce1f3-cc1a-4516-9435-0ebb13caa398',
+                   '--name', 'My backup trigger']
+        verifylist = [('trigger_id', '2a9ce1f3-cc1a-4516-9435-0ebb13caa398'),
+                      ('name', 'My backup trigger')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.triggers_mock.update.assert_called_once_with(
+            '2a9ce1f3-cc1a-4516-9435-0ebb13caa398',
+            {'name': 'My backup trigger'})
+
+
+class TestDeleteTrigger(TestTriggers):
+    def setUp(self):
+        super(TestDeleteTrigger, self).setUp()
+        self.triggers_mock.get.return_value = triggers.Trigger(
+            None, copy.deepcopy(TRIGGER_INFO))
+        # Command to test
+        self.cmd = osc_triggers.DeleteTrigger(self.app, None)
+
+    def test_trigger_delete(self):
+        arglist = ['2a9ce1f3-cc1a-4516-9435-0ebb13caa398']
+        verifylist = [('trigger', ['2a9ce1f3-cc1a-4516-9435-0ebb13caa398'])]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        # Check that correct arguments were passed
+        self.triggers_mock.delete.assert_called_once_with(
+            '2a9ce1f3-cc1a-4516-9435-0ebb13caa398')
+
+
+class TestShowTrigger(TestTriggers):
+    def setUp(self):
+        super(TestShowTrigger, self).setUp()
+        self._trigger_info = copy.deepcopy(TRIGGER_INFO)
+        self.triggers_mock.get.return_value = triggers.Trigger(
+            None, self._trigger_info)
+
+        # Command to test
+        self.cmd = osc_triggers.ShowTrigger(self.app, None)
+
+    def test_trigger_show(self):
+        arglist = ['2a9ce1f3-cc1a-4516-9435-0ebb13caa398']
+        verifylist = [('trigger', '2a9ce1f3-cc1a-4516-9435-0ebb13caa398')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Check that columns are correct
+        expected_columns = (
+            'id', 'name', 'properties', 'type')
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        self.assertEqual(self._trigger_info['id'], data[0])
+        self.assertEqual(self._trigger_info['name'], data[1])
+        self.assertEqual(self._trigger_info['properties'], data[2])
+        self.assertEqual(self._trigger_info['type'], data[3])

karborclient/tests/unit/osc/v1/test_verifications.py

@@ -0,0 +1,129 @@
+# 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 copy
+import json
+
+from karborclient.osc.v1 import verifications as osc_verifications
+from karborclient.tests.unit.osc.v1 import fakes
+from karborclient.v1 import verifications
+
+
+VERIFICATION_INFO = {
+    "id": "22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+    "project_id": "e486a2f49695423ca9c47e589b948108",
+    "provider_id": "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+    "checkpoint_id": "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+    "parameters": {},
+    "resources_status": {},
+    "resources_reason": {},
+    "status": "success"
+}
+
+
+class TestVerifications(fakes.TestDataProtection):
+    def setUp(self):
+        super(TestVerifications, self).setUp()
+        self.verifications_mock = (
+            self.app.client_manager.data_protection.verifications)
+        self.verifications_mock.reset_mock()
+
+
+class TestListVerifications(TestVerifications):
+    def setUp(self):
+        super(TestListVerifications, self).setUp()
+        self.verifications_mock.list.return_value = (
+            [verifications.Verification(
+                None, copy.deepcopy(VERIFICATION_INFO))])
+
+        # Command to test
+        self.cmd = osc_verifications.ListVerifications(self.app, None)
+
+    def test_verifications_list(self):
+        arglist = ['--status', 'success']
+        verifylist = [('status', 'success')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = (
+            ['Id', 'Project id', 'Provider id', 'Checkpoint id',
+             'Parameters', 'Status'])
+        self.assertEqual(expected_columns, columns)
+
+        # Check that data is correct
+        expected_data = [("22b82aa7-9179-4c71-bba2-caf5c0e68db7",
+                          "e486a2f49695423ca9c47e589b948108",
+                          "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
+                          "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
+                          json.dumps({}),
+                          "success")]
+        self.assertEqual(expected_data, list(data))
+
+
+class TestCreateVerification(TestVerifications):
+    def setUp(self):
+        super(TestCreateVerification, self).setUp()
+        self.verifications_mock.create.return_value = (
+            verifications.Verification(
+                None, copy.deepcopy(VERIFICATION_INFO)))
+        self.cmd = osc_verifications.CreateVerification(self.app, None)
+
+    def test_verification_create(self):
+        arglist = ['cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+                   'dcb20606-ad71-40a3-80e4-ef0fafdad0c3']
+        verifylist = [('provider_id', 'cf56bd3e-97a7-4078-b6d5-f36246333fd9'),
+                      ('checkpoint_id',
+                       'dcb20606-ad71-40a3-80e4-ef0fafdad0c3')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.verifications_mock.create.assert_called_once_with(
+            'cf56bd3e-97a7-4078-b6d5-f36246333fd9',
+            'dcb20606-ad71-40a3-80e4-ef0fafdad0c3', {})
+
+
+class TestShowVerification(TestVerifications):
+    def setUp(self):
+        super(TestShowVerification, self).setUp()
+        self._verification_info = copy.deepcopy(VERIFICATION_INFO)
+        self.verifications_mock.get.return_value = (
+            verifications.Verification(None, self._verification_info))
+
+        self.cmd = osc_verifications.ShowVerification(self.app, None)
+
+    def test_verification_show(self):
+        arglist = ['22b82aa7-9179-4c71-bba2-caf5c0e68db7']
+        verifylist = [('verification', '22b82aa7-9179-4c71-bba2-caf5c0e68db7')]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = (
+            'checkpoint_id', 'id', 'parameters', 'project_id',
+            'provider_id', 'resources_reason', 'resources_status',
+            'status')
+        self.assertEqual(expected_columns, columns)
+
+        self.assertEqual(self._verification_info['checkpoint_id'], data[0])
+        self.assertEqual(self._verification_info['id'], data[1])
+        self.assertEqual(self._verification_info['parameters'], data[2])
+        self.assertEqual(self._verification_info['project_id'], data[3])
+        self.assertEqual(self._verification_info['provider_id'], data[4])
+        self.assertEqual(self._verification_info['resources_reason'], data[5])
+        self.assertEqual(self._verification_info['resources_status'], data[6])
+        self.assertEqual(self._verification_info['status'], data[7])

karborclient/tests/unit/test_shell.py

@@ -15,8 +15,8 @@ import re
 import sys
 
 import fixtures
-from keystoneclient import fixture
-from keystoneclient.fixture import v2 as ks_v2_fixture
+from keystoneauth1 import fixture
+from keystoneauth1.fixture import v2 as ks_v2_fixture
 import mock
 from oslo_log import handlers
 from oslo_log import log
@@ -134,7 +134,7 @@ class ShellCommandTest(ShellTest):
     def test_help(self):
         required = [
             '.*?^usage: karbor',
-            '.*?^\s+plan-create\s+Create a plan.',
+            '.*?^\s+plan-create\s+Creates a plan.',
             '.*?^See "karbor help COMMAND" for help on a specific command',
         ]
         stdout, stderr = self.shell('help')
@@ -145,7 +145,7 @@ class ShellCommandTest(ShellTest):
     def test_help_on_subcommand(self):
         required = [
             '.*?^usage: karbor plan-create',
-            '.*?^Create a plan.',
+            '.*?^Creates a plan.',
         ]
         stdout, stderr = self.shell('help plan-create')
         for r in required:
@@ -155,7 +155,7 @@ class ShellCommandTest(ShellTest):
     def test_help_no_options(self):
         required = [
             '.*?^usage: karbor',
-            '.*?^\s+plan-create\s+Create a plan',
+            '.*?^\s+plan-create\s+Creates a plan',
             '.*?^See "karbor help COMMAND" for help on a specific command',
         ]
         stdout, stderr = self.shell('')

karborclient/tests/unit/v1/fakes.py

@@ -82,7 +82,7 @@ class FakeHTTPClient(base_client.HTTPClient):
                                  (method, url, callback))
 
         # Note the call
-        self.callstack.append((method, url, kwargs.get('body', None)))
+        self.callstack.append((method, url, kwargs.get('body')))
         status, headers, body = getattr(self, callback)(**kwargs)
         # add fake request-id header
         headers['x-openstack-request-id'] = REQUEST_ID

karborclient/tests/unit/v1/test_checkpoints.py

@@ -88,5 +88,5 @@ class CheckpointsTest(base.TestCaseShell):
             'checkpoints'.format(
                 provider_id=FAKE_PROVIDER_ID),
             data={
-                'checkpoint': {'plan_id': FAKE_PLAN_ID}},
+                'checkpoint': {'plan_id': FAKE_PLAN_ID, 'extra-info': None}},
             headers={})

karborclient/tests/unit/v1/test_operation_logs.py

@@ -0,0 +1,63 @@
+#    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 mock
+
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+cs = fakes.FakeClient()
+mock_request_return = ({}, {'operation_log': {}})
+
+
+class OperationLogsTest(base.TestCaseShell):
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_operation_logs_with_marker_limit(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.list(marker=1234, limit=2)
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs?limit=2&marker=1234', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_operation_logs_with_sort_key_dir(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.list(sort_key='id', sort_dir='asc')
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs?'
+            'sort_dir=asc&sort_key=id', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_operation_logs_with_invalid_sort_key(self, mock_request):
+        self.assertRaises(ValueError,
+                          cs.operation_logs.list,
+                          sort_key='invalid', sort_dir='asc')
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_operation_log(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.get('1')
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs/1',
+            headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_operation_log_with_headers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.get('1', session_id='fake_session_id')
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs/1',
+            headers={'X-Configuration-Session': 'fake_session_id'})

karborclient/tests/unit/v1/test_quota_classes.py

@@ -0,0 +1,40 @@
+#    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 mock
+
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+cs = fakes.FakeClient()
+mock_request_return = ({}, {'quota_class': {'plans': 50}})
+
+
+class QuotaClassesTest(base.TestCaseShell):
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_quota_class_update(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quota_classes.update('default', {'plans': 50})
+        mock_request.assert_called_with(
+            'PUT',
+            '/quota_classes/default',
+            data={'quota_class': {'plans': 50}}, headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_class(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quota_classes.get('default')
+        mock_request.assert_called_with(
+            'GET',
+            '/quota_classes/default',
+            headers={})

karborclient/tests/unit/v1/test_quotas.py

@@ -0,0 +1,60 @@
+#    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 mock
+
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+cs = fakes.FakeClient()
+mock_request_return = ({}, {'quota': {'plans': 50}})
+
+
+class QuotasTest(base.TestCaseShell):
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_quota_update(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.update(fakes.PROJECT_ID, {'plans': 50})
+        mock_request.assert_called_with(
+            'PUT',
+            '/quotas/{project_id}'.format(project_id=fakes.PROJECT_ID),
+            data={'quota': {'plans': 50}}, headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.get(fakes.PROJECT_ID, detail=False)
+        mock_request.assert_called_with(
+            'GET',
+            '/quotas/{project_id}'.format(project_id=fakes.PROJECT_ID),
+            headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_with_detail(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.get(fakes.PROJECT_ID, detail=True)
+        mock_request.assert_called_with(
+            'GET',
+            '/quotas/{project_id}/detail'.format(
+                project_id=fakes.PROJECT_ID),
+            headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_with_default(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.defaults(fakes.PROJECT_ID)
+        mock_request.assert_called_with(
+            'GET',
+            '/quotas/{project_id}/defaults'.format(
+                project_id=fakes.PROJECT_ID),
+            headers={})

karborclient/tests/unit/v1/test_services.py

@@ -0,0 +1,104 @@
+#    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 mock
+
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+cs = fakes.FakeClient()
+mock_request_return = ({}, {'service': {}})
+
+
+class ServicesTest(base.TestCaseShell):
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_services(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.services.list()
+        mock_request.assert_called_with(
+            'GET',
+            '/os-services',
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_services_with_host(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.services.list(host='fake_host')
+        mock_request.assert_called_with(
+            'GET',
+            '/os-services?host=fake_host',
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_services_with_binary(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.services.list(binary='fake_binary')
+        mock_request.assert_called_with(
+            'GET',
+            '/os-services?binary=fake_binary',
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_services_with_host_and_binary(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.services.list(host='fake_host', binary='fake_binary')
+        mock_request.assert_called_with(
+            'GET',
+            '/os-services?binary=fake_binary&host=fake_host',
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_enable_service(self, mock_request):
+        mock_request.return_value = mock_request_return
+        body = {
+            'status': 'enabled'
+        }
+        cs.services.enable('1')
+        mock_request.assert_called_with(
+            'PUT',
+            '/os-services/1',
+            data=body,
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_disable_service(self, mock_request):
+        mock_request.return_value = mock_request_return
+        body = {
+            'status': 'disabled'
+        }
+        cs.services.disable('1')
+        mock_request.assert_called_with(
+            'PUT',
+            '/os-services/1',
+            data=body,
+            headers={}
+        )
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_disable_service_with_reason(self, mock_request):
+        mock_request.return_value = mock_request_return
+        body = {
+            'status': 'disabled',
+            'disabled_reason': 'fake_reason'
+        }
+        cs.services.disable_log_reason('1', 'fake_reason')
+        mock_request.assert_called_with(
+            'PUT',
+            '/os-services/1',
+            data=body,
+            headers={}
+        )

karborclient/tests/unit/v1/test_verifications.py

@@ -0,0 +1,80 @@
+#    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 mock
+
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+cs = fakes.FakeClient()
+mock_request_return = ({}, {'verification': {}})
+
+
+class VerificationsTest(base.TestCaseShell):
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_verifications_with_marker_limit(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.verifications.list(marker=1234, limit=2)
+        mock_request.assert_called_with(
+            'GET',
+            '/verifications?limit=2&marker=1234', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_verifications_with_sort_key_dir(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.verifications.list(sort_key='id', sort_dir='asc')
+        mock_request.assert_called_with(
+            'GET',
+            '/verifications?'
+            'sort_dir=asc&sort_key=id', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_verifications_with_invalid_sort_key(self, mock_request):
+        self.assertRaises(ValueError,
+                          cs.verifications.list,
+                          sort_key='invalid', sort_dir='asc')
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_create_verification(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.verifications.create('586cc6ce-e286-40bd-b2b5-dd32694d9944',
+                                '2220f8b1-975d-4621-a872-fa9afb43cb6c',
+                                '{}')
+        mock_request.assert_called_with(
+            'POST',
+            '/verifications',
+            data={
+                'verification':
+                {
+                    'checkpoint_id': '2220f8b1-975d-4621-a872-fa9afb43cb6c',
+                    'parameters': '{}',
+                    'provider_id': '586cc6ce-e286-40bd-b2b5-dd32694d9944'
+                }}, headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_verification(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.verifications.get('1')
+        mock_request.assert_called_with(
+            'GET',
+            '/verifications/1',
+            headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_verification_with_headers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.verifications.get('1', session_id='fake_session_id')
+        mock_request.assert_called_with(
+            'GET',
+            '/verifications/1',
+            headers={'X-Configuration-Session': 'fake_session_id'})

karborclient/utils.py

@@ -0,0 +1,146 @@
+#    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.
+
+from oslo_serialization import jsonutils
+from oslo_utils import uuidutils
+
+from karborclient.common.apiclient import exceptions
+
+
+def extract_resources(args):
+    resources = []
+    for data in args.resources.split(','):
+        if '=' in data and len(data.split('=')) in [3, 4]:
+            resource = dict(zip(['id', 'type', 'name', 'extra_info'],
+                                data.split('=')))
+            if resource.get('extra_info'):
+                resource['extra_info'] = jsonutils.loads(
+                    resource.get('extra_info'))
+        else:
+            raise exceptions.CommandError(
+                "Unable to parse parameter resources. "
+                "The keys of resource are id , type, name and "
+                "extra_info. The extra_info field is optional.")
+        resources.append(resource)
+    return resources
+
+
+def check_resources(cs, resources):
+    # check the resource whether it is available
+    for resource in resources:
+        try:
+            instance = cs.protectables.get_instance(
+                resource["type"], resource["id"])
+        except exceptions.NotFound:
+            raise exceptions.CommandError(
+                "The resource: %s can not be found." % resource["id"])
+        else:
+            if instance is None:
+                raise exceptions.CommandError(
+                    "The resource: %s is invalid." % resource["id"])
+
+
+def extract_parameters(args):
+    if all((args.parameters, args.parameters_json)):
+        raise exceptions.CommandError(
+            "Must provide parameters or parameters-json, not both")
+    if not any((args.parameters, args.parameters_json)):
+        return {}
+
+    if args.parameters_json:
+        return jsonutils.loads(args.parameters_json)
+    parameters = {}
+    for resource_params in args.parameters:
+        resource_type = None
+        resource_id = None
+        parameter = {}
+        for param_kv in resource_params.split(','):
+            try:
+                key, value = param_kv.split('=')
+            except Exception:
+                raise exceptions.CommandError(
+                    'parameters must be in the form: key1=val1,key2=val2,...'
+                )
+            if key == "resource_type":
+                resource_type = value
+            elif key == "resource_id":
+                if not uuidutils.is_uuid_like(value):
+                    raise exceptions.CommandError('resource_id must be a uuid')
+                resource_id = value
+            else:
+                parameter[key] = value
+        if resource_type is None:
+            raise exceptions.CommandError(
+                'Must specify resource_type for parameters'
+            )
+        if resource_id is None:
+            resource_key = resource_type
+        else:
+            resource_key = "%s#%s" % (resource_type, resource_id)
+        parameters[resource_key] = parameter
+
+    return parameters
+
+
+def extract_instances_parameters(args):
+    parameters = {}
+    for parameter in args.parameters:
+        if '=' in parameter:
+            (key, value) = parameter.split('=', 1)
+        else:
+            key = parameter
+            value = None
+
+        parameters[key] = value
+    return parameters
+
+
+def extract_extra_info(args):
+    checkpoint_extra_info = {}
+    for data in args.extra_info:
+        # unset doesn't require a val, so we have the if/else
+        if '=' in data:
+            (key, value) = data.split('=', 1)
+        else:
+            key = data
+            value = None
+
+        checkpoint_extra_info[key] = value
+    return checkpoint_extra_info
+
+
+def extract_properties(args):
+    properties = {}
+    if args.properties is None:
+        return properties
+    for data in args.properties.split(','):
+        if '=' in data:
+            (resource_key, resource_value) = data.split('=', 1)
+        else:
+            raise exceptions.CommandError(
+                "Unable to parse parameter properties.")
+
+        properties[resource_key] = resource_value
+    return properties
+
+
+def extract_operation_definition(args):
+    operation_definition = {}
+    for data in args.operation_definition.split(','):
+        if '=' in data:
+            (resource_key, resource_value) = data.split('=', 1)
+        else:
+            raise exceptions.CommandError(
+                "Unable to parse parameter operation_definition.")
+
+        operation_definition[resource_key] = resource_value
+    return operation_definition

karborclient/v1/checkpoints.py

@@ -19,15 +19,26 @@ class Checkpoint(base.Resource):
     def __repr__(self):
         return "<Checkpoint %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
+    def get(self):
+        self.set_loaded(True)
+        if not hasattr(self.manager, 'get'):
+            return
+        plan = self.protection_plan
+        if plan is not None:
+            provider_id = plan.get("provider_id")
+            new = self.manager.get(provider_id, self.id)
+            if new:
+                self._add_details(new._info)
+        else:
+            return
 
 
 class CheckpointManager(base.ManagerWithFind):
     resource_class = Checkpoint
 
-    def create(self, provider_id, plan_id):
-        body = {'checkpoint': {'plan_id': plan_id}}
+    def create(self, provider_id, plan_id, checkpoint_extra_info=None):
+        body = {'checkpoint': {'plan_id': plan_id,
+                               'extra-info': checkpoint_extra_info}}
         url = "/providers/{provider_id}/" \
               "checkpoints" .format(provider_id=provider_id)
         return self._create(url, body, 'checkpoint')

karborclient/v1/client.py

@@ -14,12 +14,17 @@
 
 from karborclient.common import http
 from karborclient.v1 import checkpoints
+from karborclient.v1 import operation_logs
 from karborclient.v1 import plans
 from karborclient.v1 import protectables
 from karborclient.v1 import providers
+from karborclient.v1 import quota_classes
+from karborclient.v1 import quotas
 from karborclient.v1 import restores
 from karborclient.v1 import scheduled_operations
+from karborclient.v1 import services
 from karborclient.v1 import triggers
+from karborclient.v1 import verifications
 
 
 class Client(object):
@@ -42,3 +47,10 @@ class Client(object):
         self.triggers = triggers.TriggerManager(self.http_client)
         self.scheduled_operations = \
             scheduled_operations.ScheduledOperationManager(self.http_client)
+        self.operation_logs = \
+            operation_logs.OperationLogManager(self.http_client)
+        self.verifications = verifications.VerificationManager(
+            self.http_client)
+        self.services = services.ServiceManager(self.http_client)
+        self.quotas = quotas.QuotaManager(self.http_client)
+        self.quota_classes = quota_classes.QuotaClassManager(self.http_client)

karborclient/v1/operation_logs.py

@@ -0,0 +1,44 @@
+#    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.
+
+from karborclient.common import base
+
+
+class OperationLog(base.Resource):
+    def __repr__(self):
+        return "<OperationLog %s>" % self._info
+
+
+class OperationLogManager(base.ManagerWithFind):
+    resource_class = OperationLog
+
+    def get(self, operation_log_id, session_id=None):
+        if session_id:
+            headers = {'X-Configuration-Session': session_id}
+        else:
+            headers = {}
+        url = "/operation_logs/{operation_log_id}".format(
+            operation_log_id=operation_log_id)
+        return self._get(url, response_key="operation_log", headers=headers)
+
+    def list(self, detailed=False, search_opts=None, marker=None, limit=None,
+             sort_key=None, sort_dir=None, sort=None):
+        """Lists all operation_logs.
+
+        """
+        resource_type = "operation_logs"
+        url = self._build_list_url(
+            resource_type, detailed=detailed,
+            search_opts=search_opts, marker=marker,
+            limit=limit, sort_key=sort_key,
+            sort_dir=sort_dir, sort=sort)
+        return self._list(url, 'operation_logs')

karborclient/v1/plans.py

@@ -17,9 +17,6 @@ class Plan(base.Resource):
     def __repr__(self):
         return "<Plan %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class PlanManager(base.ManagerWithFind):
     resource_class = Plan

karborclient/v1/protectables.py

@@ -19,17 +19,11 @@ class Protectable(base.Resource):
     def __repr__(self):
         return "<Protectable %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class Instances(base.Resource):
     def __repr__(self):
         return "<Instances %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class ProtectableManager(base.ManagerWithFind):
     resource_class = Protectable
@@ -77,14 +71,27 @@ class ProtectableManager(base.ManagerWithFind):
             sort_dir=sort_dir, sort=sort)
         return self._list(url, response_key='instances', obj_class=Instances)
 
-    def get_instance(self, type, id, session_id=None):
+    def get_instance(self, type, id, search_opts=None, session_id=None):
         if session_id:
             headers = {'X-Configuration-Session': session_id}
         else:
             headers = {}
-        url = "/protectables/{protectable_type}/" \
-              "instances/{protectable_id}".format(protectable_type=type,
-                                                  protectable_id=id)
+
+        if search_opts is None:
+            search_opts = {}
+        query_params = {}
+        for key, val in search_opts.items():
+            if val:
+                query_params[key] = val
+        query_string = ""
+        if query_params:
+            params = sorted(query_params.items(), key=lambda x: x[0])
+            query_string = "?%s" % parse.urlencode(params)
+
+        url = ("/protectables/{protectable_type}/instances/"
+               "{protectable_id}{query_string}").format(
+            protectable_type=type, protectable_id=id,
+            query_string=query_string)
         return self._get(url, response_key="instance", headers=headers)
 
     def _build_instances_list_url(self, protectable_type,

karborclient/v1/providers.py

@@ -17,9 +17,6 @@ class Provider(base.Resource):
     def __repr__(self):
         return "<Provider %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class ProviderManager(base.ManagerWithFind):
     resource_class = Provider

karborclient/v1/quota_classes.py

@@ -0,0 +1,42 @@
+#    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.
+
+from karborclient.common import base
+
+
+class QuotaClass(base.Resource):
+    def __repr__(self):
+        return "<QuotaClass %s>" % self._info
+
+
+class QuotaClassManager(base.ManagerWithFind):
+    resource_class = QuotaClass
+
+    def list(self):
+        pass
+
+    def update(self, class_name, data):
+
+        body = {"quota_class": data}
+
+        return self._update('/quota_classes/{class_name}'
+                            .format(class_name=class_name),
+                            body, "quota_class")
+
+    def get(self, class_name, session_id=None):
+        if session_id:
+            headers = {'X-Configuration-Session': session_id}
+        else:
+            headers = {}
+        url = "/quota_classes/{class_name}".format(
+            class_name=class_name)
+        return self._get(url, response_key="quota_class", headers=headers)

karborclient/v1/quotas.py

@@ -0,0 +1,55 @@
+#    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.
+
+from karborclient.common import base
+
+
+class Quota(base.Resource):
+    def __repr__(self):
+        return "<Quota %s>" % self._info
+
+
+class QuotaManager(base.ManagerWithFind):
+    resource_class = Quota
+
+    def list(self):
+        pass
+
+    def update(self, project_id, data):
+
+        body = {"quota": data}
+
+        return self._update('/quotas/{project_id}'
+                            .format(project_id=project_id),
+                            body, "quota")
+
+    def get(self, project_id, detail, session_id=None):
+        if session_id:
+            headers = {'X-Configuration-Session': session_id}
+        else:
+            headers = {}
+        base_url = "/quotas/{project_id}".format(
+            project_id=project_id)
+        if detail:
+            url = base_url + '/detail'
+        else:
+            url = base_url
+        return self._get(url, response_key="quota", headers=headers)
+
+    def defaults(self, project_id, session_id=None):
+        if session_id:
+            headers = {'X-Configuration-Session': session_id}
+        else:
+            headers = {}
+        url = "/quotas/{project_id}/defaults".format(
+            project_id=project_id)
+        return self._get(url, response_key="quota", headers=headers)

karborclient/v1/restores.py

@@ -17,9 +17,6 @@ class Restore(base.Resource):
     def __repr__(self):
         return "<Restore %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class RestoreManager(base.ManagerWithFind):
     resource_class = Restore
@@ -38,11 +35,6 @@ class RestoreManager(base.ManagerWithFind):
         url = "/restores"
         return self._create(url, body, 'restore')
 
-    def delete(self, restore_id):
-        path = '/restores/{restore_id}'.format(
-            restore_id=restore_id)
-        return self._delete(path)
-
     def get(self, restore_id, session_id=None):
         if session_id:
             headers = {'X-Configuration-Session': session_id}

karborclient/v1/scheduled_operations.py

@@ -17,9 +17,6 @@ class ScheduledOperation(base.Resource):
     def __repr__(self):
         return "<ScheduledOperation %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class ScheduledOperationManager(base.ManagerWithFind):
     resource_class = ScheduledOperation

karborclient/v1/services.py

@@ -0,0 +1,64 @@
+#    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.
+
+from karborclient.common import base
+
+
+class Service(base.Resource):
+    def __repr__(self):
+        return "<Service %s>" % self._info
+
+
+class ServiceManager(base.ManagerWithFind):
+    resource_class = Service
+
+    def enable(self, service_id):
+        """Enable the service specified by the service ID
+
+        :param service_id: The ID of the service to enable.
+        """
+        body = {
+            'status': 'enabled'
+        }
+        return self._update('/os-services/%s' % service_id, body, "service")
+
+    def disable(self, service_id):
+        """Disable the service specified by the service ID.
+
+        :param service_id: The ID of the service to disable.
+        """
+        body = {
+            'status': 'disabled'
+        }
+        return self._update('/os-services/%s' % service_id, body, "service")
+
+    def disable_log_reason(self, service_id, reason):
+        """Disable the service with a reason.
+
+        :param service_id: The ID of the service to disable.
+        :param reason: The reason for disabling a service.
+        """
+        body = {
+            'status': 'disabled',
+            'disabled_reason': reason
+        }
+        return self._update("/os-services/%s" % service_id, body, "service")
+
+    def list(self, host=None, binary=None):
+        """Lists all services."""
+        search_opts = {
+            'host': host,
+            'binary': binary
+        }
+        resource_type = "os-services"
+        url = self._build_list_url(resource_type, search_opts=search_opts)
+        return self._list(url, 'services')

karborclient/v1/triggers.py

@@ -17,9 +17,6 @@ class Trigger(base.Resource):
     def __repr__(self):
         return "<Trigger %s>" % self._info
 
-    def data(self, **kwargs):
-        return self.manager.data(self, **kwargs)
-
 
 class TriggerManager(base.ManagerWithFind):
     resource_class = Trigger

karborclient/v1/verifications.py

@@ -0,0 +1,65 @@
+#    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.
+
+from karborclient.common import base
+
+
+class Verification(base.Resource):
+    def __repr__(self):
+        return "<Verification %s>" % self._info
+
+
+class VerificationManager(base.ManagerWithFind):
+    resource_class = Verification
+
+    def create(self, provider_id, checkpoint_id, parameters):
+        body = {
+            'verification': {
+                'provider_id': provider_id,
+                'checkpoint_id': checkpoint_id,
+                'parameters': parameters,
+            }
+        }
+        url = "/verifications"
+        return self._create(url, body, 'verification')
+
+    def get(self, verification_id, session_id=None):
+        if session_id:
+            headers = {'X-Configuration-Session': session_id}
+        else:
+            headers = {}
+        url = "/verifications/{verification_id}".format(
+            verification_id=verification_id)
+        return self._get(url, response_key="verification", headers=headers)
+
+    def list(self, detailed=False, search_opts=None, marker=None, limit=None,
+             sort_key=None, sort_dir=None, sort=None):
+        """Lists all verifications.
+
+        :param detailed: Whether to return detailed verification info.
+        :param search_opts: Search options to filter out verifications.
+        :param marker: Begin returning verifications that appear later in the
+                       list than that represented by this verification id.
+        :param limit: Maximum number of verifications to return.
+        :param sort_key: Key to be sorted;
+        :param sort_dir: Sort direction, should be 'desc' or 'asc';
+        :param sort: Sort information
+        :rtype: list of :class:`Verification`
+        """
+
+        resource_type = "verifications"
+        url = self._build_list_url(
+            resource_type, detailed=detailed,
+            search_opts=search_opts, marker=marker,
+            limit=limit, sort_key=sort_key,
+            sort_dir=sort_dir, sort=sort)
+        return self._list(url, 'verifications')

lower-constraints.txt

@@ -0,0 +1,88 @@
+alabaster==0.7.10
+appdirs==1.3.0
+asn1crypto==0.23.0
+Babel==2.3.4
+cffi==1.7.0
+cliff==2.8.0
+cmd2==0.8.0
+coverage==4.0
+cryptography==2.1
+debtcollector==1.2.0
+decorator==3.4.0
+deprecation==1.0
+docutils==0.11
+dogpile.cache==0.6.2
+dulwich==0.15.0
+extras==1.0.0
+fixtures==3.0.0
+flake8==2.5.5
+hacking==0.12.0
+idna==2.6
+imagesize==0.7.1
+iso8601==0.1.11
+Jinja2==2.10
+jmespath==0.9.0
+jsonpatch==1.16
+jsonpointer==1.13
+jsonschema==2.6.0
+keystoneauth1==3.4.0
+linecache2==1.0.0
+MarkupSafe==1.0
+mccabe==0.2.1
+mock==2.0.0
+monotonic==0.6
+mox3==0.20.0
+msgpack-python==0.4.0
+munch==2.1.0
+netaddr==0.7.18
+netifaces==0.10.4
+openstackdocstheme==1.18.1
+openstacksdk==0.11.2
+os-client-config==1.28.0
+os-service-types==1.2.0
+osc-lib==1.8.0
+oslo.config==5.2.0
+oslo.context==2.19.2
+oslo.i18n==3.15.3
+oslo.log==3.36.0
+oslo.serialization==2.18.0
+oslo.utils==3.33.0
+oslotest==3.2.0
+pbr==2.0.0
+pep8==1.5.7
+positional==1.2.1
+prettytable==0.7.1
+pycparser==2.18
+pyflakes==0.8.1
+Pygments==2.2.0
+pyinotify==0.9.6
+pyOpenSSL==17.1.0
+pyparsing==2.1.0
+pyperclip==1.5.27
+python-cinderclient==3.3.0
+python-dateutil==2.5.3
+python-glanceclient==2.8.0
+python-keystoneclient==3.8.0
+python-mimeparse==1.6.0
+python-novaclient==9.1.0
+python-openstackclient==3.12.0
+python-subunit==1.0.0
+pytz==2013.6
+PyYAML==3.12
+requests-mock==1.2.0
+requests==2.14.2
+requestsexceptions==1.2.0
+rfc3986==0.3.1
+simplejson==3.5.1
+six==1.10.0
+snowballstemmer==1.2.1
+Sphinx==1.6.2
+sphinxcontrib-websupport==1.0.1
+stevedore==1.20.0
+testrepository==0.0.18
+testscenarios==0.4
+testtools==2.2.0
+traceback2==1.4.0
+unittest2==1.1.0
+warlock==1.2.0
+wrapt==1.7.0

requirements.txt

@@ -1,13 +1,14 @@
 # The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
-pbr>=1.6 # Apache-2.0
-PrettyTable<0.8,>=0.7 # BSD
-python-keystoneclient!=2.1.0,>=2.0.0 # Apache-2.0
-requests>=2.10.0 # Apache-2.0
-simplejson>=2.2.0 # MIT
-Babel>=2.3.4 # BSD
-six>=1.9.0 # MIT
-oslo.utils>=3.16.0 # Apache-2.0
-oslo.log>=1.14.0 # Apache-2.0
-oslo.i18n>=2.1.0 # Apache-2.0
+pbr!=2.1.0,>=2.0.0 # Apache-2.0
+PrettyTable<0.8,>=0.7.1 # BSD
+keystoneauth1>=3.4.0 # Apache-2.0
+requests>=2.14.2 # Apache-2.0
+simplejson>=3.5.1 # MIT
+Babel!=2.4.0,>=2.3.4 # BSD
+six>=1.10.0 # MIT
+osc-lib>=1.8.0 # Apache-2.0
+oslo.utils>=3.33.0 # Apache-2.0
+oslo.log>=3.36.0 # Apache-2.0
+oslo.i18n>=3.15.3 # Apache-2.0

setup.cfg

@@ -5,7 +5,7 @@ description-file =
     README.rst
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
-home-page = http://docs.openstack.org/developer/karbor/
+home-page = https://docs.openstack.org/python-karborclient/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -16,8 +16,7 @@ classifier =
     Programming Language :: Python :: 2
     Programming Language :: Python :: 2.7
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.3
-    Programming Language :: Python :: 3.4
+    Programming Language :: Python :: 3.5
 
 [global]
 setup-hooks =
@@ -31,13 +30,64 @@ packages =
 console_scripts =
     karbor = karborclient.shell:main
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
+openstack.cli.extension =
+    data_protection = karborclient.osc.plugin
 
-[upload_sphinx]
-upload-dir = doc/build/html
+openstack.data_protection.v1 =
+    data_protection_plan_list = karborclient.osc.v1.plans:ListPlans
+    data_protection_plan_show = karborclient.osc.v1.plans:ShowPlan
+    data_protection_plan_create = karborclient.osc.v1.plans:CreatePlan
+    data_protection_plan_update = karborclient.osc.v1.plans:UpdatePlan
+    data_protection_plan_delete = karborclient.osc.v1.plans:DeletePlan
+    data_protection_restore_list = karborclient.osc.v1.restores:ListRestores
+    data_protection_restore_show = karborclient.osc.v1.restores:ShowRestore
+    data_protection_restore_create = karborclient.osc.v1.restores:CreateRestore
+    data_protection_provider_list = karborclient.osc.v1.providers:ListProviders
+    data_protection_provider_show = karborclient.osc.v1.providers:ShowProvider
+    data_protection_protectable_list = karborclient.osc.v1.protectables:ListProtectables
+    data_protection_protectable_show = karborclient.osc.v1.protectables:ShowProtectable
+    data_protection_protectable_instance_list = karborclient.osc.v1.protectables:ListProtectableInstances
+    data_protection_protectable_instance_show = karborclient.osc.v1.protectables:ShowProtectableInstance
+    data_protection_trigger_list = karborclient.osc.v1.triggers:ListTriggers
+    data_protection_trigger_show = karborclient.osc.v1.triggers:ShowTrigger
+    data_protection_trigger_create = karborclient.osc.v1.triggers:CreateTrigger
+    data_protection_trigger_update = karborclient.osc.v1.triggers:UpdateTrigger
+    data_protection_trigger_delete = karborclient.osc.v1.triggers:DeleteTrigger
+    data_protection_checkpoint_list = karborclient.osc.v1.checkpoints:ListCheckpoints
+    data_protection_checkpoint_show = karborclient.osc.v1.checkpoints:ShowCheckpoint
+    data_protection_checkpoint_create = karborclient.osc.v1.checkpoints:CreateCheckpoint
+    data_protection_checkpoint_delete = karborclient.osc.v1.checkpoints:DeleteCheckpoint
+    data_protection_scheduledoperation_list = karborclient.osc.v1.scheduled_operations:ListScheduledOperations
+    data_protection_scheduledoperation_show = karborclient.osc.v1.scheduled_operations:ShowScheduledOperation
+    data_protection_scheduledoperation_create = karborclient.osc.v1.scheduled_operations:CreateScheduledOperation
+    data_protection_scheduledoperation_delete = karborclient.osc.v1.scheduled_operations:DeleteScheduledOperation
+    data_protection_operationlog_list = karborclient.osc.v1.operation_logs:ListOperationLogs
+    data_protection_operationlog_show = karborclient.osc.v1.operation_logs:ShowOperationLog
+    data_protection_verification_list = karborclient.osc.v1.verifications:ListVerifications
+    data_protection_verification_show = karborclient.osc.v1.verifications:ShowVerification
+    data_protection_verification_create = karborclient.osc.v1.verifications:CreateVerification
+    data_protection_service_list = karborclient.osc.v1.services:ListServices
+    data_protection_service_enable = karborclient.osc.v1.services:EnableService
+    data_protection_service_disable = karborclient.osc.v1.services:DisableService
+    data_protection_quotas_show = karborclient.osc.v1.quotas:ShowQuotas
+    data_protection_quotas_default = karborclient.osc.v1.quotas:ShowDefaultQuotas
+    data_protection_quotas_update = karborclient.osc.v1.quotas:UpdateQuotas
+    data_protection_quotaclass_show = karborclient.osc.v1.quota_classes:ShowQuotaClasses
+    data_protection_quotaclass_update = karborclient.osc.v1.quota_classes:UpdateQuotaClasses
+
+[compile_catalog]
+directory = karborclient/locale
+domain = karborclient
+
+[update_catalog]
+domain = karborclient
+output_dir = karborclient/locale
+input_file = karborclient/locale/karborclient.pot
+
+[extract_messages]
+keywords = _ gettext ngettext l_ lazy_gettext
+mapping_file = babel.cfg
+output_file = karborclient/locale/karborclient.pot
 
 [wheel]
 universal = 1

setup.py

@@ -25,5 +25,5 @@ except ImportError:
     pass
 
 setuptools.setup(
-    setup_requires=['pbr>=1.8'],
+    setup_requires=['pbr>=2.0.0'],
     pbr=True)

test-requirements.txt

@@ -2,13 +2,14 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-hacking<0.11,>=0.10.2 # Apache-2.0
+hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
 
-coverage>=3.6 # Apache-2.0
-python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx!=1.3b1,<1.3,>=1.2.1 # BSD
-oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
-oslotest>=1.10.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
+python-subunit>=1.0.0 # Apache-2.0/BSD
+docutils>=0.11 # OSI-Approved Open Source, Public Domain
+oslotest>=3.2.0 # Apache-2.0
+python-openstackclient>=3.12.0 # Apache-2.0
+requests-mock>=1.2.0 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
-testtools>=1.4.0 # MIT
+testtools>=2.2.0 # MIT

tox.ini

@@ -1,40 +1,56 @@
 [tox]
-minversion = 1.6
-envlist = py34,py27,pypy,pep8
+minversion = 2.0
+envlist = py35,py27,pypy,pep8
 skipsdist = True
 
 [testenv]
 usedevelop = True
-install_command = pip install -U {opts} {packages}
+install_command = pip install {opts} {packages}
 setenv =
    VIRTUAL_ENV={envdir}
-deps = -r{toxinidir}/requirements.txt
+   PYTHONWARNINGS=default::DeprecationWarning
+deps =
+       -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+       -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
-commands = python setup.py test --slowest --testr-args='{posargs}'
+whitelist_externals = rm
+commands =
+  rm -f .testrepository/times.dbm
+  python setup.py test --slowest --testr-args='{posargs}'
 
 [testenv:pep8]
+basepython = python3
 commands = flake8
 
 [testenv:venv]
+basepython = python3
 commands = {posargs}
 
-[testenv:functional]
-setenv =
-  OS_TEST_PATH = ./karborclient/tests/functional
-passenv = OS_*
 [testenv:cover]
-commands = python setup.py test --coverage --testr-args='{posargs}'
+basepython = python3
+commands =
+  python setup.py test --coverage --testr-args='{posargs}'
+  coverage report
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+basepython = python3
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:debug]
-commands = oslo_debug_helper {posargs}
+basepython = python3
+commands = oslo_debug_helper -t karborclient/tests {posargs}
 
 [flake8]
-# E123, E125 skipped as they are invalid PEP-8.
 
 show-source = True
-ignore = E123,E125
+ignore =
 builtins = _
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
+
+[testenv:lower-constraints]
+basepython = python3
+deps =
+  -c{toxinidir}/lower-constraints.txt
+  -r{toxinidir}/test-requirements.txt
+  -r{toxinidir}/requirements.txt