Update TOX/UPPER_CONSTRAINTS_FILE for stable/train

Update the URL to the upper-constraints file to point to the redirect
rule on releases.openstack.org so that anyone working on this branch
will switch to the correct upper-constraints list automatically when
the requirements repository branches.

Until the requirements repository has as stable/train branch, tests will
continue to use the upper-constraints list on master.

Change-Id: I0abb4375f76549f4b06d0acfa257e754955736f7

.gitreview

@@ -2,4 +2,4 @@
 host=review.opendev.org
 port=29418
 project=openstack/python-watcherclient.git
-defaultbranch=stable/ussuri
+defaultbranch=stable/train

.zuul.yaml

@@ -2,7 +2,8 @@
     templates:
       - openstack-cover-jobs
       - openstack-lower-constraints-jobs
-      - openstack-python3-ussuri-jobs
+      - openstack-python-jobs
+      - openstack-python3-train-jobs
       - publish-openstack-docs-pti
       - check-requirements
       - openstackclient-plugin-jobs

doc/requirements.txt

@@ -2,7 +2,6 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
-openstackdocstheme>=1.32.1 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
-sphinxcontrib-apidoc>=0.2.0 # BSD
-
+openstackdocstheme>=1.18.1 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,>=1.6.5,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.5;python_version>='3.4' # BSD

doc/source/cli/details.rst

@@ -620,43 +620,38 @@ Create new audit template.
 ``--scope <path>``
   Part of the cluster on which an audit will be done.
   Can be provided either in yaml or json file.
-
-YAML example:
-::
-
-  ---
-  - host_aggregates:
-    - id: 1
-    - id: 2
-    - id: 3
+  YAML example:
+  ---- host_aggregates:
+  - id: 1
+  - id: 2
+  - id: 3
   - availability_zones:
-    - name: AZ1
-    - name: AZ2
+  - name: AZ1
+  - name: AZ2
   - exclude:
-    - instances:
-      - uuid: UUID1
-      - uuid: UUID2
-    - compute_nodes:
-      - name: compute1
-
-JSON example:
-::
-
-    [
-        {'host_aggregates': [
-            {'id': 1},
-            {'id': 2},
-            {'id': 3}]},
-        {'availability_zones': [
-            {'name': 'AZ1'},
-            {'name': 'AZ2'}]},
-        {'exclude': [
-            {'instances': [
-                {'uuid': 'UUID1'},
-                {'uuid': 'UUID2'}]},
-            {'compute_nodes': [
-                {'name': 'compute1'}]}]}
-    ]
+  - instances:
+  - uuid: UUID1
+  - uuid: UUID2
+  - compute_nodes:
+  - name: compute1
+  
+  JSON example:
+  [{'host_aggregates': [
+  {'id': 1},
+  {'id': 2},
+  {'id': 3}]},
+  {'availability_zones': [
+  {'name': 'AZ1'},
+  {'name': 'AZ2'}]},
+  {'exclude': [
+  {'instances': [
+  {'uuid': 'UUID1'},
+  {'uuid': 'UUID2'}
+  ]},
+  {'compute_nodes': [
+  {'name': 'compute1'}
+  ]}
+  ]}]
 
 .. _watcher_audittemplate_delete:
 

doc/source/conf.py

@@ -20,20 +20,12 @@ from watcherclient import version as watcherclient_version
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.viewcode',
-              'sphinxcontrib.apidoc',
               'openstackdocstheme',
              ]
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
 
-# sphinxcontrib.apidoc options
-apidoc_module_dir = '../../watcherclient'
-apidoc_output_dir = 'reference/api'
-apidoc_excluded_paths = [
-    'tests/*']
-apidoc_separate_modules = True
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -96,21 +88,12 @@ latex_documents = [
     ),
 ]
 
-# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
-latex_use_xindy = False
-
-latex_domain_indices = False
-
-latex_elements = {
-    'makeindex': '',
-    'printindex': '',
-    'preamble': r'\setcounter{tocdepth}{3}',
-}
-
 # openstackdocstheme options
 repository_name = 'openstack/python-watcherclient'
 bug_project = 'python-watcherclient'
 bug_tag = ''
 
+# Must set this variable to include year, month, day, hours, and minutes.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
 
 #html_theme_options = {"show_other_versions": "True"}

doc/source/reference/api/index.rst

@@ -0,0 +1,8 @@
+======================
+ Python API Reference
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   autoindex

doc/source/reference/index.rst

@@ -10,5 +10,5 @@ done so, you can use the API like so.
 .. toctree::
    :maxdepth: 2
 
-   api/modules
+   api/index
    api_v1

lower-constraints.txt

@@ -40,7 +40,7 @@ msgpack-python==0.4.0
 munch==2.2.0
 netaddr==0.7.19
 netifaces==0.10.6
-openstackdocstheme==1.32.1
+openstackdocstheme==1.18.1
 openstacksdk==0.12.0
 os-client-config==1.29.0
 os-service-types==1.2.0

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

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

setup.cfg

@@ -6,7 +6,6 @@ description-file =
 author = OpenStack
 author-email = openstack-discuss@lists.openstack.org
 home-page =  https://docs.openstack.org/python-watcherclient/latest/
-python-requires = >=3.6
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -14,6 +13,8 @@ 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 :: 3
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
@@ -113,6 +114,15 @@ autodoc_exclude_modules =
   watcherclient.tests.*
 api_doc_dir = reference/api
 
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+warning-is-error = 1
+
+[bdist_wheel]
+universal = 1
+
 [compile_catalog]
 directory = watcherclient/locale
 domain = watcherclient

setup.py

@@ -13,8 +13,17 @@
 # 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

@@ -4,7 +4,7 @@
 
 coverage!=4.4,>=4.0 # Apache-2.0
 fixtures>=3.0.0 # Apache-2.0/BSD
-hacking>=3.0,<3.1.0 # Apache-2.0
+hacking>=1.1.0,<1.2.0 # Apache-2.0
 mock>=2.0.0 # BSD
 oslotest>=3.2.0 # Apache-2.0
 python-subunit>=1.0.0 # Apache-2.0/BSD

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 minversion = 2.0
-envlist = py36,py37,pep8
+envlist = py36,py37,py27,pep8
 skipsdist = True
 
 [testenv]
@@ -11,7 +11,7 @@ install_command = pip install {opts} {packages}
 setenv =
    VIRTUAL_ENV={envdir}
 deps =
-  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/ussuri}
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/train}
   -r{toxinidir}/test-requirements.txt
   -r{toxinidir}/requirements.txt
 whitelist_externals =
@@ -43,23 +43,10 @@ commands =
 [testenv:docs]
 basepython = python3
 deps =
-  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/ussuri}
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/train}
   -r{toxinidir}/requirements.txt
   -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -W -b html doc/source doc/build/html
-
-
-[testenv:pdf-docs]
-basepython = python3
-envdir = {toxworkdir}/docs
-deps = {[testenv:docs]deps}
-whitelist_externals =
-  rm
-  make
-commands =
-  rm -rf doc/build/pdf
-  sphinx-build -W -b latex doc/source doc/build/pdf
-  make -C doc/build/pdf
+commands = python setup.py build_sphinx
 
 [testenv:debug]
 basepython = python3
@@ -69,7 +56,7 @@ commands = oslo_debug_helper -t watcherclient/tests/unit {posargs}
 # E123, E125 skipped as they are invalid PEP-8.
 show-source = True
 enable-extensions = H203,H106
-ignore = E123,E125,W504
+ignore = E123,E125
 builtins = _
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
 

watcherclient/common/httpclient.py

@@ -40,8 +40,8 @@ from watcherclient import exceptions
 
 # Record the latest version that this client was tested with.
 DEFAULT_VER = '1.latest'
-# Minor version 4 for adding webhook API
-LAST_KNOWN_API_VERSION = 4
+# Minor version 2 for adding force option to audit
+LAST_KNOWN_API_VERSION = 2
 LATEST_VERSION = '1.{}'.format(LAST_KNOWN_API_VERSION)
 
 LOG = logging.getLogger(__name__)

watcherclient/exceptions.py

@@ -71,7 +71,6 @@ class AmbiguousAuthSystem(exceptions.ClientException):
     """Could not obtain token and endpoint using provided credentials."""
     pass
 
-
 # Alias for backwards compatibility
 AmbigiousAuthSystem = AmbiguousAuthSystem
 

watcherclient/tests/unit/v1/test_audit_shell.py

@@ -426,23 +426,6 @@ class AuditShellTest(base.CommandTestCase):
             parameters={'para1': 10, 'para2': 20}
         )
 
-    def test_do_audit_create_with_type_event(self):
-        audit = resource.Audit(mock.Mock(), self.AUDIT_1)
-        self.m_audit_mgr.create.return_value = audit
-
-        exit_code, result = self.run_cmd(
-            'audit create -g fc087747-61be-4aad-8126-b701731ae836 -t EVENT')
-
-        self.assertEqual(0, exit_code)
-        self.assertEqual(
-            self.resource_as_dict(audit, self.FIELDS, self.FIELD_LABELS),
-            result)
-        self.m_audit_mgr.create.assert_called_once_with(
-            goal='fc087747-61be-4aad-8126-b701731ae836',
-            auto_trigger=False,
-            audit_type='EVENT'
-        )
-
     def test_do_audit_create_with_type_continuous(self):
         audit = resource.Audit(mock.Mock(), self.AUDIT_1)
         self.m_audit_mgr.create.return_value = audit
@@ -659,24 +642,6 @@ class AuditShellTestv12(AuditShellTest):
             force=False
         )
 
-    def test_do_audit_create_with_type_event(self):
-        audit = resource.Audit(mock.Mock(), self.AUDIT_1)
-        self.m_audit_mgr.create.return_value = audit
-
-        exit_code, result = self.run_cmd(
-            'audit create -g fc087747-61be-4aad-8126-b701731ae836 -t EVENT')
-
-        self.assertEqual(0, exit_code)
-        self.assertEqual(
-            self.resource_as_dict(audit, self.FIELDS, self.FIELD_LABELS),
-            result)
-        self.m_audit_mgr.create.assert_called_once_with(
-            goal='fc087747-61be-4aad-8126-b701731ae836',
-            auto_trigger=False,
-            audit_type='EVENT',
-            force=False
-        )
-
     def test_do_audit_create_with_name(self):
         audit = resource.Audit(mock.Mock(), self.AUDIT_1)
         self.m_audit_mgr.create.return_value = audit

watcherclient/v1/audit_shell.py

@@ -167,8 +167,8 @@ class CreateAudit(command.ShowOne):
             dest='audit_type',
             metavar='<audit_type>',
             default='ONESHOT',
-            choices=['ONESHOT', 'CONTINUOUS', 'EVENT'],
-            help=_("Audit type. It must be ONESHOT, CONTINUOUS or EVENT. "
+            choices=['ONESHOT', 'CONTINUOUS'],
+            help=_("Audit type. It must be ONESHOT or CONTINUOUS. "
                    "Default is ONESHOT."))
         parser.add_argument(
             '-p', '--parameter',
@@ -182,7 +182,7 @@ class CreateAudit(command.ShowOne):
             dest='interval',
             metavar='<interval>',
             help=_('Audit interval (in seconds or cron format). '
-                   'Cron interval can be used like: ``*/5 * * * *``. '
+                   'Cron inteval can be used like: "*/5 * * * *". '
                    'Only used if the audit is CONTINUOUS.'))
         parser.add_argument(
             '-g', '--goal',

watcherclient/v1/audit_template_shell.py

@@ -167,8 +167,8 @@ class CreateAuditTemplate(command.ShowOne):
             metavar='<path>',
             help=_("Part of the cluster on which an audit will be done.\n"
                    "Can be provided either in yaml or json file.\n"
-                   "YAML example::\n"
-                   "\n"
+                   "YAML example:\n"
+                   "---\n"
                    " - compute:\n"
                    "   - host_aggregates:\n"
                    "     - id: 1\n"
@@ -201,49 +201,48 @@ class CreateAuditTemplate(command.ShowOne):
                    "       - uuid: UUID1\n"
                    "       - uuid: UUID2\n"
                    "\n"
-                   "JSON example::\n"
-                   "\n"
-                   " [\n"
-                   "  {\"compute\":\n"
-                   "       [{\"host_aggregates\": [\n"
-                   "             {\"id\": 1},\n"
-                   "             {\"id\": 2},\n"
-                   "             {\"id\": 3}]},\n"
-                   "        {\"availability_zones\": [\n"
-                   "             {\"name\": \"AZ1\"},\n"
-                   "             {\"name\": \"AZ2\"}]},\n"
-                   "        {\"exclude\": [\n"
-                   "             {\"instances\": [\n"
-                   "                  {\"uuid\": \"UUID1\"},\n"
-                   "                  {\"uuid\": \"UUID2\"}\n"
-                   "             ]},\n"
-                   "             {\"compute_nodes\": [\n"
-                   "                  {\"name\": \"compute1\"}\n"
-                   "             ]}\n"
-                   "        ]}]\n"
-                   "   },\n"
-                   "  {\"storage\":\n"
-                   "       [{\"availability_zones\": [\n"
-                   "             {\"name\": \"AZ1\"},\n"
-                   "             {\"name\": \"AZ2\"}]},\n"
-                   "        {\"volume_types\": [\n"
-                   "             {\"name\": \"lvm1\"},\n"
-                   "             {\"name\": \"lvm2\"}]},\n"
-                   "        {\"exclude\": [\n"
-                   "             {\"storage_pools\": [\n"
-                   "                  {\"name\": \"host0@backend0#pool0\"},\n"
-                   "                  {\"name\": \"host1@backend1#pool1\"}\n"
-                   "             ]},\n"
-                   "             {\"volumes\": [\n"
-                   "                  {\"uuid\": \"UUID1\"},\n"
-                   "                  {\"uuid\": \"UUID2\"}\n"
-                   "             ]},\n"
-                   "             {\"projects\": [\n"
-                   "                  {\"uuid\": \"UUID1\"},\n"
-                   "                  {\"uuid\": \"UUID2\"}\n"
-                   "             ]},\n"
-                   "        ]}]\n"
-                   "   }\n"
+                   "JSON example:\n"
+                   "[\n"
+                   " {\"compute\":\n"
+                   "      [{\"host_aggregates\": [\n"
+                   "            {\"id\": 1},\n"
+                   "            {\"id\": 2},\n"
+                   "            {\"id\": 3}]},\n"
+                   "       {\"availability_zones\": [\n"
+                   "            {\"name\": \"AZ1\"},\n"
+                   "            {\"name\": \"AZ2\"}]},\n"
+                   "       {\"exclude\": [\n"
+                   "            {\"instances\": [\n"
+                   "                 {\"uuid\": \"UUID1\"},\n"
+                   "                 {\"uuid\": \"UUID2\"}\n"
+                   "            ]},\n"
+                   "            {\"compute_nodes\": [\n"
+                   "                 {\"name\": \"compute1\"}\n"
+                   "            ]}\n"
+                   "       ]}]\n"
+                   "  },\n"
+                   " {\"storage\":\n"
+                   "      [{\"availability_zones\": [\n"
+                   "            {\"name\": \"AZ1\"},\n"
+                   "            {\"name\": \"AZ2\"}]},\n"
+                   "       {\"volume_types\": [\n"
+                   "            {\"name\": \"lvm1\"},\n"
+                   "            {\"name\": \"lvm2\"}]},\n"
+                   "       {\"exclude\": [\n"
+                   "            {\"storage_pools\": [\n"
+                   "                 {\"name\": \"host0@backend0#pool0\"},\n"
+                   "                 {\"name\": \"host1@backend1#pool1\"}\n"
+                   "            ]},\n"
+                   "            {\"volumes\": [\n"
+                   "                 {\"uuid\": \"UUID1\"},\n"
+                   "                 {\"uuid\": \"UUID2\"}\n"
+                   "            ]},\n"
+                   "            {\"projects\": [\n"
+                   "                 {\"uuid\": \"UUID1\"},\n"
+                   "                 {\"uuid\": \"UUID2\"}\n"
+                   "            ]},\n"
+                   "       ]}]\n"
+                   "  }\n"
                    " ]\n"
                    )
         )