Updated from global requirements

Change-Id: I2cee86f0b7a9b7630322d1364463a97dbbe60b35

.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

CONTRIBUTING.rst

@@ -1,13 +1,13 @@
 If you would like to contribute to the development of OpenStack,
 you must follow the steps in this page:
 
-   http://docs.openstack.org/infra/manual/developers.html
+   https://docs.openstack.org/infra/manual/developers.html
 
 Once those steps have been completed, changes to OpenStack
 should be submitted for review via the Gerrit tool, following
 the workflow documented at:
 
-   http://docs.openstack.org/infra/manual/developers.html#development-workflow
+   https://docs.openstack.org/infra/manual/developers.html#development-workflow
 
 Pull requests submitted through GitHub will be ignored.
 

HACKING.rst

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

README.rst

@@ -23,9 +23,9 @@ operating costs, increased system performance via intelligent virtual machine
 migration, increased energy efficiency-and more!
 
 * Free software: Apache license
-* Wiki: http://wiki.openstack.org/wiki/Watcher
-* Source: http://git.openstack.org/cgit/openstack/python-watcher
-* Bugs: http://bugs.launchpad.net/watcher
+* Wiki: https://wiki.openstack.org/wiki/Watcher
+* Source: https://git.openstack.org/cgit/openstack/python-watcher
+* Bugs: https://bugs.launchpad.net/watcher
 
 Installation
 ============
@@ -61,7 +61,7 @@ You can install the Watcher CLI with the following command:
    sudo pip install python-watcherclient
 
 
-You can also use the `OpenStack client <http://docs.openstack.org/cli-reference/overview.html>`_
+You can also use the `OpenStack client <https://docs.openstack.org/python-openstackclient/latest/>`_
 with Watcher (our watcher plugin for OpenStack client is included in the
 python-watcherclient package). To install it, you have just to run this command:
 

doc/source/cli/index.rst

@@ -0,0 +1,32 @@
+=============================
+ 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
+   details

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.)
 ::
 

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.)
 ::
 
@@ -55,7 +55,7 @@ fill partially typed commands. To use this feature, source the below file
 https://git.openstack.org/cgit/openstack/python-watcherclient/tree/tools/watcher.bash_completion)
 to your terminal and then bash completion should work::
 
-    $ source watcher.bash_completion
+    $ . watcher.bash_completion
 
 To avoid doing this every time, add this to your ``.bashrc`` or copy the
 watcher.bash_completion file to the default bash completion scripts directory

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"}

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.
@@ -19,8 +19,8 @@ signed OpenStack's contributor's agreement.
 
 .. seealso::
 
-   * http://docs.openstack.org/infra/manual/developers.html
-   * http://wiki.openstack.org/CLA
+   * https://docs.openstack.org/infra/manual/developers.html
+   * https://wiki.openstack.org/CLA
 
 LaunchPad Project
 -----------------
@@ -41,7 +41,7 @@ Project Hosting Details
 -------------------------
 
 Bug tracker
-    http://launchpad.net/python-watcherclient
+    https://launchpad.net/python-watcherclient
 
 Mailing list (prefix subjects with ``[watcher]`` for faster responses)
     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

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

doc/source/reference/api/index.rst

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

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

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

requirements.txt

@@ -3,12 +3,12 @@
 # process, which may cause wedges in the gate later.
 
 Babel!=2.4.0,>=2.3.4 # BSD
-cliff>=2.6.0 # Apache-2.0
-osc-lib>=1.5.1 # Apache-2.0
-oslo.i18n!=3.15.2,>=2.1.0 # Apache-2.0
-oslo.utils>=3.20.0 # Apache-2.0
+cliff!=2.9.0,>=2.8.0 # Apache-2.0
+osc-lib>=1.7.0 # Apache-2.0
+oslo.i18n>=3.15.3 # Apache-2.0
+oslo.utils>=3.28.0 # Apache-2.0
 pbr!=2.1.0,>=2.0.0 # Apache-2.0
 PrettyTable<0.8,>=0.7.1 # BSD
-keystoneauth1>=2.20.0 # Apache-2.0
+keystoneauth1>=3.2.0 # Apache-2.0
 six>=1.9.0 # MIT
-PyYAML>=3.10.0 # MIT
+PyYAML>=3.10 # MIT

setup.cfg

@@ -5,7 +5,7 @@ description-file =
     README.rst
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
-home-page =  http://docs.openstack.org/developer/python-watcherclient
+home-page =  https://docs.openstack.org/python-watcherclient/latest/
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -54,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
@@ -90,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
@@ -102,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

test-requirements.txt

@@ -5,15 +5,15 @@
 coverage!=4.4,>=4.0 # Apache-2.0
 fixtures>=3.0.0 # Apache-2.0/BSD
 hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-mock>=2.0 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+mock>=2.0.0 # BSD
+openstackdocstheme>=1.17.0 # Apache-2.0
 oslotest>=1.10.0 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx!=1.6.1,>=1.5.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>=14.0.0 # Apache-2.0
+tempest>=16.1.0 # Apache-2.0
 
 # Needed for pypi packaging
-wheel # MIT
+wheel>=0.24.0 # MIT

tox.ini

@@ -50,6 +50,7 @@ commands = python setup.py testr --slowest --testr-args='--concurrency=1 {posarg
 [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

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:

watcherclient/common/utils.py

@@ -75,7 +75,7 @@ def import_versioned_module(version, submodule=None):
     return importutils.import_module(module)
 
 
-def split_and_deserialize(string):
+def split_and_deserialize(string, exclude_fields=[]):
     """Split and try to JSON deserialize a string.
 
     Gets a string with the KEY=VALUE format, split it (using '=' as the
@@ -88,10 +88,11 @@ def split_and_deserialize(string):
     except ValueError:
         raise exc.CommandError(_('Attributes must be a list of '
                                  'PATH=VALUE not "%s"') % string)
-    try:
-        value = jsonutils.loads(value)
-    except ValueError:
-        pass
+    if key not in exclude_fields:
+        try:
+            value = jsonutils.loads(value)
+        except ValueError:
+            pass
 
     return (key, value)
 
@@ -104,7 +105,7 @@ def args_array_to_dict(kwargs, key_to_convert):
     return kwargs
 
 
-def args_array_to_patch(op, attributes):
+def args_array_to_patch(op, attributes, exclude_fields=[]):
     patch = []
     for attr in attributes:
         # Sanitize
@@ -112,7 +113,8 @@ def args_array_to_patch(op, attributes):
             attr = '/' + attr
 
         if op in ['add', 'replace']:
-            path, value = split_and_deserialize(attr)
+            path, value = split_and_deserialize(attr,
+                                                exclude_fields=exclude_fields)
             patch.append({'op': op, 'path': path, 'value': value})
 
         elif op == "remove":

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
@@ -26,7 +26,7 @@ You need to install virtualenv, create a virtual environment and activate it::
 
     $ pip install virtualenv
     $ virtualenv watcher-env
-    $ source watcher-env/bin/activate
+    $ . watcher-env/bin/activate
 
 Then, to install Tempest you can issue the following commands::
 
@@ -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
 

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

watcherclient/tests/functional/v1/base.py

@@ -10,6 +10,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import os
+
 import re
 import shlex
 import subprocess
@@ -20,9 +22,24 @@ from tempest.lib.cli import output_parser
 from tempest.lib import exceptions
 
 
+def credentials():
+    creds = {
+        '--os-username': os.environ.get('OS_USERNAME', 'admin'),
+        '--os-password': os.environ.get('OS_PASSWORD', 'secretadmin'),
+        '--os-project-name': os.environ.get('OS_PROJECT_NAME', 'admin'),
+        '--os-auth-url': os.environ.get('OS_AUTH_URL',
+                                        'http://10.0.1.94/identity'),
+        '--os-project-domain-id': os.environ.get('OS_PROJECT_DOMAIN_ID',
+                                                 'default'),
+        '--os-user-domain-id': os.environ.get('OS_USER_DOMAIN_ID', 'default'),
+    }
+    return [x for sub in creds.items() for x in sub]
+
+
 def execute(cmd, fail_ok=False, merge_stderr=False):
     """Executes specified command for the given action."""
     cmdlist = shlex.split(cmd)
+    cmdlist.extend(credentials())
     stdout = subprocess.PIPE
     stderr = subprocess.STDOUT if merge_stderr else subprocess.PIPE
     proc = subprocess.Popen(cmdlist, stdout=stdout, stderr=stderr)

watcherclient/tests/functional/v1/test_audit.py

@@ -25,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
 

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)

watcherclient/tests/unit/v1/test_action_shell.py

@@ -30,6 +30,7 @@ ACTION_1 = {
     'action_type': 'migrate',
     'parents': ['239f02a5-9649-4e14-9d33-ac2bf67cb755'],
     'input_parameters': {"test": 1},
+    'description': 'test',
     'created_at': datetime.datetime.now().isoformat(),
     'updated_at': None,
     'deleted_at': None,
@@ -42,6 +43,7 @@ ACTION_2 = {
     'action_type': 'migrate',
     'parents': ['67653274-eb24-c7ba-70f6-a84e73d80843'],
     'input_parameters': {"test": 2},
+    'description': 'test',
     'created_at': datetime.datetime.now().isoformat(),
     'updated_at': None,
     'deleted_at': None,
@@ -53,6 +55,7 @@ ACTION_3 = {
     'parents': [],
     'state': 'PENDING',
     'action_type': 'sleep',
+    'description': 'test',
     'created_at': datetime.datetime.now().isoformat(),
     'updated_at': None,
     'deleted_at': None,

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,
 }
 
 

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)

watcherclient/v1/action_plan_shell.py

@@ -301,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)

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',
@@ -242,7 +243,8 @@ class UpdateAudit(command.ShowOne):
             raise exceptions.ValidationError()
 
         patch = common_utils.args_array_to_patch(
-            parsed_args.op, parsed_args.attributes[0])
+            parsed_args.op, parsed_args.attributes[0],
+            exclude_fields=['/interval'])
 
         audit = client.audit.update(parsed_args.audit, patch)
 

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',
@@ -63,11 +64,11 @@ ACTION_PLAN_SHORT_LIST_FIELD_LABELS = ['UUID', 'Audit', 'State',
 # Action
 ACTION_FIELDS = ['uuid', 'created_at', 'updated_at', 'deleted_at', 'parents',
                  'state', 'action_plan_uuid', 'action_type',
-                 'input_parameters']
+                 'input_parameters', 'description']
 
 ACTION_FIELD_LABELS = ['UUID', 'Created At', 'Updated At', 'Deleted At',
                        'Parents', 'State', 'Action Plan', 'Action',
-                       'Parameters']
+                       'Parameters', 'Description']
 
 ACTION_SHORT_LIST_FIELDS = ['uuid', 'parents',
                             'state', 'action_plan_uuid', 'action_type']