Fix oslo.db >= 15.0.0 compatibility

Minimal refactor of SQLAlchemy api module to be compatible with
oslo.db >= 15.0.0 where autocommit behaviour was dropped.

Closes-Bug: #2056181
Change-Id: I33be53f647faae2aad30a43c10980df950d5d7c2
(cherry picked from commit bc5922c684)

.zuul.yaml

@@ -1,9 +1,9 @@
 - project:
+    queue: watcher
     templates:
       - check-requirements
       - openstack-cover-jobs
-      - openstack-lower-constraints-jobs
-      - openstack-python3-victoria-jobs
+      - openstack-python3-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:
@@ -13,10 +13,8 @@
         - watcher-tempest-strategies
         - watcher-tempest-actuator
         - watcherclient-tempest-functional
-        - watcher-tls-test
         - watcher-tempest-functional-ipv6-only
     gate:
-      queue: watcher
       jobs:
         - watcher-tempest-functional
         - watcher-tempest-functional-ipv6-only
@@ -88,21 +86,10 @@
       tempest_concurrency: 1
       tempest_test_regex: watcher_tempest_plugin.tests.scenario.test_execute_strategies
 
-- job:
-    name: watcher-tls-test
-    parent: watcher-tempest-multinode
-    group-vars:
-      subnode:
-          devstack_services:
-            tls-proxy: true
-    vars:
-      devstack_services:
-        tls-proxy: true
-
 - job:
     name: watcher-tempest-multinode
     parent: watcher-tempest-functional
-    nodeset: openstack-two-node-bionic
+    nodeset: openstack-two-node-jammy
     roles:
       - zuul: openstack/tempest
     group-vars:
@@ -120,8 +107,7 @@
           watcher-api: false
           watcher-decision-engine: true
           watcher-applier: false
-          # We need to add TLS support for watcher plugin
-          tls-proxy: false
+          c-bak: false
           ceilometer: false
           ceilometer-acompute: false
           ceilometer-acentral: false
@@ -169,7 +155,6 @@
       devstack_plugins:
         watcher: https://opendev.org/openstack/watcher
       devstack_services:
-        tls-proxy: false
         watcher-api: true
         watcher-decision-engine: true
         watcher-applier: true

doc/source/admin/policy.rst

@@ -17,6 +17,14 @@
 Policies
 ========
 
+.. warning::
+
+   JSON formatted policy file is deprecated since Watcher 6.0.0 (Wallaby).
+   This `oslopolicy-convert-json-to-yaml`__ tool will migrate your existing
+   JSON-formatted policy file to YAML in a backward-compatible way.
+
+.. __: https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html
+
 Watcher's public API calls may be restricted to certain sets of users using a
 policy configuration file. This document explains exactly how policies are
 configured and what they apply to.

doc/source/conf.py

@@ -56,8 +56,8 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Watcher'
-copyright = u'OpenStack Foundation'
+project = 'Watcher'
+copyright = 'OpenStack Foundation'
 
 # A list of ignored prefixes for module index sorting.
 modindex_common_prefix = ['watcher.']
@@ -91,14 +91,14 @@ pygments_style = 'native'
 # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
 
 man_pages = [
-    ('man/watcher-api', 'watcher-api', u'Watcher API Server',
-     [u'OpenStack'], 1),
-    ('man/watcher-applier', 'watcher-applier', u'Watcher Applier',
-     [u'OpenStack'], 1),
+    ('man/watcher-api', 'watcher-api', 'Watcher API Server',
+     ['OpenStack'], 1),
+    ('man/watcher-applier', 'watcher-applier', 'Watcher Applier',
+     ['OpenStack'], 1),
     ('man/watcher-db-manage', 'watcher-db-manage',
-     u'Watcher Db Management Utility', [u'OpenStack'], 1),
+     'Watcher Db Management Utility', ['OpenStack'], 1),
     ('man/watcher-decision-engine', 'watcher-decision-engine',
-     u'Watcher Decision Engine', [u'OpenStack'], 1),
+     'Watcher Decision Engine', ['OpenStack'], 1),
 ]
 
 # -- Options for HTML output --------------------------------------------------
@@ -128,8 +128,8 @@ openstackdocs_bug_tag = ''
 latex_documents = [
     ('index',
      'doc-watcher.tex',
-     u'Watcher Documentation',
-     u'OpenStack Foundation', 'manual'),
+     'Watcher Documentation',
+     'OpenStack Foundation', 'manual'),
 ]
 
 # If false, no module index is generated.

doc/source/configuration/configuring.rst

@@ -372,7 +372,7 @@ You can configure and install Ceilometer by following the documentation below :
 #. https://docs.openstack.org/ceilometer/latest
 
 The built-in strategy 'basic_consolidation' provided by watcher requires
-"**compute.node.cpu.percent**" and "**cpu_util**" measurements to be collected
+"**compute.node.cpu.percent**" and "**cpu**" measurements to be collected
 by Ceilometer.
 The measurements available depend on the hypervisors that OpenStack manages on
 the specific implementation.

doc/source/contributor/devstack.rst

@@ -47,6 +47,8 @@ unavailable as well as `instance_l3_cpu_cache`::
         [[local|localrc]]
         enable_plugin watcher https://opendev.org/openstack/watcher
 
+        enable_plugin watcher-dashboard https://opendev.org/openstack/watcher-dashboard
+
         enable_plugin ceilometer https://opendev.org/openstack/ceilometer.git
         CEILOMETER_BACKEND=gnocchi
 

doc/source/contributor/plugin/strategy-plugin.rst

@@ -56,9 +56,6 @@ Here is an example showing how you can write a plugin called ``NewStrategy``:
     # filepath: thirdparty/new.py
     # import path: thirdparty.new
     import abc
-
-    import six
-
     from watcher._i18n import _
     from watcher.decision_engine.strategy.strategies import base
 
@@ -303,6 +300,6 @@ Using that you can now query the values for that specific metric:
 .. code-block:: py
 
     avg_meter = self.datasource_backend.statistic_aggregation(
-        instance.uuid, 'cpu_util', self.periods['instance'],
+        instance.uuid, 'instance_cpu_usage', self.periods['instance'],
         self.granularity,
         aggregation=self.aggregation_method['instance'])

doc/source/strategies/basic-server-consolidation.rst

@@ -26,8 +26,7 @@ metric                       service name plugins comment
                                                   ``compute_monitors`` option
                                                   to ``cpu.virt_driver`` in
                                                   the nova.conf.
-``cpu_util``                 ceilometer_  none    cpu_util has been removed
-                                                  since Stein.
+``cpu``                      ceilometer_  none
 ============================ ============ ======= ===========================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute

doc/source/strategies/saving_energy.rst

@@ -89,9 +89,9 @@ step 2: Create audit to do optimization
 .. code-block:: shell
 
     $ openstack optimize audittemplate create \
-      at1 saving_energy --strategy saving_energy
+      saving_energy_template1 saving_energy --strategy saving_energy
 
-    $ openstack optimize audit create -a at1 \
+    $ openstack optimize audit create -a saving_energy_audit1 \
       -p free_used_percent=20.0
 
 External Links

doc/source/strategies/vm_workload_consolidation.rst

@@ -22,14 +22,19 @@ The *vm_workload_consolidation* strategy requires the following metrics:
 ============================ ============ ======= =========================
 metric                       service name plugins comment
 ============================ ============ ======= =========================
-``cpu_util``                 ceilometer_  none    cpu_util has been removed
-                                                  since Stein.
+``cpu``                      ceilometer_  none
 ``memory.resident``          ceilometer_  none
 ``memory``                   ceilometer_  none
 ``disk.root.size``           ceilometer_  none
+``compute.node.cpu.percent`` ceilometer_  none    (optional) need to set the
+                                                  ``compute_monitors`` option
+                                                  to ``cpu.virt_driver`` in the
+                                                  nova.conf.
+``hardware.memory.used``     ceilometer_  SNMP_   (optional)
 ============================ ============ ======= =========================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
+.. _SNMP: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#snmp-based-meters
 
 Cluster data model
 ******************

doc/source/strategies/workload-stabilization.rst

@@ -27,9 +27,8 @@ metric                       service name plugins comment
                                                   to ``cpu.virt_driver`` in the
                                                   nova.conf.
 ``hardware.memory.used``     ceilometer_  SNMP_
-``cpu_util``                 ceilometer_  none    cpu_util has been removed
-                                                  since Stein.
-``memory.resident``          ceilometer_  none
+``cpu``                      ceilometer_  none
+``instance_ram_usage``       ceilometer_  none
 ============================ ============ ======= =============================
 
 .. _ceilometer: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-compute
@@ -107,10 +106,10 @@ parameter            type   default Value         description
                                                   period of all received ones.
 ==================== ====== ===================== =============================
 
-.. |metrics| replace:: ["cpu_util", "memory.resident"]
-.. |thresholds| replace:: {"cpu_util": 0.2, "memory.resident": 0.2}
-.. |weights| replace:: {"cpu_util_weight": 1.0, "memory.resident_weight": 1.0}
-.. |instance_metrics| replace:: {"cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used"}
+.. |metrics| replace:: ["instance_cpu_usage", "instance_ram_usage"]
+.. |thresholds| replace:: {"instance_cpu_usage": 0.2, "instance_ram_usage": 0.2}
+.. |weights| replace:: {"instance_cpu_usage_weight": 1.0, "instance_ram_usage_weight": 1.0}
+.. |instance_metrics| replace:: {"instance_cpu_usage": "compute.node.cpu.percent", "instance_ram_usage": "hardware.memory.used"}
 .. |periods| replace:: {"instance": 720, "node": 600}
 
 Efficacy Indicator
@@ -136,8 +135,8 @@ How to use it ?
       at1 workload_balancing --strategy workload_stabilization
 
     $ openstack optimize audit create -a at1 \
-      -p thresholds='{"memory.resident": 0.05}' \
-      -p metrics='["memory.resident"]'
+      -p thresholds='{"instance_ram_usage": 0.05}' \
+      -p metrics='["instance_ram_usage"]'
 
 External Links
 --------------

doc/source/strategies/workload_balance.rst

@@ -24,8 +24,7 @@ The *workload_balance* strategy requires the following metrics:
 ======================= ============ ======= =========================
 metric                  service name plugins comment
 ======================= ============ ======= =========================
-``cpu_util``            ceilometer_  none    cpu_util has been removed
-                                             since Stein.
+``cpu``                 ceilometer_  none
 ``memory.resident``     ceilometer_  none
 ======================= ============ ======= =========================
 
@@ -65,15 +64,16 @@ Configuration
 
 Strategy parameters are:
 
-============== ====== ============= ====================================
-parameter      type   default Value description
-============== ====== ============= ====================================
-``metrics``    String 'cpu_util'    Workload balance base on cpu or ram
-                                    utilization. choice: ['cpu_util',
-                                    'memory.resident']
-``threshold``  Number 25.0          Workload threshold for migration
-``period``     Number 300           Aggregate time period of ceilometer
-============== ====== ============= ====================================
+============== ====== ==================== ====================================
+parameter      type   default Value        description
+============== ====== ==================== ====================================
+``metrics``    String 'instance_cpu_usage' Workload balance base on cpu or ram
+                                           utilization. Choices:
+                                           ['instance_cpu_usage',
+                                           'instance_ram_usage']
+``threshold``  Number 25.0                 Workload threshold for migration
+``period``     Number 300                  Aggregate time period of ceilometer
+============== ====== ==================== ====================================
 
 Efficacy Indicator
 ------------------
@@ -95,7 +95,7 @@ How to use it ?
       at1 workload_balancing --strategy workload_balance
 
     $ openstack optimize audit create -a at1 -p threshold=26.0 \
-            -p period=310 -p metrics=cpu_util
+            -p period=310 -p metrics=instance_cpu_usage
 
 External Links
 --------------

lower-constraints.txt

@@ -1,150 +0,0 @@
-alabaster==0.7.10
-alembic==0.9.8
-amqp==2.2.2
-appdirs==1.4.3
-APScheduler==3.5.1
-asn1crypto==0.24.0
-automaton==1.14.0
-beautifulsoup4==4.6.0
-cachetools==2.0.1
-certifi==2018.1.18
-cffi==1.11.5
-chardet==3.0.4
-cliff==2.11.0
-cmd2==0.8.1
-contextlib2==0.5.5
-coverage==4.5.1
-croniter==0.3.20
-cryptography==2.1.4
-debtcollector==1.19.0
-decorator==4.2.1
-deprecation==2.0
-doc8==0.8.0
-docutils==0.14
-dogpile.cache==0.6.5
-dulwich==0.19.0
-enum34==1.1.6
-enum-compat==0.0.2
-eventlet==0.20.0
-extras==1.0.0
-fasteners==0.14.1
-fixtures==3.0.0
-freezegun==0.3.10
-futurist==1.8.0
-gitdb2==2.0.3
-GitPython==2.1.8
-gnocchiclient==7.0.1
-greenlet==0.4.13
-idna==2.6
-imagesize==1.0.0
-iso8601==0.1.12
-Jinja2==2.10
-jmespath==0.9.3
-jsonpatch==1.21
-jsonpointer==2.0
-jsonschema==3.2.0
-keystoneauth1==3.4.0
-keystonemiddleware==4.21.0
-kombu==4.1.0
-linecache2==1.0.0
-logutils==0.3.5
-lxml==4.1.1
-Mako==1.0.7
-MarkupSafe==1.0
-mccabe==0.2.1
-microversion_parse==0.2.1
-monotonic==1.4
-msgpack==0.5.6
-munch==2.2.0
-netaddr==0.7.19
-netifaces==0.10.6
-networkx==2.2
-openstacksdk==0.12.0
-os-api-ref===1.4.0
-os-client-config==1.29.0
-os-service-types==1.2.0
-os-testr==1.0.0
-osc-lib==1.10.0
-os-resource-classes==0.4.0
-oslo.cache==1.29.0
-oslo.concurrency==3.26.0
-oslo.config==5.2.0
-oslo.context==2.21.0
-oslo.db==4.35.0
-oslo.i18n==3.20.0
-oslo.log==3.37.0
-oslo.messaging==8.1.2
-oslo.middleware==3.35.0
-oslo.policy==1.34.0
-oslo.reports==1.27.0
-oslo.serialization==2.25.0
-oslo.service==1.30.0
-oslo.upgradecheck==0.1.0
-oslo.utils==3.36.0
-oslo.versionedobjects==1.32.0
-oslotest==3.3.0
-packaging==17.1
-Paste==2.0.3
-PasteDeploy==1.5.2
-pbr==3.1.1
-pecan==1.3.2
-pika==0.10.0
-pika-pool==0.1.3
-prettytable==0.7.2
-psutil==5.4.3
-pycadf==2.7.0
-pycparser==2.18
-Pygments==2.2.0
-pyinotify==0.9.6
-pyOpenSSL==17.5.0
-pyparsing==2.2.0
-pyperclip==1.6.0
-python-ceilometerclient==2.9.0
-python-cinderclient==3.5.0
-python-dateutil==2.7.0
-python-editor==1.0.3
-python-glanceclient==2.9.1
-python-ironicclient==2.5.0
-python-keystoneclient==3.15.0
-python-mimeparse==1.6.0
-python-monascaclient==1.12.0
-python-neutronclient==6.7.0
-python-novaclient==14.1.0
-python-openstackclient==3.14.0
-python-subunit==1.2.0
-pytz==2018.3
-PyYAML==3.12
-repoze.lru==0.7
-requests==2.18.4
-requestsexceptions==1.4.0
-restructuredtext-lint==1.1.3
-rfc3986==1.1.0
-Routes==2.4.1
-simplegeneric==0.8.1
-simplejson==3.13.2
-smmap2==2.0.3
-snowballstemmer==1.2.1
-SQLAlchemy==1.2.5
-sqlalchemy-migrate==0.11.0
-sqlparse==0.2.4
-statsd==3.2.2
-stestr==2.0.0
-stevedore==1.28.0
-taskflow==3.7.1
-Tempita==0.5.2
-tenacity==4.9.0
-testresources==2.0.1
-testscenarios==0.5.0
-testtools==2.3.0
-traceback2==1.4.0
-tzlocal==1.5.1
-ujson==1.35
-unittest2==1.1.0
-urllib3==1.22
-vine==1.1.4
-waitress==1.1.0
-warlock==1.3.0
-WebOb==1.8.5
-WebTest==2.0.29
-wrapt==1.10.11
-WSME==0.9.2

releasenotes/notes/deprecate-json-formatted-policy-file-3a92379e9f5dd203.yaml

@@ -0,0 +1,20 @@
+---
+upgrade:
+  - |
+    The default value of ``[oslo_policy] policy_file`` config option has
+    been changed from ``policy.json`` to ``policy.yaml``.
+    Operators who are utilizing customized or previously generated
+    static policy JSON files (which are not needed by default), should
+    generate new policy files or convert them in YAML format. Use the
+    `oslopolicy-convert-json-to-yaml
+    <https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_
+    tool to convert a JSON to YAML formatted policy file in
+    backward compatible way.
+deprecations:
+  - |
+    Use of JSON policy files was deprecated by the ``oslo.policy`` library
+    during the Victoria development cycle. As a result, this deprecation is
+    being noted in the Wallaby cycle with an anticipated future removal of support
+    by ``oslo.policy``. As such operators will need to convert to YAML policy
+    files. Please see the upgrade notes for details on migration of any
+    custom policy files.

releasenotes/source/2023.1.rst

@@ -0,0 +1,6 @@
+===========================
+2023.1 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2023.1

releasenotes/source/2023.2.rst

@@ -0,0 +1,6 @@
+===========================
+2023.2 Series Release Notes
+===========================
+
+.. release-notes::
+   :branch: stable/2023.2

releasenotes/source/conf.py

@@ -53,7 +53,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-copyright = u'2016, Watcher developers'
+copyright = '2016, Watcher developers'
 
 # Release notes are version independent
 # The short X.Y version.
@@ -196,8 +196,8 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual])
 latex_documents = [
-  ('index', 'watcher.tex', u'Watcher Documentation',
-   u'Watcher developers', 'manual'),
+  ('index', 'watcher.tex', 'Watcher Documentation',
+   'Watcher developers', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -226,8 +226,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'watcher', u'Watcher Documentation',
-     [u'Watcher developers'], 1)
+    ('index', 'watcher', 'Watcher Documentation',
+     ['Watcher developers'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -240,8 +240,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'watcher', u'Watcher Documentation',
-   u'Watcher developers', 'watcher', 'One line description of project.',
+  ('index', 'watcher', 'Watcher Documentation',
+   'Watcher developers', 'watcher', 'One line description of project.',
    'Miscellaneous'),
 ]
 

releasenotes/source/index.rst

@@ -21,6 +21,13 @@ Contents:
    :maxdepth: 1
 
    unreleased
+   2023.2
+   2023.1
+   zed
+   yoga
+   xena
+   wallaby
+   victoria
    ussuri
    train
    stein

releasenotes/source/locale/en_GB/LC_MESSAGES/releasenotes.po

@@ -1,14 +1,17 @@
 # Andi Chandler <andi@gowling.com>, 2017. #zanata
 # Andi Chandler <andi@gowling.com>, 2018. #zanata
+# Andi Chandler <andi@gowling.com>, 2020. #zanata
+# Andi Chandler <andi@gowling.com>, 2022. #zanata
+# Andi Chandler <andi@gowling.com>, 2023. #zanata
 msgid ""
 msgstr ""
 "Project-Id-Version: python-watcher\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2018-11-08 01:22+0000\n"
+"POT-Creation-Date: 2023-08-14 03:05+0000\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"PO-Revision-Date: 2018-11-07 06:15+0000\n"
+"PO-Revision-Date: 2023-06-21 07:54+0000\n"
 "Last-Translator: Andi Chandler <andi@gowling.com>\n"
 "Language-Team: English (United Kingdom)\n"
 "Language: en_GB\n"
@@ -54,6 +57,67 @@ msgstr "1.7.0"
 msgid "1.9.0"
 msgstr "1.9.0"
 
+msgid "2.0.0"
+msgstr "2.0.0"
+
+msgid "2023.1 Series Release Notes"
+msgstr "2023.1 Series Release Notes"
+
+msgid "3.0.0"
+msgstr "3.0.0"
+
+msgid "4.0.0"
+msgstr "4.0.0"
+
+msgid "6.0.0"
+msgstr "6.0.0"
+
+msgid "A ``watcher-status upgrade check`` has been added for this."
+msgstr "A ``watcher-status upgrade check`` has been added for this."
+
+msgid ""
+"A new threadpool for the decision engine that contributors can use to "
+"improve the performance of many operations, primarily I/O bound onces. The "
+"amount of workers used by the decision engine threadpool can be configured "
+"to scale according to the available infrastructure using the "
+"`watcher_decision_engine.max_general_workers` config option. Documentation "
+"for contributors to effectively use this threadpool is available online: "
+"https://docs.openstack.org/watcher/latest/contributor/concurrency.html"
+msgstr ""
+"A new threadpool for the decision engine that contributors can use to "
+"improve the performance of many operations, primarily I/O bound onces. The "
+"amount of workers used by the decision engine threadpool can be configured "
+"to scale according to the available infrastructure using the "
+"`watcher_decision_engine.max_general_workers` config option. Documentation "
+"for contributors to effectively use this threadpool is available online: "
+"https://docs.openstack.org/watcher/latest/contributor/concurrency.html"
+
+msgid ""
+"API calls while building the Compute data model will be retried upon "
+"failure. The amount of failures allowed before giving up and the time before "
+"reattempting are configurable. The `api_call_retries` and "
+"`api_query_timeout` parameters in the `[collector]` group can be used to "
+"adjust these paremeters. 10 retries with a 1 second time in between "
+"reattempts is the default."
+msgstr ""
+"API calls while building the Compute data model will be retried upon "
+"failure. The amount of failures allowed before giving up and the time before "
+"reattempting are configurable. The `api_call_retries` and "
+"`api_query_timeout` parameters in the `[collector]` group can be used to "
+"adjust these parameters. 10 retries with a 1 second time in between "
+"reattempts is the default."
+
+msgid ""
+"Add a new webhook API and a new audit type EVENT, the microversion is 1.4. "
+"Now Watcher user can create audit with EVENT type and the audit will be "
+"triggered by webhook API. The user guide is available online: https://docs."
+"openstack.org/watcher/latest/user/event_type_audit.html"
+msgstr ""
+"Add a new webhook API and a new audit type EVENT, the microversion is 1.4. "
+"Now Watcher user can create audit with EVENT type and the audit will be "
+"triggered by webhook API. The user guide is available online: https://docs."
+"openstack.org/watcher/latest/user/event_type_audit.html"
+
 msgid "Add a service supervisor to watch Watcher deamons."
 msgstr "Add a service supervisor to watch Watcher daemons."
 
@@ -67,6 +131,24 @@ msgstr ""
 "Add description property for dynamic action. Admin can see detail "
 "information of any specify action."
 
+msgid ""
+"Add force field to Audit. User can set --force to enable the new option when "
+"launching audit. If force is True, audit will be executed despite of ongoing "
+"actionplan. The new audit may create a wrong actionplan if they use the same "
+"data model."
+msgstr ""
+"Add force field to Audit. User can set --force to enable the new option when "
+"launching audit. If force is True, audit will be executed despite of ongoing "
+"actionplan. The new audit may create a wrong actionplan if they use the same "
+"data model."
+
+msgid ""
+"Add keystone_client Group for user to configure 'interface' and "
+"'region_name' by watcher.conf. The default value of 'interface' is 'admin'."
+msgstr ""
+"Add keystone_client Group for user to configure 'interface' and "
+"'region_name' by watcher.conf. The default value of 'interface' is 'admin'."
+
 msgid "Add notifications related to Action object."
 msgstr "Add notifications related to Action object."
 
@@ -79,6 +161,25 @@ msgstr "Add notifications related to Audit object."
 msgid "Add notifications related to Service object."
 msgstr "Add notifications related to Service object."
 
+msgid ""
+"Add show data model api for Watcher. New in version 1.3. User can use "
+"'openstack optimize datamodel list' command to view the current data model "
+"information in memory. User can also add '--audit <Audit_UUID>' to view "
+"specific data model in memory filted by the scope in audit. User can also "
+"add '--detail' to view detailed information about current data model. User "
+"can also add '--type <type>' to specify the type of data model. Default type "
+"is 'compute'. In the future, type 'storage' and 'baremetal' will be "
+"supported."
+msgstr ""
+"Add show data model API for Watcher. New in version 1.3. User can use "
+"'openstack optimize datamodel list' command to view the current data model "
+"information in memory. User can also add '--audit <Audit_UUID>' to view "
+"specific data model in memory filtered by the scope in audit. User can also "
+"add '--detail' to view detailed information about current data model. User "
+"can also add '--type <type>' to specify the type of data model. Default type "
+"is 'compute'. In the future, type 'storage' and 'baremetal' will be "
+"supported."
+
 msgid ""
 "Add start_time and end_time fields in audits table. User can set the start "
 "time and/or end time when creating CONTINUOUS audit."
@@ -93,6 +194,19 @@ msgstr ""
 "Add superseded state for an action plan if the cluster data model has "
 "changed after it has been created."
 
+msgid ""
+"Added Placement API helper to Watcher. Now Watcher can get information about "
+"resource providers, it can be used for the data model and strategies. Config "
+"group placement_client with options 'api_version', 'interface' and "
+"'region_name' is also added. The default values for 'api_version' and "
+"'interface' are 1.29 and 'public', respectively."
+msgstr ""
+"Added Placement API helper to Watcher. Now Watcher can get information about "
+"resource providers, it can be used for the data model and strategies. Config "
+"group placement_client with options 'api_version', 'interface' and "
+"'region_name' is also added. The default values for 'api_version' and "
+"'interface' are 1.29 and 'public', respectively."
+
 msgid "Added SUSPENDED audit state"
 msgstr "Added SUSPENDED audit state"
 
@@ -107,6 +221,31 @@ msgstr ""
 "scoring engine by different Strategies, which improve the code and data "
 "model re-use."
 
+msgid ""
+"Added a new config option 'action_execution_rule' which is a dict type. Its "
+"key field is strategy name and the value is 'ALWAYS' or 'ANY'. 'ALWAYS' "
+"means the callback function returns True as usual. 'ANY' means the return "
+"depends on the result of previous action execution. The callback returns "
+"True if previous action gets failed, and the engine continues to run the "
+"next action. If previous action executes success, the callback returns False "
+"then the next action will be ignored. For strategies that aren't in "
+"'action_execution_rule', the callback always returns True. Please add the "
+"next section in the watcher.conf file if your strategy needs this feature. "
+"[watcher_workflow_engines.taskflow] action_execution_rule = {'your strategy "
+"name': 'ANY'}"
+msgstr ""
+"Added a new config option 'action_execution_rule' which is a dict type. Its "
+"key field is strategy name and the value is 'ALWAYS' or 'ANY'. 'ALWAYS' "
+"means the callback function returns True as usual. 'ANY' means the return "
+"depends on the result of previous action execution. The callback returns "
+"True if previous action gets failed, and the engine continues to run the "
+"next action. If previous action executes success, the callback returns False "
+"then the next action will be ignored. For strategies that aren't in "
+"'action_execution_rule', the callback always returns True. Please add the "
+"next section in the watcher.conf file if your strategy needs this feature. "
+"[watcher_workflow_engines.taskflow] action_execution_rule = {'your strategy "
+"name': 'ANY'}"
+
 msgid ""
 "Added a new strategy based on the airflow of servers. This strategy makes "
 "decisions to migrate VMs to make the airflow uniform."
@@ -248,6 +387,15 @@ msgstr ""
 "The strategy migrates many instances and volumes efficiently with minimum "
 "downtime automatically."
 
+msgid ""
+"Added strategy \"node resource consolidation\". This strategy is used to "
+"centralize VMs to as few nodes as possible by VM migration. User can set an "
+"input parameter to decide how to select the destination node."
+msgstr ""
+"Added strategy \"node resource consolidation\". This strategy is used to "
+"centralize VMs to as few nodes as possible by VM migration. User can set an "
+"input parameter to decide how to select the destination node."
+
 msgid ""
 "Added strategy to identify and migrate a Noisy Neighbor - a low priority VM "
 "that negatively affects peformance of a high priority VM by over utilizing "
@@ -284,6 +432,19 @@ msgstr ""
 msgid "Adds baremetal data model in Watcher"
 msgstr "Adds baremetal data model in Watcher"
 
+msgid ""
+"All datasources can now be configured to retry retrieving a metric upon "
+"encountering an error. Between each attempt will be a set amount of time "
+"which can be adjusted from the configuration. These configuration options "
+"can be found in the `[watcher_datasources]` group and are named "
+"`query_max_retries` and `query_timeout`."
+msgstr ""
+"All datasources can now be configured to retry retrieving a metric upon "
+"encountering an error. Between each attempt will be a set amount of time "
+"which can be adjusted from the configuration. These configuration options "
+"can be found in the `[watcher_datasources]` group and are named "
+"`query_max_retries` and `query_timeout`."
+
 msgid ""
 "Allow decision engine to pass strategy parameters, like optimization "
 "threshold, to selected strategy, also strategy to provide parameters info to "
@@ -293,6 +454,34 @@ msgstr ""
 "threshold, to selected strategy, also strategy to provide parameters info to "
 "end user."
 
+msgid ""
+"Allow using file to override metric map. Override the metric map of each "
+"datasource as soon as it is created by the manager. This override comes from "
+"a file whose path is provided by a setting in config file. The setting is "
+"`watcher_decision_engine/metric_map_path`.  The file contains a map per "
+"datasource whose keys are the metric names as recognized by watcher and the "
+"value is the real name of the metric in the datasource. This setting "
+"defaults to `/etc/watcher/metric_map.yaml`, and presence of this file is "
+"optional."
+msgstr ""
+"Allow using file to override metric map. Override the metric map of each "
+"datasource as soon as it is created by the manager. This override comes from "
+"a file whose path is provided by a setting in config file. The setting is "
+"`watcher_decision_engine/metric_map_path`.  The file contains a map per "
+"datasource whose keys are the metric names as recognized by watcher and the "
+"value is the real name of the metric in the datasource. This setting "
+"defaults to `/etc/watcher/metric_map.yaml`, and presence of this file is "
+"optional."
+
+msgid ""
+"An Watcher API WSGI application script ``watcher-api-wsgi`` is now "
+"available. It is auto-generated by ``pbr`` and allows to run the API service "
+"using WSGI server (for example Nginx and uWSGI)."
+msgstr ""
+"An Watcher API WSGI application script ``watcher-api-wsgi`` is now "
+"available. It is auto-generated by ``pbr`` and allows to run the API service "
+"using WSGI server (for example Nginx and uWSGI)."
+
 msgid ""
 "Audits have 'name' field now, that is more friendly to end users. Audit's "
 "name can't exceed 63 characters."
@@ -300,9 +489,25 @@ msgstr ""
 "Audits have 'name' field now, that is more friendly to end users. Audit's "
 "name can't exceed 63 characters."
 
+msgid ""
+"Baremetal Model gets Audit scoper with an ability to exclude Ironic nodes."
+msgstr ""
+"Baremetal Model gets Audit scope with an ability to exclude Ironic nodes."
+
 msgid "Bug Fixes"
 msgstr "Bug Fixes"
 
+msgid ""
+"Ceilometer Datasource has been deprecated since its API has been deprecated "
+"in Ocata cycle. Watcher has supported Ceilometer for some releases after "
+"Ocata to let users migrate to Gnocchi/Monasca datasources. Since Train "
+"release, Ceilometer support will be removed."
+msgstr ""
+"Ceilometer Datasource has been deprecated since its API has been deprecated "
+"in Ocata cycle. Watcher has supported Ceilometer for some releases after "
+"Ocata to let users migrate to Gnocchi/Monasca datasources. Since Train "
+"release, Ceilometer support will be removed."
+
 msgid "Centralize all configuration options for Watcher."
 msgstr "Centralise all configuration options for Watcher."
 
@@ -360,6 +565,52 @@ msgstr ""
 "Now instances from particular project in OpenStack can be excluded from "
 "audit defining scope in audit templates."
 
+msgid ""
+"For a large cloud infrastructure, retrieving data from Nova may take a long "
+"time. To avoid getting too much data from Nova, building the compute data "
+"model according to the scope of audit."
+msgstr ""
+"For a large cloud infrastructure, retrieving data from Nova may take a long "
+"time. To avoid getting too much data from Nova, building the compute data "
+"model according to the scope of audit."
+
+msgid ""
+"Grafana has been added as datasource that can be used for collecting "
+"metrics. The configuration options allow to specify what metrics and how "
+"they are stored in grafana so that no matter how Grafana is configured it "
+"can still be used. The configuration can be done via the typical "
+"configuration file but it is recommended to configure most options in the "
+"yaml file for metrics. For a complete walkthrough on configuring Grafana "
+"see: https://docs.openstack.org/watcher/latest/datasources/grafana.html"
+msgstr ""
+"Grafana has been added as datasource that can be used for collecting "
+"metrics. The configuration options allow to specify what metrics and how "
+"they are stored in Grafana so that no matter how Grafana is configured it "
+"can still be used. The configuration can be done via the typical "
+"configuration file but it is recommended to configure most options in the "
+"yaml file for metrics. For a complete walkthrough on configuring Grafana "
+"see: https://docs.openstack.org/watcher/latest/datasources/grafana.html"
+
+msgid ""
+"If Gnocchi was configured to have a custom amount of retries and or a custom "
+"timeout then the configuration needs to moved into the "
+"`[watcher_datasources]` group instead of the `[gnocchi_client]` group."
+msgstr ""
+"If Gnocchi was configured to have a custom amount of retries and or a custom "
+"timeout then the configuration needs to moved into the "
+"`[watcher_datasources]` group instead of the `[gnocchi_client]` group."
+
+msgid ""
+"Improved interface for datasource baseclass that better defines expected "
+"values and types for parameters and return types of all abstract methods. "
+"This allows all strategies to work with every datasource provided the "
+"metrics are configured for that given datasource."
+msgstr ""
+"Improved interface for datasource baseclass that better defines expected "
+"values and types for parameters and return types of all abstract methods. "
+"This allows all strategies to work with every datasource provided the "
+"metrics are configured for that given datasource."
+
 msgid ""
 "Instance cold migration logic is now replaced with using Nova migrate "
 "Server(migrate Action) API which has host option since v2.56."
@@ -367,6 +618,17 @@ msgstr ""
 "Instance cold migration logic is now replaced with using Nova migrate "
 "Server(migrate Action) API which has host option since v2.56."
 
+msgid ""
+"Many operations in the decision engine will block on I/O. Such I/O "
+"operations can stall the execution of a sequential application "
+"significantly. To reduce the potential bottleneck of many operations the "
+"general purpose decision engine threadpool is introduced."
+msgstr ""
+"Many operations in the decision engine will block on I/O. Such I/O "
+"operations can stall the execution of a sequential application "
+"significantly. To reduce the potential bottleneck of many operations the "
+"general purpose decision engine threadpool is introduced."
+
 msgid "New Features"
 msgstr "New Features"
 
@@ -389,6 +651,13 @@ msgstr ""
 "Nova API version is now set to 2.56 by default. This needs the migrate "
 "action of migration type cold with destination_node parameter to work."
 
+msgid ""
+"Now Watcher strategy can select specific planner beyond default. Strategy "
+"can set planner property to specify its own planner."
+msgstr ""
+"Now Watcher strategy can select specific planner beyond default. Strategy "
+"can set planner property to specify its own planner."
+
 msgid "Ocata Series Release Notes"
 msgstr "Ocata Series Release Notes"
 
@@ -429,12 +698,77 @@ msgstr ""
 "resources will be called \"Audit scope\" and will be defined in each audit "
 "template (which contains the audit settings)."
 
+msgid ""
+"Python 2.7 support has been dropped. Last release of Watcher to support "
+"py2.7 is OpenStack Train. The minimum version of Python now supported by "
+"Watcher is Python 3.6."
+msgstr ""
+"Python 2.7 support has been dropped. Last release of Watcher to support "
+"py2.7 is OpenStack Train. The minimum version of Python now supported by "
+"Watcher is Python 3.6."
+
 msgid "Queens Series Release Notes"
 msgstr "Queens Series Release Notes"
 
 msgid "Rocky Series Release Notes"
 msgstr "Rocky Series Release Notes"
 
+msgid ""
+"Several strategies have changed the `node` parameter to `compute_node` to be "
+"better aligned with terminology. These strategies include "
+"`basic_consolidation` and `workload_stabilzation`. The `node` parameter will "
+"remain supported during Train release and will be removed in the subsequent "
+"release."
+msgstr ""
+"Several strategies have changed the `node` parameter to `compute_node` to be "
+"better aligned with terminology. These strategies include "
+"`basic_consolidation` and `workload_stabilzation`. The `node` parameter will "
+"remain supported during Train release and will be removed in the subsequent "
+"release."
+
+msgid ""
+"Specific strategies can override this order and use datasources which are "
+"not listed in the global preference."
+msgstr ""
+"Specific strategies can override this order and use datasources which are "
+"not listed in the global preference."
+
+msgid "Stein Series Release Notes"
+msgstr "Stein Series Release Notes"
+
+msgid ""
+"The building of the compute (Nova) data model will be done using the "
+"decision engine threadpool, thereby, significantly reducing the total time "
+"required to build it."
+msgstr ""
+"The building of the compute (Nova) data model will be done using the "
+"decision engine threadpool, thereby, significantly reducing the total time "
+"required to build it."
+
+msgid ""
+"The configuration options for query retries in `[gnocchi_client]` are "
+"deprecated and the option in `[watcher_datasources]` should now be used."
+msgstr ""
+"The configuration options for query retries in `[gnocchi_client]` are "
+"deprecated and the option in `[watcher_datasources]` should now be used."
+
+msgid ""
+"The default value of ``[oslo_policy] policy_file`` config option has been "
+"changed from ``policy.json`` to ``policy.yaml``. Operators who are utilizing "
+"customized or previously generated static policy JSON files (which are not "
+"needed by default), should generate new policy files or convert them in YAML "
+"format. Use the `oslopolicy-convert-json-to-yaml <https://docs.openstack.org/"
+"oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_ tool to "
+"convert a JSON to YAML formatted policy file in backward compatible way."
+msgstr ""
+"The default value of ``[oslo_policy] policy_file`` config option has been "
+"changed from ``policy.json`` to ``policy.yaml``. Operators who are utilizing "
+"customized or previously generated static policy JSON files (which are not "
+"needed by default), should generate new policy files or convert them in YAML "
+"format. Use the `oslopolicy-convert-json-to-yaml <https://docs.openstack.org/"
+"oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_ tool to "
+"convert a JSON to YAML formatted policy file in backward compatible way."
+
 msgid ""
 "The graph model describes how VMs are associated to compute hosts. This "
 "allows for seeing relationships upfront between the entities and hence can "
@@ -455,6 +789,22 @@ msgstr ""
 "was fixed. Before fixing, it booted an instance in the service project as a "
 "migrated instance."
 
+msgid ""
+"The minimum required version of the ``[nova_client]/api_version`` value is "
+"now enforced to be ``2.56`` which is available since the Queens version of "
+"the nova compute service."
+msgstr ""
+"The minimum required version of the ``[nova_client]/api_version`` value is "
+"now enforced to be ``2.56`` which is available since the Queens version of "
+"the Nova compute service."
+
+msgid ""
+"The new strategy baseclass has significant changes in method parameters and "
+"any out-of-tree strategies will have to be adopted."
+msgstr ""
+"The new strategy baseclass has significant changes in method parameters and "
+"any out-of-tree strategies will have to be adopted."
+
 msgid ""
 "There is new ability to create Watcher continuous audits with cron interval. "
 "It means you may use, for example, optional argument '--interval \"\\*/5 \\* "
@@ -468,9 +818,45 @@ msgstr ""
 "best effort basis and therefore, we recommend you to use a minimal cron "
 "interval of at least one minute."
 
+msgid "Train Series Release Notes"
+msgstr "Train Series Release Notes"
+
 msgid "Upgrade Notes"
 msgstr "Upgrade Notes"
 
+msgid ""
+"Use of JSON policy files was deprecated by the ``oslo.policy`` library "
+"during the Victoria development cycle. As a result, this deprecation is "
+"being noted in the Wallaby cycle with an anticipated future removal of "
+"support by ``oslo.policy``. As such operators will need to convert to YAML "
+"policy files. Please see the upgrade notes for details on migration of any "
+"custom policy files."
+msgstr ""
+"Use of JSON policy files was deprecated by the ``oslo.policy`` library "
+"during the Victoria development cycle. As a result, this deprecation is "
+"being noted in the Wallaby cycle with an anticipated future removal of "
+"support by ``oslo.policy``. As such operators will need to convert to YAML "
+"policy files. Please see the upgrade notes for details on migration of any "
+"custom policy files."
+
+msgid ""
+"Using ``watcher/api/app.wsgi`` script is deprecated and it will be removed "
+"in U release. Please switch to automatically generated ``watcher-api-wsgi`` "
+"script instead."
+msgstr ""
+"Using ``watcher/api/app.wsgi`` script is deprecated and it will be removed "
+"in U release. Please switch to automatically generated ``watcher-api-wsgi`` "
+"script instead."
+
+msgid "Ussuri Series Release Notes"
+msgstr "Ussuri Series Release Notes"
+
+msgid "Victoria Series Release Notes"
+msgstr "Victoria Series Release Notes"
+
+msgid "Wallaby Series Release Notes"
+msgstr "Wallaby Series Release Notes"
+
 msgid ""
 "Watcher can continuously optimize the OpenStack cloud for a specific "
 "strategy or goal by triggering an audit periodically which generates an "
@@ -480,6 +866,15 @@ msgstr ""
 "strategy or goal by triggering an audit periodically which generates an "
 "action plan and run it automatically."
 
+msgid ""
+"Watcher can get resource information such as total, allocation ratio and "
+"reserved information from Placement API. Now we add some new fields to the "
+"Watcher Data Model:"
+msgstr ""
+"Watcher can get resource information such as total, allocation ratio and "
+"reserved information from Placement API. Now we add some new fields to the "
+"Watcher Data Model:"
+
 msgid ""
 "Watcher can now run specific actions in parallel improving the performances "
 "dramatically when executing an action plan."
@@ -517,6 +912,15 @@ msgstr ""
 "includes all instances. It filters excluded instances when migration during "
 "the audit."
 
+msgid ""
+"Watcher now supports configuring which datasource to use and in which order. "
+"This configuration is done by specifying datasources in the "
+"watcher_datasources section:"
+msgstr ""
+"Watcher now supports configuring which datasource to use and in which order. "
+"This configuration is done by specifying datasources in the "
+"watcher_datasources section:"
+
 msgid ""
 "Watcher removes the support to Nova legacy notifications because of Nova "
 "will deprecate them."
@@ -557,9 +961,24 @@ msgstr ""
 "Watcher supports multiple metrics backend and relies on Ceilometer and "
 "Monasca."
 
+msgid "We also add some new propeties:"
+msgstr "We also add some new properties:"
+
 msgid "Welcome to watcher's Release Notes documentation!"
 msgstr "Welcome to watcher's Release Notes documentation!"
 
+msgid "Xena Series Release Notes"
+msgstr "Xena Series Release Notes"
+
+msgid "Yoga Series Release Notes"
+msgstr "Yoga Series Release Notes"
+
+msgid "Zed Series Release Notes"
+msgstr "Zed Series Release Notes"
+
+msgid "``[watcher_datasources] datasources = gnocchi,monasca,ceilometer``"
+msgstr "``[watcher_datasources] datasources = gnocchi,monasca,ceilometer``"
+
 msgid ""
 "all Watcher objects have been refactored to support OVO (oslo."
 "versionedobjects) which was a prerequisite step in order to implement "
@@ -569,6 +988,21 @@ msgstr ""
 "versionedobjects) which was a prerequisite step in order to implement "
 "versioned notifications."
 
+msgid ""
+"disk_gb_capacity: The amount of disk, take allocation ratio into account, "
+"but do not include reserved."
+msgstr ""
+"disk_gb_capacity: The amount of disk, take allocation ratio into account, "
+"but do not include reserved."
+
+msgid ""
+"disk_gb_reserved: The amount of disk a node has reserved for its own use."
+msgstr ""
+"disk_gb_reserved: The amount of disk a node has reserved for its own use."
+
+msgid "disk_ratio: Disk allocation ratio."
+msgstr "disk_ratio: Disk allocation ratio."
+
 msgid "instance.create.end"
 msgstr "instance.create.end"
 
@@ -635,6 +1069,21 @@ msgstr "instance.unshelve.end"
 msgid "instance.update"
 msgstr "instance.update"
 
+msgid ""
+"memory_mb_capacity: The amount of memory, take allocation ratio into "
+"account, but do not include reserved."
+msgstr ""
+"memory_mb_capacity: The amount of memory, take allocation ratio into "
+"account, but do not include reserved."
+
+msgid ""
+"memory_mb_reserved: The amount of memory a node has reserved for its own use."
+msgstr ""
+"memory_mb_reserved: The amount of memory a node has reserved for its own use."
+
+msgid "memory_ratio: Memory allocation ratio."
+msgstr "memory_ratio: Memory allocation ratio."
+
 msgid "new:"
 msgstr "new:"
 
@@ -649,3 +1098,16 @@ msgstr "service.delete"
 
 msgid "service.update"
 msgstr "service.update"
+
+msgid ""
+"vcpu_capacity: The amount of vcpu, take allocation ratio into account, but "
+"do not include reserved."
+msgstr ""
+"vcpu_capacity: The amount of vcpu, take allocation ratio into account, but "
+"do not include reserved."
+
+msgid "vcpu_ratio: CPU allocation ratio."
+msgstr "vcpu_ratio: CPU allocation ratio."
+
+msgid "vcpu_reserved: The amount of cpu a node has reserved for its own use."
+msgstr "vcpu_reserved: The amount of CPU a node has reserved for its own use."

releasenotes/source/victoria.rst

@@ -0,0 +1,6 @@
+=============================
+Victoria Series Release Notes
+=============================
+
+.. release-notes::
+   :branch: stable/victoria

releasenotes/source/wallaby.rst

@@ -0,0 +1,6 @@
+============================
+Wallaby Series Release Notes
+============================
+
+.. release-notes::
+   :branch: stable/wallaby

releasenotes/source/xena.rst

@@ -0,0 +1,6 @@
+=========================
+Xena Series Release Notes
+=========================
+
+.. release-notes::
+   :branch: stable/xena

releasenotes/source/yoga.rst

@@ -0,0 +1,6 @@
+=========================
+Yoga Series Release Notes
+=========================
+
+.. release-notes::
+   :branch: stable/yoga

releasenotes/source/zed.rst

@@ -0,0 +1,6 @@
+========================
+Zed Series Release Notes
+========================
+
+.. release-notes::
+   :branch: stable/zed

requirements.txt

@@ -1,4 +1,4 @@
-# The order of packages is significant, because pip processes them in the order
+#  The order of packages is significant, because pip processes them in the order
 # of appearance. Changing the order has an impact on the overall integration
 # process, which may cause wedges in the gate later.
 
@@ -7,30 +7,29 @@ jsonpatch>=1.21 # BSD
 keystoneauth1>=3.4.0 # Apache-2.0
 jsonschema>=3.2.0 # MIT
 keystonemiddleware>=4.21.0 # Apache-2.0
-lxml>=4.1.1 # BSD
+lxml>=4.5.1 # BSD
 croniter>=0.3.20 # MIT License
 os-resource-classes>=0.4.0
 oslo.concurrency>=3.26.0 # Apache-2.0
 oslo.cache>=1.29.0 # Apache-2.0
-oslo.config>=5.2.0 # Apache-2.0
+oslo.config>=6.8.0 # Apache-2.0
 oslo.context>=2.21.0 # Apache-2.0
-oslo.db>=4.35.0 # Apache-2.0
+oslo.db>=4.44.0 # Apache-2.0
 oslo.i18n>=3.20.0 # Apache-2.0
 oslo.log>=3.37.0 # Apache-2.0
-oslo.messaging>=8.1.2 # Apache-2.0
-oslo.policy>=1.34.0 # Apache-2.0
+oslo.messaging>=14.1.0 # Apache-2.0
+oslo.policy>=3.6.0 # Apache-2.0
 oslo.reports>=1.27.0 # Apache-2.0
 oslo.serialization>=2.25.0 # Apache-2.0
 oslo.service>=1.30.0 # Apache-2.0
-oslo.upgradecheck>=0.1.0 # Apache-2.0
+oslo.upgradecheck>=1.3.0 # Apache-2.0
 oslo.utils>=3.36.0 # Apache-2.0
 oslo.versionedobjects>=1.32.0 # Apache-2.0
 PasteDeploy>=1.5.2 # MIT
 pbr>=3.1.1 # Apache-2.0
 pecan>=1.3.2 # BSD
-PrettyTable<0.8,>=0.7.2 # BSD
+PrettyTable>=0.7.2 # BSD
 gnocchiclient>=7.0.1 # Apache-2.0
-python-ceilometerclient>=2.9.0 # Apache-2.0
 python-cinderclient>=3.5.0 # Apache-2.0
 python-glanceclient>=2.9.1 # Apache-2.0
 python-keystoneclient>=3.15.0 # Apache-2.0
@@ -41,9 +40,9 @@ python-openstackclient>=3.14.0 # Apache-2.0
 python-ironicclient>=2.5.0 # Apache-2.0
 SQLAlchemy>=1.2.5 # MIT
 stevedore>=1.28.0 # Apache-2.0
-taskflow>=3.7.1 # Apache-2.0
+taskflow>=3.8.0 # Apache-2.0
 WebOb>=1.8.5 # MIT
 WSME>=0.9.2 # MIT
-networkx>=2.2 # BSD
+networkx>=2.4 # BSD
 microversion_parse>=0.2.1 # Apache-2.0
 futurist>=1.8.0 # Apache-2.0

setup.cfg

@@ -1,12 +1,12 @@
 [metadata]
 name = python-watcher
 summary = OpenStack Watcher provides a flexible and scalable resource optimization service for multi-tenant OpenStack-based clouds.
-description-file =
+description_file =
     README.rst
 author = OpenStack
-author-email = openstack-discuss@lists.openstack.org
-home-page = https://docs.openstack.org/watcher/latest/
-python-requires = >=3.6
+author_email = openstack-discuss@lists.openstack.org
+home_page = https://docs.openstack.org/watcher/latest/
+python_requires = >=3.8
 classifier =
     Environment :: OpenStack
     Intended Audience :: Information Technology
@@ -17,9 +17,10 @@ classifier =
     Programming Language :: Python :: Implementation :: CPython
     Programming Language :: Python :: 3 :: Only
     Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
+    Programming Language :: Python :: 3.11
 
 [files]
 packages =

test-requirements.txt

@@ -7,9 +7,9 @@ doc8>=0.8.0 # Apache-2.0
 freezegun>=0.3.10 # Apache-2.0
 hacking>=3.0.1,<3.1.0 # Apache-2.0
 oslotest>=3.3.0 # Apache-2.0
-os-testr>=1.0.0 # Apache-2.0
 testscenarios>=0.5.0 # Apache-2.0/BSD
 testtools>=2.3.0 # MIT
 stestr>=2.0.0 # Apache-2.0
 os-api-ref>=1.4.0 # Apache-2.0
 bandit>=1.6.0 # Apache-2.0
+WebTest>=2.0.27 # MIT

tox.ini

@@ -1,37 +1,41 @@
 [tox]
-minversion = 2.0
-envlist = py36,py37,pep8
-skipsdist = True
+minversion = 3.18.0
+envlist = py3,pep8
 ignore_basepython_conflict = True
 
 [testenv]
 basepython = python3
 usedevelop = True
-whitelist_externals = find
+allowlist_externals = find
                       rm
-install_command = pip install {opts} {packages}
+install_command = pip install -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} {opts} {packages}
 setenv =
    VIRTUAL_ENV={envdir}
 deps =
-    -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
     -r{toxinidir}/test-requirements.txt
     -r{toxinidir}/requirements.txt
+    python-libmaas>=0.6.8
 commands =
   rm -f .testrepository/times.dbm
   find . -type f -name "*.py[c|o]" -delete
   stestr run {posargs}
-passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
+passenv =
+  http_proxy
+  HTTP_PROXY
+  https_proxy
+  HTTPS_PROXY
+  no_proxy
+  NO_PROXY
 
 [testenv:pep8]
 commands =
     doc8 doc/source/ CONTRIBUTING.rst HACKING.rst README.rst
     flake8
-    bandit -r watcher -x watcher/tests/* -n5 -ll -s B320,B322
+    #bandit -r watcher -x watcher/tests/* -n5 -ll -s B320
 
 [testenv:venv]
 setenv = PYTHONHASHSEED=0
 deps =
-    -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
     -r{toxinidir}/doc/requirements.txt
     -r{toxinidir}/test-requirements.txt
     -r{toxinidir}/requirements.txt
@@ -49,14 +53,15 @@ commands =
 
 [testenv:docs]
 setenv = PYTHONHASHSEED=0
-deps = -r{toxinidir}/doc/requirements.txt
+deps =
+  -r{toxinidir}/doc/requirements.txt
 commands =
   rm -fr doc/build doc/source/api/ .autogenerated
   sphinx-build -W --keep-going -b html doc/source doc/build/html
 
 [testenv:api-ref]
 deps = -r{toxinidir}/doc/requirements.txt
-whitelist_externals = bash
+allowlist_externals = bash
 commands =
   bash -c 'rm -rf api-ref/build'
   sphinx-build -W --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
@@ -73,6 +78,28 @@ commands =
 commands =
     oslopolicy-sample-generator --config-file etc/watcher/oslo-policy-generator/watcher-policy-generator.conf
 
+[testenv:wheel]
+commands = python setup.py bdist_wheel
+
+[testenv:pdf-docs]
+envdir = {toxworkdir}/docs
+deps = {[testenv:docs]deps}
+allowlist_externals =
+  rm
+  make
+commands =
+  rm -rf doc/build/pdf
+  sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
+[testenv:releasenotes]
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -a -W -E -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
+
+[testenv:bandit]
+deps = -r{toxinidir}/test-requirements.txt
+commands = bandit -r watcher -x watcher/tests/* -n5 -ll -s B320
+
 [flake8]
 filename = *.py,app.wsgi
 show-source=True
@@ -82,9 +109,6 @@ builtins= _
 enable-extensions = H106,H203,H904
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,*sqlalchemy/alembic/versions/*,demo/,releasenotes
 
-[testenv:wheel]
-commands = python setup.py bdist_wheel
-
 [hacking]
 import_exceptions = watcher._i18n
 
@@ -108,33 +132,7 @@ extension =
    N366 = checks:import_stock_mock
 paths = ./watcher/hacking
 
-
 [doc8]
 extension=.rst
 # todo: stop ignoring doc/source/man when https://bugs.launchpad.net/doc8/+bug/1502391 is fixed
 ignore-path=doc/source/image_src,doc/source/man,doc/source/api
-
-[testenv:pdf-docs]
-envdir = {toxworkdir}/docs
-deps = {[testenv:docs]deps}
-whitelist_externals =
-  rm
-  make
-commands =
-  rm -rf doc/build/pdf
-  sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
-  make -C doc/build/pdf
-
-[testenv:releasenotes]
-deps = -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -a -W -E -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html
-
-[testenv:bandit]
-deps = -r{toxinidir}/test-requirements.txt
-commands = bandit -r watcher -x watcher/tests/* -n5 -ll -s B320
-
-[testenv:lower-constraints]
-deps =
-  -c{toxinidir}/lower-constraints.txt
-  -r{toxinidir}/test-requirements.txt
-  -r{toxinidir}/requirements.txt

watcher/api/controllers/v1/action.py

@@ -57,6 +57,7 @@ are dynamically loaded by Watcher at launch time.
 
 import datetime
 
+from http import HTTPStatus
 import pecan
 from pecan import rest
 import wsme
@@ -362,7 +363,7 @@ class ActionsController(rest.RestController):
 
         return Action.convert_with_links(action)
 
-    @wsme_pecan.wsexpose(Action, body=Action, status_code=201)
+    @wsme_pecan.wsexpose(Action, body=Action, status_code=HTTPStatus.CREATED)
     def post(self, action):
         """Create a new action(forbidden).
 
@@ -422,7 +423,7 @@ class ActionsController(rest.RestController):
         action_to_update.save()
         return Action.convert_with_links(action_to_update)
 
-    @wsme_pecan.wsexpose(None, types.uuid, status_code=204)
+    @wsme_pecan.wsexpose(None, types.uuid, status_code=HTTPStatus.NO_CONTENT)
     def delete(self, action_uuid):
         """Delete a action(forbidden).
 

watcher/api/controllers/v1/action_plan.py

@@ -56,6 +56,7 @@ state machine <action_plan_state_machine>`.
 
 import datetime
 
+from http import HTTPStatus
 from oslo_log import log
 import pecan
 from pecan import rest
@@ -460,7 +461,7 @@ class ActionPlansController(rest.RestController):
 
         return ActionPlan.convert_with_links(action_plan)
 
-    @wsme_pecan.wsexpose(None, types.uuid, status_code=204)
+    @wsme_pecan.wsexpose(None, types.uuid, status_code=HTTPStatus.NO_CONTENT)
     def delete(self, action_plan_uuid):
         """Delete an action plan.
 

watcher/api/controllers/v1/audit.py

@@ -32,6 +32,7 @@ states, visit :ref:`the Audit State machine <audit_state_machine>`.
 import datetime
 from dateutil import tz
 
+from http import HTTPStatus
 import pecan
 from pecan import rest
 import wsme
@@ -595,7 +596,8 @@ class AuditsController(rest.RestController):
 
         return Audit.convert_with_links(rpc_audit)
 
-    @wsme_pecan.wsexpose(Audit, body=AuditPostType, status_code=201)
+    @wsme_pecan.wsexpose(Audit, body=AuditPostType,
+                         status_code=HTTPStatus.CREATED)
     def post(self, audit_p):
         """Create a new audit.
 
@@ -717,7 +719,7 @@ class AuditsController(rest.RestController):
         audit_to_update.save()
         return Audit.convert_with_links(audit_to_update)
 
-    @wsme_pecan.wsexpose(None, wtypes.text, status_code=204)
+    @wsme_pecan.wsexpose(None, wtypes.text, status_code=HTTPStatus.NO_CONTENT)
     def delete(self, audit):
         """Delete an audit.
 

watcher/api/controllers/v1/audit_template.py

@@ -45,6 +45,7 @@ will be launched automatically or will need a manual confirmation from the
 
 import datetime
 
+from http import HTTPStatus
 import pecan
 from pecan import rest
 import wsme
@@ -618,7 +619,7 @@ class AuditTemplatesController(rest.RestController):
 
     @wsme.validate(types.uuid, AuditTemplatePostType)
     @wsme_pecan.wsexpose(AuditTemplate, body=AuditTemplatePostType,
-                         status_code=201)
+                         status_code=HTTPStatus.CREATED)
     def post(self, audit_template_postdata):
         """Create a new audit template.
 
@@ -694,7 +695,7 @@ class AuditTemplatesController(rest.RestController):
         audit_template_to_update.save()
         return AuditTemplate.convert_with_links(audit_template_to_update)
 
-    @wsme_pecan.wsexpose(None, wtypes.text, status_code=204)
+    @wsme_pecan.wsexpose(None, wtypes.text, status_code=HTTPStatus.NO_CONTENT)
     def delete(self, audit_template):
         """Delete a audit template.
 

watcher/api/controllers/v1/service.py

@@ -19,8 +19,6 @@ Service mechanism provides ability to monitor Watcher services state.
 """
 
 import datetime
-import six
-
 from oslo_config import cfg
 from oslo_log import log
 from oslo_utils import timeutils
@@ -70,7 +68,7 @@ class Service(base.APIBase):
         service = objects.Service.get(pecan.request.context, id)
         last_heartbeat = (service.last_seen_up or service.updated_at or
                           service.created_at)
-        if isinstance(last_heartbeat, six.string_types):
+        if isinstance(last_heartbeat, str):
             # NOTE(russellb) If this service came in over rpc via
             # conductor, then the timestamp will be a string and needs to be
             # converted back to a datetime.

watcher/api/controllers/v1/types.py

@@ -15,7 +15,6 @@
 
 from oslo_serialization import jsonutils
 from oslo_utils import strutils
-import six
 import wsme
 from wsme import types as wtypes
 
@@ -132,7 +131,7 @@ class JsonType(wtypes.UserType):
 
     def __str__(self):
         # These are the json serializable native types
-        return ' | '.join(map(str, (wtypes.text, six.integer_types, float,
+        return ' | '.join(map(str, (wtypes.text, int, float,
                                     BooleanType, list, dict, None)))
 
     @staticmethod

watcher/api/controllers/v1/webhooks.py

@@ -14,6 +14,7 @@
 Webhook endpoint for Watcher v1 REST API.
 """
 
+from http import HTTPStatus
 from oslo_log import log
 import pecan
 from pecan import rest
@@ -36,7 +37,7 @@ class WebhookController(rest.RestController):
         self.dc_client = rpcapi.DecisionEngineAPI()
 
     @wsme_pecan.wsexpose(None, wtypes.text, body=types.jsontype,
-                         status_code=202)
+                         status_code=HTTPStatus.ACCEPTED)
     def post(self, audit_ident, body):
         """Trigger the given audit.
 

watcher/api/hooks.py

@@ -15,7 +15,7 @@
 # under the License.
 
 
-from http import client as http_client
+from http import HTTPStatus
 from oslo_config import cfg
 from pecan import hooks
 
@@ -91,8 +91,8 @@ class NoExceptionTracebackHook(hooks.PecanHook):
         # Do nothing if there is no error.
         # Status codes in the range 200 (OK) to 399 (400 = BAD_REQUEST) are not
         # an error.
-        if (http_client.OK <= state.response.status_int <
-                http_client.BAD_REQUEST):
+        if (HTTPStatus.OK <= state.response.status_int <
+                HTTPStatus.BAD_REQUEST):
             return
 
         json_body = state.response.json

watcher/applier/actions/change_node_power_state.py

@@ -17,17 +17,17 @@
 # limitations under the License.
 #
 
-import enum
 import time
 
+from oslo_log import log
+
 from watcher._i18n import _
 from watcher.applier.actions import base
 from watcher.common import exception
+from watcher.common.metal_helper import constants as metal_constants
+from watcher.common.metal_helper import factory as metal_helper_factory
 
-
-class NodeState(enum.Enum):
-    POWERON = 'on'
-    POWEROFF = 'off'
+LOG = log.getLogger(__name__)
 
 
 class ChangeNodePowerState(base.BaseAction):
@@ -43,8 +43,8 @@ class ChangeNodePowerState(base.BaseAction):
          'state': str,
         })
 
-    The `resource_id` references a ironic node id (list of available
-    ironic node is returned by this command: ``ironic node-list``).
+    The `resource_id` references a baremetal node id (list of available
+    ironic nodes is returned by this command: ``ironic node-list``).
     The `state` value should either be `on` or `off`.
     """
 
@@ -59,10 +59,14 @@ class ChangeNodePowerState(base.BaseAction):
                     'type': 'string',
                     "minlength": 1
                 },
+                'resource_name': {
+                    'type': 'string',
+                    "minlength": 1
+                },
                 'state': {
                     'type': 'string',
-                    'enum': [NodeState.POWERON.value,
-                             NodeState.POWEROFF.value]
+                    'enum': [metal_constants.PowerState.ON.value,
+                             metal_constants.PowerState.OFF.value]
                 }
             },
             'required': ['resource_id', 'state'],
@@ -82,10 +86,10 @@ class ChangeNodePowerState(base.BaseAction):
         return self._node_manage_power(target_state)
 
     def revert(self):
-        if self.state == NodeState.POWERON.value:
-            target_state = NodeState.POWEROFF.value
-        elif self.state == NodeState.POWEROFF.value:
-            target_state = NodeState.POWERON.value
+        if self.state == metal_constants.PowerState.ON.value:
+            target_state = metal_constants.PowerState.OFF.value
+        elif self.state == metal_constants.PowerState.OFF.value:
+            target_state = metal_constants.PowerState.ON.value
         return self._node_manage_power(target_state)
 
     def _node_manage_power(self, state, retry=60):
@@ -93,30 +97,32 @@ class ChangeNodePowerState(base.BaseAction):
             raise exception.IllegalArgumentException(
                 message=_("The target state is not defined"))
 
-        ironic_client = self.osc.ironic()
-        nova_client = self.osc.nova()
-        current_state = ironic_client.node.get(self.node_uuid).power_state
-        # power state: 'power on' or 'power off', if current node state
-        # is the same as state, just return True
-        if state in current_state:
+        metal_helper = metal_helper_factory.get_helper(self.osc)
+        node = metal_helper.get_node(self.node_uuid)
+        current_state = node.get_power_state()
+
+        if state == current_state.value:
             return True
 
-        if state == NodeState.POWEROFF.value:
-            node_info = ironic_client.node.get(self.node_uuid).to_dict()
-            compute_node_id = node_info['extra']['compute_node_id']
-            compute_node = nova_client.hypervisors.get(compute_node_id)
-            compute_node = compute_node.to_dict()
+        if state == metal_constants.PowerState.OFF.value:
+            compute_node = node.get_hypervisor_node().to_dict()
             if (compute_node['running_vms'] == 0):
-                ironic_client.node.set_power_state(
-                    self.node_uuid, state)
+                node.set_power_state(state)
+            else:
+                LOG.warning(
+                    "Compute node %s has %s running vms and will "
+                    "NOT be shut off.",
+                    compute_node["hypervisor_hostname"],
+                    compute_node['running_vms'])
+                return False
         else:
-            ironic_client.node.set_power_state(self.node_uuid, state)
+            node.set_power_state(state)
 
-        ironic_node = ironic_client.node.get(self.node_uuid)
-        while ironic_node.power_state == current_state and retry:
+        node = metal_helper.get_node(self.node_uuid)
+        while node.get_power_state() == current_state and retry:
             time.sleep(10)
             retry -= 1
-            ironic_node = ironic_client.node.get(self.node_uuid)
+            node = metal_helper.get_node(self.node_uuid)
         if retry > 0:
             return True
         else:
@@ -130,4 +136,4 @@ class ChangeNodePowerState(base.BaseAction):
 
     def get_description(self):
         """Description of the action"""
-        return ("Compute node power on/off through ironic.")
+        return ("Compute node power on/off through Ironic or MaaS.")

watcher/cmd/status.py

@@ -14,6 +14,7 @@
 
 import sys
 
+from oslo_upgradecheck import common_checks
 from oslo_upgradecheck import upgradecheck
 
 from watcher._i18n import _
@@ -43,6 +44,10 @@ class Checks(upgradecheck.UpgradeCommands):
     _upgrade_checks = (
         # Added in Train.
         (_('Minimum Nova API Version'), _minimum_nova_api_version),
+        # Added in Wallaby.
+        (_("Policy File JSON to YAML Migration"),
+         (common_checks.check_policy_json, {'conf': CONF})),
+
     )
 
 

watcher/common/cinder_helper.py

@@ -17,7 +17,7 @@ import time
 from oslo_log import log
 
 from cinderclient import exceptions as cinder_exception
-from cinderclient.v2.volumes import Volume
+from cinderclient.v3.volumes import Volume
 from watcher._i18n import _
 from watcher.common import clients
 from watcher.common import exception

watcher/common/clients.py

@@ -25,6 +25,7 @@ from novaclient import api_versions as nova_api_versions
 from novaclient import client as nvclient
 
 from watcher.common import exception
+from watcher.common import utils
 
 try:
     from ceilometerclient import client as ceclient
@@ -32,6 +33,12 @@ try:
 except ImportError:
     HAS_CEILCLIENT = False
 
+try:
+    from maas import client as maas_client
+except ImportError:
+    maas_client = None
+
+
 CONF = cfg.CONF
 
 _CLIENTS_AUTH_GROUP = 'watcher_clients_auth'
@@ -74,6 +81,7 @@ class OpenStackClients(object):
         self._monasca = None
         self._neutron = None
         self._ironic = None
+        self._maas = None
         self._placement = None
 
     def _get_keystone_session(self):
@@ -265,6 +273,23 @@ class OpenStackClients(object):
                                            session=self.session)
         return self._ironic
 
+    def maas(self):
+        if self._maas:
+            return self._maas
+
+        if not maas_client:
+            raise exception.UnsupportedError(
+                "MAAS client unavailable. Please install python-libmaas.")
+
+        url = self._get_client_option('maas', 'url')
+        api_key = self._get_client_option('maas', 'api_key')
+        timeout = self._get_client_option('maas', 'timeout')
+        self._maas = utils.async_compat_call(
+            maas_client.connect,
+            url, apikey=api_key,
+            timeout=timeout)
+        return self._maas
+
     @exception.wrap_keystone_exception
     def placement(self):
         if self._placement:

watcher/common/exception.py

@@ -25,6 +25,7 @@ SHOULD include dedicated exception logging.
 import functools
 import sys
 
+from http import HTTPStatus
 from keystoneclient import exceptions as keystone_exceptions
 from oslo_config import cfg
 from oslo_log import log
@@ -62,7 +63,7 @@ class WatcherException(Exception):
 
     """
     msg_fmt = _("An unknown exception occurred")
-    code = 500
+    code = HTTPStatus.INTERNAL_SERVER_ERROR
     headers = {}
     safe = False
 
@@ -114,12 +115,12 @@ class UnsupportedError(WatcherException):
 
 class NotAuthorized(WatcherException):
     msg_fmt = _("Not authorized")
-    code = 403
+    code = HTTPStatus.FORBIDDEN
 
 
 class NotAcceptable(WatcherException):
     msg_fmt = _("Request not acceptable.")
-    code = 406
+    code = HTTPStatus.NOT_ACCEPTABLE
 
 
 class PolicyNotAuthorized(NotAuthorized):
@@ -132,7 +133,7 @@ class OperationNotPermitted(NotAuthorized):
 
 class Invalid(WatcherException, ValueError):
     msg_fmt = _("Unacceptable parameters")
-    code = 400
+    code = HTTPStatus.BAD_REQUEST
 
 
 class ObjectNotFound(WatcherException):
@@ -141,12 +142,12 @@ class ObjectNotFound(WatcherException):
 
 class Conflict(WatcherException):
     msg_fmt = _('Conflict')
-    code = 409
+    code = HTTPStatus.CONFLICT
 
 
 class ResourceNotFound(ObjectNotFound):
     msg_fmt = _("The %(name)s resource %(id)s could not be found")
-    code = 404
+    code = HTTPStatus.NOT_FOUND
 
 
 class InvalidParameter(Invalid):

watcher/common/metal_helper/base.py

@@ -0,0 +1,81 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import abc
+
+from watcher.common import exception
+from watcher.common.metal_helper import constants as metal_constants
+
+
+class BaseMetalNode(abc.ABC):
+    hv_up_when_powered_off = False
+
+    def __init__(self, nova_node=None):
+        self._nova_node = nova_node
+
+    def get_hypervisor_node(self):
+        if not self._nova_node:
+            raise exception.Invalid(message="No associated hypervisor.")
+        return self._nova_node
+
+    def get_hypervisor_hostname(self):
+        return self.get_hypervisor_node().hypervisor_hostname
+
+    @abc.abstractmethod
+    def get_power_state(self):
+        # TODO(lpetrut): document the following methods
+        pass
+
+    @abc.abstractmethod
+    def get_id(self):
+        """Return the node id provided by the bare metal service."""
+        pass
+
+    @abc.abstractmethod
+    def power_on(self):
+        pass
+
+    @abc.abstractmethod
+    def power_off(self):
+        pass
+
+    def set_power_state(self, state):
+        state = metal_constants.PowerState(state)
+        if state == metal_constants.PowerState.ON:
+            self.power_on()
+        elif state == metal_constants.PowerState.OFF:
+            self.power_off()
+        else:
+            raise exception.UnsupportedActionType(
+                "Cannot set power state: %s" % state)
+
+
+class BaseMetalHelper(abc.ABC):
+    def __init__(self, osc):
+        self._osc = osc
+
+    @property
+    def nova_client(self):
+        if not getattr(self, "_nova_client", None):
+            self._nova_client = self._osc.nova()
+        return self._nova_client
+
+    @abc.abstractmethod
+    def list_compute_nodes(self):
+        pass
+
+    @abc.abstractmethod
+    def get_node(self, node_id):
+        pass

watcher/common/metal_helper/constants.py

@@ -0,0 +1,23 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import enum
+
+
+class PowerState(str, enum.Enum):
+    ON = "on"
+    OFF = "off"
+    UNKNOWN = "unknown"
+    ERROR = "error"

watcher/common/metal_helper/factory.py

@@ -0,0 +1,33 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from oslo_config import cfg
+
+from watcher.common import clients
+from watcher.common.metal_helper import ironic
+from watcher.common.metal_helper import maas
+
+CONF = cfg.CONF
+
+
+def get_helper(osc=None):
+    # TODO(lpetrut): consider caching this client.
+    if not osc:
+        osc = clients.OpenStackClients()
+
+    if CONF.maas_client.url:
+        return maas.MaasHelper(osc)
+    else:
+        return ironic.IronicHelper(osc)

watcher/common/metal_helper/ironic.py

@@ -0,0 +1,94 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from oslo_log import log
+
+from watcher.common.metal_helper import base
+from watcher.common.metal_helper import constants as metal_constants
+
+LOG = log.getLogger(__name__)
+
+POWER_STATES_MAP = {
+    'power on': metal_constants.PowerState.ON,
+    'power off': metal_constants.PowerState.OFF,
+    # For now, we only use ON/OFF states
+    'rebooting': metal_constants.PowerState.ON,
+    'soft power off': metal_constants.PowerState.OFF,
+    'soft reboot': metal_constants.PowerState.ON,
+}
+
+
+class IronicNode(base.BaseMetalNode):
+    hv_up_when_powered_off = True
+
+    def __init__(self, ironic_node, nova_node, ironic_client):
+        super().__init__(nova_node)
+
+        self._ironic_client = ironic_client
+        self._ironic_node = ironic_node
+
+    def get_power_state(self):
+        return POWER_STATES_MAP.get(self._ironic_node.power_state,
+                                    metal_constants.PowerState.UNKNOWN)
+
+    def get_id(self):
+        return self._ironic_node.uuid
+
+    def power_on(self):
+        self._ironic_client.node.set_power_state(self.get_id(), "on")
+
+    def power_off(self):
+        self._ironic_client.node.set_power_state(self.get_id(), "off")
+
+
+class IronicHelper(base.BaseMetalHelper):
+    @property
+    def _client(self):
+        if not getattr(self, "_cached_client", None):
+            self._cached_client = self._osc.ironic()
+        return self._cached_client
+
+    def list_compute_nodes(self):
+        out_list = []
+        # TODO(lpetrut): consider using "detailed=True" instead of making
+        # an additional GET request per node
+        node_list = self._client.node.list()
+
+        for node in node_list:
+            node_info = self._client.node.get(node.uuid)
+            hypervisor_id = node_info.extra.get('compute_node_id', None)
+            if hypervisor_id is None:
+                LOG.warning('Cannot find compute_node_id in extra '
+                            'of ironic node %s', node.uuid)
+                continue
+
+            hypervisor_node = self.nova_client.hypervisors.get(hypervisor_id)
+            if hypervisor_node is None:
+                LOG.warning('Cannot find hypervisor %s', hypervisor_id)
+                continue
+
+            out_node = IronicNode(node, hypervisor_node, self._client)
+            out_list.append(out_node)
+
+        return out_list
+
+    def get_node(self, node_id):
+        ironic_node = self._client.node.get(node_id)
+        compute_node_id = ironic_node.extra.get('compute_node_id')
+        if compute_node_id:
+            compute_node = self.nova_client.hypervisors.get(compute_node_id)
+        else:
+            compute_node = None
+        return IronicNode(ironic_node, compute_node, self._client)

watcher/common/metal_helper/maas.py

@@ -0,0 +1,125 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from oslo_config import cfg
+from oslo_log import log
+
+from watcher.common import exception
+from watcher.common.metal_helper import base
+from watcher.common.metal_helper import constants as metal_constants
+from watcher.common import utils
+
+CONF = cfg.CONF
+LOG = log.getLogger(__name__)
+
+try:
+    from maas.client import enum as maas_enum
+except ImportError:
+    maas_enum = None
+
+
+class MaasNode(base.BaseMetalNode):
+    hv_up_when_powered_off = False
+
+    def __init__(self, maas_node, nova_node, maas_client):
+        super().__init__(nova_node)
+
+        self._maas_client = maas_client
+        self._maas_node = maas_node
+
+    def get_power_state(self):
+        maas_state = utils.async_compat_call(
+            self._maas_node.query_power_state,
+            timeout=CONF.maas_client.timeout)
+
+        # python-libmaas may not be available, so we'll avoid a global
+        # variable.
+        power_states_map = {
+            maas_enum.PowerState.ON: metal_constants.PowerState.ON,
+            maas_enum.PowerState.OFF: metal_constants.PowerState.OFF,
+            maas_enum.PowerState.ERROR: metal_constants.PowerState.ERROR,
+            maas_enum.PowerState.UNKNOWN: metal_constants.PowerState.UNKNOWN,
+        }
+        return power_states_map.get(maas_state,
+                                    metal_constants.PowerState.UNKNOWN)
+
+    def get_id(self):
+        return self._maas_node.system_id
+
+    def power_on(self):
+        LOG.info("Powering on MAAS node: %s %s",
+                 self._maas_node.fqdn,
+                 self._maas_node.system_id)
+        utils.async_compat_call(
+            self._maas_node.power_on,
+            timeout=CONF.maas_client.timeout)
+
+    def power_off(self):
+        LOG.info("Powering off MAAS node: %s %s",
+                 self._maas_node.fqdn,
+                 self._maas_node.system_id)
+        utils.async_compat_call(
+            self._maas_node.power_off,
+            timeout=CONF.maas_client.timeout)
+
+
+class MaasHelper(base.BaseMetalHelper):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if not maas_enum:
+            raise exception.UnsupportedError(
+                "MAAS client unavailable. Please install python-libmaas.")
+
+    @property
+    def _client(self):
+        if not getattr(self, "_cached_client", None):
+            self._cached_client = self._osc.maas()
+        return self._cached_client
+
+    def list_compute_nodes(self):
+        out_list = []
+        node_list = utils.async_compat_call(
+            self._client.machines.list,
+            timeout=CONF.maas_client.timeout)
+
+        compute_nodes = self.nova_client.hypervisors.list()
+        compute_node_map = dict()
+        for compute_node in compute_nodes:
+            compute_node_map[compute_node.hypervisor_hostname] = compute_node
+
+        for node in node_list:
+            hypervisor_node = compute_node_map.get(node.fqdn)
+            if not hypervisor_node:
+                LOG.info('Cannot find hypervisor %s', node.fqdn)
+                continue
+
+            out_node = MaasNode(node, hypervisor_node, self._client)
+            out_list.append(out_node)
+
+        return out_list
+
+    def _get_compute_node_by_hostname(self, hostname):
+        compute_nodes = self.nova_client.hypervisors.search(
+            hostname, detailed=True)
+        for compute_node in compute_nodes:
+            if compute_node.hypervisor_hostname == hostname:
+                return compute_node
+
+    def get_node(self, node_id):
+        maas_node = utils.async_compat_call(
+            self._client.machines.get, node_id,
+            timeout=CONF.maas_client.timeout)
+        compute_node = self._get_compute_node_by_hostname(maas_node.fqdn)
+        return MaasNode(maas_node, compute_node, self._client)

watcher/common/placement_helper.py

@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_log import log as logging
 
@@ -53,7 +54,7 @@ class PlacementHelper(object):
         if rp_name:
             url += '?name=%s' % rp_name
         resp = self.get(url)
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             json_resp = resp.json()
             return json_resp['resource_providers']
 
@@ -77,7 +78,7 @@ class PlacementHelper(object):
         """
         url = '/resource_providers/%s/inventories' % rp_uuid
         resp = self.get(url)
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             json = resp.json()
             return json['inventories']
         msg = ("Failed to get resource provider %(rp_uuid)s inventories. "
@@ -97,7 +98,7 @@ class PlacementHelper(object):
         """
         resp = self.get("/resource_providers/%s/traits" % rp_uuid)
 
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             json = resp.json()
             return json['traits']
         msg = ("Failed to get resource provider %(rp_uuid)s traits. "
@@ -118,7 +119,7 @@ class PlacementHelper(object):
         """
         url = '/allocations/%s' % consumer_uuid
         resp = self.get(url)
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             json = resp.json()
             return json['allocations']
         msg = ("Failed to get allocations for consumer %(c_uuid). "
@@ -139,7 +140,7 @@ class PlacementHelper(object):
         """
         url = '/resource_providers/%s/usages' % rp_uuid
         resp = self.get(url)
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             json = resp.json()
             return json['usages']
         msg = ("Failed to get resource provider %(rp_uuid)s usages. "
@@ -164,7 +165,7 @@ class PlacementHelper(object):
         """
         url = "/allocation_candidates?%s" % resources
         resp = self.get(url)
-        if resp.status_code == 200:
+        if resp.status_code == HTTPStatus.OK:
             data = resp.json()
             return data['provider_summaries']
 

watcher/common/policy.py

@@ -18,6 +18,7 @@
 import sys
 
 from oslo_config import cfg
+from oslo_policy import opts
 from oslo_policy import policy
 
 from watcher.common import exception
@@ -26,6 +27,12 @@ from watcher.common import policies
 _ENFORCER = None
 CONF = cfg.CONF
 
+# TODO(gmann): Remove setting the default value of config policy_file
+# once oslo_policy change the default value to 'policy.yaml'.
+# https://github.com/openstack/oslo.policy/blob/a626ad12fe5a3abd49d70e3e5b95589d279ab578/oslo_policy/opts.py#L49
+DEFAULT_POLICY_FILE = 'policy.yaml'
+opts.set_defaults(CONF, DEFAULT_POLICY_FILE)
+
 
 # we can get a policy enforcer by this init.
 # oslo policy support change policy rule dynamically.

watcher/common/rpc.py

@@ -121,22 +121,40 @@ class RequestContextSerializer(messaging.Serializer):
 def get_client(target, version_cap=None, serializer=None):
     assert TRANSPORT is not None
     serializer = RequestContextSerializer(serializer)
-    return messaging.RPCClient(TRANSPORT,
-                               target,
-                               version_cap=version_cap,
-                               serializer=serializer)
+    return messaging.get_rpc_client(
+        TRANSPORT,
+        target,
+        version_cap=version_cap,
+        serializer=serializer
+    )
 
 
 def get_server(target, endpoints, serializer=None):
     assert TRANSPORT is not None
     access_policy = dispatcher.DefaultRPCAccessPolicy
     serializer = RequestContextSerializer(serializer)
-    return messaging.get_rpc_server(TRANSPORT,
-                                    target,
-                                    endpoints,
-                                    executor='eventlet',
-                                    serializer=serializer,
-                                    access_policy=access_policy)
+    return messaging.get_rpc_server(
+        TRANSPORT,
+        target,
+        endpoints,
+        executor='eventlet',
+        serializer=serializer,
+        access_policy=access_policy
+    )
+
+
+def get_notification_listener(targets, endpoints, serializer=None, pool=None):
+    assert NOTIFICATION_TRANSPORT is not None
+    serializer = RequestContextSerializer(serializer)
+    return messaging.get_notification_listener(
+        NOTIFICATION_TRANSPORT,
+        targets,
+        endpoints,
+        allow_requeue=False,
+        executor='eventlet',
+        pool=pool,
+        serializer=serializer
+    )
 
 
 def get_notifier(publisher_id):

watcher/common/service.py

@@ -21,14 +21,12 @@ from oslo_concurrency import processutils
 from oslo_config import cfg
 from oslo_log import _options
 from oslo_log import log
-import oslo_messaging as om
+import oslo_messaging as messaging
 from oslo_reports import guru_meditation_report as gmr
 from oslo_reports import opts as gmr_opts
 from oslo_service import service
 from oslo_service import wsgi
 
-from oslo_messaging.rpc import dispatcher
-
 from watcher._i18n import _
 from watcher.api import app
 from watcher.common import config
@@ -183,11 +181,6 @@ class Service(service.ServiceBase):
         ]
         self.notification_endpoints = self.manager.notification_endpoints
 
-        self.serializer = rpc.RequestContextSerializer(
-            base.WatcherObjectSerializer())
-
-        self._transport = None
-        self._notification_transport = None
         self._conductor_client = None
 
         self.conductor_topic_handler = None
@@ -201,27 +194,17 @@ class Service(service.ServiceBase):
                 self.notification_topics, self.notification_endpoints
             )
 
-    @property
-    def transport(self):
-        if self._transport is None:
-            self._transport = om.get_rpc_transport(CONF)
-        return self._transport
-
-    @property
-    def notification_transport(self):
-        if self._notification_transport is None:
-            self._notification_transport = om.get_notification_transport(CONF)
-        return self._notification_transport
-
     @property
     def conductor_client(self):
         if self._conductor_client is None:
-            target = om.Target(
+            target = messaging.Target(
                 topic=self.conductor_topic,
                 version=self.API_VERSION,
             )
-            self._conductor_client = om.RPCClient(
-                self.transport, target, serializer=self.serializer)
+            self._conductor_client = rpc.get_client(
+                target,
+                serializer=base.WatcherObjectSerializer()
+            )
         return self._conductor_client
 
     @conductor_client.setter
@@ -229,21 +212,18 @@ class Service(service.ServiceBase):
         self.conductor_client = c
 
     def build_topic_handler(self, topic_name, endpoints=()):
-        access_policy = dispatcher.DefaultRPCAccessPolicy
-        serializer = rpc.RequestContextSerializer(rpc.JsonPayloadSerializer())
-        target = om.Target(
+        target = messaging.Target(
             topic=topic_name,
             # For compatibility, we can override it with 'host' opt
             server=CONF.host or socket.gethostname(),
             version=self.api_version,
         )
-        return om.get_rpc_server(
-            self.transport, target, endpoints,
-            executor='eventlet', serializer=serializer,
-            access_policy=access_policy)
+        return rpc.get_server(
+            target, endpoints,
+            serializer=rpc.JsonPayloadSerializer()
+        )
 
     def build_notification_handler(self, topic_names, endpoints=()):
-        serializer = rpc.RequestContextSerializer(rpc.JsonPayloadSerializer())
         targets = []
         for topic in topic_names:
             kwargs = {}
@@ -251,11 +231,13 @@ class Service(service.ServiceBase):
                 exchange, topic = topic.split('.')
                 kwargs['exchange'] = exchange
             kwargs['topic'] = topic
-            targets.append(om.Target(**kwargs))
-        return om.get_notification_listener(
-            self.notification_transport, targets, endpoints,
-            executor='eventlet', serializer=serializer,
-            allow_requeue=False, pool=CONF.host)
+            targets.append(messaging.Target(**kwargs))
+
+        return rpc.get_notification_listener(
+            targets, endpoints,
+            serializer=rpc.JsonPayloadSerializer(),
+            pool=CONF.host
+        )
 
     def start(self):
         LOG.debug("Connecting to '%s'", CONF.transport_url)

watcher/common/utils.py

@@ -16,12 +16,16 @@
 
 """Utilities and helper functions."""
 
+import asyncio
 import datetime
+import inspect
 import random
 import re
 import string
 
 from croniter import croniter
+import eventlet
+from eventlet import tpool
 
 from jsonschema import validators
 from oslo_config import cfg
@@ -162,3 +166,37 @@ Draft4Validator = validators.Draft4Validator
 def random_string(n):
     return ''.join([random.choice(
         string.ascii_letters + string.digits) for i in range(n)])
+
+
+# Some clients (e.g. MAAS) use asyncio, which isn't compatible with Eventlet.
+# As a workaround, we're delegating such calls to a native thread.
+def async_compat_call(f, *args, **kwargs):
+    timeout = kwargs.pop('timeout', None)
+
+    async def async_wrapper():
+        ret = f(*args, **kwargs)
+        if inspect.isawaitable(ret):
+            return await asyncio.wait_for(ret, timeout)
+        return ret
+
+    def tpool_wrapper():
+        # This will run in a separate native thread. Ideally, there should be
+        # a single thread permanently running an asyncio loop, but for
+        # convenience we'll use eventlet.tpool, which leverages a thread pool.
+        #
+        # That being considered, we're setting up a temporary asyncio loop to
+        # handle this call.
+        loop = asyncio.new_event_loop()
+        try:
+            asyncio.set_event_loop(loop)
+            return loop.run_until_complete(async_wrapper())
+        finally:
+            loop.close()
+
+    # We'll use eventlet timeouts as an extra precaution and asyncio timeouts
+    # to avoid lingering threads. For consistency, we'll convert eventlet
+    # timeout exceptions to asyncio timeout errors.
+    with eventlet.timeout.Timeout(
+            seconds=timeout,
+            exception=asyncio.TimeoutError("Timeout: %ss" % timeout)):
+        return tpool.execute(tpool_wrapper)

watcher/conf/__init__.py

@@ -35,6 +35,7 @@ from watcher.conf import grafana_client
 from watcher.conf import grafana_translators
 from watcher.conf import ironic_client
 from watcher.conf import keystone_client
+from watcher.conf import maas_client
 from watcher.conf import monasca_client
 from watcher.conf import neutron_client
 from watcher.conf import nova_client
@@ -54,6 +55,7 @@ db.register_opts(CONF)
 planner.register_opts(CONF)
 applier.register_opts(CONF)
 decision_engine.register_opts(CONF)
+maas_client.register_opts(CONF)
 monasca_client.register_opts(CONF)
 nova_client.register_opts(CONF)
 glance_client.register_opts(CONF)

watcher/conf/grafana_client.py

@@ -134,7 +134,13 @@ GRAFANA_CLIENT_OPTS = [
                      "InfluxDB this will be the retention period. "
                      "These queries will need to be constructed using tools "
                      "such as Postman. Example: SELECT cpu FROM {4}."
-                     "cpu_percent WHERE host == '{1}' AND time > now()-{2}s")]
+                     "cpu_percent WHERE host == '{1}' AND time > now()-{2}s"),
+    cfg.IntOpt('http_timeout',
+               min=0,
+               default=60,
+               mutable=True,
+               help='Timeout for Grafana request')
+]
 
 
 def register_opts(conf):

watcher/conf/maas_client.py

@@ -0,0 +1,38 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+
+from oslo_config import cfg
+
+maas_client = cfg.OptGroup(name='maas_client',
+                           title='Configuration Options for MaaS')
+
+MAAS_CLIENT_OPTS = [
+    cfg.StrOpt('url',
+               help='MaaS URL, example: http://1.2.3.4:5240/MAAS'),
+    cfg.StrOpt('api_key',
+               help='MaaS API authentication key.'),
+    cfg.IntOpt('timeout',
+               default=60,
+               help='MaaS client operation timeout in seconds.')]
+
+
+def register_opts(conf):
+    conf.register_group(maas_client)
+    conf.register_opts(MAAS_CLIENT_OPTS, group=maas_client)
+
+
+def list_opts():
+    return [(maas_client, MAAS_CLIENT_OPTS)]

watcher/db/sqlalchemy/alembic/versions/0f6042416884_add_apscheduler_jobs.py

@@ -6,6 +6,7 @@ Create Date: 2017-03-24 11:21:29.036532
 
 """
 from alembic import op
+from sqlalchemy import inspect
 import sqlalchemy as sa
 
 from watcher.db.sqlalchemy import models
@@ -14,8 +15,17 @@ from watcher.db.sqlalchemy import models
 revision = '0f6042416884'
 down_revision = '001'
 
+def _table_exists(table_name):
+    bind = op.get_context().bind
+    insp = inspect(bind)
+    names = insp.get_table_names()
+    return any(t == table_name for t in names)
+
 
 def upgrade():
+    if _table_exists('apscheduler_jobs'):
+        return
+
     op.create_table(
         'apscheduler_jobs',
         sa.Column('id', sa.Unicode(191, _warn_on_bytestring=False),

watcher/db/sqlalchemy/api.py

@@ -248,26 +248,31 @@ class Connection(api.BaseConnection):
         return query
 
     def _create(self, model, values):
-        obj = model()
-        cleaned_values = {k: v for k, v in values.items()
-                          if k not in self._get_relationships(model)}
-        obj.update(cleaned_values)
-        obj.save()
+        session = get_session()
+        with session.begin():
+            obj = model()
+            cleaned_values = {k: v for k, v in values.items()
+                              if k not in self._get_relationships(model)}
+            obj.update(cleaned_values)
+            obj.save(session=session)
+            session.commit()
         return obj
 
     def _get(self, context, model, fieldname, value, eager):
-        query = model_query(model)
-        if eager:
-            query = self._set_eager_options(model, query)
+        session = get_session()
+        with session.begin():
+            query = model_query(model, session=session)
+            if eager:
+                query = self._set_eager_options(model, query)
 
-        query = query.filter(getattr(model, fieldname) == value)
-        if not context.show_deleted:
-            query = query.filter(model.deleted_at.is_(None))
+            query = query.filter(getattr(model, fieldname) == value)
+            if not context.show_deleted:
+                query = query.filter(model.deleted_at.is_(None))
 
-        try:
-            obj = query.one()
-        except exc.NoResultFound:
-            raise exception.ResourceNotFound(name=model.__name__, id=value)
+            try:
+                obj = query.one()
+            except exc.NoResultFound:
+                raise exception.ResourceNotFound(name=model.__name__, id=value)
 
         return obj
 
@@ -278,7 +283,7 @@ class Connection(api.BaseConnection):
             query = model_query(model, session=session)
             query = add_identity_filter(query, id_)
             try:
-                ref = query.with_lockmode('update').one()
+                ref = query.with_for_update().one()
             except exc.NoResultFound:
                 raise exception.ResourceNotFound(name=model.__name__, id=id_)
 
@@ -815,7 +820,7 @@ class Connection(api.BaseConnection):
             query = model_query(models.Action, session=session)
             query = add_identity_filter(query, action_id)
             try:
-                ref = query.with_lockmode('update').one()
+                ref = query.with_for_update().one()
             except exc.NoResultFound:
                 raise exception.ActionNotFound(action=action_id)
 
@@ -900,7 +905,7 @@ class Connection(api.BaseConnection):
             query = model_query(models.ActionPlan, session=session)
             query = add_identity_filter(query, action_plan_id)
             try:
-                ref = query.with_lockmode('update').one()
+                ref = query.with_for_update().one()
             except exc.NoResultFound:
                 raise exception.ActionPlanNotFound(action_plan=action_plan_id)
 

watcher/db/sqlalchemy/models.py

@@ -18,7 +18,6 @@ SQLAlchemy models for watcher service
 
 from oslo_db.sqlalchemy import models
 from oslo_serialization import jsonutils
-import six.moves.urllib.parse as urlparse
 from sqlalchemy import Boolean
 from sqlalchemy import Column
 from sqlalchemy import DateTime
@@ -33,7 +32,7 @@ from sqlalchemy import String
 from sqlalchemy import Text
 from sqlalchemy.types import TypeDecorator, TEXT
 from sqlalchemy import UniqueConstraint
-
+import urllib.parse as urlparse
 from watcher import conf
 
 CONF = conf.CONF

watcher/decision_engine/datasources/base.py

@@ -19,6 +19,8 @@ import time
 from oslo_config import cfg
 from oslo_log import log
 
+from watcher.common import exception
+
 CONF = cfg.CONF
 LOG = log.getLogger(__name__)
 
@@ -54,7 +56,14 @@ class DataSourceBase(object):
                       instance_root_disk_size=None,
                       )
 
-    def query_retry(self, f, *args, **kwargs):
+    def _get_meter(self, meter_name):
+        """Retrieve the meter from the metric map or raise error"""
+        meter = self.METRIC_MAP.get(meter_name)
+        if meter is None:
+            raise exception.MetricNotAvailable(metric=meter_name)
+        return meter
+
+    def query_retry(self, f, *args, ignored_exc=None, **kwargs):
         """Attempts to retrieve metrics from the external service
 
         Attempts to access data from the external service and handles
@@ -62,15 +71,23 @@ class DataSourceBase(object):
         to the value of query_max_retries
         :param f: The method that performs the actual querying for metrics
         :param args: Array of arguments supplied to the method
+        :param ignored_exc: An exception or tuple of exceptions that shouldn't
+                            be retried, for example "NotFound" exceptions.
         :param kwargs: The amount of arguments supplied to the method
         :return: The value as retrieved from the external service
         """
 
         num_retries = CONF.watcher_datasources.query_max_retries
         timeout = CONF.watcher_datasources.query_timeout
+        ignored_exc = ignored_exc or tuple()
+
         for i in range(num_retries):
             try:
                 return f(*args, **kwargs)
+            except ignored_exc as e:
+                LOG.debug("Got an ignored exception (%s) while calling: %s ",
+                          e, f)
+                return
             except Exception as e:
                 LOG.exception(e)
                 self.query_retry_reset(e)
@@ -122,6 +139,30 @@ class DataSourceBase(object):
 
         pass
 
+    @abc.abstractmethod
+    def statistic_series(self, resource=None, resource_type=None,
+                         meter_name=None, start_time=None, end_time=None,
+                         granularity=300):
+        """Retrieves metrics based on the specified parameters over a period
+
+        :param resource: Resource object as defined in watcher models such as
+                         ComputeNode and Instance
+        :param resource_type: Indicates which type of object is supplied
+                              to the resource parameter
+        :param meter_name: The desired metric to retrieve as key from
+                           METRIC_MAP
+        :param start_time: The datetime to start retrieving metrics for
+        :type start_time: datetime.datetime
+        :param end_time: The datetime to limit the retrieval of metrics to
+        :type end_time: datetime.datetime
+        :param granularity: Interval between samples in measurements in
+                            seconds
+        :return: Dictionary of key value pairs with timestamps and metric
+                 values
+        """
+
+        pass
+
     @abc.abstractmethod
     def get_host_cpu_usage(self, resource, period, aggregate,
                            granularity=None):

watcher/decision_engine/datasources/ceilometer.py

@@ -161,9 +161,7 @@ class CeilometerHelper(base.DataSourceBase):
         end_time = datetime.datetime.utcnow()
         start_time = end_time - datetime.timedelta(seconds=int(period))
 
-        meter = self.METRIC_MAP.get(meter_name)
-        if meter is None:
-            raise exception.MetricNotAvailable(metric=meter_name)
+        meter = self._get_meter(meter_name)
 
         if aggregate == 'mean':
             aggregate = 'avg'
@@ -194,6 +192,12 @@ class CeilometerHelper(base.DataSourceBase):
                 item_value *= 10
         return item_value
 
+    def statistic_series(self, resource=None, resource_type=None,
+                         meter_name=None, start_time=None, end_time=None,
+                         granularity=300):
+        raise NotImplementedError(
+            _('Ceilometer helper does not support statistic series method'))
+
     def get_host_cpu_usage(self, resource, period,
                            aggregate, granularity=None):
 

watcher/decision_engine/datasources/gnocchi.py

@@ -19,11 +19,11 @@
 from datetime import datetime
 from datetime import timedelta
 
+from gnocchiclient import exceptions as gnc_exc
 from oslo_config import cfg
 from oslo_log import log
 
 from watcher.common import clients
-from watcher.common import exception
 from watcher.decision_engine.datasources import base
 
 CONF = cfg.CONF
@@ -39,7 +39,7 @@ class GnocchiHelper(base.DataSourceBase):
                       host_inlet_temp='hardware.ipmi.node.temperature',
                       host_airflow='hardware.ipmi.node.airflow',
                       host_power='hardware.ipmi.node.power',
-                      instance_cpu_usage='cpu_util',
+                      instance_cpu_usage='cpu',
                       instance_ram_usage='memory.resident',
                       instance_ram_allocated='memory',
                       instance_l3_cache_usage='cpu_l3_cache',
@@ -72,9 +72,7 @@ class GnocchiHelper(base.DataSourceBase):
         stop_time = datetime.utcnow()
         start_time = stop_time - timedelta(seconds=(int(period)))
 
-        meter = self.METRIC_MAP.get(meter_name)
-        if meter is None:
-            raise exception.MetricNotAvailable(metric=meter_name)
+        meter = self._get_meter(meter_name)
 
         if aggregate == 'count':
             aggregate = 'mean'
@@ -87,7 +85,9 @@ class GnocchiHelper(base.DataSourceBase):
             kwargs = dict(query={"=": {"original_resource_id": resource_id}},
                           limit=1)
             resources = self.query_retry(
-                f=self.gnocchi.resource.search, **kwargs)
+                f=self.gnocchi.resource.search,
+                ignored_exc=gnc_exc.NotFound,
+                **kwargs)
 
             if not resources:
                 LOG.warning("The {0} resource {1} could not be "
@@ -96,6 +96,25 @@ class GnocchiHelper(base.DataSourceBase):
 
             resource_id = resources[0]['id']
 
+        if meter_name == "instance_cpu_usage":
+            if resource_type != "instance":
+                LOG.warning("Unsupported resource type for metric "
+                            "'instance_cpu_usage': ", resource_type)
+                return
+
+            # The "cpu_util" gauge (percentage) metric has been removed.
+            # We're going to obtain the same result by using the rate of change
+            # aggregate operation.
+            if aggregate not in ("mean", "rate:mean"):
+                LOG.warning("Unsupported aggregate for instance_cpu_usage "
+                            "metric: %s. "
+                            "Supported aggregates: mean, rate:mean ",
+                            aggregate)
+                return
+
+            # TODO(lpetrut): consider supporting other aggregates.
+            aggregate = "rate:mean"
+
         raw_kwargs = dict(
             metric=meter,
             start=start_time,
@@ -108,7 +127,9 @@ class GnocchiHelper(base.DataSourceBase):
         kwargs = {k: v for k, v in raw_kwargs.items() if k and v}
 
         statistics = self.query_retry(
-            f=self.gnocchi.metric.get_measures, **kwargs)
+            f=self.gnocchi.metric.get_measures,
+            ignored_exc=gnc_exc.NotFound,
+            **kwargs)
 
         return_value = None
         if statistics:
@@ -120,6 +141,67 @@ class GnocchiHelper(base.DataSourceBase):
                 # Airflow from hardware.ipmi.node.airflow is reported as
                 # 1/10 th of actual CFM
                 return_value *= 10
+            if meter_name == "instance_cpu_usage":
+                # "rate:mean" can return negative values for migrated vms.
+                return_value = max(0, return_value)
+
+                # We're converting the cumulative cpu time (ns) to cpu usage
+                # percentage.
+                vcpus = resource.vcpus
+                if not vcpus:
+                    LOG.warning("instance vcpu count not set, assuming 1")
+                    vcpus = 1
+                return_value *= 100 / (granularity * 10e+8) / vcpus
+
+        return return_value
+
+    def statistic_series(self, resource=None, resource_type=None,
+                         meter_name=None, start_time=None, end_time=None,
+                         granularity=300):
+
+        meter = self._get_meter(meter_name)
+
+        resource_id = resource.uuid
+        if resource_type == 'compute_node':
+            resource_id = "%s_%s" % (resource.hostname, resource.hostname)
+            kwargs = dict(query={"=": {"original_resource_id": resource_id}},
+                          limit=1)
+            resources = self.query_retry(
+                f=self.gnocchi.resource.search,
+                ignored_exc=gnc_exc.NotFound,
+                **kwargs)
+
+            if not resources:
+                LOG.warning("The {0} resource {1} could not be "
+                            "found".format(self.NAME, resource_id))
+                return
+
+            resource_id = resources[0]['id']
+
+        raw_kwargs = dict(
+            metric=meter,
+            start=start_time,
+            stop=end_time,
+            resource_id=resource_id,
+            granularity=granularity,
+        )
+
+        kwargs = {k: v for k, v in raw_kwargs.items() if k and v}
+
+        statistics = self.query_retry(
+            f=self.gnocchi.metric.get_measures,
+            ignored_exc=gnc_exc.NotFound,
+            **kwargs)
+
+        return_value = None
+        if statistics:
+            # measure has structure [time, granularity, value]
+            if meter_name == 'host_airflow':
+                # Airflow from hardware.ipmi.node.airflow is reported as
+                # 1/10 th of actual CFM
+                return_value = {s[0]: s[2]*10 for s in statistics}
+            else:
+                return_value = {s[0]: s[2] for s in statistics}
 
         return return_value
 

watcher/decision_engine/datasources/grafana.py

@@ -18,9 +18,11 @@
 
 from urllib import parse as urlparse
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_log import log
 
+from watcher._i18n import _
 from watcher.common import clients
 from watcher.common import exception
 from watcher.decision_engine.datasources import base
@@ -136,12 +138,13 @@ class GrafanaHelper(base.DataSourceBase):
             raise exception.DataSourceNotAvailable(self.NAME)
 
         resp = requests.get(self._base_url + str(project_id) + '/query',
-                            params=params, headers=self._headers)
-        if resp.status_code == 200:
+                            params=params, headers=self._headers,
+                            timeout=CONF.grafana_client.http_timeout)
+        if resp.status_code == HTTPStatus.OK:
             return resp
-        elif resp.status_code == 400:
+        elif resp.status_code == HTTPStatus.BAD_REQUEST:
             LOG.error("Query for metric is invalid")
-        elif resp.status_code == 401:
+        elif resp.status_code == HTTPStatus.UNAUTHORIZED:
             LOG.error("Authorization token is invalid")
         raise exception.DataSourceNotAvailable(self.NAME)
 
@@ -188,6 +191,12 @@ class GrafanaHelper(base.DataSourceBase):
 
         return result
 
+    def statistic_series(self, resource=None, resource_type=None,
+                         meter_name=None, start_time=None, end_time=None,
+                         granularity=300):
+        raise NotImplementedError(
+            _('Grafana helper does not support statistic series method'))
+
     def get_host_cpu_usage(self, resource, period=300,
                            aggregate="mean", granularity=None):
         return self.statistic_aggregation(

watcher/decision_engine/datasources/monasca.py

@@ -21,7 +21,6 @@ import datetime
 from monascaclient import exc
 
 from watcher.common import clients
-from watcher.common import exception
 from watcher.decision_engine.datasources import base
 
 
@@ -90,9 +89,7 @@ class MonascaHelper(base.DataSourceBase):
         stop_time = datetime.datetime.utcnow()
         start_time = stop_time - datetime.timedelta(seconds=(int(period)))
 
-        meter = self.METRIC_MAP.get(meter_name)
-        if meter is None:
-            raise exception.MetricNotAvailable(metric=meter_name)
+        meter = self._get_meter(meter_name)
 
         if aggregate == 'mean':
             aggregate = 'avg'
@@ -121,6 +118,34 @@ class MonascaHelper(base.DataSourceBase):
 
         return cpu_usage
 
+    def statistic_series(self, resource=None, resource_type=None,
+                         meter_name=None, start_time=None, end_time=None,
+                         granularity=300):
+
+        meter = self._get_meter(meter_name)
+
+        raw_kwargs = dict(
+            name=meter,
+            start_time=start_time.isoformat(),
+            end_time=end_time.isoformat(),
+            dimensions={'hostname': resource.uuid},
+            statistics='avg',
+            group_by='*',
+        )
+
+        kwargs = {k: v for k, v in raw_kwargs.items() if k and v}
+
+        statistics = self.query_retry(
+            f=self.monasca.metrics.list_statistics, **kwargs)
+
+        result = {}
+        for stat in statistics:
+            v_index = stat['columns'].index('avg')
+            t_index = stat['columns'].index('timestamp')
+            result.update({r[t_index]: r[v_index] for r in stat['statistics']})
+
+        return result
+
     def get_host_cpu_usage(self, resource, period,
                            aggregate, granularity=None):
         return self.statistic_aggregation(

watcher/decision_engine/model/collector/cinder.py

@@ -205,7 +205,7 @@ class CinderModelBuilder(base.BaseModelBuilder):
         """Build a storage node from a Cinder storage node
 
         :param node: A storage node
-        :type node: :py:class:`~cinderclient.v2.services.Service`
+        :type node: :py:class:`~cinderclient.v3.services.Service`
         """
         # node.host is formatted as host@backendname since ocata,
         # or may be only host as of ocata
@@ -233,7 +233,7 @@ class CinderModelBuilder(base.BaseModelBuilder):
         """Build a storage pool from a Cinder storage pool
 
         :param pool: A storage pool
-        :type pool: :py:class:`~cinderclient.v2.pools.Pool`
+        :type pool: :py:class:`~cinderclient.v3.pools.Pool`
         :raises: exception.InvalidPoolAttributeValue
         """
         # build up the storage pool.

watcher/decision_engine/model/collector/ironic.py

@@ -81,6 +81,7 @@ class BareMetalModelBuilder(base.BaseModelBuilder):
     def __init__(self, osc):
         self.osc = osc
         self.model = model_root.BaremetalModelRoot()
+        # TODO(lpetrut): add MAAS support
         self.ironic_helper = ironic_helper.IronicHelper(osc=self.osc)
 
     def add_ironic_node(self, node):

watcher/decision_engine/model/collector/nova.py

@@ -48,7 +48,7 @@ class NovaClusterDataModelCollector(base.BaseClusterDataModelCollector):
                     "type": "array",
                     "items": {
                         "anyOf": [
-                            {"$ref": HOST_AGGREGATES + "id"},
+                            {"$ref": HOST_AGGREGATES + "host_aggr_id"},
                             {"$ref": HOST_AGGREGATES + "name"},
                         ]
                     }
@@ -98,7 +98,8 @@ class NovaClusterDataModelCollector(base.BaseClusterDataModelCollector):
                                 "type": "array",
                                 "items": {
                                     "anyOf": [
-                                        {"$ref": HOST_AGGREGATES + "id"},
+                                        {"$ref":
+                                            HOST_AGGREGATES + "host_aggr_id"},
                                         {"$ref": HOST_AGGREGATES + "name"},
                                     ]
                                 }
@@ -129,7 +130,7 @@ class NovaClusterDataModelCollector(base.BaseClusterDataModelCollector):
             "additionalProperties": False
         },
         "host_aggregates": {
-            "id": {
+            "host_aggr_id": {
                 "properties": {
                     "id": {
                         "oneOf": [

watcher/decision_engine/model/model_root.py

@@ -157,7 +157,7 @@ class ModelRoot(nx.DiGraph, base.Model):
             if node_list:
                 return node_list[0]
             else:
-                raise exception.ComputeResourceNotFound
+                raise exception.ComputeNodeNotFound(name=name)
         except exception.ComputeResourceNotFound:
             raise exception.ComputeNodeNotFound(name=name)
 
@@ -631,7 +631,7 @@ class BaremetalModelRoot(nx.DiGraph, base.Model):
             super(BaremetalModelRoot, self).remove_node(node.uuid)
         except nx.NetworkXError as exc:
             LOG.exception(exc)
-            raise exception.IronicNodeNotFound(name=node.uuid)
+            raise exception.IronicNodeNotFound(uuid=node.uuid)
 
     @lockutils.synchronized("baremetal_model")
     def get_all_ironic_nodes(self):
@@ -643,7 +643,7 @@ class BaremetalModelRoot(nx.DiGraph, base.Model):
         try:
             return self._get_by_uuid(uuid)
         except exception.BaremetalResourceNotFound:
-            raise exception.IronicNodeNotFound(name=uuid)
+            raise exception.IronicNodeNotFound(uuid=uuid)
 
     def _get_by_uuid(self, uuid):
         try:

watcher/decision_engine/strategy/strategies/base.py

@@ -252,9 +252,6 @@ class BaseStrategy(loadable.Loadable, metaclass=abc.ABCMeta):
         if not self.compute_model:
             raise exception.ClusterStateNotDefined()
 
-        if self.compute_model.stale:
-            raise exception.ClusterStateStale()
-
         LOG.debug(self.compute_model.to_string())
 
     def execute(self, audit=None):

watcher/decision_engine/strategy/strategies/host_maintenance.py

@@ -18,8 +18,6 @@
 #
 
 from oslo_log import log
-import six
-
 from watcher._i18n import _
 from watcher.common import exception
 from watcher.decision_engine.model import element
@@ -103,7 +101,7 @@ class HostMaintenance(base.HostMaintenanceBaseStrategy):
 
     def get_instance_state_str(self, instance):
         """Get instance state in string format"""
-        if isinstance(instance.state, six.string_types):
+        if isinstance(instance.state, str):
             return instance.state
         elif isinstance(instance.state, element.InstanceState):
             return instance.state.value
@@ -116,7 +114,7 @@ class HostMaintenance(base.HostMaintenanceBaseStrategy):
 
     def get_node_status_str(self, node):
         """Get node status in string format"""
-        if isinstance(node.status, six.string_types):
+        if isinstance(node.status, str):
             return node.status
         elif isinstance(node.status, element.ServiceState):
             return node.status.value

watcher/decision_engine/strategy/strategies/saving_energy.py

@@ -23,6 +23,8 @@ from oslo_log import log
 
 from watcher._i18n import _
 from watcher.common import exception
+from watcher.common.metal_helper import constants as metal_constants
+from watcher.common.metal_helper import factory as metal_helper_factory
 from watcher.decision_engine.strategy.strategies import base
 
 LOG = log.getLogger(__name__)
@@ -81,7 +83,7 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
     def __init__(self, config, osc=None):
 
         super(SavingEnergy, self).__init__(config, osc)
-        self._ironic_client = None
+        self._metal_helper = None
         self._nova_client = None
 
         self.with_vms_node_pool = []
@@ -91,10 +93,10 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
         self.min_free_hosts_num = 1
 
     @property
-    def ironic_client(self):
-        if not self._ironic_client:
-            self._ironic_client = self.osc.ironic()
-        return self._ironic_client
+    def metal_helper(self):
+        if not self._metal_helper:
+            self._metal_helper = metal_helper_factory.get_helper(self.osc)
+        return self._metal_helper
 
     @property
     def nova_client(self):
@@ -149,10 +151,10 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
         :return: None
         """
         params = {'state': state,
-                  'resource_name': node.hostname}
+                  'resource_name': node.get_hypervisor_hostname()}
         self.solution.add_action(
             action_type='change_node_power_state',
-            resource_id=node.uuid,
+            resource_id=node.get_id(),
             input_parameters=params)
 
     def get_hosts_pool(self):
@@ -162,57 +164,61 @@ class SavingEnergy(base.SavingEnergyBaseStrategy):
 
         """
 
-        node_list = self.ironic_client.node.list()
+        node_list = self.metal_helper.list_compute_nodes()
         for node in node_list:
-            node_info = self.ironic_client.node.get(node.uuid)
-            hypervisor_id = node_info.extra.get('compute_node_id', None)
-            if hypervisor_id is None:
-                LOG.warning(('Cannot find compute_node_id in extra '
-                             'of ironic node %s'), node.uuid)
-                continue
-            hypervisor_node = self.nova_client.hypervisors.get(hypervisor_id)
-            if hypervisor_node is None:
-                LOG.warning(('Cannot find hypervisor %s'), hypervisor_id)
-                continue
-            node.hostname = hypervisor_node.hypervisor_hostname
-            hypervisor_node = hypervisor_node.to_dict()
+            hypervisor_node = node.get_hypervisor_node().to_dict()
+
             compute_service = hypervisor_node.get('service', None)
             host_name = compute_service.get('host')
+            LOG.debug("Found hypervisor: %s", hypervisor_node)
             try:
                 self.compute_model.get_node_by_name(host_name)
             except exception.ComputeNodeNotFound:
+                LOG.info("The compute model does not contain the host: %s",
+                         host_name)
                 continue
 
-            if not (hypervisor_node.get('state') == 'up'):
-                """filter nodes that are not in 'up' state"""
+            if (node.hv_up_when_powered_off and
+                    hypervisor_node.get('state') != 'up'):
+                # filter nodes that are not in 'up' state
+                LOG.info("Ignoring node that isn't in 'up' state: %s",
+                         host_name)
                 continue
             else:
                 if (hypervisor_node['running_vms'] == 0):
-                    if (node_info.power_state == 'power on'):
+                    power_state = node.get_power_state()
+                    if power_state == metal_constants.PowerState.ON:
                         self.free_poweron_node_pool.append(node)
-                    elif (node_info.power_state == 'power off'):
+                    elif power_state == metal_constants.PowerState.OFF:
                         self.free_poweroff_node_pool.append(node)
+                    else:
+                        LOG.info("Ignoring node %s, unknown state: %s",
+                                 node, power_state)
                 else:
                     self.with_vms_node_pool.append(node)
 
     def save_energy(self):
 
-        need_poweron = max(
+        need_poweron = int(max(
             (len(self.with_vms_node_pool) * self.free_used_percent / 100), (
-                self.min_free_hosts_num))
+                self.min_free_hosts_num)))
         len_poweron = len(self.free_poweron_node_pool)
         len_poweroff = len(self.free_poweroff_node_pool)
+        LOG.debug("need_poweron: %s, len_poweron: %s, len_poweroff: %s",
+                  need_poweron, len_poweron, len_poweroff)
         if len_poweron > need_poweron:
             for node in random.sample(self.free_poweron_node_pool,
                                       (len_poweron - need_poweron)):
-                self.add_action_poweronoff_node(node, 'off')
-                LOG.debug("power off %s", node.uuid)
+                self.add_action_poweronoff_node(node,
+                                                metal_constants.PowerState.OFF)
+                LOG.info("power off %s", node.get_id())
         elif len_poweron < need_poweron:
             diff = need_poweron - len_poweron
             for node in random.sample(self.free_poweroff_node_pool,
                                       min(len_poweroff, diff)):
-                self.add_action_poweronoff_node(node, 'on')
-                LOG.debug("power on %s", node.uuid)
+                self.add_action_poweronoff_node(node,
+                                                metal_constants.PowerState.ON)
+                LOG.info("power on %s", node.get_id())
 
     def pre_execute(self):
         self._pre_execute()

watcher/decision_engine/strategy/strategies/vm_workload_consolidation.py

@@ -18,9 +18,13 @@
 # limitations under the License.
 #
 
+import collections
+
 from oslo_log import log
+import oslo_utils
 
 from watcher._i18n import _
+from watcher.applier.actions import migration
 from watcher.common import exception
 from watcher.decision_engine.model import element
 from watcher.decision_engine.strategy.strategies import base
@@ -66,7 +70,8 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
 
     AGGREGATE = 'mean'
     DATASOURCE_METRICS = ['instance_ram_allocated', 'instance_cpu_usage',
-                          'instance_ram_usage', 'instance_root_disk_size']
+                          'instance_ram_usage', 'instance_root_disk_size',
+                          'host_cpu_usage', 'host_ram_usage']
 
     MIGRATION = "migrate"
     CHANGE_NOVA_SERVICE_STATE = "change_nova_service_state"
@@ -76,6 +81,11 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
         self.number_of_migrations = 0
         self.number_of_released_nodes = 0
         self.datasource_instance_data_cache = dict()
+        self.datasource_node_data_cache = dict()
+        # Host metric adjustments that take into account planned
+        # migrations.
+        self.host_metric_delta = collections.defaultdict(
+            lambda: collections.defaultdict(int))
 
     @classmethod
     def get_name(cls):
@@ -196,12 +206,12 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
         :return: None
         """
         instance_state_str = self.get_instance_state_str(instance)
-        if instance_state_str not in (element.InstanceState.ACTIVE.value,
-                                      element.InstanceState.PAUSED.value):
-            # Watcher currently only supports live VM migration and block live
-            # VM migration which both requires migrated VM to be active.
-            # When supported, the cold migration may be used as a fallback
-            # migration mechanism to move non active VMs.
+        if instance_state_str in (element.InstanceState.ACTIVE.value,
+                                  element.InstanceState.PAUSED.value):
+            migration_type = migration.Migrate.LIVE_MIGRATION
+        elif instance_state_str == element.InstanceState.STOPPED.value:
+            migration_type = migration.Migrate.COLD_MIGRATION
+        else:
             LOG.error(
                 'Cannot live migrate: instance_uuid=%(instance_uuid)s, '
                 'state=%(instance_state)s.', dict(
@@ -209,8 +219,6 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                     instance_state=instance_state_str))
             return
 
-        migration_type = 'live'
-
         # Here will makes repeated actions to enable the same compute node,
         # when migrating VMs to the destination node which is disabled.
         # Whether should we remove the same actions in the solution???
@@ -228,6 +236,18 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                 destination_node)
             self.number_of_migrations += 1
 
+            instance_util = self.get_instance_utilization(instance)
+            self.host_metric_delta[source_node.hostname]['cpu'] -= (
+                instance_util['cpu'])
+            # We'll deduce the vm allocated memory.
+            self.host_metric_delta[source_node.hostname]['ram'] -= (
+                instance.memory)
+
+            self.host_metric_delta[destination_node.hostname]['cpu'] += (
+                instance_util['cpu'])
+            self.host_metric_delta[destination_node.hostname]['ram'] += (
+                instance.memory)
+
     def disable_unused_nodes(self):
         """Generate actions for disabling unused nodes.
 
@@ -290,6 +310,21 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
             disk=instance_disk_util)
         return self.datasource_instance_data_cache.get(instance.uuid)
 
+    def _get_node_total_utilization(self, node):
+        if node.hostname in self.datasource_node_data_cache:
+            return self.datasource_node_data_cache[node.hostname]
+
+        cpu = self.datasource_backend.get_host_cpu_usage(
+            node, self.period, self.AGGREGATE,
+            self.granularity)
+        ram = self.datasource_backend.get_host_ram_usage(
+            node, self.period, self.AGGREGATE,
+            self.granularity)
+
+        self.datasource_node_data_cache[node.hostname] = dict(
+            cpu=cpu, ram=ram)
+        return self.datasource_node_data_cache[node.hostname]
+
     def get_node_utilization(self, node):
         """Collect cpu, ram and disk utilization statistics of a node.
 
@@ -307,8 +342,36 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
             node_cpu_util += instance_util['cpu']
             node_ram_util += instance_util['ram']
             node_disk_util += instance_util['disk']
+            LOG.debug("instance utilization: %s %s",
+                      instance, instance_util)
 
-        return dict(cpu=node_cpu_util, ram=node_ram_util,
+        total_node_util = self._get_node_total_utilization(node)
+        total_node_cpu_util = total_node_util['cpu'] or 0
+        if total_node_cpu_util:
+            total_node_cpu_util = total_node_cpu_util * node.vcpus / 100
+            # account for planned migrations
+            total_node_cpu_util += self.host_metric_delta[node.hostname]['cpu']
+
+        total_node_ram_util = total_node_util['ram'] or 0
+        if total_node_ram_util:
+            total_node_ram_util /= oslo_utils.units.Ki
+            total_node_ram_util += self.host_metric_delta[node.hostname]['ram']
+
+        LOG.debug(
+            "node utilization: %s. "
+            "total instance cpu: %s, "
+            "total instance ram: %s, "
+            "total instance disk: %s, "
+            "total host cpu: %s, "
+            "total host ram: %s, "
+            "node delta usage: %s.",
+            node,
+            node_cpu_util, node_ram_util, node_disk_util,
+            total_node_cpu_util, total_node_ram_util,
+            self.host_metric_delta[node.hostname])
+
+        return dict(cpu=max(node_cpu_util, total_node_cpu_util),
+                    ram=max(node_ram_util, total_node_ram_util),
                     disk=node_disk_util)
 
     def get_node_capacity(self, node):
@@ -388,8 +451,15 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
         instance_utilization = self.get_instance_utilization(instance)
         metrics = ['cpu', 'ram', 'disk']
         for m in metrics:
-            if (instance_utilization[m] + node_utilization[m] >
-                    node_capacity[m] * cc[m]):
+            fits = (instance_utilization[m] + node_utilization[m] <=
+                    node_capacity[m] * cc[m])
+            LOG.debug(
+                "Instance fits: %s, metric: %s, instance: %s, "
+                "node: %s, instance utilization: %s, "
+                "node utilization: %s, node capacity: %s, cc: %s",
+                fits, m, instance, node, instance_utilization[m],
+                node_utilization[m], node_capacity[m], cc[m])
+            if not fits:
                 return False
         return True
 
@@ -424,6 +494,9 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                 for a in actions:
                     self.solution.actions.remove(a)
                     self.number_of_migrations -= 1
+                LOG.info("Optimized migrations: %s. "
+                         "Source: %s, destination: %s", actions,
+                         src_name, dst_name)
                 src_node = self.compute_model.get_node_by_name(src_name)
                 dst_node = self.compute_model.get_node_by_name(dst_name)
                 instance = self.compute_model.get_instance_by_uuid(
@@ -460,6 +533,8 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                         key=lambda x: self.get_instance_utilization(
                             x)['cpu']
                 ):
+                    LOG.info("Node %s overloaded, attempting to reduce load.",
+                             node)
                     # skip exclude instance when migrating
                     if instance.watcher_exclude:
                         LOG.debug("Instance is excluded by scope, "
@@ -468,11 +543,19 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                     for destination_node in reversed(sorted_nodes):
                         if self.instance_fits(
                                 instance, destination_node, cc):
+                            LOG.info("Offload: found fitting "
+                                     "destination (%s) for instance: %s. "
+                                     "Planning migration.",
+                                     destination_node, instance.uuid)
                             self.add_migration(instance, node,
                                                destination_node)
                             break
                     if not self.is_overloaded(node, cc):
+                        LOG.info("Node %s no longer overloaded.", node)
                         break
+                    else:
+                        LOG.info("Node still overloaded (%s), "
+                                 "continuing offload phase.", node)
 
     def consolidation_phase(self, cc):
         """Perform consolidation phase.
@@ -508,6 +591,10 @@ class VMWorkloadConsolidation(base.ServerConsolidationBaseStrategy):
                         break
                     if self.instance_fits(
                             instance, destination_node, cc):
+                        LOG.info("Consolidation: found fitting "
+                                 "destination (%s) for instance: %s. "
+                                 "Planning migration.",
+                                 destination_node, instance.uuid)
                         self.add_migration(instance, node,
                                            destination_node)
                         break

watcher/decision_engine/strategy/strategies/workload_balance.py

@@ -295,7 +295,7 @@ class WorkloadBalance(base.WorkloadStabilizationBaseStrategy):
                         self.threshold)
             return self.solution
 
-        # choose the server with largest cpu_util
+        # choose the server with largest cpu usage
         source_nodes = sorted(source_nodes,
                               reverse=True,
                               key=lambda x: (x[self._meter]))

watcher/decision_engine/strategy/strategies/zone_migration.py

@@ -16,7 +16,7 @@ from dateutil.parser import parse
 
 from oslo_log import log
 
-from cinderclient.v2.volumes import Volume
+from cinderclient.v3.volumes import Volume
 from novaclient.v2.servers import Server
 from watcher._i18n import _
 from watcher.common import cinder_helper
@@ -350,7 +350,7 @@ class ZoneMigration(base.ZoneMigrationBaseStrategy):
     def is_in_use(self, volume):
         return getattr(volume, 'status') == IN_USE
 
-    def instances_no_attached(instances):
+    def instances_no_attached(self, instances):
         return [i for i in instances
                 if not getattr(i, "os-extended-volumes:volumes_attached")]
 

watcher/hacking/checks.py

@@ -128,22 +128,20 @@ def check_assert_called_once_with(logical_line, filename):
 @flake8ext
 def check_python3_xrange(logical_line):
     if re.search(r"\bxrange\s*\(", logical_line):
-        yield(0, "N325: Do not use xrange. Use range, or six.moves.range for "
-                 "large loops.")
+        yield(0, "N325: Do not use xrange. Use range for large loops.")
 
 
 @flake8ext
 def check_no_basestring(logical_line):
     if re.search(r"\bbasestring\b", logical_line):
-        msg = ("N326: basestring is not Python3-compatible, use "
-               "six.string_types instead.")
+        msg = ("N326: basestring is not Python3-compatible, use str instead.")
         yield(0, msg)
 
 
 @flake8ext
 def check_python3_no_iteritems(logical_line):
     if re.search(r".*\.iteritems\(\)", logical_line):
-        msg = ("N327: Use six.iteritems() instead of dict.iteritems().")
+        msg = ("N327: Use dict.items() instead of dict.iteritems().")
         yield(0, msg)
 
 

watcher/locale/en_GB/LC_MESSAGES/watcher.po

@@ -1,14 +1,16 @@
 # Andi Chandler <andi@gowling.com>, 2017. #zanata
 # Andi Chandler <andi@gowling.com>, 2018. #zanata
+# Andi Chandler <andi@gowling.com>, 2020. #zanata
+# Andi Chandler <andi@gowling.com>, 2022. #zanata
 msgid ""
 msgstr ""
 "Project-Id-Version: watcher VERSION\n"
 "Report-Msgid-Bugs-To: https://bugs.launchpad.net/openstack-i18n/\n"
-"POT-Creation-Date: 2020-04-26 02:09+0000\n"
+"POT-Creation-Date: 2022-08-29 03:03+0000\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"PO-Revision-Date: 2018-11-07 06:14+0000\n"
+"PO-Revision-Date: 2022-05-31 08:38+0000\n"
 "Last-Translator: Andi Chandler <andi@gowling.com>\n"
 "Language-Team: English (United Kingdom)\n"
 "Language: en_GB\n"
@@ -187,10 +189,18 @@ msgstr "Audit Templates"
 msgid "Audit parameter %(parameter)s are not allowed"
 msgstr "Audit parameter %(parameter)s are not allowed"
 
+#, python-format
+msgid "Audit state %(state)s is disallowed."
+msgstr "Audit state %(state)s is disallowed."
+
 #, python-format
 msgid "Audit type %(audit_type)s could not be found"
 msgstr "Audit type %(audit_type)s could not be found"
 
+#, python-format
+msgid "Audit type %(audit_type)s is disallowed."
+msgstr "Audit type %(audit_type)s is disallowed."
+
 #, python-format
 msgid "AuditTemplate %(audit_template)s could not be found"
 msgstr "AuditTemplate %(audit_template)s could not be found"
@@ -243,6 +253,9 @@ msgstr "Cannot overwrite UUID for an existing efficacy indicator."
 msgid "Cannot remove 'goal' attribute from an audit template"
 msgstr "Cannot remove 'goal' attribute from an audit template"
 
+msgid "Ceilometer helper does not support statistic series method"
+msgstr "Ceilometer helper does not support statistic series method"
+
 msgid "Cluster Maintaining"
 msgstr "Cluster Maintaining"
 
@@ -369,6 +382,9 @@ msgstr "Goal %(goal)s is invalid"
 msgid "Goals"
 msgstr "Goals"
 
+msgid "Grafana helper does not support statistic series method"
+msgstr "Grafana helper does not support statistic series method"
+
 msgid "Hardware Maintenance"
 msgstr "Hardware Maintenance"
 
@@ -434,10 +450,17 @@ msgstr "Limit should be positive"
 msgid "Maximum time since last check-in for up service."
 msgstr "Maximum time since last check-in for up service."
 
+#, python-format
+msgid "Metric: %(metric)s not available"
+msgstr "Metric: %(metric)s not available"
+
 #, python-format
 msgid "Migration of type '%(migration_type)s' is not supported."
 msgstr "Migration of type '%(migration_type)s' is not supported."
 
+msgid "Minimum Nova API Version"
+msgstr "Minimum Nova API Version"
+
 msgid ""
 "Name of this node. This can be an opaque identifier. It is not necessarily a "
 "hostname, FQDN, or IP address. However, the node name must be valid within "
@@ -451,10 +474,16 @@ msgstr ""
 msgid "No %(metric)s metric for %(host)s found."
 msgstr "No %(metric)s metric for %(host)s found."
 
+msgid "No datasources available"
+msgstr "No datasources available"
+
 #, python-format
 msgid "No strategy could be found to achieve the '%(goal)s' goal."
 msgstr "No strategy could be found to achieve the '%(goal)s' goal."
 
+msgid "Node Resource Consolidation strategy"
+msgstr "Node Resource Consolidation strategy"
+
 msgid "Noisy Neighbor"
 msgstr "Noisy Neighbour"
 
@@ -479,6 +508,9 @@ msgstr ""
 msgid "Plugins"
 msgstr "Plugins"
 
+msgid "Policy File JSON to YAML Migration"
+msgstr "Policy File JSON to YAML Migration"
+
 #, python-format
 msgid "Policy doesn't allow %(action)s to be performed."
 msgstr "Policy doesn't allow %(action)s to be performed."
@@ -606,6 +638,10 @@ msgstr "Strategy %(strategy)s could not be found"
 msgid "Strategy %(strategy)s is invalid"
 msgstr "Strategy %(strategy)s is invalid"
 
+#, python-format
+msgid "The %(data_model_type)s data model could not be found"
+msgstr "The %(data_model_type)s data model could not be found"
+
 #, python-format
 msgid "The %(name)s %(id)s could not be found"
 msgstr "The %(name)s %(id)s could not be found"
@@ -675,6 +711,13 @@ msgstr "The instance '%(name)s' could not be found"
 msgid "The ironic node %(uuid)s could not be found"
 msgstr "The Ironic node %(uuid)s could not be found"
 
+#, python-format
+msgid "The mapped compute node for instance '%(uuid)s' could not be found."
+msgstr "The mapped compute node for instance '%(uuid)s' could not be found."
+
+msgid "The node status is not defined"
+msgstr "The node status is not defined"
+
 msgid "The number of VM migrations to be performed."
 msgstr "The number of VM migrations to be performed."
 
@@ -738,6 +781,10 @@ msgstr "The total number of audited instances in strategy."
 msgid "The total number of enabled compute nodes."
 msgstr "The total number of enabled compute nodes."
 
+#, python-format
+msgid "The value %(value)s for parameter %(parameter)s is invalid"
+msgstr "The value %(value)s for parameter %(parameter)s is invalid"
+
 msgid "The value of original standard deviation."
 msgstr "The value of original standard deviation."
 

watcher/tests/api/test_base.py

@@ -13,6 +13,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from http import HTTPStatus
+
 from watcher.tests.api import base
 
 
@@ -25,6 +27,6 @@ class TestBase(base.FunctionalTest):
         response = self.get_json('/bad/path',
                                  expect_errors=True,
                                  headers={"Accept": "application/json"})
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual("application/json", response.content_type)
         self.assertTrue(response.json['error_message'])

watcher/tests/api/test_hooks.py

@@ -14,14 +14,11 @@
 
 """Tests for the Pecan API hooks."""
 
-from unittest import mock
-
+from http import client as http_client
 from oslo_config import cfg
 import oslo_messaging as messaging
 from oslo_serialization import jsonutils
-import six
-from six.moves import http_client
-
+from unittest import mock
 from watcher.api.controllers import root
 from watcher.api import hooks
 from watcher.common import context
@@ -144,7 +141,7 @@ class TestNoExceptionTracebackHook(base.FunctionalTest):
         # we don't care about this garbage.
         expected_msg = ("Remote error: %s %s"
                         % (test_exc_type, self.MSG_WITHOUT_TRACE) +
-                        ("\n[u'" if six.PY2 else "\n['"))
+                        "\n['")
         actual_msg = jsonutils.loads(
             response.json['error_message'])['faultstring']
         self.assertEqual(expected_msg, actual_msg)

watcher/tests/api/v1/test_actions.py

@@ -14,6 +14,7 @@ import datetime
 import itertools
 from unittest import mock
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from wsme import types as wtypes
@@ -102,7 +103,7 @@ class TestListAction(api_base.FunctionalTest):
 
         response = self.get_json('/actions/%s' % action['uuid'],
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         action = obj_utils.create_test_action(self.context, parents=None)
@@ -125,7 +126,7 @@ class TestListAction(api_base.FunctionalTest):
         action = obj_utils.create_test_action(self.context, parents=None)
         response = self.get_json('/actions/%s/detail' % action['uuid'],
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         action_list = []
@@ -266,7 +267,7 @@ class TestListAction(api_base.FunctionalTest):
         url = '/actions?action_plan_uuid=%s&audit_uuid=%s' % (
             action_plan.uuid, self.audit.uuid)
         response = self.get_json(url, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
     def test_many_with_sort_key_uuid(self):
         action_plan = obj_utils.create_test_action_plan(
@@ -327,7 +328,7 @@ class TestListAction(api_base.FunctionalTest):
         response = self.get_json(
             '/actions?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
     def test_many_with_soft_deleted_action_plan_uuid(self):
         action_plan1 = obj_utils.create_test_action_plan(
@@ -488,7 +489,7 @@ class TestPatch(api_base.FunctionalTest):
             [{'path': '/state', 'value': new_state, 'op': 'replace'}],
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertTrue(response.json['error_message'])
 
 
@@ -516,7 +517,7 @@ class TestDelete(api_base.FunctionalTest):
         mock_utcnow.return_value = test_time
         response = self.delete('/actions/%s' % self.action.uuid,
                                expect_errors=True)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -536,7 +537,7 @@ class TestActionPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_actions_plans.py

@@ -14,6 +14,7 @@ import datetime
 import itertools
 from unittest import mock
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 
@@ -87,7 +88,7 @@ class TestListActionPlan(api_base.FunctionalTest):
 
         response = self.get_json('/action_plans/%s' % action_plan['uuid'],
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         action_plan = obj_utils.create_test_action_plan(self.context)
@@ -113,7 +114,7 @@ class TestListActionPlan(api_base.FunctionalTest):
         response = self.get_json(
             '/action_plan/%s/detail' % action_plan['uuid'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         action_plan_list = []
@@ -260,7 +261,7 @@ class TestListActionPlan(api_base.FunctionalTest):
         response = self.get_json(
             '/action_plans?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
     def test_links(self):
         uuid = utils.generate_uuid()
@@ -317,7 +318,7 @@ class TestDelete(api_base.FunctionalTest):
     def test_delete_action_plan_without_action(self):
         response = self.delete('/action_plans/%s' % self.action_plan.uuid,
                                expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
         self.action_plan.state = objects.action_plan.State.SUCCEEDED
@@ -325,7 +326,7 @@ class TestDelete(api_base.FunctionalTest):
         self.delete('/action_plans/%s' % self.action_plan.uuid)
         response = self.get_json('/action_plans/%s' % self.action_plan.uuid,
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -345,20 +346,20 @@ class TestDelete(api_base.FunctionalTest):
             expect_errors=True)
 
         # The action plan does not exist anymore
-        self.assertEqual(404, ap_response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, ap_response.status_int)
         self.assertEqual('application/json', ap_response.content_type)
         self.assertTrue(ap_response.json['error_message'])
 
         # Nor does the action
         self.assertEqual(0, len(acts_response['actions']))
-        self.assertEqual(404, act_response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, act_response.status_int)
         self.assertEqual('application/json', act_response.content_type)
         self.assertTrue(act_response.json['error_message'])
 
     def test_delete_action_plan_not_found(self):
         uuid = utils.generate_uuid()
         response = self.delete('/action_plans/%s' % uuid, expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -388,7 +389,7 @@ class TestStart(api_base.FunctionalTest):
         uuid = utils.generate_uuid()
         response = self.post('/v1/action_plans/%s/%s' %
                              (uuid, 'start'), expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -401,11 +402,11 @@ class TestStart(api_base.FunctionalTest):
         response = self.post('/v1/action_plans/%s/%s/'
                              % (self.action_plan.uuid, 'start'),
                              expect_errors=True)
-        self.assertEqual(200, response.status_int)
+        self.assertEqual(HTTPStatus.OK, response.status_int)
         act_response = self.get_json(
             '/actions/%s' % action.uuid,
             expect_errors=True)
-        self.assertEqual(200, act_response.status_int)
+        self.assertEqual(HTTPStatus.OK, act_response.status_int)
         self.assertEqual('PENDING', act_response.json['state'])
         self.assertEqual('application/json', act_response.content_type)
 
@@ -445,7 +446,7 @@ class TestPatch(api_base.FunctionalTest):
             expect_errors=True)
 
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_replace_non_existent_action_plan_denied(self):
@@ -455,7 +456,7 @@ class TestPatch(api_base.FunctionalTest):
               'value': objects.action_plan.State.PENDING,
               'op': 'replace'}],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -465,7 +466,7 @@ class TestPatch(api_base.FunctionalTest):
             [{'path': '/foo', 'value': 'bar', 'op': 'add'}],
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_remove_denied(self):
@@ -480,7 +481,7 @@ class TestPatch(api_base.FunctionalTest):
             expect_errors=True)
 
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_remove_uuid_denied(self):
@@ -488,7 +489,7 @@ class TestPatch(api_base.FunctionalTest):
             '/action_plans/%s' % self.action_plan.uuid,
             [{'path': '/uuid', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -497,7 +498,7 @@ class TestPatch(api_base.FunctionalTest):
             '/action_plans/%s' % self.action_plan.uuid,
             [{'path': '/non-existent', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(400, response.status_code)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_code)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -512,7 +513,7 @@ class TestPatch(api_base.FunctionalTest):
             [{'path': '/state', 'value': new_state,
               'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
         applier_mock.assert_called_once_with(mock.ANY,
                                              self.action_plan.uuid)
 
@@ -579,7 +580,7 @@ class TestPatchStateTransitionDenied(api_base.FunctionalTest):
 
         self.assertNotEqual(self.new_state, initial_ap['state'])
         self.assertEqual(self.original_state, updated_ap['state'])
-        self.assertEqual(400, response.status_code)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_code)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -618,7 +619,7 @@ class TestPatchStateTransitionOk(api_base.FunctionalTest):
         self.assertNotEqual(self.new_state, initial_ap['state'])
         self.assertEqual(self.new_state, updated_ap['state'])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
 
 class TestActionPlanPolicyEnforcement(api_base.FunctionalTest):
@@ -635,7 +636,7 @@ class TestActionPlanPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_audit_templates.py

@@ -15,6 +15,7 @@ import itertools
 from unittest import mock
 from urllib import parse as urlparse
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from oslo_utils import timeutils
@@ -126,7 +127,7 @@ class TestListAuditTemplate(FunctionalTestWithSetup):
         response = self.get_json(
             '/audit_templates/%s' % audit_template['uuid'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         audit_template = obj_utils.create_test_audit_template(self.context)
@@ -152,7 +153,7 @@ class TestListAuditTemplate(FunctionalTestWithSetup):
         response = self.get_json(
             '/audit_templates/%s/detail' % audit_template['uuid'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         audit_template_list = []
@@ -336,7 +337,7 @@ class TestListAuditTemplate(FunctionalTestWithSetup):
         response = self.get_json(
             '/audit_templates?sort_key=%s' % 'goal_bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
 
 class TestPatch(FunctionalTestWithSetup):
@@ -362,7 +363,7 @@ class TestPatch(FunctionalTestWithSetup):
             [{'path': '/goal', 'value': new_goal_uuid,
               'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
         response = self.get_json(
             '/audit_templates/%s' % self.audit_template.uuid)
@@ -386,7 +387,7 @@ class TestPatch(FunctionalTestWithSetup):
             [{'path': '/goal', 'value': new_goal_uuid,
               'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
         response = self.get_json(
             '/audit_templates/%s' % self.audit_template.name)
@@ -401,7 +402,7 @@ class TestPatch(FunctionalTestWithSetup):
             [{'path': '/goal', 'value': self.fake_goal1.uuid,
               'op': 'replace'}],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -416,7 +417,7 @@ class TestPatch(FunctionalTestWithSetup):
                 [{'path': '/goal', 'value': utils.generate_uuid(),
                   'op': 'replace'}],
                 expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not cn_mock.called
 
     def test_add_goal_uuid(self):
@@ -426,7 +427,7 @@ class TestPatch(FunctionalTestWithSetup):
               'value': self.fake_goal2.uuid,
               'op': 'add'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_int)
+        self.assertEqual(HTTPStatus.OK, response.status_int)
 
         response = self.get_json(
             '/audit_templates/%s' % self.audit_template.uuid)
@@ -439,7 +440,7 @@ class TestPatch(FunctionalTestWithSetup):
               'value': self.fake_strategy1.uuid,
               'op': 'add'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_int)
+        self.assertEqual(HTTPStatus.OK, response.status_int)
 
         response = self.get_json(
             '/audit_templates/%s' % self.audit_template.uuid)
@@ -452,7 +453,7 @@ class TestPatch(FunctionalTestWithSetup):
               'value': self.fake_strategy2['uuid'],
               'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_int)
+        self.assertEqual(HTTPStatus.OK, response.status_int)
 
         response = self.get_json(
             '/audit_templates/%s' % self.audit_template.uuid)
@@ -466,7 +467,7 @@ class TestPatch(FunctionalTestWithSetup):
               'value': utils.generate_uuid(),  # Does not exist
               'op': 'replace'}], expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_add_non_existent_property(self):
@@ -475,7 +476,7 @@ class TestPatch(FunctionalTestWithSetup):
             [{'path': '/foo', 'value': 'bar', 'op': 'add'}],
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_remove_strategy(self):
@@ -492,7 +493,7 @@ class TestPatch(FunctionalTestWithSetup):
             '/audit_templates/%s' % self.audit_template.uuid,
             [{'path': '/strategy', 'op': 'remove'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
     def test_remove_goal(self):
         response = self.get_json(
@@ -503,7 +504,7 @@ class TestPatch(FunctionalTestWithSetup):
             '/audit_templates/%s' % self.audit_template.uuid,
             [{'path': '/goal', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(403, response.status_code)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_code)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -512,7 +513,7 @@ class TestPatch(FunctionalTestWithSetup):
             '/audit_templates/%s' % self.audit_template.uuid,
             [{'path': '/uuid', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -521,7 +522,7 @@ class TestPatch(FunctionalTestWithSetup):
             '/audit_templates/%s' % self.audit_template.uuid,
             [{'path': '/non-existent', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(400, response.status_code)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_code)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -538,7 +539,7 @@ class TestPost(FunctionalTestWithSetup):
 
         response = self.post_json('/audit_templates', audit_template_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         # Check location header
         self.assertIsNotNone(response.location)
         expected_location = \
@@ -565,7 +566,7 @@ class TestPost(FunctionalTestWithSetup):
 
         response = self.post_json('/audit_templates', audit_template_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         # Check location header
         self.assertIsNotNone(response.location)
         expected_location = \
@@ -613,7 +614,8 @@ class TestPost(FunctionalTestWithSetup):
             strategy=self.fake_strategy1.uuid, scope=scope)
         response = self.post_json('/audit_templates',
                                   audit_template_dict, expect_errors=True)
-        self.assertEqual(500, response.status_int)
+        self.assertEqual(HTTPStatus.INTERNAL_SERVER_ERROR,
+                         response.status_int)
 
     def test_create_audit_template_does_autogenerate_id(self):
         audit_template_dict = post_get_test_audit_template(
@@ -635,7 +637,7 @@ class TestPost(FunctionalTestWithSetup):
 
         response = self.post_json('/audit_templates', audit_template_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertTrue(utils.is_uuid_like(response.json['uuid']))
 
     def test_create_audit_template_with_invalid_goal(self):
@@ -648,7 +650,7 @@ class TestPost(FunctionalTestWithSetup):
                 goal_uuid=utils.generate_uuid())
             response = self.post_json('/audit_templates',
                                       audit_template_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not cn_mock.called
 
     def test_create_audit_template_with_invalid_strategy(self):
@@ -662,7 +664,7 @@ class TestPost(FunctionalTestWithSetup):
                 strategy_uuid=utils.generate_uuid())
             response = self.post_json('/audit_templates',
                                       audit_template_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not cn_mock.called
 
     def test_create_audit_template_with_unrelated_strategy(self):
@@ -676,7 +678,7 @@ class TestPost(FunctionalTestWithSetup):
                 strategy=self.fake_strategy2['uuid'])
             response = self.post_json('/audit_templates',
                                       audit_template_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not cn_mock.called
 
     def test_create_audit_template_with_uuid(self):
@@ -689,7 +691,7 @@ class TestPost(FunctionalTestWithSetup):
             response = self.post_json('/audit_templates', audit_template_dict,
                                       expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not cn_mock.called
 
     def test_create_audit_template_with_old_scope(self):
@@ -710,7 +712,7 @@ class TestPost(FunctionalTestWithSetup):
             strategy=self.fake_strategy1.uuid, scope=scope)
         response = self.post_json('/audit_templates',
                                   audit_template_dict)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
 
 
 class TestDelete(api_base.FunctionalTest):
@@ -730,7 +732,7 @@ class TestDelete(api_base.FunctionalTest):
         response = self.get_json(
             urlparse.quote('/audit_templates/%s' % self.audit_template.uuid),
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -753,7 +755,7 @@ class TestDelete(api_base.FunctionalTest):
         response = self.get_json(
             urlparse.quote('/audit_templates/%s' % self.audit_template.name),
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -771,7 +773,7 @@ class TestDelete(api_base.FunctionalTest):
         uuid = utils.generate_uuid()
         response = self.delete(
             '/audit_templates/%s' % uuid, expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -784,7 +786,7 @@ class TestAuditTemplatePolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_audits.py

@@ -16,6 +16,7 @@ import itertools
 from unittest import mock
 from urllib import parse as urlparse
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from oslo_utils import timeutils
@@ -130,7 +131,7 @@ class TestListAudit(api_base.FunctionalTest):
 
         response = self.get_json('/audits/%s' % audit['uuid'],
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         audit = obj_utils.create_test_audit(self.context)
@@ -153,7 +154,7 @@ class TestListAudit(api_base.FunctionalTest):
         audit = obj_utils.create_test_audit(self.context)
         response = self.get_json('/audits/%s/detail' % audit['uuid'],
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         audit_list = []
@@ -225,7 +226,7 @@ class TestListAudit(api_base.FunctionalTest):
         response = self.get_json(
             '/audits?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
     def test_links(self):
         uuid = utils.generate_uuid()
@@ -295,7 +296,7 @@ class TestPatch(api_base.FunctionalTest):
             [{'path': '/state', 'value': new_state,
              'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
         response = self.get_json('/audits/%s' % self.audit.uuid)
         self.assertEqual(new_state, response['state'])
@@ -308,7 +309,7 @@ class TestPatch(api_base.FunctionalTest):
             '/audits/%s' % utils.generate_uuid(),
             [{'path': '/state', 'value': objects.audit.State.SUCCEEDED,
               'op': 'replace'}], expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -318,7 +319,7 @@ class TestPatch(api_base.FunctionalTest):
             '/audits/%s' % self.audit.uuid,
             [{'path': '/state', 'value': new_state, 'op': 'add'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_int)
+        self.assertEqual(HTTPStatus.OK, response.status_int)
 
         response = self.get_json('/audits/%s' % self.audit.uuid)
         self.assertEqual(new_state, response['state'])
@@ -329,7 +330,7 @@ class TestPatch(api_base.FunctionalTest):
             [{'path': '/foo', 'value': 'bar', 'op': 'add'}],
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertTrue(response.json['error_message'])
 
     def test_remove_ok(self):
@@ -339,7 +340,7 @@ class TestPatch(api_base.FunctionalTest):
         response = self.patch_json('/audits/%s' % self.audit.uuid,
                                    [{'path': '/interval', 'op': 'remove'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
         response = self.get_json('/audits/%s' % self.audit.uuid)
         self.assertIsNone(response['interval'])
@@ -348,7 +349,7 @@ class TestPatch(api_base.FunctionalTest):
         response = self.patch_json('/audits/%s' % self.audit.uuid,
                                    [{'path': '/uuid', 'op': 'remove'}],
                                    expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -357,7 +358,7 @@ class TestPatch(api_base.FunctionalTest):
             '/audits/%s' % self.audit.uuid,
             [{'path': '/non-existent', 'op': 'remove'}],
             expect_errors=True)
-        self.assertEqual(400, response.status_code)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_code)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -415,7 +416,7 @@ class TestPatchStateTransitionDenied(api_base.FunctionalTest):
               'op': 'replace'}],
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_code)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_code)
         self.assertTrue(response.json['error_message'])
 
         response = self.get_json('/audits/%s' % self.audit.uuid)
@@ -462,7 +463,7 @@ class TestPatchStateTransitionOk(api_base.FunctionalTest):
             [{'path': '/state', 'value': self.new_state,
              'op': 'replace'}])
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(200, response.status_code)
+        self.assertEqual(HTTPStatus.OK, response.status_code)
 
         response = self.get_json('/audits/%s' % self.audit.uuid)
         self.assertEqual(self.new_state, response['state'])
@@ -502,7 +503,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         # Check location header
         self.assertIsNotNone(response.location)
         expected_location = '/v1/audits/%s' % response.json['uuid']
@@ -527,7 +528,7 @@ class TestPost(api_base.FunctionalTest):
         audit_dict = post_get_test_audit(state=objects.audit.State.SUCCEEDED)
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -542,7 +543,7 @@ class TestPost(api_base.FunctionalTest):
                                'next_run_time', 'hostname'])
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -557,7 +558,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertTrue(utils.is_uuid_like(response.json['uuid']))
@@ -573,7 +574,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertTrue(utils.is_uuid_like(response.json['uuid']))
@@ -590,7 +591,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertTrue(utils.is_uuid_like(response.json['uuid']))
@@ -608,7 +609,7 @@ class TestPost(api_base.FunctionalTest):
             '01234567-8910-1112-1314-151617181920')
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual("application/json", response.content_type)
         expected_error_msg = ('The audit template UUID or name specified is '
                               'invalid')
@@ -643,7 +644,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertTrue(utils.is_uuid_like(response.json['uuid']))
@@ -660,7 +661,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertEqual(audit_dict['interval'], response.json['interval'])
@@ -679,7 +680,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertEqual(audit_dict['interval'], response.json['interval'])
@@ -698,9 +699,9 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(500, response.status_int)
+        self.assertEqual(HTTPStatus.INTERNAL_SERVER_ERROR, response.status_int)
         expected_error_msg = ('Exactly 5 or 6 columns has to be '
-                              'specified for iteratorexpression.')
+                              'specified for iterator expression.')
         self.assertTrue(response.json['error_message'])
         self.assertIn(expected_error_msg, response.json['error_message'])
 
@@ -714,7 +715,7 @@ class TestPost(api_base.FunctionalTest):
         audit_dict['audit_type'] = objects.audit.AuditType.CONTINUOUS.value
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         expected_error_msg = ('Interval of audit must be specified '
                               'for CONTINUOUS.')
@@ -731,7 +732,7 @@ class TestPost(api_base.FunctionalTest):
         audit_dict['audit_type'] = objects.audit.AuditType.ONESHOT.value
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         expected_error_msg = 'Interval of audit must not be set for ONESHOT.'
         self.assertTrue(response.json['error_message'])
@@ -755,7 +756,7 @@ class TestPost(api_base.FunctionalTest):
         del audit_dict['scope']
         response = self.post_json('/audits', audit_dict, expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         assert not mock_trigger_audit.called
 
     @mock.patch.object(deapi.DecisionEngineAPI, 'trigger_audit')
@@ -769,7 +770,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         expected_error_msg = ('Specify parameters but no predefined '
                               'strategy for audit, or no '
                               'parameter spec in predefined strategy')
@@ -792,7 +793,7 @@ class TestPost(api_base.FunctionalTest):
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         expected_error_msg = ('Specify parameters but no predefined '
                               'strategy for audit, or no '
                               'parameter spec in predefined strategy')
@@ -816,7 +817,7 @@ class TestPost(api_base.FunctionalTest):
             del audit_dict[k]
 
         response = self.post_json('/audits', audit_dict, expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual("application/json", response.content_type)
         expected_error_msg = 'Audit parameter fake2 are not allowed'
         self.assertTrue(response.json['error_message'])
@@ -875,13 +876,13 @@ class TestPost(api_base.FunctionalTest):
         audit_dict['name'] = normal_name
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(normal_name, response.json['name'])
 
         audit_dict['name'] = long_name
         response = self.post_json('/audits', audit_dict)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertNotEqual(long_name, response.json['name'])
 
     @mock.patch.object(deapi.DecisionEngineAPI, 'trigger_audit')
@@ -905,7 +906,7 @@ class TestPost(api_base.FunctionalTest):
             audit_dict,
             headers={'OpenStack-API-Version': 'infra-optim 1.1'})
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertEqual(objects.audit.State.PENDING,
                          response.json['state'])
         self.assertEqual(audit_dict['interval'], response.json['interval'])
@@ -944,7 +945,7 @@ class TestPost(api_base.FunctionalTest):
             headers={'OpenStack-API-Version': 'infra-optim 1.0'},
             expect_errors=True)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(406, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_ACCEPTABLE, response.status_int)
         expected_error_msg = 'Request not acceptable.'
         self.assertTrue(response.json['error_message'])
         self.assertIn(expected_error_msg, response.json['error_message'])
@@ -963,7 +964,7 @@ class TestPost(api_base.FunctionalTest):
             audit_dict,
             headers={'OpenStack-API-Version': 'infra-optim 1.2'})
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertFalse(response.json['force'])
 
     @mock.patch.object(deapi.DecisionEngineAPI, 'trigger_audit')
@@ -980,7 +981,7 @@ class TestPost(api_base.FunctionalTest):
             audit_dict,
             headers={'OpenStack-API-Version': 'infra-optim 1.2'})
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(201, response.status_int)
+        self.assertEqual(HTTPStatus.CREATED, response.status_int)
         self.assertTrue(response.json['force'])
 
 
@@ -1013,7 +1014,7 @@ class TestDelete(api_base.FunctionalTest):
              'op': 'replace'}])
         response = self.delete('/audits/%s' % self.audit.uuid,
                                expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -1025,7 +1026,7 @@ class TestDelete(api_base.FunctionalTest):
         self.delete('/audits/%s' % self.audit.uuid)
         response = self.get_json('/audits/%s' % self.audit.uuid,
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -1041,7 +1042,7 @@ class TestDelete(api_base.FunctionalTest):
     def test_delete_audit_not_found(self):
         uuid = utils.generate_uuid()
         response = self.delete('/audits/%s' % uuid, expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -1058,7 +1059,7 @@ class TestAuditPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_data_model.py

@@ -15,6 +15,7 @@
 
 from unittest import mock
 
+from http import HTTPStatus
 from oslo_serialization import jsonutils
 
 from watcher.decision_engine import rpcapi as deapi
@@ -42,7 +43,7 @@ class TestListDataModel(api_base.FunctionalTest):
             '/data_model/?data_model_type=compute',
             headers={'OpenStack-API-Version': 'infra-optim 1.2'},
             expect_errors=True)
-        self.assertEqual(406, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_ACCEPTABLE, response.status_int)
 
 
 class TestDataModelPolicyEnforcement(api_base.FunctionalTest):
@@ -59,7 +60,7 @@ class TestDataModelPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_goals.py

@@ -10,6 +10,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from urllib import parse as urlparse
@@ -59,7 +60,7 @@ class TestListGoal(api_base.FunctionalTest):
         response = self.get_json(
             '/goals/%s' % goal['uuid'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         goal = obj_utils.create_test_goal(self.context)
@@ -71,7 +72,7 @@ class TestListGoal(api_base.FunctionalTest):
         goal = obj_utils.create_test_goal(self.context)
         response = self.get_json('/goals/%s/detail' % goal.uuid,
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         goal_list = []
@@ -139,7 +140,7 @@ class TestListGoal(api_base.FunctionalTest):
         response = self.get_json(
             '/goals?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
 
 class TestGoalPolicyEnforcement(api_base.FunctionalTest):
@@ -150,7 +151,7 @@ class TestGoalPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:default"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_microversions.py

@@ -10,6 +10,8 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+from http import HTTPStatus
+
 from watcher.api.controllers.v1 import versions
 from watcher.tests.api import base as api_base
 
@@ -38,7 +40,7 @@ class TestMicroversions(api_base.FunctionalTest):
                                                         '10'])},
             expect_errors=True, return_json=False)
         self.assertEqual('application/json', response.content_type)
-        self.assertEqual(406, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_ACCEPTABLE, response.status_int)
         expected_error_msg = ('Invalid value for'
                               ' OpenStack-API-Version header')
         self.assertTrue(response.json['error_message'])
@@ -98,7 +100,7 @@ class TestMicroversions(api_base.FunctionalTest):
             headers={'OpenStack-API-Version': ' '.join([SERVICE_TYPE,
                                                         '1.999'])},
             expect_errors=True)
-        self.assertEqual(406, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_ACCEPTABLE, response.status_int)
         self.assertEqual(response.headers[H_MIN_VER], MIN_VER)
         self.assertEqual(response.headers[H_MAX_VER], MAX_VER)
         expected_error_msg = ('Version 1.999 was requested but the minor '

watcher/tests/api/v1/test_scoring_engines.py

@@ -10,6 +10,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from watcher.common import utils
@@ -44,7 +45,7 @@ class TestListScoringEngine(api_base.FunctionalTest):
         response = self.get_json(
             '/scoring_engines/%s' % scoring_engine['name'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         obj_utils.create_test_goal(self.context)
@@ -63,7 +64,7 @@ class TestListScoringEngine(api_base.FunctionalTest):
         response = self.get_json(
             '/scoring_engines/%s/detail' % scoring_engine.id,
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         scoring_engine_list = []
@@ -131,7 +132,7 @@ class TestListScoringEngine(api_base.FunctionalTest):
         response = self.get_json(
             '/goals?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
 
 class TestScoringEnginePolicyEnforcement(api_base.FunctionalTest):
@@ -142,7 +143,7 @@ class TestScoringEnginePolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:default"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_services.py

@@ -10,6 +10,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 from urllib import parse as urlparse
@@ -57,7 +58,7 @@ class TestListService(api_base.FunctionalTest):
         response = self.get_json(
             '/services/%s' % service['id'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         service = obj_utils.create_test_service(self.context)
@@ -74,7 +75,7 @@ class TestListService(api_base.FunctionalTest):
         service = obj_utils.create_test_service(self.context)
         response = self.get_json('/services/%s/detail' % service.id,
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         service_list = []
@@ -149,7 +150,7 @@ class TestListService(api_base.FunctionalTest):
         response = self.get_json(
             '/services?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
 
 class TestServicePolicyEnforcement(api_base.FunctionalTest):
@@ -160,7 +161,7 @@ class TestServicePolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:default"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_strategies.py

@@ -13,6 +13,7 @@
 from unittest import mock
 from urllib import parse as urlparse
 
+from http import HTTPStatus
 from oslo_config import cfg
 from oslo_serialization import jsonutils
 
@@ -88,7 +89,7 @@ class TestListStrategy(api_base.FunctionalTest):
         response = self.get_json(
             '/strategies/%s' % strategy['uuid'],
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_detail(self):
         strategy = obj_utils.create_test_strategy(self.context)
@@ -104,7 +105,7 @@ class TestListStrategy(api_base.FunctionalTest):
         strategy = obj_utils.create_test_strategy(self.context)
         response = self.get_json('/strategies/%s/detail' % strategy.uuid,
                                  expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
 
     def test_many(self):
         strategy_list = []
@@ -240,7 +241,7 @@ class TestListStrategy(api_base.FunctionalTest):
         response = self.get_json(
             '/strategies?sort_key=%s' % 'bad_name',
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
 
 
 class TestStrategyPolicyEnforcement(api_base.FunctionalTest):
@@ -256,7 +257,7 @@ class TestStrategyPolicyEnforcement(api_base.FunctionalTest):
             "default": "rule:admin_api",
             rule: "rule:defaut"})
         response = func(*arg, **kwarg)
-        self.assertEqual(403, response.status_int)
+        self.assertEqual(HTTPStatus.FORBIDDEN, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(
             "Policy doesn't allow %s to be performed." % rule,

watcher/tests/api/v1/test_types.py

@@ -18,6 +18,8 @@ import webtest
 import wsme
 from wsme import types as wtypes
 
+from http import HTTPStatus
+
 from watcher.api.controllers.v1 import types
 from watcher.common import exception
 from watcher.common import utils
@@ -120,68 +122,68 @@ class TestJsonPatchType(base.TestCase):
                          {'path': '/dict', 'op': 'add',
                           'value': {'cat': 'meow'}}]
         ret = self._patch_json(valid_patches, False)
-        self.assertEqual(200, ret.status_int)
+        self.assertEqual(HTTPStatus.OK, ret.status_int)
         self.assertEqual(valid_patches, ret.json)
 
     def test_cannot_update_internal_attr(self):
         patch = [{'path': '/internal', 'op': 'replace', 'value': 'foo'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_cannot_update_internal_dict_attr(self):
         patch = [{'path': '/internal', 'op': 'replace',
                  'value': 'foo'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_mandatory_attr(self):
         patch = [{'op': 'replace', 'path': '/mandatory', 'value': 'foo'}]
         ret = self._patch_json(patch, False)
-        self.assertEqual(200, ret.status_int)
+        self.assertEqual(HTTPStatus.OK, ret.status_int)
         self.assertEqual(patch, ret.json)
 
     def test_cannot_remove_mandatory_attr(self):
         patch = [{'op': 'remove', 'path': '/mandatory'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_missing_required_fields_path(self):
         missing_path = [{'op': 'remove'}]
         ret = self._patch_json(missing_path, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_missing_required_fields_op(self):
         missing_op = [{'path': '/foo'}]
         ret = self._patch_json(missing_op, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_invalid_op(self):
         patch = [{'path': '/foo', 'op': 'invalid'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_invalid_path(self):
         patch = [{'path': 'invalid-path', 'op': 'remove'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_cannot_add_with_no_value(self):
         patch = [{'path': '/extra/foo', 'op': 'add'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
     def test_cannot_replace_with_no_value(self):
         patch = [{'path': '/foo', 'op': 'replace'}]
         ret = self._patch_json(patch, True)
-        self.assertEqual(400, ret.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, ret.status_int)
         self.assertTrue(ret.json['faultstring'])
 
 

watcher/tests/api/v1/test_webhooks.py

@@ -12,6 +12,8 @@
 
 from unittest import mock
 
+from http import HTTPStatus
+
 from watcher.decision_engine import rpcapi as deapi
 from watcher import objects
 from watcher.tests.api import base as api_base
@@ -34,7 +36,7 @@ class TestPost(api_base.FunctionalTest):
         response = self.post_json(
             '/webhooks/%s' % audit['uuid'], {},
             headers={'OpenStack-API-Version': 'infra-optim 1.4'})
-        self.assertEqual(202, response.status_int)
+        self.assertEqual(HTTPStatus.ACCEPTED, response.status_int)
         mock_trigger_audit.assert_called_once_with(
             mock.ANY, audit['uuid'])
 
@@ -43,7 +45,7 @@ class TestPost(api_base.FunctionalTest):
             '/webhooks/no-audit', {},
             headers={'OpenStack-API-Version': 'infra-optim 1.4'},
             expect_errors=True)
-        self.assertEqual(404, response.status_int)
+        self.assertEqual(HTTPStatus.NOT_FOUND, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -53,7 +55,7 @@ class TestPost(api_base.FunctionalTest):
             '/webhooks/%s' % audit['uuid'], {},
             headers={'OpenStack-API-Version': 'infra-optim 1.4'},
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])
 
@@ -66,6 +68,6 @@ class TestPost(api_base.FunctionalTest):
             '/webhooks/%s' % audit['uuid'], {},
             headers={'OpenStack-API-Version': 'infra-optim 1.4'},
             expect_errors=True)
-        self.assertEqual(400, response.status_int)
+        self.assertEqual(HTTPStatus.BAD_REQUEST, response.status_int)
         self.assertEqual('application/json', response.content_type)
         self.assertTrue(response.json['error_message'])

watcher/tests/applier/actions/test_change_node_power_state.py

@@ -19,134 +19,151 @@ import jsonschema
 
 from watcher.applier.actions import base as baction
 from watcher.applier.actions import change_node_power_state
-from watcher.common import clients
+from watcher.common.metal_helper import constants as m_constants
+from watcher.common.metal_helper import factory as m_helper_factory
 from watcher.tests import base
+from watcher.tests.decision_engine import fake_metal_helper
 
 COMPUTE_NODE = "compute-1"
 
 
-@mock.patch.object(clients.OpenStackClients, 'nova')
-@mock.patch.object(clients.OpenStackClients, 'ironic')
 class TestChangeNodePowerState(base.TestCase):
 
     def setUp(self):
         super(TestChangeNodePowerState, self).setUp()
 
+        p_m_factory = mock.patch.object(m_helper_factory, 'get_helper')
+        m_factory = p_m_factory.start()
+        self._metal_helper = m_factory.return_value
+        self.addCleanup(p_m_factory.stop)
+
+        # Let's avoid unnecessary sleep calls while running the test.
+        p_sleep = mock.patch('time.sleep')
+        p_sleep.start()
+        self.addCleanup(p_sleep.stop)
+
         self.input_parameters = {
             baction.BaseAction.RESOURCE_ID: COMPUTE_NODE,
-            "state": change_node_power_state.NodeState.POWERON.value,
+            "state": m_constants.PowerState.ON.value,
         }
         self.action = change_node_power_state.ChangeNodePowerState(
             mock.Mock())
         self.action.input_parameters = self.input_parameters
 
-    def test_parameters_down(self, mock_ironic, mock_nova):
+    def test_parameters_down(self):
         self.action.input_parameters = {
             baction.BaseAction.RESOURCE_ID: COMPUTE_NODE,
             self.action.STATE:
-                change_node_power_state.NodeState.POWEROFF.value}
+                m_constants.PowerState.OFF.value}
         self.assertTrue(self.action.validate_parameters())
 
-    def test_parameters_up(self, mock_ironic, mock_nova):
+    def test_parameters_up(self):
         self.action.input_parameters = {
             baction.BaseAction.RESOURCE_ID: COMPUTE_NODE,
             self.action.STATE:
-                change_node_power_state.NodeState.POWERON.value}
+                m_constants.PowerState.ON.value}
         self.assertTrue(self.action.validate_parameters())
 
-    def test_parameters_exception_wrong_state(self, mock_ironic, mock_nova):
+    def test_parameters_exception_wrong_state(self):
         self.action.input_parameters = {
             baction.BaseAction.RESOURCE_ID: COMPUTE_NODE,
             self.action.STATE: 'error'}
         self.assertRaises(jsonschema.ValidationError,
                           self.action.validate_parameters)
 
-    def test_parameters_resource_id_empty(self, mock_ironic, mock_nova):
+    def test_parameters_resource_id_empty(self):
         self.action.input_parameters = {
             self.action.STATE:
-                change_node_power_state.NodeState.POWERON.value,
+                m_constants.PowerState.ON.value,
         }
         self.assertRaises(jsonschema.ValidationError,
                           self.action.validate_parameters)
 
-    def test_parameters_applies_add_extra(self, mock_ironic, mock_nova):
+    def test_parameters_applies_add_extra(self):
         self.action.input_parameters = {"extra": "failed"}
         self.assertRaises(jsonschema.ValidationError,
                           self.action.validate_parameters)
 
-    def test_change_service_state_pre_condition(self, mock_ironic, mock_nova):
+    def test_change_service_state_pre_condition(self):
         try:
             self.action.pre_condition()
         except Exception as exc:
             self.fail(exc)
 
-    def test_change_node_state_post_condition(self, mock_ironic, mock_nova):
+    def test_change_node_state_post_condition(self):
         try:
             self.action.post_condition()
         except Exception as exc:
             self.fail(exc)
 
-    def test_execute_node_service_state_with_poweron_target(
-            self, mock_ironic, mock_nova):
-        mock_irclient = mock_ironic.return_value
+    def test_execute_node_service_state_with_poweron_target(self):
         self.action.input_parameters["state"] = (
-            change_node_power_state.NodeState.POWERON.value)
-        mock_irclient.node.get.side_effect = [
-            mock.MagicMock(power_state='power off'),
-            mock.MagicMock(power_state='power on')]
+            m_constants.PowerState.ON.value)
+        mock_nodes = [
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.OFF),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON)
+        ]
+        self._metal_helper.get_node.side_effect = mock_nodes
 
         result = self.action.execute()
         self.assertTrue(result)
 
-        mock_irclient.node.set_power_state.assert_called_once_with(
-            COMPUTE_NODE, change_node_power_state.NodeState.POWERON.value)
+        mock_nodes[0].set_power_state.assert_called_once_with(
+            m_constants.PowerState.ON.value)
 
-    def test_execute_change_node_state_with_poweroff_target(
-            self, mock_ironic, mock_nova):
-        mock_irclient = mock_ironic.return_value
-        mock_nvclient = mock_nova.return_value
-        mock_get = mock.MagicMock()
-        mock_get.to_dict.return_value = {'running_vms': 0}
-        mock_nvclient.hypervisors.get.return_value = mock_get
+    def test_execute_change_node_state_with_poweroff_target(self):
         self.action.input_parameters["state"] = (
-            change_node_power_state.NodeState.POWEROFF.value)
-        mock_irclient.node.get.side_effect = [
-            mock.MagicMock(power_state='power on'),
-            mock.MagicMock(power_state='power on'),
-            mock.MagicMock(power_state='power off')]
+            m_constants.PowerState.OFF.value)
+
+        mock_nodes = [
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.OFF)
+        ]
+        self._metal_helper.get_node.side_effect = mock_nodes
+
         result = self.action.execute()
         self.assertTrue(result)
 
-        mock_irclient.node.set_power_state.assert_called_once_with(
-            COMPUTE_NODE, change_node_power_state.NodeState.POWEROFF.value)
+        mock_nodes[0].set_power_state.assert_called_once_with(
+            m_constants.PowerState.OFF.value)
 
-    def test_revert_change_node_state_with_poweron_target(
-            self, mock_ironic, mock_nova):
-        mock_irclient = mock_ironic.return_value
-        mock_nvclient = mock_nova.return_value
-        mock_get = mock.MagicMock()
-        mock_get.to_dict.return_value = {'running_vms': 0}
-        mock_nvclient.hypervisors.get.return_value = mock_get
+    def test_revert_change_node_state_with_poweron_target(self):
         self.action.input_parameters["state"] = (
-            change_node_power_state.NodeState.POWERON.value)
-        mock_irclient.node.get.side_effect = [
-            mock.MagicMock(power_state='power on'),
-            mock.MagicMock(power_state='power on'),
-            mock.MagicMock(power_state='power off')]
+            m_constants.PowerState.ON.value)
+
+        mock_nodes = [
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.OFF)
+        ]
+        self._metal_helper.get_node.side_effect = mock_nodes
+
         self.action.revert()
 
-        mock_irclient.node.set_power_state.assert_called_once_with(
-            COMPUTE_NODE, change_node_power_state.NodeState.POWEROFF.value)
+        mock_nodes[0].set_power_state.assert_called_once_with(
+            m_constants.PowerState.OFF.value)
 
-    def test_revert_change_node_state_with_poweroff_target(
-            self, mock_ironic, mock_nova):
-        mock_irclient = mock_ironic.return_value
+    def test_revert_change_node_state_with_poweroff_target(self):
         self.action.input_parameters["state"] = (
-            change_node_power_state.NodeState.POWEROFF.value)
-        mock_irclient.node.get.side_effect = [
-            mock.MagicMock(power_state='power off'),
-            mock.MagicMock(power_state='power on')]
+            m_constants.PowerState.OFF.value)
+        mock_nodes = [
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.OFF),
+            fake_metal_helper.get_mock_metal_node(
+                power_state=m_constants.PowerState.ON)
+        ]
+        self._metal_helper.get_node.side_effect = mock_nodes
+
         self.action.revert()
 
-        mock_irclient.node.set_power_state.assert_called_once_with(
-            COMPUTE_NODE, change_node_power_state.NodeState.POWERON.value)
+        mock_nodes[0].set_power_state.assert_called_once_with(
+            m_constants.PowerState.ON.value)

watcher/tests/applier/test_rpcapi.py

@@ -40,7 +40,7 @@ class TestApplierAPI(base.TestCase):
                 'check_api_version',
                 api_version=rpcapi.ApplierAPI().API_VERSION)
 
-    def test_execute_audit_without_error(self):
+    def test_execute_action_plan_without_error(self):
         with mock.patch.object(om.RPCClient, 'cast') as mock_cast:
             action_plan_uuid = utils.generate_uuid()
             self.api.launch_action_plan(self.context, action_plan_uuid)

watcher/tests/applier/test_sync.py

@@ -83,4 +83,4 @@ class TestCancelOngoingActionPlans(db_base.DbTestCase):
         m_action_list.assert_called()
         m_plan_save.assert_called()
         m_action_save.assert_called()
-        self.assertEqual(self.action.state, objects.audit.State.CANCELLED)
+        self.assertEqual(self.action.state, objects.action.State.CANCELLED)

watcher/tests/common/metal_helper/test_base.py

@@ -0,0 +1,96 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from unittest import mock
+
+from watcher.common import exception
+from watcher.common.metal_helper import base as m_helper_base
+from watcher.common.metal_helper import constants as m_constants
+from watcher.tests import base
+
+
+# The base classes have abstract methods, we'll need to
+# stub them.
+class MockMetalNode(m_helper_base.BaseMetalNode):
+    def get_power_state(self):
+        raise NotImplementedError()
+
+    def get_id(self):
+        raise NotImplementedError()
+
+    def power_on(self):
+        raise NotImplementedError()
+
+    def power_off(self):
+        raise NotImplementedError()
+
+
+class MockMetalHelper(m_helper_base.BaseMetalHelper):
+    def list_compute_nodes(self):
+        pass
+
+    def get_node(self, node_id):
+        pass
+
+
+class TestBaseMetalNode(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._nova_node = mock.Mock()
+        self._node = MockMetalNode(self._nova_node)
+
+    def test_get_hypervisor_node(self):
+        self.assertEqual(
+            self._nova_node,
+            self._node.get_hypervisor_node())
+
+    def test_get_hypervisor_node_missing(self):
+        node = MockMetalNode()
+        self.assertRaises(
+            exception.Invalid,
+            node.get_hypervisor_node)
+
+    def test_get_hypervisor_hostname(self):
+        self.assertEqual(
+            self._nova_node.hypervisor_hostname,
+            self._node.get_hypervisor_hostname())
+
+    @mock.patch.object(MockMetalNode, 'power_on')
+    @mock.patch.object(MockMetalNode, 'power_off')
+    def test_set_power_state(self,
+                             mock_power_off, mock_power_on):
+        self._node.set_power_state(m_constants.PowerState.ON)
+        mock_power_on.assert_called_once_with()
+
+        self._node.set_power_state(m_constants.PowerState.OFF)
+        mock_power_off.assert_called_once_with()
+
+        self.assertRaises(
+            exception.UnsupportedActionType,
+            self._node.set_power_state,
+            m_constants.PowerState.UNKNOWN)
+
+
+class TestBaseMetalHelper(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._osc = mock.Mock()
+        self._helper = MockMetalHelper(self._osc)
+
+    def test_nova_client_attr(self):
+        self.assertEqual(self._osc.nova.return_value,
+                         self._helper.nova_client)

watcher/tests/common/metal_helper/test_factory.py

@@ -0,0 +1,38 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from unittest import mock
+
+from watcher.common import clients
+from watcher.common.metal_helper import factory
+from watcher.common.metal_helper import ironic
+from watcher.common.metal_helper import maas
+from watcher.tests import base
+
+
+class TestMetalHelperFactory(base.TestCase):
+
+    @mock.patch.object(clients, 'OpenStackClients')
+    @mock.patch.object(maas, 'MaasHelper')
+    @mock.patch.object(ironic, 'IronicHelper')
+    def test_factory(self, mock_ironic, mock_maas, mock_osc):
+        self.assertEqual(
+            mock_ironic.return_value,
+            factory.get_helper())
+
+        self.config(url="fake_maas_url", group="maas_client")
+        self.assertEqual(
+            mock_maas.return_value,
+            factory.get_helper())

watcher/tests/common/metal_helper/test_ironic.py

@@ -0,0 +1,128 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from unittest import mock
+
+from watcher.common.metal_helper import constants as m_constants
+from watcher.common.metal_helper import ironic
+from watcher.tests import base
+
+
+class TestIronicNode(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._wrapped_node = mock.Mock()
+        self._nova_node = mock.Mock()
+        self._ironic_client = mock.Mock()
+
+        self._node = ironic.IronicNode(
+            self._wrapped_node, self._nova_node, self._ironic_client)
+
+    def test_get_power_state(self):
+        states = (
+            "power on",
+            "power off",
+            "rebooting",
+            "soft power off",
+            "soft reboot",
+            'SomeOtherState')
+        type(self._wrapped_node).power_state = mock.PropertyMock(
+            side_effect=states)
+
+        expected_states = (
+            m_constants.PowerState.ON,
+            m_constants.PowerState.OFF,
+            m_constants.PowerState.ON,
+            m_constants.PowerState.OFF,
+            m_constants.PowerState.ON,
+            m_constants.PowerState.UNKNOWN)
+
+        for expected_state in expected_states:
+            actual_state = self._node.get_power_state()
+            self.assertEqual(expected_state, actual_state)
+
+    def test_get_id(self):
+        self.assertEqual(
+            self._wrapped_node.uuid,
+            self._node.get_id())
+
+    def test_power_on(self):
+        self._node.power_on()
+        self._ironic_client.node.set_power_state.assert_called_once_with(
+            self._wrapped_node.uuid, "on")
+
+    def test_power_off(self):
+        self._node.power_off()
+        self._ironic_client.node.set_power_state.assert_called_once_with(
+            self._wrapped_node.uuid, "off")
+
+
+class TestIronicHelper(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._mock_osc = mock.Mock()
+        self._mock_nova_client = self._mock_osc.nova.return_value
+        self._mock_ironic_client = self._mock_osc.ironic.return_value
+        self._helper = ironic.IronicHelper(osc=self._mock_osc)
+
+    def test_list_compute_nodes(self):
+        mock_machines = [
+            mock.Mock(
+                extra=dict(compute_node_id=mock.sentinel.compute_node_id)),
+            mock.Mock(
+                extra=dict(compute_node_id=mock.sentinel.compute_node_id2)),
+            mock.Mock(
+                extra=dict())
+        ]
+        mock_hypervisor = mock.Mock()
+
+        self._mock_ironic_client.node.list.return_value = mock_machines
+        self._mock_ironic_client.node.get.side_effect = mock_machines
+        self._mock_nova_client.hypervisors.get.side_effect = (
+            mock_hypervisor, None)
+
+        out_nodes = self._helper.list_compute_nodes()
+        self.assertEqual(1, len(out_nodes))
+
+        out_node = out_nodes[0]
+        self.assertIsInstance(out_node, ironic.IronicNode)
+        self.assertEqual(mock_hypervisor, out_node._nova_node)
+        self.assertEqual(mock_machines[0], out_node._ironic_node)
+        self.assertEqual(self._mock_ironic_client, out_node._ironic_client)
+
+    def test_get_node(self):
+        mock_machine = mock.Mock(
+            extra=dict(compute_node_id=mock.sentinel.compute_node_id))
+        self._mock_ironic_client.node.get.return_value = mock_machine
+
+        out_node = self._helper.get_node(mock.sentinel.id)
+
+        self.assertEqual(self._mock_nova_client.hypervisors.get.return_value,
+                         out_node._nova_node)
+        self.assertEqual(self._mock_ironic_client, out_node._ironic_client)
+        self.assertEqual(mock_machine, out_node._ironic_node)
+
+    def test_get_node_not_a_hypervisor(self):
+        mock_machine = mock.Mock(extra=dict(compute_node_id=None))
+        self._mock_ironic_client.node.get.return_value = mock_machine
+
+        out_node = self._helper.get_node(mock.sentinel.id)
+
+        self._mock_nova_client.hypervisors.get.assert_not_called()
+        self.assertIsNone(out_node._nova_node)
+        self.assertEqual(self._mock_ironic_client, out_node._ironic_client)
+        self.assertEqual(mock_machine, out_node._ironic_node)

watcher/tests/common/metal_helper/test_maas.py

@@ -0,0 +1,126 @@
+# Copyright 2023 Cloudbase Solutions
+# All Rights Reserved.
+#
+#    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.
+
+from unittest import mock
+
+try:
+    from maas.client import enum as maas_enum
+except ImportError:
+    maas_enum = None
+
+from watcher.common.metal_helper import constants as m_constants
+from watcher.common.metal_helper import maas
+from watcher.tests import base
+
+
+class TestMaasNode(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._wrapped_node = mock.Mock()
+        self._nova_node = mock.Mock()
+        self._maas_client = mock.Mock()
+
+        self._node = maas.MaasNode(
+            self._wrapped_node, self._nova_node, self._maas_client)
+
+    def test_get_power_state(self):
+        if not maas_enum:
+            self.skipTest("python-libmaas not intalled.")
+
+        self._wrapped_node.query_power_state.side_effect = (
+            maas_enum.PowerState.ON,
+            maas_enum.PowerState.OFF,
+            maas_enum.PowerState.ERROR,
+            maas_enum.PowerState.UNKNOWN,
+            'SomeOtherState')
+
+        expected_states = (
+            m_constants.PowerState.ON,
+            m_constants.PowerState.OFF,
+            m_constants.PowerState.ERROR,
+            m_constants.PowerState.UNKNOWN,
+            m_constants.PowerState.UNKNOWN)
+
+        for expected_state in expected_states:
+            actual_state = self._node.get_power_state()
+            self.assertEqual(expected_state, actual_state)
+
+    def test_get_id(self):
+        self.assertEqual(
+            self._wrapped_node.system_id,
+            self._node.get_id())
+
+    def test_power_on(self):
+        self._node.power_on()
+        self._wrapped_node.power_on.assert_called_once_with()
+
+    def test_power_off(self):
+        self._node.power_off()
+        self._wrapped_node.power_off.assert_called_once_with()
+
+
+class TestMaasHelper(base.TestCase):
+    def setUp(self):
+        super().setUp()
+
+        self._mock_osc = mock.Mock()
+        self._mock_nova_client = self._mock_osc.nova.return_value
+        self._mock_maas_client = self._mock_osc.maas.return_value
+        self._helper = maas.MaasHelper(osc=self._mock_osc)
+
+    def test_list_compute_nodes(self):
+        compute_fqdn = "compute-0"
+        # some other MAAS node, not a Nova node
+        ctrl_fqdn = "ctrl-1"
+
+        mock_machines = [
+            mock.Mock(fqdn=compute_fqdn,
+                      system_id=mock.sentinel.compute_node_id),
+            mock.Mock(fqdn=ctrl_fqdn,
+                      system_id=mock.sentinel.ctrl_node_id),
+        ]
+        mock_hypervisors = [
+            mock.Mock(hypervisor_hostname=compute_fqdn),
+        ]
+
+        self._mock_maas_client.machines.list.return_value = mock_machines
+        self._mock_nova_client.hypervisors.list.return_value = mock_hypervisors
+
+        out_nodes = self._helper.list_compute_nodes()
+        self.assertEqual(1, len(out_nodes))
+
+        out_node = out_nodes[0]
+        self.assertIsInstance(out_node, maas.MaasNode)
+        self.assertEqual(mock.sentinel.compute_node_id, out_node.get_id())
+        self.assertEqual(compute_fqdn, out_node.get_hypervisor_hostname())
+
+    def test_get_node(self):
+        mock_machine = mock.Mock(fqdn='compute-0')
+        self._mock_maas_client.machines.get.return_value = mock_machine
+
+        mock_compute_nodes = [
+            mock.Mock(hypervisor_hostname="compute-011"),
+            mock.Mock(hypervisor_hostname="compute-0"),
+            mock.Mock(hypervisor_hostname="compute-01"),
+        ]
+        self._mock_nova_client.hypervisors.search.return_value = (
+            mock_compute_nodes)
+
+        out_node = self._helper.get_node(mock.sentinel.id)
+
+        self.assertEqual(mock_compute_nodes[1], out_node._nova_node)
+        self.assertEqual(self._mock_maas_client, out_node._maas_client)
+        self.assertEqual(mock_machine, out_node._maas_node)

watcher/tests/common/test_cinder_helper.py

@@ -13,9 +13,11 @@
 # limitations under the License.
 #
 
-import time
 from unittest import mock
 
+from http import HTTPStatus
+import time
+
 from cinderclient import exceptions as cinder_exception
 
 from watcher.common import cinder_helper
@@ -291,7 +293,8 @@ class TestCinderHelper(base.TestCase):
 
         volume = self.fake_volume()
         cinder_util.get_volume = mock.MagicMock()
-        cinder_util.get_volume.side_effect = cinder_exception.NotFound(404)
+        cinder_util.get_volume.side_effect =\
+            cinder_exception.NotFound(HTTPStatus.NOT_FOUND)
         result = cinder_util._can_get_volume(volume.id)
         self.assertFalse(result)
 
@@ -339,7 +342,7 @@ class TestCinderHelper(base.TestCase):
         cinder_util = cinder_helper.CinderHelper()
 
         volume = self.fake_volume()
-        side_effect = cinder_exception.NotFound(404)
+        side_effect = cinder_exception.NotFound(HTTPStatus.NOT_FOUND)
         cinder_util.cinder.volumes.get.side_effect = side_effect
         cinder_util.cinder.volumes.find.return_value = False
         result = cinder_util.get_volume(volume)

watcher/tests/common/test_clients.py

@@ -10,8 +10,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-from ceilometerclient import client as ceclient
-import ceilometerclient.v2.client as ceclient_v2
 from unittest import mock
 
 from cinderclient import client as ciclient
@@ -270,56 +268,6 @@ class TestClients(base.TestCase):
         cinder_cached = osc.cinder()
         self.assertEqual(cinder, cinder_cached)
 
-    @mock.patch.object(ceclient, 'Client')
-    @mock.patch.object(clients.OpenStackClients, 'session')
-    def test_clients_ceilometer(self, mock_session, mock_call):
-        osc = clients.OpenStackClients()
-        osc._ceilometer = None
-        osc.ceilometer()
-        mock_call.assert_called_once_with(
-            CONF.ceilometer_client.api_version,
-            None,
-            endpoint_type=CONF.ceilometer_client.endpoint_type,
-            region_name=CONF.ceilometer_client.region_name,
-            session=mock_session)
-
-    @mock.patch.object(clients.OpenStackClients, 'session')
-    @mock.patch.object(ceclient_v2.Client, '_get_redirect_client')
-    def test_clients_ceilometer_diff_vers(self, mock_get_redirect_client,
-                                          mock_session):
-        '''ceilometerclient currently only has one version (v2)'''
-        mock_get_redirect_client.return_value = [mock.Mock(), mock.Mock()]
-        CONF.set_override('api_version', '2',
-                          group='ceilometer_client')
-        osc = clients.OpenStackClients()
-        osc._ceilometer = None
-        osc.ceilometer()
-        self.assertEqual(ceclient_v2.Client,
-                         type(osc.ceilometer()))
-
-    @mock.patch.object(clients.OpenStackClients, 'session')
-    @mock.patch.object(ceclient_v2.Client, '_get_redirect_client')
-    def test_clients_ceilometer_diff_endpoint(self, mock_get_redirect_client,
-                                              mock_session):
-        mock_get_redirect_client.return_value = [mock.Mock(), mock.Mock()]
-        CONF.set_override('endpoint_type', 'publicURL',
-                          group='ceilometer_client')
-        osc = clients.OpenStackClients()
-        osc._ceilometer = None
-        osc.ceilometer()
-        self.assertEqual('publicURL', osc.ceilometer().http_client.interface)
-
-    @mock.patch.object(clients.OpenStackClients, 'session')
-    @mock.patch.object(ceclient_v2.Client, '_get_redirect_client')
-    def test_clients_ceilometer_cached(self, mock_get_redirect_client,
-                                       mock_session):
-        mock_get_redirect_client.return_value = [mock.Mock(), mock.Mock()]
-        osc = clients.OpenStackClients()
-        osc._ceilometer = None
-        ceilometer = osc.ceilometer()
-        ceilometer_cached = osc.ceilometer()
-        self.assertEqual(ceilometer, ceilometer_cached)
-
     @mock.patch.object(netclient, 'Client')
     @mock.patch.object(clients.OpenStackClients, 'session')
     def test_clients_neutron(self, mock_session, mock_call):

watcher/tests/common/test_placement_helper.py

@@ -11,6 +11,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from http import HTTPStatus
 from unittest import mock
 
 from watcher.common import placement_helper
@@ -55,10 +56,10 @@ class TestPlacementHelper(base.TestCase):
         kss_req.assert_called_once_with(url, method, **kwargs)
 
     def test_get(self, kss_req):
-        kss_req.return_value = fake_requests.FakeResponse(200)
+        kss_req.return_value = fake_requests.FakeResponse(HTTPStatus.OK)
         url = '/resource_providers'
         resp = self.client.get(url)
-        self.assertEqual(200, resp.status_code)
+        self.assertEqual(HTTPStatus.OK, resp.status_code)
         self._assert_keystone_called_once(kss_req, url, 'GET')
 
     def test_get_resource_providers_OK(self, kss_req):
@@ -76,7 +77,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_resource_providers(rp_name)
 
@@ -99,7 +100,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_resource_providers(rp_name)
 
@@ -110,7 +111,8 @@ class TestPlacementHelper(base.TestCase):
     def test_get_resource_providers_fail(self, kss_req):
         rp_name = 'compute'
         kss_req.return_value = fake_requests.FakeResponse(
-            400, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.BAD_REQUEST,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_resource_providers(rp_name)
         self.assertIsNone(result)
 
@@ -149,7 +151,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_inventories(rp_uuid)
 
@@ -160,7 +162,8 @@ class TestPlacementHelper(base.TestCase):
     def test_get_inventories_fail(self, kss_req):
         rp_uuid = uuidutils.generate_uuid()
         kss_req.return_value = fake_requests.FakeResponse(
-            404, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.NOT_FOUND,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_inventories(rp_uuid)
         self.assertIsNone(result)
 
@@ -175,7 +178,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_provider_traits(rp_uuid)
 
@@ -186,7 +189,8 @@ class TestPlacementHelper(base.TestCase):
     def test_get_provider_traits_fail(self, kss_req):
         rp_uuid = uuidutils.generate_uuid()
         kss_req.return_value = fake_requests.FakeResponse(
-            404, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.NOT_FOUND,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_provider_traits(rp_uuid)
         self.assertIsNone(result)
 
@@ -216,7 +220,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_allocations_for_consumer(c_uuid)
 
@@ -227,7 +231,8 @@ class TestPlacementHelper(base.TestCase):
     def test_get_allocations_for_consumer_fail(self, kss_req):
         c_uuid = uuidutils.generate_uuid()
         kss_req.return_value = fake_requests.FakeResponse(
-            404, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.NOT_FOUND,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_allocations_for_consumer(c_uuid)
         self.assertIsNone(result)
 
@@ -245,7 +250,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_usages_for_resource_provider(rp_uuid)
 
@@ -256,7 +261,8 @@ class TestPlacementHelper(base.TestCase):
     def test_get_usages_for_resource_provider_fail(self, kss_req):
         rp_uuid = uuidutils.generate_uuid()
         kss_req.return_value = fake_requests.FakeResponse(
-            404, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.NOT_FOUND,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_usages_for_resource_provider(rp_uuid)
         self.assertIsNone(result)
 
@@ -296,7 +302,7 @@ class TestPlacementHelper(base.TestCase):
         }
 
         kss_req.return_value = fake_requests.FakeResponse(
-            200, content=jsonutils.dump_as_bytes(mock_json_data))
+            HTTPStatus.OK, content=jsonutils.dump_as_bytes(mock_json_data))
 
         result = self.client.get_candidate_providers(resources)
 
@@ -307,6 +313,7 @@ class TestPlacementHelper(base.TestCase):
     def test_get_candidate_providers_fail(self, kss_req):
         rp_uuid = uuidutils.generate_uuid()
         kss_req.return_value = fake_requests.FakeResponse(
-            404, content=jsonutils.dump_as_bytes(self.fake_err_msg))
+            HTTPStatus.NOT_FOUND,
+            content=jsonutils.dump_as_bytes(self.fake_err_msg))
         result = self.client.get_candidate_providers(rp_uuid)
         self.assertIsNone(result)

watcher/tests/common/test_service.py

@@ -20,7 +20,6 @@ from unittest import mock
 from oslo_config import cfg
 
 import oslo_messaging as om
-from watcher.common import rpc
 from watcher.common import service
 from watcher import objects
 from watcher.tests import base
@@ -81,13 +80,13 @@ class TestService(base.TestCase):
         super(TestService, self).setUp()
 
     @mock.patch.object(om.rpc.server, "RPCServer")
-    def test_start(self, m_handler):
+    def _test_start(self, m_handler):
         dummy_service = service.Service(DummyManager)
         dummy_service.start()
         self.assertEqual(1, m_handler.call_count)
 
     @mock.patch.object(om.rpc.server, "RPCServer")
-    def test_stop(self, m_handler):
+    def _test_stop(self, m_handler):
         dummy_service = service.Service(DummyManager)
         dummy_service.stop()
         self.assertEqual(1, m_handler.call_count)
@@ -102,8 +101,6 @@ class TestService(base.TestCase):
 
     def test_init_service(self):
         dummy_service = service.Service(DummyManager)
-        self.assertIsInstance(dummy_service.serializer,
-                              rpc.RequestContextSerializer)
         self.assertIsInstance(
             dummy_service.conductor_topic_handler,
             om.rpc.server.RPCServer)