Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I34f79cee33b7f5ad4a3adf0ad73f7e38052e921b

.gitreview

@@ -1,4 +1,4 @@
 [gerrit]
-host=review.openstack.org
+host=review.opendev.org
 port=29418
 project=openstack/python-karborclient.git

.zuul.yaml

@@ -3,8 +3,6 @@
       - check-requirements
       - openstack-cover-jobs
       - openstack-lower-constraints-jobs
-      - openstack-python-jobs
-      - openstack-python35-jobs
-      - openstack-python36-jobs
+      - openstack-python3-victoria-jobs
       - openstackclient-plugin-jobs
       - publish-openstack-docs-pti

README.rst

@@ -36,7 +36,7 @@ Karbor Mission Statement
 .. _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
+.. _Source: https://opendev.org/openstack/python-karborclient
 .. _Specs: https://docs.openstack.org/karbor/latest/specs/index.html
 .. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html
 

doc/requirements.txt

@@ -1,5 +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
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0

doc/source/conf.py

@@ -48,7 +48,7 @@ add_function_parentheses = True
 add_module_names = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # -- Options for HTML output --------------------------------------------------
 
@@ -59,10 +59,9 @@ 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'
+openstackdocs_repo_name = 'openstack/python-karborclient'
+openstackdocs_bug_project = 'python-karborclient'
+openstackdocs_bug_tag = ''
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project

karborclient/common/apiclient/client.py

@@ -25,14 +25,10 @@ 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_serialization import jsonutils
 from oslo_utils import importutils
 import requests
 
@@ -132,7 +128,7 @@ class HTTPClient(object):
     def serialize(self, kwargs):
         if kwargs.get('json') is not None:
             kwargs['headers']['Content-Type'] = 'application/json'
-            kwargs['data'] = json.dumps(kwargs['json'])
+            kwargs['data'] = jsonutils.dumps(kwargs['json'])
         try:
             del kwargs['json']
         except KeyError:

karborclient/common/apiclient/fake_client.py

@@ -24,7 +24,7 @@ places where actual behavior differs from the spec.
 # W0102: Dangerous default value %s as argument
 # pylint: disable=W0102
 
-import json
+from oslo_serialization import jsonutils
 
 import requests
 import six
@@ -58,7 +58,7 @@ class TestResponse(requests.Response):
             # Fake the text attribute to streamline Response creation
             text = data.get('text', "")
             if isinstance(text, (dict, list)):
-                self._content = json.dumps(text)
+                self._content = jsonutils.dumps(text)
                 default_headers = {
                     "Content-Type": "application/json",
                 }

karborclient/common/utils.py

@@ -12,13 +12,13 @@
 
 from __future__ import print_function
 
-import json
 import os
 import sys
 
 import six
 import uuid
 
+from oslo_serialization import jsonutils
 from oslo_utils import encodeutils
 
 import prettytable
@@ -138,7 +138,7 @@ def dict_prettyprint(val):
     :param val: dict.
     :return: formatted json string.
     """
-    return json.dumps(val, indent=2, sort_keys=True)
+    return jsonutils.dumps(val, indent=2, sort_keys=True)
 
 
 def json_prettyprint(val):
@@ -147,7 +147,8 @@ def json_prettyprint(val):
     :param val: json string.
     :return: formatted json string.
     """
-    return val and json.dumps(json.loads(val), indent=2, sort_keys=True)
+    return val and jsonutils.dumps(jsonutils.loads(val),
+                                   indent=2, sort_keys=True)
 
 
 def find_resource(manager, name_or_id, *args, **kwargs):

karborclient/osc/v1/checkpoints.py

@@ -12,10 +12,10 @@
 
 """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 oslo_serialization import jsonutils
 
 from karborclient.common.apiclient import exceptions
 from karborclient.i18n import _
@@ -28,7 +28,7 @@ def format_checkpoint(checkpoint_info):
         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'] = jsonutils.dumps(jsonutils.loads(
             checkpoint_info['resource_graph']), indent=2, sort_keys=True)
     checkpoint_info.pop("links", None)
 

karborclient/osc/v1/plans.py

@@ -12,7 +12,7 @@
 
 """Data protection V1 plan action implementations"""
 
-import json
+from oslo_serialization import jsonutils
 from oslo_utils import uuidutils
 
 from osc_lib.command import command
@@ -28,7 +28,8 @@ 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[key] = jsonutils.dumps(plan_info[key],
+                                         indent=2, sort_keys=True)
     plan_info.pop("links", None)
 
 

karborclient/osc/v1/protectables.py

@@ -13,10 +13,10 @@
 """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 oslo_serialization import jsonutils
 
 from karborclient.i18n import _
 from karborclient import utils
@@ -136,7 +136,8 @@ class ListProtectableInstances(command.Lister):
         column_headers = ['Id', 'Type', 'Name', 'Dependent resources',
                           'Extra info']
 
-        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        json_dumps = functools.partial(jsonutils.dumps,
+                                       indent=2, sort_keys=True)
         formatters = {
             "Extra info": json_dumps,
             "Dependent resources": json_dumps,
@@ -186,7 +187,8 @@ class ShowProtectableInstance(command.ShowOne):
             parsed_args.protectable_id,
             search_opts=search_opts)
 
-        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        json_dumps = functools.partial(jsonutils.dumps,
+                                       indent=2, sort_keys=True)
         instance._info.pop("links", None)
         for key in ('extra_info', 'dependent_resources'):
             if key not in instance._info:

karborclient/osc/v1/providers.py

@@ -13,10 +13,10 @@
 """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 oslo_serialization import jsonutils
 
 from karborclient.i18n import _
 
@@ -96,7 +96,8 @@ class ShowProvider(command.ShowOne):
         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)
+        json_dumps = functools.partial(jsonutils.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(

karborclient/osc/v1/restores.py

@@ -13,8 +13,8 @@
 """Data protection V1 restore action implementations"""
 
 import functools
-import json
 
+from oslo_serialization import jsonutils
 from oslo_utils import uuidutils
 
 from osc_lib.command import command
@@ -31,8 +31,8 @@ def format_restore(restore_info):
                 'resources_reason'):
         if key not in restore_info:
             continue
-        restore_info[key] = json.dumps(restore_info[key],
-                                       indent=2, sort_keys=True)
+        restore_info[key] = jsonutils.dumps(restore_info[key],
+                                            indent=2, sort_keys=True)
     restore_info.pop("links", None)
 
 
@@ -98,7 +98,9 @@ class ListRestores(command.Lister):
         column_headers = ['Id', 'Project id', 'Provider id', 'Checkpoint id',
                           'Restore target', 'Parameters', 'Status']
 
-        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        json_dumps = functools.partial(jsonutils.dumps,
+                                       indent=2,
+                                       sort_keys=True)
         formatters = {
             "Parameters": json_dumps,
         }

karborclient/osc/v1/scheduled_operations.py

@@ -13,9 +13,9 @@
 """Data protection V1 scheduled_operations action implementations"""
 
 import functools
-import json
 import six
 
+from oslo_serialization import jsonutils
 from oslo_utils import uuidutils
 
 from osc_lib.command import command
@@ -30,8 +30,8 @@ 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[key] = jsonutils.dumps(
+            scheduledoperation_info[key], indent=2, sort_keys=True)
     scheduledoperation_info.pop("links", None)
 
 
@@ -118,7 +118,9 @@ class ListScheduledOperations(command.Lister):
         column_headers = ['Id', 'Name', 'Operation Type', 'Trigger Id',
                           'Operation Definition']
 
-        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        json_dumps = functools.partial(jsonutils.dumps,
+                                       indent=2,
+                                       sort_keys=True)
         formatters = {
             "Operation Definition": json_dumps,
         }

karborclient/osc/v1/verifications.py

@@ -13,13 +13,13 @@
 """Data protection V1 verification action implementations"""
 
 import functools
-import json
 
+from oslo_log import log as logging
+from oslo_serialization import jsonutils
 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 _
@@ -31,8 +31,8 @@ def format_verification(verification_info):
                 'resources_reason'):
         if key not in verification_info:
             continue
-        verification_info[key] = json.dumps(verification_info[key],
-                                            indent=2, sort_keys=True)
+        verification_info[key] = jsonutils.dumps(verification_info[key],
+                                                 indent=2, sort_keys=True)
     verification_info.pop("links", None)
 
 
@@ -98,7 +98,9 @@ class ListVerifications(command.Lister):
         column_headers = ['Id', 'Project id', 'Provider id', 'Checkpoint id',
                           'Parameters', 'Status']
 
-        json_dumps = functools.partial(json.dumps, indent=2, sort_keys=True)
+        json_dumps = functools.partial(jsonutils.dumps,
+                                       indent=2,
+                                       sort_keys=True)
         formatters = {
             "Parameters": json_dumps,
         }

karborclient/shell.py

@@ -400,9 +400,9 @@ class KarborShell(object):
         if args.api_timeout:
             kwargs['timeout'] = args.api_timeout
 
-        client = karbor_client.Client(api_version, endpoint, **kwargs)
+        self.cs = karbor_client.Client(api_version, endpoint, **kwargs)
 
-        args.func(client, args)
+        args.func(self.cs, args)
 
     def do_bash_completion(self, args):
         """Prints all of the commands and options to stdout."""

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

@@ -12,7 +12,8 @@
 # limitations under the License.
 
 import copy
-import json
+
+from oslo_serialization import jsonutils
 
 from karborclient.osc.v1 import checkpoints as osc_checkpoints
 from karborclient.tests.unit.osc.v1 import fakes
@@ -32,7 +33,7 @@ CHECKPOINT_INFO = {
             "type": "OS::Glance::Image",
             "name": "cirros-0.3.4-x86_64-uec"}]
     },
-    "resource_graph": json.dumps(
+    "resource_graph": jsonutils.dumps(
         "[{'0x0': ['OS::Glance::Image', "
         "'99777fdd-8a5b-45ab-ba2c-52420008103f', "
         "'cirros-0.3.4-x86_64-uec']}, [[['0x0']]]]"
@@ -52,7 +53,7 @@ CHECKPOINT_INFO_2 = {
             "type": "OS::Glance::Image",
             "name": "cirros-0.3.4-x86_64-uec"}]
     },
-    "resource_graph": json.dumps(
+    "resource_graph": jsonutils.dumps(
         "[{'0x0': ['OS::Glance::Image', "
         "'99777fdd-8a5b-45ab-ba2c-52420008103f', "
         "'cirros-0.3.4-x86_64-uec']}, [[['0x0']]]]"

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

@@ -12,7 +12,8 @@
 # limitations under the License.
 
 import copy
-import json
+
+from oslo_serialization import jsonutils
 
 from karborclient.osc.v1 import restores as osc_restores
 from karborclient.tests.unit.osc.v1 import fakes
@@ -69,7 +70,7 @@ class TestListRestores(TestRestores):
                           "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
                           "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
                           "",
-                          json.dumps({}),
+                          jsonutils.dumps({}),
                           "success")]
         self.assertEqual(expected_data, list(data))
 

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

@@ -12,7 +12,8 @@
 # limitations under the License.
 
 import copy
-import json
+
+from oslo_serialization import jsonutils
 
 from karborclient.osc.v1 import verifications as osc_verifications
 from karborclient.tests.unit.osc.v1 import fakes
@@ -67,7 +68,7 @@ class TestListVerifications(TestVerifications):
                           "e486a2f49695423ca9c47e589b948108",
                           "cf56bd3e-97a7-4078-b6d5-f36246333fd9",
                           "dcb20606-ad71-40a3-80e4-ef0fafdad0c3",
-                          json.dumps({}),
+                          jsonutils.dumps({}),
                           "success")]
         self.assertEqual(expected_data, list(data))
 

karborclient/tests/unit/test_shell.py

@@ -133,9 +133,9 @@ class ShellCommandTest(ShellTest):
 
     def test_help(self):
         required = [
-            '.*?^usage: karbor',
-            '.*?^\s+plan-create\s+Creates a plan.',
-            '.*?^See "karbor help COMMAND" for help on a specific command',
+            r'.*?^usage: karbor',
+            r'.*?^\s+plan-create\s+Creates a plan.',
+            r'.*?^See "karbor help COMMAND" for help on a specific command',
         ]
         stdout, stderr = self.shell('help')
         for r in required:
@@ -144,8 +144,8 @@ class ShellCommandTest(ShellTest):
 
     def test_help_on_subcommand(self):
         required = [
-            '.*?^usage: karbor plan-create',
-            '.*?^Creates a plan.',
+            r'.*?^usage: karbor plan-create',
+            r'.*?^Creates a plan.',
         ]
         stdout, stderr = self.shell('help plan-create')
         for r in required:
@@ -154,9 +154,9 @@ class ShellCommandTest(ShellTest):
 
     def test_help_no_options(self):
         required = [
-            '.*?^usage: karbor',
-            '.*?^\s+plan-create\s+Creates a plan',
-            '.*?^See "karbor help COMMAND" for help on a specific command',
+            r'.*?^usage: karbor',
+            r'.*?^\s+plan-create\s+Creates a plan',
+            r'.*?^See "karbor help COMMAND" for help on a specific command',
         ]
         stdout, stderr = self.shell('')
         for r in required:

karborclient/tests/unit/v1/fakes.py

@@ -37,12 +37,13 @@ class FakeClient(fakes.FakeClient, client.Client):
             'project_id': PROJECT_ID,
         }
         client.Client.__init__(self, 'http://endpoint', **kwargs)
-        self.client = FakeHTTPClient(**kwargs)
+        self.client = self.http_client
 
 
 class FakeHTTPClient(base_client.HTTPClient):
 
-    def __init__(self, **kwargs):
+    def __init__(self, endpoint, **kwargs):
+        super(FakeHTTPClient, self)
         self.username = 'username'
         self.password = 'password'
         self.auth_url = 'auth_url'
@@ -50,6 +51,9 @@ class FakeHTTPClient(base_client.HTTPClient):
         self.management_url = 'http://10.0.2.15:8776/v1/fake'
         self.osapi_max_limit = 1000
         self.marker = None
+        self.project_id = 'project_id'
+        self.auth_token = 'auth_token'
+        self.region_name = 'region_name'
 
     def _cs_request(self, url, method, **kwargs):
         # Check that certain things are called correctly
@@ -92,3 +96,27 @@ class FakeHTTPClient(base_client.HTTPClient):
             "headers": headers,
         })
         return r, body
+
+    def json_request(self, method, url, **kwargs):
+        return self._cs_request(url, method, **kwargs)
+
+    def get_providers_1234_checkpoints(self, **kwargs):
+        return 200, {}, {"checkpoints": []}
+
+    def get_plans(self, **kwargs):
+        return 200, {}, {"plans": []}
+
+    def get_operation_logs(self, **kwargs):
+        return 200, {}, {"operation_logs": []}
+
+    def get_restores(self, **kwargs):
+        return 200, {}, {"restores": []}
+
+    def get_scheduled_operations(self, **kwargs):
+        return 200, {}, {"operations": []}
+
+    def get_triggers(self, **kwargs):
+        return 200, {}, {"triggers": []}
+
+    def get_verifications(self, **kwargs):
+        return 200, {}, {"verifications": []}

karborclient/tests/unit/v1/test_operation_logs.py

@@ -21,6 +21,22 @@ mock_request_return = ({}, {'operation_log': {}})
 
 class OperationLogsTest(base.TestCaseShell):
 
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_operation_logs(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.list()
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_operation_logs_with_all_tenants(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.operation_logs.list(search_opts={'all_tenants': 1})
+        mock_request.assert_called_with(
+            'GET',
+            '/operation_logs?all_tenants=1', headers={})
+
     @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

karborclient/tests/unit/v1/test_quota_classes.py

@@ -30,6 +30,15 @@ class QuotaClassesTest(base.TestCaseShell):
             '/quota_classes/default',
             data={'quota_class': {'plans': 50}}, headers={})
 
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_quota_class_update_with_none(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quota_classes.update('default', {'plans': None})
+        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
@@ -38,3 +47,12 @@ class QuotaClassesTest(base.TestCaseShell):
             'GET',
             '/quota_classes/default',
             headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_class_with_headers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quota_classes.get('default', session_id='fake_session_id')
+        mock_request.assert_called_with(
+            'GET',
+            '/quota_classes/default',
+            headers={'X-Configuration-Session': 'fake_session_id'})

karborclient/tests/unit/v1/test_quotas.py

@@ -30,6 +30,15 @@ class QuotasTest(base.TestCaseShell):
             '/quotas/{project_id}'.format(project_id=fakes.PROJECT_ID),
             data={'quota': {'plans': 50}}, headers={})
 
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_quota_update_with_none(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.update(fakes.PROJECT_ID, {'plans': None})
+        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
@@ -39,6 +48,15 @@ class QuotasTest(base.TestCaseShell):
             '/quotas/{project_id}'.format(project_id=fakes.PROJECT_ID),
             headers={})
 
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_with_headers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.get(fakes.PROJECT_ID, False, session_id='fake_session_id')
+        mock_request.assert_called_with(
+            'GET',
+            '/quotas/{project_id}'.format(project_id=fakes.PROJECT_ID),
+            headers={'X-Configuration-Session': 'fake_session_id'})
+
     @mock.patch('karborclient.common.http.HTTPClient.json_request')
     def test_show_quota_with_detail(self, mock_request):
         mock_request.return_value = mock_request_return
@@ -58,3 +76,13 @@ class QuotasTest(base.TestCaseShell):
             '/quotas/{project_id}/defaults'.format(
                 project_id=fakes.PROJECT_ID),
             headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_show_quota_default_with_headers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.quotas.defaults(fakes.PROJECT_ID, session_id='fake_session_id')
+        mock_request.assert_called_with(
+            'GET',
+            '/quotas/{project_id}/defaults'.format(
+                project_id=fakes.PROJECT_ID),
+            headers={'X-Configuration-Session': 'fake_session_id'})

karborclient/tests/unit/v1/test_shell.py

@@ -0,0 +1,137 @@
+#    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 fixtures
+import mock
+
+from karborclient import shell
+from karborclient.tests.unit import base
+from karborclient.tests.unit.v1 import fakes
+
+FAKE_PROVIDER_ID = '1234'
+FAKE_ENDPOINT = 'http://127.0.0.1/identity'
+
+
+class ShellFixture(fixtures.Fixture):
+    def setUp(self):
+        super(ShellFixture, self).setUp()
+        self.shell = shell.KarborShell()
+
+    def tearDown(self):
+        # For some method like test_image_meta_bad_action we are
+        # testing a SystemExit to be thrown and object self.shell has
+        # no time to get instantiated which is OK in this case, so
+        # we make sure the method is there before launching it.
+        if hasattr(self.shell, 'cs'):
+            self.shell.cs.clear_callstack()
+        super(ShellFixture, self).tearDown()
+
+
+class ShellTest(base.TestCaseShell):
+
+    FAKE_ENV = {
+        'OS_USERNAME': 'username',
+        'OS_PASSWORD': 'password',
+        'OS_TENANT_NAME': 'project_id',
+        'OS_AUTH_URL': 'http://no.where/v2.0',
+        'OS_AUTH_TOKEN': 'fake_token'
+    }
+
+    def setUp(self):
+        """Run before each test."""
+        super(ShellTest, self).setUp()
+        for var in self.FAKE_ENV:
+            self.useFixture(fixtures.EnvironmentVariable(
+                var, self.FAKE_ENV[var]))
+        self.shell = self.useFixture(ShellFixture()).shell
+
+        get_endpoint = mock.MagicMock()
+        get_endpoint.return_value = FAKE_ENDPOINT
+        self.useFixture(fixtures.MonkeyPatch(
+            'keystoneauth1.identity.generic.token.Token.get_endpoint',
+            get_endpoint))
+        self.useFixture(fixtures.MonkeyPatch('karborclient.client.Client',
+                                             fakes.FakeClient))
+        self.useFixture(fixtures.MonkeyPatch(
+            'karborclient.common.http._construct_http_client',
+            fakes.FakeHTTPClient))
+
+    def run_command(self, cmd):
+        if not isinstance(cmd, list):
+            cmd = cmd.split()
+        self.shell.main(cmd)
+
+    def assert_called(self, method, url, body=None, **kwargs):
+        return self.shell.cs.assert_called(method, url, body, **kwargs)
+
+    def test_checkpoint_list_with_all_tenants(self):
+        self.run_command(
+            'checkpoint-list ' + FAKE_PROVIDER_ID + ' --all-tenants 1')
+
+        self.assert_called('GET',
+                           '/providers/1234/'
+                           'checkpoints?all_tenants=1')
+
+    def test_checkpoint_list_with_all(self):
+        self.run_command(
+            'checkpoint-list ' + FAKE_PROVIDER_ID + ' --all')
+        self.assert_called('GET',
+                           '/providers/1234/'
+                           'checkpoints?all_tenants=1')
+
+    def test_plan_list_with_all_tenants(self):
+        self.run_command('plan-list --all-tenants 1')
+        self.assert_called('GET', '/plans?all_tenants=1')
+
+    def test_plan_list_with_all(self):
+        self.run_command('plan-list --all')
+        self.assert_called('GET', '/plans?all_tenants=1')
+
+    def test_resotre_list_with_all_tenants(self):
+        self.run_command('restore-list --all-tenants 1')
+        self.assert_called('GET', '/restores?all_tenants=1')
+
+    def test_resotre_list_with_all(self):
+        self.run_command('restore-list --all')
+        self.assert_called('GET', '/restores?all_tenants=1')
+
+    def test_verification_list_with_all_tenants(self):
+        self.run_command('verification-list --all-tenants 1')
+        self.assert_called('GET', '/verifications?all_tenants=1')
+
+    def test_verification_list_with_all(self):
+        self.run_command('verification-list --all')
+        self.assert_called('GET', '/verifications?all_tenants=1')
+
+    def test_trigger_list_with_all_tenants(self):
+        self.run_command('trigger-list --all-tenants 1')
+        self.assert_called('GET', '/triggers?all_tenants=1')
+
+    def test_trigger_list_with_all(self):
+        self.run_command('trigger-list --all')
+        self.assert_called('GET', '/triggers?all_tenants=1')
+
+    def test_scheduledoperation_list_with_all_tenants(self):
+        self.run_command('scheduledoperation-list --all-tenants 1')
+        self.assert_called('GET', '/scheduled_operations?all_tenants=1')
+
+    def test_scheduledoperation_list_with_all(self):
+        self.run_command('scheduledoperation-list --all')
+        self.assert_called('GET', '/scheduled_operations?all_tenants=1')
+
+    def test_operationlog_list_with_all_tenants(self):
+        self.run_command('operationlog-list --all-tenants 1')
+        self.assert_called('GET', '/operation_logs?all_tenants=1')
+
+    def test_operationlog_list_with_all(self):
+        self.run_command('operationlog-list --all')
+        self.assert_called('GET', '/operation_logs?all_tenants=1')

karborclient/tests/unit/v1/test_triggers.py

@@ -22,6 +22,22 @@ mock_request_return = ({}, {'trigger_info': {'name': 'fake_name'}})
 
 class TriggersTest(base.TestCaseShell):
 
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_triggers(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.triggers.list()
+        mock_request.assert_called_with(
+            'GET',
+            '/triggers', headers={})
+
+    @mock.patch('karborclient.common.http.HTTPClient.json_request')
+    def test_list_triggers_with_all_tenants(self, mock_request):
+        mock_request.return_value = mock_request_return
+        cs.triggers.list(search_opts={'all_tenants': 1})
+        mock_request.assert_called_with(
+            'GET',
+            '/triggers?all_tenants=1', headers={})
+
     @mock.patch('karborclient.common.http.HTTPClient.json_request')
     def test_list_triggers_with_marker_limit(self, mock_request):
         mock_request.return_value = mock_request_return
@@ -103,3 +119,9 @@ class TriggersTest(base.TestCaseShell):
             data=body,
             headers={}
         )
+
+    def test_update_trigger_with_invalid_window(self):
+        trigger_id = '123'
+        self.assertRaises(exceptions.CommandError,
+                          cs.triggers.update,
+                          trigger_id, {'properties': {'window': 'fake'}})

karborclient/v1/quota_classes.py

@@ -26,6 +26,9 @@ class QuotaClassManager(base.ManagerWithFind):
 
     def update(self, class_name, data):
 
+        if "plans" in data and data["plans"] is None:
+            data["plans"] = 50
+
         body = {"quota_class": data}
 
         return self._update('/quota_classes/{class_name}'

karborclient/v1/quotas.py

@@ -26,6 +26,9 @@ class QuotaManager(base.ManagerWithFind):
 
     def update(self, project_id, data):
 
+        if "plans" in data and data["plans"] is None:
+            data["plans"] = 50
+
         body = {"quota": data}
 
         return self._update('/quotas/{project_id}'

karborclient/v1/shell.py

@@ -11,10 +11,10 @@
 #    under the License.
 
 import argparse
-import json
 import os
 
 from datetime import datetime
+from oslo_serialization import jsonutils
 from oslo_utils import uuidutils
 
 from karborclient.common.apiclient import exceptions
@@ -31,11 +31,6 @@ from karborclient import utils as arg_utils
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--name',
            metavar='<name>',
            default=None,
@@ -200,7 +195,7 @@ def do_plan_update(cs, args):
     if args.name is not None:
         data['name'] = args.name
     if args.description is not None:
-            data['description'] = args.description
+        data['description'] = args.description
     if args.resources is not None:
         plan_resources = arg_utils.extract_resources(args)
         data['resources'] = plan_resources
@@ -286,11 +281,6 @@ def do_restore_create(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--status',
            metavar='<status>',
            default=None,
@@ -353,7 +343,7 @@ def do_restore_list(cs, args):
         sortby_index = None
     else:
         sortby_index = 0
-    formatters = {"Parameters": lambda obj: json.dumps(
+    formatters = {"Parameters": lambda obj: jsonutils.dumps(
         obj.parameters, indent=2, sort_keys=True)}
     utils.print_list(restores, key_list, exclude_unavailable=True,
                      sortby_index=sortby_index, formatters=formatters)
@@ -416,11 +406,6 @@ def do_verification_create(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--status',
            metavar='<status>',
            default=None,
@@ -486,7 +471,7 @@ def do_verification_list(cs, args):
         sortby_index = None
     else:
         sortby_index = 0
-    formatters = {"Parameters": lambda obj: json.dumps(
+    formatters = {"Parameters": lambda obj: jsonutils.dumps(
         obj.parameters, indent=2, sort_keys=True)}
     utils.print_list(verifications, key_list, exclude_unavailable=True,
                      sortby_index=sortby_index, formatters=formatters)
@@ -614,7 +599,7 @@ def do_protectable_list_instances(cs, args):
     else:
         sortby_index = 0
 
-    formatters = {"Dependent resources": lambda obj: json.dumps(
+    formatters = {"Dependent resources": lambda obj: jsonutils.dumps(
         obj.dependent_resources, indent=2, sort_keys=True)}
     utils.print_list(instances, key_list, exclude_unavailable=True,
                      sortby_index=sortby_index, formatters=formatters)
@@ -724,11 +709,6 @@ def do_checkpoint_create(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('provider_id',
            metavar='<provider_id>',
            help='ID of provider.')
@@ -917,11 +897,6 @@ def do_checkpoint_reset_state(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--name',
            metavar='<name>',
            default=None,
@@ -994,7 +969,7 @@ def do_trigger_list(cs, args):
     else:
         sortby_index = 0
 
-    formatters = {"Properties": lambda obj: json.dumps(
+    formatters = {"Properties": lambda obj: jsonutils.dumps(
         obj.properties, indent=2, sort_keys=True)}
     utils.print_list(triggers, key_list, exclude_unavailable=True,
                      sortby_index=sortby_index, formatters=formatters)
@@ -1073,11 +1048,6 @@ def do_trigger_delete(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--name',
            metavar='<name>',
            default=None,
@@ -1225,11 +1195,6 @@ def do_scheduledoperation_delete(cs, args):
            const=1,
            default=0,
            help='Shows details for all tenants. Admin only.')
-@utils.arg('--all_tenants',
-           nargs='?',
-           type=int,
-           const=1,
-           help=argparse.SUPPRESS)
 @utils.arg('--status',
            metavar='<status>',
            default=None,
@@ -1392,7 +1357,7 @@ def _quota_set_pretty_show(quotas):
     metavar='<plans>',
     type=int,
     default=None,
-    help='New value for the "plans" quota.')
+    help='New value for the "plans" quota. The default value is 50.')
 def do_quota_update(cs, args):
     """Update the quotas for a project (Admin only)."""
     project_id = args.tenant
@@ -1435,7 +1400,7 @@ def do_quota_class_show(cs, args):
     metavar='<plans>',
     type=int,
     default=None,
-    help='New value for the "plans" quota.')
+    help='New value for the "plans" quota. The default value is 50.')
 def do_quota_class_update(cs, args):
     """Update the quotas for a quota class (Admin only)."""
     class_name = args.class_name

lower-constraints.txt

@@ -36,7 +36,6 @@ 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
@@ -76,8 +75,6 @@ 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

releasenotes/notes/drop-py-2-7-7a92a5906980666b.yaml

@@ -0,0 +1,6 @@
+---
+upgrade:
+  - |
+    Python 2.7 support has been dropped. Last release of python-karborclient
+    to support python 2.7 is OpenStack Train. The minimum version of Python now
+    supported is Python 3.6.

setup.cfg

@@ -6,6 +6,7 @@ description-file =
 author = OpenStack
 author-email = openstack-discuss@lists.openstack.org
 home-page = https://docs.openstack.org/python-karborclient/latest/
+python-requires = >=3.6
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -13,15 +14,11 @@ classifier =
     License :: OSI Approved :: Apache Software License
     Operating System :: POSIX :: Linux
     Programming Language :: Python
-    Programming Language :: Python :: 2
-    Programming Language :: Python :: 2.7
+    Programming Language :: Python :: Implementation :: CPython
+    Programming Language :: Python :: 3 :: Only
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.5
     Programming Language :: Python :: 3.6
-
-[global]
-setup-hooks =
-    pbr.hooks.setup_hook
+    Programming Language :: Python :: 3.7
 
 [files]
 packages =
@@ -90,6 +87,3 @@ input_file = karborclient/locale/karborclient.pot
 keywords = _ gettext ngettext l_ lazy_gettext
 mapping_file = babel.cfg
 output_file = karborclient/locale/karborclient.pot
-
-[wheel]
-universal = 1

setup.py

@@ -13,17 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
 import setuptools
 
-# In python < 2.7.4, a lazy loading of package `pbr` will break
-# setuptools if some other modules registered functions in `atexit`.
-# solution from: http://bugs.python.org/issue15881#msg170215
-try:
-    import multiprocessing  # noqa
-except ImportError:
-    pass
-
 setuptools.setup(
     setup_requires=['pbr>=2.0.0'],
     pbr=True)

test-requirements.txt

@@ -2,7 +2,7 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
+hacking>=3.0,<3.1.0 # Apache-2.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 python-subunit>=1.0.0 # Apache-2.0/BSD

tox.ini

@@ -1,16 +1,18 @@
 [tox]
-minversion = 2.0
-envlist = py35,py27,pypy,pep8
+minversion = 3.1.1
+envlist = py37,pypy,pep8
 skipsdist = True
+ignore_basepython_conflict = True
 
 [testenv]
+basepython = python3
 usedevelop = True
 install_command = pip install {opts} {packages}
 setenv =
    VIRTUAL_ENV={envdir}
    PYTHONWARNINGS=default::DeprecationWarning
 deps =
-       -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+       -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
        -r{toxinidir}/requirements.txt
        -r{toxinidir}/test-requirements.txt
 whitelist_externals = rm
@@ -19,37 +21,33 @@ commands =
   python setup.py test --slowest --testr-args='{posargs}'
 
 [testenv:pep8]
-basepython = python3
 commands = flake8
 
 [testenv:venv]
-basepython = python3
 commands = {posargs}
 
 [testenv:cover]
-basepython = python3
 commands =
   python setup.py test --coverage --testr-args='{posargs}'
   coverage report
 
 [testenv:docs]
-basepython = python3
-deps = -r{toxinidir}/doc/requirements.txt
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:debug]
-basepython = python3
 commands = oslo_debug_helper -t karborclient/tests {posargs}
 
 [flake8]
 
 show-source = True
-ignore =
+ignore = W504
 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