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

.zuul.yaml

@@ -3,9 +3,6 @@
       - check-requirements
       - openstack-cover-jobs
       - openstack-lower-constraints-jobs
-      - openstack-python-jobs
-      - openstack-python35-jobs
-      - openstack-python36-jobs
-      - openstack-python37-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/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/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_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

@@ -195,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
@@ -1357,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
@@ -1400,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,9 +1,11 @@
 [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 =
@@ -19,39 +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 =
   -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