Fix compatibility with oslo.db 12.1.0

oslo.db 12.1.0 has changed the default value for the 'autocommit'
parameter of 'LegacyEngineFacade' from 'True' to 'False'. This is a
necessary step to ensure compatibility with SQLAlchemy 2.0. However, we
are currently relying on the autocommit behavior and need changes to
explicitly manage sessions. Until that happens, we need to override the
default.

This also moves the watcher queue declaration from the pipeline level
(where it is no longer valid) to the project level.

Co-Authored-By: Thierry Carrez <thierry@openstack.org>
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
(cherry picked from commit 5d70c207cd)
Change-Id: I7db39d958d087322bfa0aad70dfbd04de9228dd7

.zuul.yaml

@@ -1,8 +1,9 @@
 - project:
+    queue: watcher
     templates:
       - check-requirements
       - openstack-cover-jobs
-      - openstack-python3-yoga-jobs
+      - openstack-python3-zed-jobs
       - publish-openstack-docs-pti
       - release-notes-jobs-python3
     check:
@@ -14,7 +15,6 @@
         - watcherclient-tempest-functional
         - watcher-tempest-functional-ipv6-only
     gate:
-      queue: watcher
       jobs:
         - watcher-tempest-functional
         - watcher-tempest-functional-ipv6-only

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.

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,7 @@ Contents:
    :maxdepth: 1
 
    unreleased
+   yoga
    xena
    wallaby
    victoria

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

@@ -1,15 +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: python-watcher\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2020-10-27 04:13+0000\n"
+"POT-Creation-Date: 2022-08-29 03:02+0000\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"PO-Revision-Date: 2020-10-28 11:13+0000\n"
+"PO-Revision-Date: 2022-05-31 08:39+0000\n"
 "Last-Translator: Andi Chandler <andi@gowling.com>\n"
 "Language-Team: English (United Kingdom)\n"
 "Language: en_GB\n"
@@ -64,6 +65,9 @@ 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."
 
@@ -744,6 +748,23 @@ 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 "
@@ -799,6 +820,21 @@ 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`` "
@@ -814,6 +850,9 @@ 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 "
@@ -924,6 +963,12 @@ 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 "``[watcher_datasources] datasources = gnocchi,monasca,ceilometer``"
 msgstr "``[watcher_datasources] datasources = gnocchi,monasca,ceilometer``"
 

releasenotes/source/yoga.rst

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

test-requirements.txt

@@ -12,3 +12,4 @@ 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

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

@@ -44,7 +44,11 @@ _FACADE = None
 def _create_facade_lazily():
     global _FACADE
     if _FACADE is None:
-        _FACADE = db_session.EngineFacade.from_config(CONF)
+        # FIXME(amoralej): Remove autocommit=True (and ideally use of
+        # LegacyEngineFacade) asap since it's not compatible with SQLAlchemy
+        # 2.0.
+        _FACADE = db_session.EngineFacade.from_config(CONF,
+                                                      autocommit=True)
     return _FACADE
 
 

watcher/locale/en_GB/LC_MESSAGES/watcher.po

@@ -1,15 +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-10-27 04:14+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: 2020-10-28 11:02+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"
@@ -507,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."