From 832522c2924afe7407f2b526e483560085745cb2 Mon Sep 17 00:00:00 2001
From: Ifat Afek <ifat.afek@nokia.com>
Date: Thu, 13 Dec 2018 16:33:54 +0000
Subject: [PATCH] Use Nova versioned notifications by default

Changed the behavior of the Nova instance datasource to use by
default the versioned notifications.

Change-Id: Ife5c78c6568939f919174b5072fd70f461de0bd1
Story: 2004052
Task: 28501
---
 devstack/README.rst                           |  4 ++++
 devstack/gate_hook.sh                         |  4 ++++
 devstack/gate_hook_mock.sh                    |  4 ++++
 doc/source/contributor/configuration.rst      |  1 +
 doc/source/contributor/nova-config.rst        | 23 +++++++++++++++++++
 doc/source/install/install-rdo.rst            |  4 ++++
 ...sioned-notifications-3c5ff450b9fe69f0.yaml |  4 +++-
 vitrage/datasources/nova/instance/driver.py   |  3 ---
 .../nova/instance/field_extractor.py          |  1 +
 vitrage/os_clients.py                         |  2 +-
 vitrage/tests/unit/entity_graph/base.py       |  2 +-
 .../entity_graph/processor/test_processor.py  | 16 ++++++++-----
 12 files changed, 56 insertions(+), 12 deletions(-)
 create mode 100644 doc/source/contributor/nova-config.rst

diff --git a/devstack/README.rst b/devstack/README.rst
index 5d5f46410..47546ca62 100644
--- a/devstack/README.rst
+++ b/devstack/README.rst
@@ -25,6 +25,10 @@ Enabling Vitrage in DevStack
    notification_topics = notifications,vitrage_notifications
    notification_driver=messagingv2
 
+   [notifications]
+   versioned_notifications_topics = versioned_notifications,vitrage_notifications
+   notification_driver = messagingv2
+
 4. Add this to add notification from neutron to vitrage
    (make sure neutron is enabled in devstack)
 
diff --git a/devstack/gate_hook.sh b/devstack/gate_hook.sh
index 675dac6b8..45cd29fb8 100644
--- a/devstack/gate_hook.sh
+++ b/devstack/gate_hook.sh
@@ -38,6 +38,10 @@ DEVSTACK_LOCAL_CONFIG+="$(cat <<EOF
 notification_topics = notifications,vitrage_notifications
 notification_driver = messagingv2
 
+[notifications]
+versioned_notifications_topics = versioned_notifications,vitrage_notifications
+notification_driver = messagingv2
+
 [[post-config|\$NEUTRON_CONF]]
 [DEFAULT]
 notification_topics = notifications,vitrage_notifications
diff --git a/devstack/gate_hook_mock.sh b/devstack/gate_hook_mock.sh
index 0f2cd2f5f..dc52ecc9a 100644
--- a/devstack/gate_hook_mock.sh
+++ b/devstack/gate_hook_mock.sh
@@ -32,6 +32,10 @@ DEVSTACK_LOCAL_CONFIG+="$(cat <<EOF
 notification_topics = notifications,vitrage_notifications
 notification_driver = messagingv2
 
+[notifications]
+versioned_notifications_topics = versioned_notifications,vitrage_notifications
+notification_driver = messagingv2
+
 [[post-config|\$CINDER_CONF]]
 [DEFAULT]
 notification_topics = notifications,vitrage_notifications
diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst
index 49c6d8e9b..2e5d2daaf 100644
--- a/doc/source/contributor/configuration.rst
+++ b/doc/source/contributor/configuration.rst
@@ -26,6 +26,7 @@ Datasources
    static-config
    zabbix_vitrage
    k8s_datasource
+   nova-config
 
 Notifiers
 ---------
diff --git a/doc/source/contributor/nova-config.rst b/doc/source/contributor/nova-config.rst
new file mode 100644
index 000000000..d570832a0
--- /dev/null
+++ b/doc/source/contributor/nova-config.rst
@@ -0,0 +1,23 @@
+=============================
+Nova Datasource Configuration
+=============================
+
+By default, Nova datasource listens to Nova versioned notifications. If you
+are using Nova legacy notifications, then it should be indicated in Vitrage
+configuration as well.
+
+That is, if you have in ``/etc/nova/nova.conf`` or in ``/etc/nova/nova-cpu.conf``:
+
+.. code:: bash
+
+   notification_format = unversioned
+
+Then you should set in ``/etc/vitrage/vitrage.conf``:
+
+.. code:: bash
+
+   [nova.instance]
+   use_nova_versioned_notifications = False
+
+
+In other cases there is no need to set this option.
diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst
index 168088d74..07872c28b 100644
--- a/doc/source/install/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
@@ -144,6 +144,10 @@ Neutron, Heat and Aodh) to Vitrage, set the following in their conf files:
    notification_driver=messagingv2
 
 
+[notifications]
+versioned_notifications_topics = versioned_notifications,vitrage_notifications
+notification_driver = messagingv2
+
 Initialize Vitrage
 ------------------
 
diff --git a/releasenotes/notes/nova-versioned-notifications-3c5ff450b9fe69f0.yaml b/releasenotes/notes/nova-versioned-notifications-3c5ff450b9fe69f0.yaml
index 1c42d1d52..744dcd410 100644
--- a/releasenotes/notes/nova-versioned-notifications-3c5ff450b9fe69f0.yaml
+++ b/releasenotes/notes/nova-versioned-notifications-3c5ff450b9fe69f0.yaml
@@ -1,3 +1,5 @@
 ---
 features:
-  - Added support for Nova versioned notifications.
+  - Use Nova versioned notifications instead of the legacy, unversioned ones.
+    This bahavior is controlled by the ``use_nova_versioned_notifications``
+    configuration option.
diff --git a/vitrage/datasources/nova/instance/driver.py b/vitrage/datasources/nova/instance/driver.py
index 8a507826a..cf9c5897b 100644
--- a/vitrage/datasources/nova/instance/driver.py
+++ b/vitrage/datasources/nova/instance/driver.py
@@ -97,9 +97,6 @@ LEGACY_NOTIFICATIONS = {
 
 class InstanceDriver(NovaDriverBase):
 
-    def __init__(self, conf):
-        super(InstanceDriver, self).__init__(conf)
-
     @staticmethod
     def extract_events(instances):
         events = [instance.__dict__ for instance in instances]
diff --git a/vitrage/datasources/nova/instance/field_extractor.py b/vitrage/datasources/nova/instance/field_extractor.py
index e204054ff..09e09a840 100644
--- a/vitrage/datasources/nova/instance/field_extractor.py
+++ b/vitrage/datasources/nova/instance/field_extractor.py
@@ -12,6 +12,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 import abc
+
 from vitrage.datasources.transformer_base import extract_field_value
 
 
diff --git a/vitrage/os_clients.py b/vitrage/os_clients.py
index 9a4160b18..06fbf8ccc 100644
--- a/vitrage/os_clients.py
+++ b/vitrage/os_clients.py
@@ -30,7 +30,7 @@ OPTS = [
     cfg.StrOpt('mistral_version', default='2', help='Mistral version'),
     cfg.StrOpt('gnocchi_version', default='1', help='Gnocchi version'),
     cfg.BoolOpt('use_nova_versioned_notifications',
-                default=False,
+                default=True,
                 help='Indicates whether to use Nova versioned notifications.'
                      'The default is True. If False, the deprecated Nova '
                      'legacy notifications will be used.'
diff --git a/vitrage/tests/unit/entity_graph/base.py b/vitrage/tests/unit/entity_graph/base.py
index dc9dba3ec..4f5dd8238 100644
--- a/vitrage/tests/unit/entity_graph/base.py
+++ b/vitrage/tests/unit/entity_graph/base.py
@@ -65,7 +65,7 @@ class TestEntityGraphUnitBase(base.BaseTest):
 
     OS_CLIENTS_OPTS = [
         cfg.BoolOpt('use_nova_versioned_notifications',
-                    default=False, required=True),
+                    default=True, required=True),
     ]
 
     NUM_CLUSTERS = 1
diff --git a/vitrage/tests/unit/entity_graph/processor/test_processor.py b/vitrage/tests/unit/entity_graph/processor/test_processor.py
index f5cd437c4..0d71b276f 100644
--- a/vitrage/tests/unit/entity_graph/processor/test_processor.py
+++ b/vitrage/tests/unit/entity_graph/processor/test_processor.py
@@ -58,13 +58,17 @@ class TestProcessor(TestEntityGraphUnitBase):
         self._check_graph(processor, self.NUM_VERTICES_AFTER_CREATION,
                           self.NUM_EDGES_AFTER_CREATION)
 
-        # check update instance event
+        # check update instance event (versioned notification format)
         event[DSProps.DATASOURCE_ACTION] = DSAction.UPDATE
-        event[DSProps.EVENT_TYPE] = 'compute.instance.volume.attach'
-        event['hostname'] = 'new_host'
-        event['instance_id'] = event['id']
-        event['state'] = event['status']
-        event['host'] = event['OS-EXT-SRV-ATTR:host']
+        event[DSProps.EVENT_TYPE] = 'instance.volume_attach.end'
+
+        nova_object_data = {
+            'host_name': 'new_host',
+            'uuid': event['id'],
+            'state': event['status'],
+            'host': event['OS-EXT-SRV-ATTR:host']
+        }
+        event['nova_object.data'] = nova_object_data
 
         processor.process_event(event)
         self._check_graph(processor, self.NUM_VERTICES_AFTER_CREATION,