Update .gitignore because of doc migration

This patch set updates .gitignore and fixes autodoc_exclude_modules Change-Id: If0e8a28c541b7e0711cc5a76ef93513c51080974
Updated from global requirements
2017-07-26 11:58:58 +03:00 · 2017-07-23 13:53:11 +00:00 · 2017-07-21 09:10:08 +00:00 · 2017-07-19 14:04:41 +00:00 · 2017-07-19 13:42:36 +00:00 · 2017-07-19 14:45:56 +03:00
91 changed files with 302 additions and 491 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,7 @@
 # Packages
 *.egg
 *.egg-info
+.eggs
 dist
 build
 eggs
@@ -42,7 +43,7 @@ output/*/index.html

 # Sphinx
 doc/build
-doc/source/api
+doc/source/reference/api

 # pbr generates these
 AUTHORS
@@ -55,3 +56,6 @@ ChangeLog

 sftp-config.json
 /.idea/
+
+# Desktop Service Store
+*.DS_Store
--- a/.gitreview
+++ b/.gitreview
@@ -1,5 +1,4 @@
 [gerrit]
-host=review.opendev.org
+host=review.openstack.org
 port=29418
 project=openstack/python-watcherclient.git
-defaultbranch=stable/ocata
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,12 +0,0 @@
- project:
-    templates:
-      - openstack-python-jobs
-      - openstack-python35-jobs
-      - publish-openstack-sphinx-docs
-      - check-requirements
-      - openstackclient-plugin-jobs
-    check:
-      jobs:
-        - openstack-tox-cover:
-            voting: false
-
--- a/README.rst
+++ b/README.rst
@@ -2,8 +2,8 @@
 Team and repository tags
 ========================

-.. image:: http://governance.openstack.org/badges/python-watcherclient.svg
-    :target: http://governance.openstack.org/reference/tags/index.html
+.. image:: https://governance.openstack.org/badges/python-watcherclient.svg
+    :target: https://governance.openstack.org/reference/tags/index.html

 .. Change things from this point on

--- a/doc/source/api/watcherclient.client.rst
+++ b/doc/source/api/watcherclient.client.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.client` Module
-======================================
-
-.. automodule:: watcherclient.client
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.apiclient.auth.rst
+++ b/doc/source/api/watcherclient.common.apiclient.auth.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.apiclient.auth` Module
-=====================================================
-
-.. automodule:: watcherclient.common.apiclient.auth
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.apiclient.base.rst
+++ b/doc/source/api/watcherclient.common.apiclient.base.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.apiclient.base` Module
-=====================================================
-
-.. automodule:: watcherclient.common.apiclient.base
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.apiclient.client.rst
+++ b/doc/source/api/watcherclient.common.apiclient.client.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.apiclient.client` Module
-=======================================================
-
-.. automodule:: watcherclient.common.apiclient.client
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.apiclient.exceptions.rst
+++ b/doc/source/api/watcherclient.common.apiclient.exceptions.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.apiclient.exceptions` Module
-===========================================================
-
-.. automodule:: watcherclient.common.apiclient.exceptions
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.apiclient.utils.rst
+++ b/doc/source/api/watcherclient.common.apiclient.utils.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.apiclient.utils` Module
-======================================================
-
-.. automodule:: watcherclient.common.apiclient.utils
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.base.rst
+++ b/doc/source/api/watcherclient.common.base.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.base` Module
-===========================================
-
-.. automodule:: watcherclient.common.base
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.cliutils.rst
+++ b/doc/source/api/watcherclient.common.cliutils.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.cliutils` Module
-===============================================
-
-.. automodule:: watcherclient.common.cliutils
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.http.rst
+++ b/doc/source/api/watcherclient.common.http.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.http` Module
-===========================================
-
-.. automodule:: watcherclient.common.http
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.i18n.rst
+++ b/doc/source/api/watcherclient.common.i18n.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.i18n` Module
-===========================================
-
-.. automodule:: watcherclient.common.i18n
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.common.utils.rst
+++ b/doc/source/api/watcherclient.common.utils.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.common.utils` Module
-============================================
-
-.. automodule:: watcherclient.common.utils
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.exceptions.rst
+++ b/doc/source/api/watcherclient.exceptions.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.exceptions` Module
-==========================================
-
-.. automodule:: watcherclient.exceptions
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.shell.rst
+++ b/doc/source/api/watcherclient.shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.shell` Module
-=====================================
-
-.. automodule:: watcherclient.shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.keystone_client_fixtures.rst
+++ b/doc/source/api/watcherclient.tests.keystone_client_fixtures.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.keystone_client_fixtures` Module
-==============================================================
-
-.. automodule:: watcherclient.tests.keystone_client_fixtures
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.test_client.rst
+++ b/doc/source/api/watcherclient.tests.test_client.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.test_client` Module
-=================================================
-
-.. automodule:: watcherclient.tests.test_client
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.test_http.rst
+++ b/doc/source/api/watcherclient.tests.test_http.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.test_http` Module
-===============================================
-
-.. automodule:: watcherclient.tests.test_http
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.test_import.rst
+++ b/doc/source/api/watcherclient.tests.test_import.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.test_import` Module
-=================================================
-
-.. automodule:: watcherclient.tests.test_import
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.test_shell.rst
+++ b/doc/source/api/watcherclient.tests.test_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.test_shell` Module
-================================================
-
-.. automodule:: watcherclient.tests.test_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.test_utils.rst
+++ b/doc/source/api/watcherclient.tests.test_utils.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.test_utils` Module
-================================================
-
-.. automodule:: watcherclient.tests.test_utils
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.utils.rst
+++ b/doc/source/api/watcherclient.tests.utils.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.utils` Module
-===========================================
-
-.. automodule:: watcherclient.tests.utils
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_action.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_action.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_action` Module
-====================================================
-
-.. automodule:: watcherclient.tests.v1.test_action
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_action_plan.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_action_plan.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_action_plan` Module
-=========================================================
-
-.. automodule:: watcherclient.tests.v1.test_action_plan
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_action_plan_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_action_plan_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_action_plan_shell` Module
-===============================================================
-
-.. automodule:: watcherclient.tests.v1.test_action_plan_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_action_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_action_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_action_shell` Module
-==========================================================
-
-.. automodule:: watcherclient.tests.v1.test_action_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_audit.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_audit.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_audit` Module
-===================================================
-
-.. automodule:: watcherclient.tests.v1.test_audit
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_audit_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_audit_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_audit_shell` Module
-=========================================================
-
-.. automodule:: watcherclient.tests.v1.test_audit_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_audit_template.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_audit_template.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_audit_template` Module
-============================================================
-
-.. automodule:: watcherclient.tests.v1.test_audit_template
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_audit_template_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_audit_template_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_audit_template_shell` Module
-==================================================================
-
-.. automodule:: watcherclient.tests.v1.test_audit_template_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_goal.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_goal.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_goal` Module
-==================================================
-
-.. automodule:: watcherclient.tests.v1.test_goal
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_goal_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_goal_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_goal_shell` Module
-========================================================
-
-.. automodule:: watcherclient.tests.v1.test_goal_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_metric_collector.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_metric_collector.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_metric_collector` Module
-==============================================================
-
-.. automodule:: watcherclient.tests.v1.test_metric_collector
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.tests.v1.test_metric_collector_shell.rst
+++ b/doc/source/api/watcherclient.tests.v1.test_metric_collector_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.tests.v1.test_metric_collector_shell` Module
-====================================================================
-
-.. automodule:: watcherclient.tests.v1.test_metric_collector_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.action.rst
+++ b/doc/source/api/watcherclient.v1.action.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.action` Module
-=========================================
-
-.. automodule:: watcherclient.v1.action
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.action_plan.rst
+++ b/doc/source/api/watcherclient.v1.action_plan.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.action_plan` Module
-==============================================
-
-.. automodule:: watcherclient.v1.action_plan
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.action_plan_shell.rst
+++ b/doc/source/api/watcherclient.v1.action_plan_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.action_plan_shell` Module
-====================================================
-
-.. automodule:: watcherclient.v1.action_plan_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.action_shell.rst
+++ b/doc/source/api/watcherclient.v1.action_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.action_shell` Module
-===============================================
-
-.. automodule:: watcherclient.v1.action_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.audit.rst
+++ b/doc/source/api/watcherclient.v1.audit.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.audit` Module
-========================================
-
-.. automodule:: watcherclient.v1.audit
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.audit_shell.rst
+++ b/doc/source/api/watcherclient.v1.audit_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.audit_shell` Module
-==============================================
-
-.. automodule:: watcherclient.v1.audit_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.audit_template.rst
+++ b/doc/source/api/watcherclient.v1.audit_template.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.audit_template` Module
-=================================================
-
-.. automodule:: watcherclient.v1.audit_template
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.audit_template_shell.rst
+++ b/doc/source/api/watcherclient.v1.audit_template_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.audit_template_shell` Module
-=======================================================
-
-.. automodule:: watcherclient.v1.audit_template_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.client.rst
+++ b/doc/source/api/watcherclient.v1.client.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.client` Module
-=========================================
-
-.. automodule:: watcherclient.v1.client
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.goal.rst
+++ b/doc/source/api/watcherclient.v1.goal.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.goal` Module
-=======================================
-
-.. automodule:: watcherclient.v1.goal
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.goal_shell.rst
+++ b/doc/source/api/watcherclient.v1.goal_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.goal_shell` Module
-=============================================
-
-.. automodule:: watcherclient.v1.goal_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.metric_collector.rst
+++ b/doc/source/api/watcherclient.v1.metric_collector.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.metric_collector` Module
-===================================================
-
-.. automodule:: watcherclient.v1.metric_collector
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.metric_collector_shell.rst
+++ b/doc/source/api/watcherclient.v1.metric_collector_shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.metric_collector_shell` Module
-=========================================================
-
-.. automodule:: watcherclient.v1.metric_collector_shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.resource_fields.rst
+++ b/doc/source/api/watcherclient.v1.resource_fields.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.resource_fields` Module
-==================================================
-
-.. automodule:: watcherclient.v1.resource_fields
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.v1.shell.rst
+++ b/doc/source/api/watcherclient.v1.shell.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.v1.shell` Module
-========================================
-
-.. automodule:: watcherclient.v1.shell
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/api/watcherclient.version.rst
+++ b/doc/source/api/watcherclient.version.rst
@@ -1,7 +0,0 @@
-The :mod:`watcherclient.version` Module
-=======================================
-
-.. automodule:: watcherclient.version
-  :members:
-  :undoc-members:
-  :show-inheritance:
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -0,0 +1,31 @@
+=============================
+ Command-line Tool Reference
+=============================
+
+In order to use the CLI, you must provide your OpenStack username,
+password, tenant, and auth endpoint. Use the corresponding
+configuration options (``--os-username``, ``--os-password``,
+``--os-tenant-id``, and ``--os-auth-url``) or set them in environment
+variables::
+
+    export OS_USERNAME=user
+    export OS_PASSWORD=pass
+    export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+
+The command line tool will attempt to reauthenticate using your
+provided credentials for every request. You can override this behavior
+by manually supplying an auth token using ``--os-watcher-url`` and
+``--os-auth-token``. You can alternatively set these environment
+variables::
+
+    export OS_WATCHER_URL=http://watcher.example.org:9322/
+    export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
+
+Once you've configured your authentication parameters, you can run
+``watcher help`` to see a complete listing of available commands.
+
+.. toctree::
+
+   watcher
+   openstack_cli
--- a/doc/source/cli/openstack_cli.rst
+++ b/doc/source/cli/openstack_cli.rst
@@ -24,9 +24,9 @@ OpenStack infra-optim Service (Watcher), by using our additional plugin

 In order to use the CLI, you must provide your OpenStack username, password,
 project (historically called tenant), and auth endpoint. You can use
-configuration options :option:`--os-username`, :option:`--os-password`,
-:option:`--os-tenant-id` (or :option:`--os-tenant-name`),
-and :option:`--os-auth-url`, or set the corresponding
+configuration options :option:``--os-username``, :option:``--os-password``,
+:option:``--os-tenant-id`` (or :option:``--os-tenant-name``),
+and :option:``--os-auth-url``, or set the corresponding
 environment variables::

    $ export OS_USERNAME=user
@@ -37,14 +37,14 @@ environment variables::

 The command-line tool will attempt to reauthenticate using the provided
 credentials for every request. You can override this behavior by manually
-supplying an auth token using :option:`--watcher-url` and
-:option:`--os-auth-token`, or by setting the corresponding environment variables::
+supplying an auth token using :option:``--watcher-url`` and
+:option:``--os-auth-token``, or by setting the corresponding environment variables::

    export WATCHER_URL=http://watcher.example.org:9322/
    export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

 Since Keystone can return multiple regions in the Service Catalog, you can
-specify the one you want with :option:`--os-region-name` or set the following
+specify the one you want with :option:``--os-region-name`` or set the following
 environment variable. (It defaults to the first in the list returned.)
 ::

--- a/doc/source/cli/watcher.rst
+++ b/doc/source/cli/watcher.rst
@@ -1,6 +1,6 @@
-==============================================
+===============================================
 :program:`watcher` Command-Line Interface (CLI)
-==============================================
+===============================================

 .. program:: watcher
 .. highlight:: bash
@@ -23,9 +23,9 @@ OpenStack infra-optim Service (Watcher).

 In order to use the CLI, you must provide your OpenStack username, password,
 project (historically called tenant), and auth endpoint. You can use
-configuration options :option:`--os-username`, :option:`--os-password`,
-:option:`--os-tenant-id` (or :option:`--os-tenant-name`),
-and :option:`--os-auth-url`, or set the corresponding
+configuration options :option:``--os-username``, :option:``--os-password``,
+:option:``--os-tenant-id`` (or :option:``--os-tenant-name``),
+and :option:``--os-auth-url``, or set the corresponding
 environment variables::

    $ export OS_USERNAME=user
@@ -36,14 +36,14 @@ environment variables::

 The command-line tool will attempt to reauthenticate using the provided
 credentials for every request. You can override this behavior by manually
-supplying an auth token using :option:`--watcher-url` and
-:option:`--os-auth-token`, or by setting the corresponding environment variables::
+supplying an auth token using :option:``--watcher-url`` and
+:option:``--os-auth-token``, or by setting the corresponding environment variables::

    $ export WATCHER_URL=http://watcher.example.org:9322/
    $ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155

 Since Keystone can return multiple regions in the Service Catalog, you can
-specify the one you want with :option:`--os-region-name` or set the following
+specify the one you want with :option:``--os-region-name`` or set the following
 environment variable. (It defaults to the first in the list returned.)
 ::

--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

+
 from watcherclient import version as watcherclient_version

 # -- General configuration ----------------------------------------------------
@@ -19,9 +20,8 @@ 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',
-              'oslosphinx',
-              ]
-
+              '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
@@ -69,7 +69,8 @@ pygments_style = 'sphinx'
 # html_theme_path = ["."]
 # html_theme = '_theme'
 # html_static_path = ['_static']
-html_theme_options = {'incubating': True}
+html_theme = 'openstackdocs'
+# html_theme_path = [openstackdocstheme.get_html_theme_path()]

 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
@@ -86,3 +87,13 @@ latex_documents = [
        u'OpenStack Foundation', 'manual'
    ),
 ]
+
+# 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"}
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1,8 +1,8 @@
 .. _contributing:

-===================================
+====================================
 Contributing to python-watcherclient
-===================================
+====================================

 If you're interested in contributing to the python-watcherclient project,
 the following will help get you started.
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,42 +1,15 @@
 Python bindings to the OpenStack Watcher API
 ============================================

-This is a client for OpenStack Watcher API. There's :doc:`a Python API
-<api_v1>` (the :mod:`watcherclient` modules), and a :doc:`command-line script
-<cli>` (installed as :program:`watcher`). Each implements the entire
+This is a client for OpenStack Watcher API. There's a Python API
+(the :mod:`watcherclient` modules), and a command-line script
+(installed as :program:`watcher`). Each implements the entire
 OpenStack Watcher API.

-You'll need credentials for an OpenStack cloud in order to use the watcher client.
-
-
-Contents:
-
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2

+   cli/index
+   reference/index
   installation
-   api_v1
-   cli
-   openstack_cli
   contributing
-
-Contributing
-============
-
-Code is hosted at `git.openstack.org`_. Submit bugs to the Watcher project on
-`Launchpad`_. Submit code to the openstack/python-watcherclient project using
-`Gerrit`_.
-
-.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-watcherclient
-.. _Launchpad: https://launchpad.net/watcher
-.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
-
-Testing
-------
-
-The preferred way to run the unit tests is using ``tox``.
-
-See `Consistent Testing Interface`_ for more details.
-
-.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst
-.. _Watcher: https://wiki.openstack.org/wiki/Watcher
--- a/doc/source/reference/api/index.rst
+++ b/doc/source/reference/api/index.rst
@@ -0,0 +1,8 @@
+======================
+ Python API Reference
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   autoindex
--- a/doc/source/reference/api_v1.rst
+++ b/doc/source/reference/api_v1.rst
@@ -80,12 +80,6 @@ Refer to the modules themselves, for more details.
 watcherclient Modules
 =====================

-.. toctree::
-    :maxdepth: 1
-
-    modules <api/autoindex>
-
-
 .. _watcherclient.v1.audit: api/watcherclient.v1.audit.html#watcherclient.v1.audit.Audit
 .. _watcherclient.v1.client.Client: api/watcherclient.v1.client.html#watcherclient.v1.client.Client
 .. _Client: api/watcherclient.v1.client.html#watcherclient.v1.client.Client
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,14 @@
+==========================
+ Python Library Reference
+==========================
+
+In order to use the python api directly, you must first obtain an auth
+token and identify which endpoint you wish to speak to. Once you have
+done so, you can use the API like so.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   api/index
+   api_v1
--- a/requirements.txt
+++ b/requirements.txt
@@ -2,13 +2,13 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.

-Babel>=2.3.4 # BSD
-cliff>=2.3.0 # Apache-2.0
-osc-lib>=1.2.0 # Apache-2.0
-oslo.i18n>=2.1.0 # Apache-2.0
-oslo.utils>=3.18.0 # Apache-2.0
-pbr>=1.8 # Apache-2.0
+Babel!=2.4.0,>=2.3.4 # BSD
+cliff>=2.8.0 # Apache-2.0
+osc-lib>=1.7.0 # Apache-2.0
+oslo.i18n!=3.15.2,>=2.1.0 # Apache-2.0
+oslo.utils>=3.20.0 # Apache-2.0
+pbr!=2.1.0,>=2.0.0 # Apache-2.0
 PrettyTable<0.8,>=0.7.1 # BSD
-keystoneauth1>=2.18.0 # Apache-2.0
+keystoneauth1>=3.0.1 # Apache-2.0
 six>=1.9.0 # MIT
 PyYAML>=3.10.0 # MIT
--- a/setup.cfg
+++ b/setup.cfg
@@ -16,7 +16,6 @@ classifier =
    Programming Language :: Python :: 2
    Programming Language :: Python :: 2.7
    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.4
    Programming Language :: Python :: 3.5

 [files]
@@ -55,6 +54,7 @@ openstack.infra_optim.v1 =
    optimize_actionplan_create = watcherclient.v1.action_plan_shell:CreateActionPlan
    optimize_actionplan_update = watcherclient.v1.action_plan_shell:UpdateActionPlan
    optimize_actionplan_start = watcherclient.v1.action_plan_shell:StartActionPlan
+    optimize_actionplan_cancel = watcherclient.v1.action_plan_shell:CancelActionPlan

    optimize_action_show = watcherclient.v1.action_shell:ShowAction
    optimize_action_list = watcherclient.v1.action_shell:ListAction
@@ -91,6 +91,7 @@ watcherclient.v1 =
    actionplan_update = watcherclient.v1.action_plan_shell:UpdateActionPlan
    actionplan_start = watcherclient.v1.action_plan_shell:StartActionPlan
    actionplan_delete = watcherclient.v1.action_plan_shell:DeleteActionPlan
+    actionplan_cancel = watcherclient.v1.action_plan_shell:CancelActionPlan

    action_show = watcherclient.v1.action_shell:ShowAction
    action_list = watcherclient.v1.action_shell:ListAction
@@ -103,11 +104,15 @@ watcherclient.v1 =

 [pbr]
 autodoc_index_modules = True
+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
--- a/setup.py
+++ b/setup.py
@@ -25,5 +25,5 @@ except ImportError:
    pass

 setuptools.setup(
-    setup_requires=['pbr>=1.8'],
+    setup_requires=['pbr>=2.0.0'],
    pbr=True)
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -2,17 +2,18 @@
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.

-coverage>=4.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
 fixtures>=3.0.0 # Apache-2.0/BSD
-hacking<0.11,>=0.10.2
+hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
 mock>=2.0 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
+sphinx>=1.6.2 # BSD
 testrepository>=0.0.18 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
+tempest>=16.1.0 # Apache-2.0

 # Needed for pypi packaging
 wheel # MIT
--- a/tox.ini
+++ b/tox.ini
@@ -1,18 +1,19 @@
 [tox]
 minversion = 1.8
-envlist = py35,py34,py27,pep8
+envlist = py35,py27,pep8
 skipsdist = True

 [testenv]
 usedevelop = True
 install_command =
-                  constraints: pip install -U --force-reinstall -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt?h=stable/ocata} {opts} {packages}
+                  constraints: pip install -U --force-reinstall -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
                  pip install -U {opts} {packages}
 setenv =
   VIRTUAL_ENV={envdir}
   OS_TEST_PATH=./watcherclient/tests/unit
 deps = -r{toxinidir}/test-requirements.txt
-commands = python setup.py testr --slowest --testr-args='{posargs}'
+commands = rm -f .testrepository/times.dbm
+           python setup.py testr --slowest --testr-args='{posargs}'

 [testenv:pep8]
 commands = flake8
@@ -29,11 +30,27 @@ commands =
 commands = python setup.py build_sphinx

 [testenv:debug]
-commands = oslo_debug_helper {posargs}
+commands = oslo_debug_helper -t watcherclient/tests/unit {posargs}
+
+[testenv:functional]
+basepython = python2.7
+passenv =
+  OS_PROJECT_DOMAIN_NAME
+  OS_USER_DOMAIN_NAME
+  OS_PROJECT_NAME
+  OS_USERNAME
+  OS_PASSWORD
+  OS_AUTH_URL
+  OS_IDENTITY_API_VERSION
+  OS_IMAGE_API_VERSION
+setenv =
+  OS_TEST_PATH = ./watcherclient/tests/functional
+commands = python setup.py testr --slowest --testr-args='--concurrency=1 {posargs}'

 [flake8]
 # E123, E125 skipped as they are invalid PEP-8.
 show-source = True
+enable-extensions = H203,H106
 ignore = E123,E125
 builtins = _
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build
--- a/watcherclient/_i18n.py
+++ b/watcherclient/_i18n.py
@@ -30,16 +30,6 @@ _C = _translators.contextual_form
 # requires oslo.i18n >=2.1.0
 _P = _translators.plural_form

-# 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
-

 def get_available_languages():
    return oslo_i18n.get_available_languages(DOMAIN)
--- a/watcherclient/common/api_versioning.py
+++ b/watcherclient/common/api_versioning.py
@@ -18,7 +18,7 @@ import re

 from oslo_utils import strutils

-from watcherclient._i18n import _, _LW
+from watcherclient._i18n import _
 from watcherclient import exceptions

 LOG = logging.getLogger(__name__)
@@ -202,8 +202,8 @@ def get_api_version(version_string):
    version_string = str(version_string)
    if version_string in DEPRECATED_VERSIONS:
        LOG.warning(
-            _LW("Version %(deprecated_version)s is deprecated, using "
-                "alternative version %(alternative)s instead."),
+            "Version %(deprecated_version)s is deprecated, using "
+            "alternative version %(alternative)s instead.",
            {"deprecated_version": version_string,
             "alternative": DEPRECATED_VERSIONS[version_string]})
        version_string = DEPRECATED_VERSIONS[version_string]
--- a/watcherclient/common/cliutils.py
+++ b/watcherclient/common/cliutils.py
@@ -204,6 +204,8 @@ def print_dict(dct, dict_property="Property", wrap=0):
            v = six.text_type(v)
        if wrap > 0:
            v = textwrap.fill(six.text_type(v), wrap)
+        elif wrap < 0:
+            raise ValueError(_("Wrap argument should be a positive integer"))
        # if value has a newline, add in multiple rows
        # e.g. fault with stacktrace
        if v and isinstance(v, six.string_types) and r'\n' in v:
--- a/watcherclient/common/httpclient.py
+++ b/watcherclient/common/httpclient.py
@@ -17,7 +17,6 @@ import copy
 from distutils import version
 import functools
 import hashlib
-import json
 import logging
 import os
 import socket
@@ -27,13 +26,14 @@ import time

 from keystoneauth1 import adapter
 from keystoneauth1 import exceptions as kexceptions
+from oslo_serialization import jsonutils
 from oslo_utils import strutils
 import requests
 import six
 from six.moves import http_client
 import six.moves.urllib.parse as urlparse

-from watcherclient._i18n import _, _LE, _LW
+from watcherclient._i18n import _
 from watcherclient import exceptions


@@ -70,10 +70,10 @@ def _extract_error_json(body):
    """Return  error_message from the HTTP response body."""
    error_json = {}
    try:
-        body_json = json.loads(body)
+        body_json = jsonutils.loads(body)
        if 'error_message' in body_json:
            raw_msg = body_json['error_message']
-            error_json = json.loads(raw_msg)
+            error_json = jsonutils.loads(raw_msg)
    except ValueError:
        pass

@@ -185,8 +185,8 @@ def with_retries(func):
            try:
                return func(self, url, method, **kwargs)
            except _RETRY_EXCEPTIONS as error:
-                msg = (_LE("Error contacting Watcher server: %(error)s. "
-                           "Attempt %(attempt)d of %(total)d") %
+                msg = ("Error contacting Watcher server: %(error)s. "
+                       "Attempt %(attempt)d of %(total)d" %
                       {'attempt': attempt,
                        'total': num_attempts,
                        'error': error})
@@ -382,7 +382,7 @@ class HTTPClient(VersionNegotiationMixin):
        kwargs['headers'].setdefault('Accept', 'application/json')

        if 'body' in kwargs:
-            kwargs['body'] = json.dumps(kwargs['body'])
+            kwargs['body'] = jsonutils.dumps(kwargs['body'])

        resp, body_iter = self._http_request(url, method, **kwargs)
        content_type = resp.headers.get('Content-Type')
@@ -395,9 +395,9 @@ class HTTPClient(VersionNegotiationMixin):
        if 'application/json' in content_type:
            body = ''.join([chunk for chunk in body_iter])
            try:
-                body = json.loads(body)
+                body = jsonutils.loads(body)
            except ValueError:
-                LOG.error(_LE('Could not decode response body as JSON'))
+                LOG.error('Could not decode response body as JSON')
        else:
            body = None

@@ -545,7 +545,7 @@ class SessionClient(VersionNegotiationMixin, adapter.LegacyJsonAdapter):
        kwargs['headers'].setdefault('Accept', 'application/json')

        if 'body' in kwargs:
-            kwargs['data'] = json.dumps(kwargs.pop('body'))
+            kwargs['data'] = jsonutils.dumps(kwargs.pop('body'))

        resp = self._http_request(url, method, **kwargs)
        body = resp.content
@@ -558,7 +558,7 @@ class SessionClient(VersionNegotiationMixin, adapter.LegacyJsonAdapter):
            try:
                body = resp.json()
            except ValueError:
-                LOG.error(_LE('Could not decode response body as JSON'))
+                LOG.error('Could not decode response body as JSON')
        else:
            body = None

@@ -602,8 +602,8 @@ def _construct_http_client(endpoint=None,
        dvars = [k for k, v in ignored.items() if v]

        if dvars:
-            LOG.warning(_LW('The following arguments are ignored when using '
-                            'the session to construct a client: %s'),
+            LOG.warning('The following arguments are ignored when using '
+                        'the session to construct a client: %s',
                        ', '.join(dvars))

        return SessionClient(session=session,
@@ -615,8 +615,8 @@ def _construct_http_client(endpoint=None,
                             **kwargs)
    else:
        if kwargs:
-            LOG.warning(_LW('The following arguments are being ignored when '
-                            'constructing the client: %s'), ', '.join(kwargs))
+            LOG.warning('The following arguments are being ignored when '
+                        'constructing the client: %s', ', '.join(kwargs))

        return HTTPClient(endpoint=endpoint,
                          token=token,
--- a/watcherclient/common/utils.py
+++ b/watcherclient/common/utils.py
@@ -17,11 +17,11 @@
 from __future__ import print_function

 import argparse
-import json
 import os
 import uuid
 import yaml

+from oslo_serialization import jsonutils
 from oslo_utils import importutils

 from watcherclient._i18n import _
@@ -89,7 +89,7 @@ def split_and_deserialize(string):
        raise exc.CommandError(_('Attributes must be a list of '
                                 'PATH=VALUE not "%s"') % string)
    try:
-        value = json.loads(value)
+        value = jsonutils.loads(value)
    except ValueError:
        pass

--- a/watcherclient/tests/README.rst
+++ b/watcherclient/tests/README.rst
@@ -16,7 +16,7 @@ Functional tests
 The following procedure gets you started with Tempest testing but you can also
 refer to the `Tempest documentation`_ for more details.

-.. _Tempest documentation: http://docs.openstack.org/developer/tempest/
+.. _Tempest documentation: https://docs.openstack.org/tempest/latest/


 Tempest installation
@@ -52,7 +52,7 @@ variables.
 To run functional tests you need to go to python-watcherclient folder, install
 all requirements and execute ``tempest run`` command::

-    $ pip install -r requirements.txt test-requirements.txt
+    $ pip install -r requirements.txt -r test-requirements.txt
    $ pip install .
    $ tempest run --regex watcherclient.tests.functional

--- a/watcherclient/tests/functional/hooks/post_test_hook.sh
+++ b/watcherclient/tests/functional/hooks/post_test_hook.sh
@@ -0,0 +1,53 @@
+#!/bin/bash -xe
+
+# 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.
+
+# This script is executed inside post_test_hook function in devstack gate.
+
+# Default gate uses /opt/stack/new... but some of us may install differently
+STACK_DIR=$BASE/new/devstack
+
+function generate_testr_results {
+    if [ -f .testrepository/0 ]; then
+        sudo .tox/functional/bin/testr last --subunit > $WORKSPACE/testrepository.subunit
+        sudo mv $WORKSPACE/testrepository.subunit $BASE/logs/testrepository.subunit
+        sudo /usr/os-testr-env/bin/subunit2html $BASE/logs/testrepository.subunit $BASE/logs/testr_results.html
+        sudo gzip -9 $BASE/logs/testrepository.subunit
+        sudo gzip -9 $BASE/logs/testr_results.html
+        sudo chown jenkins:jenkins $BASE/logs/testrepository.subunit.gz $BASE/logs/testr_results.html.gz
+        sudo chmod a+r $BASE/logs/testrepository.subunit.gz $BASE/logs/testr_results.html.gz
+    fi
+}
+
+export WATCHERCLIENT_DIR="$BASE/new/python-watcherclient"
+
+sudo chown -R jenkins:stack $WATCHERCLIENT_DIR
+
+# Get admin credentials
+cd $STACK_DIR
+source openrc admin admin
+
+# Go to the watcherclient dir
+cd $WATCHERCLIENT_DIR
+
+# Run tests
+echo "Running watcherclient functional test suite"
+set +e
+# Preserve env for OS_ credentials
+sudo -E -H -u jenkins tox -efunctional
+EXIT_CODE=$?
+set -e
+
+# Collect and parse result
+generate_testr_results
+exit $EXIT_CODE
--- a/watcherclient/tests/functional/v1/test_action.py
+++ b/watcherclient/tests/functional/v1/test_action.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_action_plan.py
+++ b/watcherclient/tests/functional/v1/test_action_plan.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_audit.py
+++ b/watcherclient/tests/functional/v1/test_audit.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +25,8 @@ class AuditTests(base.TestCase):
    list_fields = ['UUID', 'Audit Type', 'State', 'Goal', 'Strategy']
    detailed_list_fields = list_fields + ['Created At', 'Updated At',
                                          'Deleted At', 'Parameters',
-                                          'Interval', 'Audit Scope']
+                                          'Interval', 'Audit Scope',
+                                          'Next Run Time']
    audit_template_name = 'a' + uuidutils.generate_uuid()
    audit_uuid = None

--- a/watcherclient/tests/functional/v1/test_audit_template.py
+++ b/watcherclient/tests/functional/v1/test_audit_template.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_goal.py
+++ b/watcherclient/tests/functional/v1/test_goal.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_scoring_engine.py
+++ b/watcherclient/tests/functional/v1/test_scoring_engine.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_service.py
+++ b/watcherclient/tests/functional/v1/test_service.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/functional/v1/test_strategy.py
+++ b/watcherclient/tests/functional/v1/test_strategy.py
@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 # Copyright (c) 2016 Servionica
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
--- a/watcherclient/tests/unit/common/test_api_versioning.py
+++ b/watcherclient/tests/unit/common/test_api_versioning.py
@@ -82,12 +82,12 @@ class APIVersionTestCase(utils.BaseTestCase):
        v4 = api_versioning.APIVersion("2.0")
        v_null = api_versioning.APIVersion()

-        self.assertTrue(v1 < v2)
-        self.assertTrue(v3 > v2)
-        self.assertTrue(v1 != v2)
-        self.assertTrue(v1 == v4)
-        self.assertTrue(v1 != v_null)
-        self.assertTrue(v_null == v_null)
+        self.assertLess(v1, v2)
+        self.assertGreater(v3, v2)
+        self.assertNotEqual(v1, v2)
+        self.assertEqual(v1, v4)
+        self.assertNotEqual(v1, v_null)
+        self.assertEqual(v_null, v_null)
        self.assertRaises(TypeError, v1.__le__, "2.1")

    def test_version_matches(self):
--- a/watcherclient/tests/unit/keystone_client_fixtures.py
+++ b/watcherclient/tests/unit/keystone_client_fixtures.py
@@ -10,7 +10,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.

-import json
+from oslo_serialization import jsonutils
 from oslo_utils import uuidutils

 from keystoneauth1.fixture import v2 as ks_v2_fixture
@@ -53,11 +53,11 @@ TOKENID = uuidutils.generate_uuid(dashed=False)


 def _create_version_list(versions):
-    return json.dumps({'versions': {'values': versions}})
+    return jsonutils.dumps({'versions': {'values': versions}})


 def _create_single_version(version):
-    return json.dumps({'version': version})
+    return jsonutils.dumps({'version': version})


 V3_VERSION_LIST = _create_version_list([V3_VERSION, V2_VERSION])
@@ -74,8 +74,8 @@ def keystone_request_callback(request, uri, headers):
        return (200, headers, V3_VERSION_LIST)
    elif uri == BASE_URL + "/v2.0":
        v2_token = ks_v2_fixture.Token(token_id)
-        return (200, response_headers, json.dumps(v2_token))
+        return (200, response_headers, jsonutils.dumps(v2_token))
    elif uri == BASE_URL + "/v3":
        v3_token = ks_v3_fixture.Token()
        response_headers["X-Subject-Token"] = token_id
-        return (201, response_headers, json.dumps(v3_token))
+        return (201, response_headers, jsonutils.dumps(v3_token))
--- a/watcherclient/tests/unit/v1/base.py
+++ b/watcherclient/tests/unit/v1/base.py
@@ -13,11 +13,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-import json
 import shlex

 import mock
 from osc_lib import utils as oscutils
+from oslo_serialization import jsonutils

 from watcherclient.common import httpclient
 from watcherclient.tests.unit import utils
@@ -55,7 +55,7 @@ class CommandTestCase(utils.BaseTestCase):
    def run_cmd(self, cmd, formatting='json'):
        if formatting:
            formatter_arg = " -f %s" % formatting
-            formatter = json.loads
+            formatter = jsonutils.loads
        else:
            formatter_arg = ''
            formatter = str
--- a/watcherclient/tests/unit/v1/test_action_plan_shell.py
+++ b/watcherclient/tests/unit/v1/test_action_plan_shell.py
@@ -257,3 +257,25 @@ class ActionPlanShellTest(base.CommandTestCase):

        self.assertEqual(1, exit_code)
        self.assertEqual('', result)
+
+    def test_do_action_plan_cancel(self):
+        action_plan = resource.ActionPlan(mock.Mock(), ACTION_PLAN_1)
+        self.m_action_plan_mgr.cancel.return_value = action_plan
+
+        exit_code, result = self.run_cmd(
+            'actionplan cancel 5869da81-4876-4687-a1ed-12cd64cf53d9')
+
+        self.assertEqual(0, exit_code)
+        self.assertEqual(
+            self.resource_as_dict(action_plan, self.FIELDS, self.FIELD_LABELS),
+            result)
+        self.m_action_plan_mgr.cancel.assert_called_once_with(
+            '5869da81-4876-4687-a1ed-12cd64cf53d9')
+
+    def test_do_action_plan_cancel_not_uuid(self):
+        exit_code, result = self.run_cmd(
+            'actionplan cancel not_uuid',
+            formatting=None)
+
+        self.assertEqual(1, exit_code)
+        self.assertEqual('', result)
--- a/watcherclient/tests/unit/v1/test_audit_shell.py
+++ b/watcherclient/tests/unit/v1/test_audit_shell.py
@@ -68,6 +68,7 @@ AUDIT_1 = {
    'interval': None,
    'scope': '',
    'auto_trigger': False,
+    'next_run_time': None,
 }

 AUDIT_2 = {
@@ -85,6 +86,7 @@ AUDIT_2 = {
    'interval': None,
    'scope': '',
    'auto_trigger': False,
+    'next_run_time': None,
 }

 AUDIT_3 = {
@@ -102,6 +104,7 @@ AUDIT_3 = {
    'interval': 3600,
    'scope': '',
    'auto_trigger': True,
+    'next_run_time': None,
 }


--- a/watcherclient/v1/action_plan.py
+++ b/watcherclient/v1/action_plan.py
@@ -89,3 +89,12 @@ class ActionPlanManager(base.Manager):
    def start(self, action_plan_id):
        patch = [{'op': 'replace', 'value': 'PENDING', 'path': '/state'}]
        return self._update(self._path(action_plan_id), patch)
+
+    def cancel(self, action_plan_id):
+        action_plan = self.get(action_plan_id)
+        if action_plan.state == "ONGOING":
+            patch = [{'op': 'replace', 'value': 'CANCELLING',
+                      'path': '/state'}]
+        else:
+            patch = [{'op': 'replace', 'value': 'CANCELLED', 'path': '/state'}]
+        return self._update(self._path(action_plan_id), patch)
--- a/watcherclient/v1/action_plan_shell.py
+++ b/watcherclient/v1/action_plan_shell.py
@@ -181,13 +181,15 @@ class CreateActionPlan(command.ShowOne):
            required=True,
            dest='audit_template_uuid',
            metavar='<audit_template>',
-            help=_('ActionPlan template used for this audit (name or uuid).'))
+            help=_('Audit template used for this audit (name or uuid).'))
        parser.add_argument(
            '-t', '--audit_type',
            dest='audit_type',
            metavar='<audit_type>',
            default='ONESHOT',
-            help=_("ActionPlan type."))
+            choices=['ONESHOT', 'CONTINUOUS'],
+            help=_("Audit type. It must be ONESHOT or CONTINUOUS. "
+                   "Default is ONESHOT."))

        return parser

@@ -299,3 +301,29 @@ class DeleteActionPlan(command.Command):
                raise exceptions.ValidationError()

            client.action_plan.delete(action_plan)
+
+
+class CancelActionPlan(command.ShowOne):
+    """Cancel action plan command."""
+
+    def get_parser(self, prog_name):
+        parser = super(CancelActionPlan, self).get_parser(prog_name)
+        parser.add_argument(
+            'action_plan',
+            metavar='<action-plan>',
+            help=_("UUID of the action_plan."))
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = getattr(self.app.client_manager, "infra-optim")
+
+        if not uuidutils.is_uuid_like(parsed_args.action_plan):
+            raise exceptions.ValidationError()
+
+        action_plan = client.action_plan.cancel(parsed_args.action_plan)
+
+        columns = res_fields.ACTION_PLAN_FIELDS
+        column_headers = res_fields.ACTION_PLAN_FIELD_LABELS
+
+        return column_headers, utils.get_item_properties(action_plan, columns)
--- a/watcherclient/v1/audit_shell.py
+++ b/watcherclient/v1/audit_shell.py
@@ -150,8 +150,9 @@ class CreateAudit(command.ShowOne):
            '-i', '--interval',
            dest='interval',
            metavar='<interval>',
-            help=_('Audit interval (in seconds). '
-                   "Only used if the audit is CONTINUOUS."))
+            help=_('Audit interval (in seconds or cron format). '
+                   'Cron inteval can be used like: "*/5 * * * *". '
+                   'Only used if the audit is CONTINUOUS.'))
        parser.add_argument(
            '-g', '--goal',
            dest='goal',
--- a/watcherclient/v1/resource_fields.py
+++ b/watcherclient/v1/resource_fields.py
@@ -32,11 +32,12 @@ AUDIT_TEMPLATE_SHORT_LIST_FIELD_LABELS = ['UUID', 'Name', 'Goal', 'Strategy']
 # Audit
 AUDIT_FIELDS = ['uuid', 'created_at', 'updated_at', 'deleted_at',
                'state', 'audit_type', 'parameters', 'interval', 'goal_name',
-                'strategy_name', 'scope', 'auto_trigger']
+                'strategy_name', 'scope', 'auto_trigger', 'next_run_time']

 AUDIT_FIELD_LABELS = ['UUID', 'Created At', 'Updated At', 'Deleted At',
                      'State', 'Audit Type', 'Parameters', 'Interval', 'Goal',
-                      'Strategy', 'Audit Scope', 'Auto Trigger']
+                      'Strategy', 'Audit Scope', 'Auto Trigger',
+                      'Next Run Time']

 AUDIT_SHORT_LIST_FIELDS = ['uuid', 'audit_type',
                           'state', 'goal_name', 'strategy_name',
--- a/watcherclient/v1/strategy_shell.py
+++ b/watcherclient/v1/strategy_shell.py
@@ -13,8 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-import json
 from osc_lib import utils
+from oslo_serialization import jsonutils

 from watcherclient._i18n import _
 from watcherclient.common import command
@@ -38,7 +38,7 @@ class ShowStrategy(command.ShowOne):
    def _format_spec(self, strategy):
        parameters_spec = strategy.parameters_spec.get('properties')
        if parameters_spec:
-            return json.dumps(parameters_spec, indent=2)
+            return jsonutils.dumps(parameters_spec, indent=2)

        return {}
Author	SHA1	Message	Date
Alexander Chadin	c02f584b33	Update .gitignore because of doc migration This patch set updates .gitignore and fixes autodoc_exclude_modules Change-Id: If0e8a28c541b7e0711cc5a76ef93513c51080974	2017-07-26 11:58:58 +03:00
OpenStack Proposal Bot	a9405f5c2d	Updated from global requirements Change-Id: Iecde214cf1d386bb0a170f1456814a349a3c3f7d	2017-07-23 13:53:11 +00:00
Jenkins	4bb678f7a5	Merge "Add support for cron syntax"	2017-07-21 09:10:08 +00:00
Jenkins	baadbe3dca	Merge "Update URLs in documents according to document migration"	2017-07-19 14:04:41 +00:00
Jenkins	24b089c057	Merge "Update permissions for post_test_hook.sh"	2017-07-19 13:42:36 +00:00
Alexander Chadin	c8acc20e82	Update permissions for post_test_hook.sh This patch updates permissions up to 755 for post_test_hook.sh to let it be executed using jenkins jobs. Change-Id: I0224d10089df05729b8d479d6d910a2a2105c3f8	2017-07-19 14:45:56 +03:00
melissaml	fa91740b47	Update URLs in documents according to document migration Change-Id: Ic1f137214fc16cdaab2e0da8fd5761a0ed153ad8	2017-07-14 11:38:36 +08:00
OpenStack Proposal Bot	504ca86b78	Updated from global requirements Change-Id: Iee0f3a7ccade75a51bed40d08521306dd710732b	2017-07-13 14:25:08 +00:00
Jenkins	2b155f9505	Merge "Move existing content into the new standard structure"	2017-07-12 15:01:40 +00:00
Alexander Chadin	c8df16da8f	Add support for cron syntax Implements: blueprint cron-based-continuous-audits Change-Id: Ib281964fbf9c160791d30eafe94fd83937cac23e	2017-07-10 07:30:38 +00:00
OpenStack Proposal Bot	0de3f627c5	Updated from global requirements Change-Id: Ifd99e023666c7cfccff15cc4e7d2ffe06811dfa4	2017-07-06 01:45:35 +00:00
Jenkins	9c46ee00bb	Merge "Add post_test_hook"	2017-07-06 00:22:40 +00:00
Jenkins	48703e19e4	Merge "Fix for README.rst of tests"	2017-07-06 00:21:33 +00:00
Jenkins	799084d3d1	Merge "Fixed wrap from taking negative values"	2017-07-06 00:17:15 +00:00
kavithahr	ee087b85d5	Fixed wrap from taking negative values Now for wrap input it will take only postive integers as an input and if any negative numbers are give it will give output as "Wrap argument should be a positive integer". Change-Id: I375dab0bdd53ee464f5634162472000119f247cb	2017-07-05 18:06:10 +05:30
Alexander Chadin	8524016170	Add post_test_hook This patch set adds post_test_hook.sh which allows to set jenkins job to execute functional jobs. Change-Id: Icc4cdf8680da3ae83f36b3455fb32aecae2fb57f	2017-07-05 12:11:50 +03:00
Yumeng Bao	ed5e1b86c3	Move existing content into the new standard structure This patch rearranges and reformats existing content. Change-Id: I05088140504ba55abc724115828a7a977bd5c087	2017-07-05 16:10:09 +08:00
Alexander Chadin	42bf82c22c	Fix for README.rst of tests This patch set fixes one of steps to prepare functional env. Change-Id: Ibb2536e61f847cda2590674e50d34d68726926a8	2017-07-05 11:07:38 +03:00
Yumeng Bao	0d0192c472	switch to openstackdocstheme Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I93dfcbd516810c41a1d64e872a28a539ec4f3155	2017-07-04 09:56:28 +08:00
Jenkins	641cd44adb	Merge "Updated from global requirements"	2017-06-28 12:44:55 +00:00
Jenkins	da715f8e70	Merge "Enable some off-by-default checks"	2017-06-28 12:44:43 +00:00
OpenStack Proposal Bot	abe14a14d4	Updated from global requirements Change-Id: Iffc25e19f78014db1d50b7778bf550f900f24a35	2017-06-27 12:23:00 +00:00
Yumeng Bao	984601ecfa	Turn on warning-is-error in sphinx build Turn on the flag to ensure that future warnings in the doc build trigger a build failure. Change-Id: I6f93e229cfd9bc56208750d1ddfe88404f89ab8e	2017-06-26 20:17:57 +08:00
blue55	f32956493b	Enable some off-by-default checks Some of the available checks are disabled by default, like: [H106] Don’t put vim configuration in source files [H203] Use assertIs(Not)None to check for None Change-Id: I2809ab2cce76dd31a04d3cca0e97cdad26c14cb4	2017-06-23 10:13:40 +08:00
Jenkins	1e2a13fe1a	Merge "Add CLI for Action Plan Cancel"	2017-06-19 09:17:59 +00:00
OpenStack Proposal Bot	417b3a2669	Updated from global requirements Change-Id: Ie3692b21a749dec23583f302a42a822c5922bff5	2017-06-10 11:48:35 +00:00
aditi	3f25b6b223	Add CLI for Action Plan Cancel This patch CLI for for action plan cancel watcher action plan cancel <action-plan-uuid> Change-Id: I9c8d53107b1926d6ce4532d7c696dc36c84c6cf8 Partially-Implements: blueprint cancel-action-plan	2017-05-31 11:19:20 +00:00
OpenStack Proposal Bot	5cbce9fb20	Updated from global requirements Change-Id: I7e4668bd04f9a439296644f6d9dd181ba0b2ae9d	2017-05-23 12:00:31 +00:00
OpenStack Proposal Bot	f379b1544c	Updated from global requirements Change-Id: I02ae2ad14f93141e3aaadc873d43fec076480686	2017-05-17 03:58:59 +00:00
OpenStack Proposal Bot	30f49c9f70	Updated from global requirements Change-Id: Ia162a2106be6cb4982c694d5a37d9c2ed845f143	2017-05-03 12:23:47 +00:00
Jenkins	af13d9cdd1	Merge "Updated from global requirements"	2017-05-03 12:21:47 +00:00
OpenStack Proposal Bot	8952b2fbd2	Updated from global requirements Change-Id: I14c857805f9156640e9c0fd57233ca4cf2b5d99f	2017-05-01 14:08:23 +00:00
M V P Nitesh	66681ef9c9	Add 'rm -f .testrepository/times.dbm' command in testenv Running py2* post py3* tests results in error. Add 'rm -f .testrepository/times.dbm' command in testenv to resolve this. Change-Id: Ie704b12c413c9e8cc0b2649c1d2bbc03a3b61a11	2017-04-25 12:55:27 +05:30
Jenkins	4285b388ca	Merge "Updated from global requirements"	2017-04-12 12:23:36 +00:00
OpenStack Proposal Bot	723d39cd65	Updated from global requirements Change-Id: I32bd693211fe91f86f1f2e1f5921ad56fbeaf1e5	2017-04-12 04:22:27 +00:00
M V P Nitesh	156d660cd3	Optimize the link address Use https instead of http to ensure the safety Change-Id: Ieeea614ce26b99b007a89cb12a8e83f120b64d32	2017-04-10 16:15:11 +05:30
Jenkins	07b19ede3f	Merge "Remove log translations"	2017-03-29 12:57:12 +00:00
daohanli	94c317250e	Remove log translations Log messages are no longer being translated. This removes all use of the _LE, _LI, and _LW translation markers to simplify logging and to avoid confusion with new contributions. See: http://lists.openstack.org/pipermail/openstack-i18n/2016-November/002574.html http://lists.openstack.org/pipermail/openstack-dev/2017-March/113365.html Change-Id: Icfe6ab464fd9fbbbfb9c9a05dba2220aa9e0bace	2017-03-23 10:43:15 +08:00
Luong Anh Tuan	7250886d14	Indicating the location tests directory in oslo_debug_helper According to [1], we can passing a "-t" argument to oslo_debug_helper to indicate the directory where tests are located. This will solves ImportError exception. [1] https://docs.openstack.org/developer/oslotest/features.html Change-Id: Id72596a8c3d9e2e344ef492f2d60b89bc0422aec Closes-Bug: #1666560	2017-03-22 10:14:22 +00:00
Jenkins	03ac32b1be	Merge "Using assert methods instead of assertTrue"	2017-03-08 09:35:39 +00:00
Jenkins	89390ac0a9	Merge "Updated from global requirements"	2017-03-03 08:28:09 +00:00
zhuzeyu	69c10379af	Using assert methods instead of assertTrue It will print a nicer error message if it fails. Change-Id: I6fb9054e3285db76057db373fe87964e510de516	2017-03-03 06:33:21 +00:00
Jenkins	0ea4020d98	Merge "Remove support for py34"	2017-03-03 05:44:14 +00:00
Jenkins	cbcc990383	Merge "update help description about actionplan create"	2017-03-03 03:19:08 +00:00
OpenStack Proposal Bot	15f519f827	Updated from global requirements Change-Id: I6055fa04daf29ae76845af307e844d94ba030117	2017-03-03 03:09:00 +00:00
ricolin	1ccf0588f9	[Fix gate]Update test requirement Since pbr already landed and the old version of hacking seems not work very well with pbr>=2, we should update it to match global requirement. Partial-Bug: #1668848 Change-Id: I21616cbbd11d2ccab60155ea78ed261ee12db5d4	2017-03-02 20:14:13 +08:00
Chris Spencer	cd267c9fa4	Remove RST files located in doc/source/api. Change-Id: Ib9600297b6b65a44a72090cfb0c7d8f80dcfd34a Closes-Bug: 1640811	2017-02-14 10:06:50 -07:00
gengchc2	ce477baa1f	Remove support for py34 The gating on python 3.4 is restricted to <= Mitaka. This is due to the change from Ubuntu Trusty to Xenial, where only python3.5 is available. There is no need to continue to keep these settings. Change-Id: I66b76645b7799c6550583c675bc968310d5e0d1c	2017-02-08 16:33:34 +08:00
licanwei	cd918fe086	update help description about actionplan create help=_("ActionPlan type.") => help=_("Audit type. It must be ONESHOT or CONTINUOUS. " "Default is ONESHOT.")) Change-Id: Ic79b5d1d0cb5ed459aaa290269219ff0e00065d5	2017-02-07 09:56:47 +08:00
Jenkins	1f7df3d53d	Merge "Using jsonutils instead of json"	2017-02-03 08:47:00 +00:00
zhuzeyu	dfe9d31ee4	Using jsonutils instead of json TrivialFix Change-Id: I1d17994f4cf854f6ba62c75ed18ebee3c7f5fa47	2017-02-03 15:48:12 +08:00
Jenkins	2ea26be247	Merge "Add functional env to tox"	2017-02-02 08:40:25 +00:00
OpenStack Proposal Bot	15b5fb791e	Updated from global requirements Change-Id: I487004e11fc37040601562bc2cf807d5d853335a	2017-01-25 09:37:23 +00:00
zhuzeyu	eafb6b21f7	Remove useless utf-8 coding TrivialFix Change-Id: I37d77df21349f3c113582a0a6e51a84be297cc73	2017-01-25 15:20:48 +08:00
Alexander Chadin	08cf7d99d3	Add functional env to tox This patch set adds functional environment to tox to be able to create post_hook file for functional gate. Change-Id: I8e918fe47f6008b9570e39c2d0e9159d0d223362	2017-01-23 18:58:43 +03:00