Distinguish between stack and resource events when polling

Don't accidentally treat a resource event like a stack event.

Change-Id: I0e4d97f9954adfac3124f6ed684b608f4da668b4
Closes-Bug: #1655142

3 files changed, 72 insertions, 14 deletions

diff --git a/heatclient/common/event_utils.py b/heatclient/common/event_utils.py
index 309a193..df000f7 100644
--- a/heatclient/common/event_utils.py
+++ b/heatclient/common/event_utils.py
@@ -181,6 +181,17 @@ def poll_for_events(hc, stack_name, action=None, poll_period=5, marker=None,
     if not out:
         out = sys.stdout
     event_log_context = utils.EventLogContext()
+
+    def is_stack_event(event):
+        if getattr(event, 'resource_name', '') != stack_name:
+            return False
+
+        phys_id = getattr(event, 'physical_resource_id', '')
+        links = dict((l.get('rel'),
+                      l.get('href')) for l in getattr(event, 'links', []))
+        stack_id = links.get('stack', phys_id).rsplit('/', 1)[-1]
+        return stack_id == phys_id
+
     while True:
         events = get_events(hc, stack_id=stack_name, nested_depth=nested_depth,
                             event_args={'sort_dir': 'asc',
@@ -198,7 +209,7 @@ def poll_for_events(hc, stack_name, action=None, poll_period=5, marker=None,
 
             for event in events:
                 # check if stack event was also received
-                if getattr(event, 'resource_name', '') == stack_name:
+                if is_stack_event(event):
                     stack_status = getattr(event, 'resource_status', '')
                     msg = msg_template % dict(
                         name=stack_name, status=stack_status)
diff --git a/heatclient/tests/unit/test_event_utils.py b/heatclient/tests/unit/test_event_utils.py
index 58f2e28..a9e8912 100644
--- a/heatclient/tests/unit/test_event_utils.py
+++ b/heatclient/tests/unit/test_event_utils.py
@@ -47,7 +47,8 @@ class ShellTestEventUtils(testtools.TestCase):
     @staticmethod
     def _mock_event(event_id, resource_id,
                     resource_status='CREATE_COMPLETE'):
-        ev_info = {"links": [{"href": "http://heat/foo", "rel": "self"}],
+        ev_info = {"links": [{"href": "http://heat/foo", "rel": "self"},
+                             {"href": "http://heat/stacks/a", "rel": "stack"}],
                    "logical_resource_id": resource_id,
                    "physical_resource_id": resource_id,
                    "resource_name": resource_id,
@@ -57,6 +58,23 @@ class ShellTestEventUtils(testtools.TestCase):
                    "id": event_id}
         return hc_ev.Event(manager=None, info=ev_info)
 
+    @staticmethod
+    def _mock_stack_event(event_id, stack_name,
+                          stack_status='CREATE_COMPLETE'):
+        stack_id = 'abcdef'
+        ev_info = {"links": [{"href": "http://heat/foo", "rel": "self"},
+                             {"href": "http://heat/stacks/%s/%s" % (stack_name,
+                                                                    stack_id),
+                              "rel": "stack"}],
+                   "logical_resource_id": stack_name,
+                   "physical_resource_id": stack_id,
+                   "resource_name": stack_name,
+                   "resource_status": stack_status,
+                   "resource_status_reason": "state changed",
+                   "event_time": "2014-12-05T14:14:30Z",
+                   "id": event_id}
+        return hc_ev.Event(manager=None, info=ev_info)
+
     def test_get_nested_ids(self):
         def list_stub(stack_id):
             return [self._mock_resource('aresource', 'foo3/3id')]
@@ -143,7 +161,7 @@ class ShellTestEventUtils(testtools.TestCase):
     @mock.patch('heatclient.common.event_utils.get_events')
     def test_poll_for_events(self, ge):
         ge.side_effect = [[
-            self._mock_event('1', 'astack', 'CREATE_IN_PROGRESS'),
+            self._mock_stack_event('1', 'astack', 'CREATE_IN_PROGRESS'),
             self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
             self._mock_event('3', 'res_child2', 'CREATE_IN_PROGRESS'),
             self._mock_event('4', 'res_child3', 'CREATE_IN_PROGRESS')
@@ -151,7 +169,7 @@ class ShellTestEventUtils(testtools.TestCase):
             self._mock_event('5', 'res_child1', 'CREATE_COMPLETE'),
             self._mock_event('6', 'res_child2', 'CREATE_COMPLETE'),
             self._mock_event('7', 'res_child3', 'CREATE_COMPLETE'),
-            self._mock_event('8', 'astack', 'CREATE_COMPLETE')
+            self._mock_stack_event('8', 'astack', 'CREATE_COMPLETE')
         ]]
 
         stack_status, msg = event_utils.poll_for_events(
@@ -168,12 +186,41 @@ class ShellTestEventUtils(testtools.TestCase):
         ])
 
     @mock.patch('heatclient.common.event_utils.get_events')
+    def test_poll_for_events_same_name(self, ge):
+        ge.side_effect = [[
+            self._mock_stack_event('1', 'mything', 'CREATE_IN_PROGRESS'),
+            self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
+            self._mock_event('3', 'mything', 'CREATE_IN_PROGRESS'),
+        ], [
+            self._mock_event('4', 'mything', 'CREATE_COMPLETE'),
+        ], [
+            self._mock_event('5', 'res_child1', 'CREATE_COMPLETE'),
+            self._mock_stack_event('6', 'mything', 'CREATE_COMPLETE'),
+        ]]
+
+        stack_status, msg = event_utils.poll_for_events(
+            None, 'mything', action='CREATE', poll_period=0)
+        self.assertEqual('CREATE_COMPLETE', stack_status)
+        self.assertEqual('\n Stack mything CREATE_COMPLETE \n', msg)
+        ge.assert_has_calls([
+            mock.call(None, stack_id='mything', nested_depth=0, event_args={
+                'sort_dir': 'asc', 'marker': None
+            }),
+            mock.call(None, stack_id='mything', nested_depth=0, event_args={
+                'sort_dir': 'asc', 'marker': '3'
+            }),
+            mock.call(None, stack_id='mything', nested_depth=0, event_args={
+                'sort_dir': 'asc', 'marker': '4'
+            })
+        ])
+
+    @mock.patch('heatclient.common.event_utils.get_events')
     def test_poll_for_events_with_marker(self, ge):
         ge.side_effect = [[
             self._mock_event('5', 'res_child1', 'CREATE_COMPLETE'),
             self._mock_event('6', 'res_child2', 'CREATE_COMPLETE'),
             self._mock_event('7', 'res_child3', 'CREATE_COMPLETE'),
-            self._mock_event('8', 'astack', 'CREATE_COMPLETE')
+            self._mock_stack_event('8', 'astack', 'CREATE_COMPLETE')
         ]]
 
         stack_status, msg = event_utils.poll_for_events(
@@ -190,9 +237,9 @@ class ShellTestEventUtils(testtools.TestCase):
     @mock.patch('heatclient.common.event_utils.get_events')
     def test_poll_for_events_in_progress_resource(self, ge):
         ge.side_effect = [[
-            self._mock_event('1', 'astack', 'CREATE_IN_PROGRESS'),
+            self._mock_stack_event('1', 'astack', 'CREATE_IN_PROGRESS'),
             self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
-            self._mock_event('3', 'astack', 'CREATE_COMPLETE')
+            self._mock_stack_event('3', 'astack', 'CREATE_COMPLETE')
         ]]
 
         stack_status, msg = event_utils.poll_for_events(
@@ -203,7 +250,7 @@ class ShellTestEventUtils(testtools.TestCase):
     @mock.patch('heatclient.common.event_utils.get_events')
     def test_poll_for_events_failed(self, ge):
         ge.side_effect = [[
-            self._mock_event('1', 'astack', 'CREATE_IN_PROGRESS'),
+            self._mock_stack_event('1', 'astack', 'CREATE_IN_PROGRESS'),
             self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
             self._mock_event('3', 'res_child2', 'CREATE_IN_PROGRESS'),
             self._mock_event('4', 'res_child3', 'CREATE_IN_PROGRESS')
@@ -211,7 +258,7 @@ class ShellTestEventUtils(testtools.TestCase):
             self._mock_event('5', 'res_child1', 'CREATE_COMPLETE'),
             self._mock_event('6', 'res_child2', 'CREATE_FAILED'),
             self._mock_event('7', 'res_child3', 'CREATE_COMPLETE'),
-            self._mock_event('8', 'astack', 'CREATE_FAILED')
+            self._mock_stack_event('8', 'astack', 'CREATE_FAILED')
         ]]
 
         stack_status, msg = event_utils.poll_for_events(
@@ -222,7 +269,7 @@ class ShellTestEventUtils(testtools.TestCase):
     @mock.patch('heatclient.common.event_utils.get_events')
     def test_poll_for_events_no_action(self, ge):
         ge.side_effect = [[
-            self._mock_event('1', 'astack', 'CREATE_IN_PROGRESS'),
+            self._mock_stack_event('1', 'astack', 'CREATE_IN_PROGRESS'),
             self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
             self._mock_event('3', 'res_child2', 'CREATE_IN_PROGRESS'),
             self._mock_event('4', 'res_child3', 'CREATE_IN_PROGRESS')
@@ -230,7 +277,7 @@ class ShellTestEventUtils(testtools.TestCase):
             self._mock_event('5', 'res_child1', 'CREATE_COMPLETE'),
             self._mock_event('6', 'res_child2', 'CREATE_FAILED'),
             self._mock_event('7', 'res_child3', 'CREATE_COMPLETE'),
-            self._mock_event('8', 'astack', 'FOO_FAILED')
+            self._mock_stack_event('8', 'astack', 'FOO_FAILED')
         ]]
 
         stack_status, msg = event_utils.poll_for_events(
@@ -244,7 +291,7 @@ class ShellTestEventUtils(testtools.TestCase):
         mock_client.stacks.get.return_value.stack_status = 'CREATE_FAILED'
 
         ge.side_effect = [[
-            self._mock_event('1', 'astack', 'CREATE_IN_PROGRESS'),
+            self._mock_stack_event('1', 'astack', 'CREATE_IN_PROGRESS'),
             self._mock_event('2', 'res_child1', 'CREATE_IN_PROGRESS'),
             self._mock_event('3', 'res_child2', 'CREATE_IN_PROGRESS'),
             self._mock_event('4', 'res_child3', 'CREATE_IN_PROGRESS')
diff --git a/heatclient/tests/unit/test_shell.py b/heatclient/tests/unit/test_shell.py
index efa124e..18173de 100644
--- a/heatclient/tests/unit/test_shell.py
+++ b/heatclient/tests/unit/test_shell.py
@@ -211,7 +211,7 @@ class TestCase(testtools.TestCase):
                               {"href": "http://heat.example.com:8004/foo3",
                                "rel": "stack"}],
                     "logical_resource_id": "aResource",
-                    "physical_resource_id": None,
+                    "physical_resource_id": 'foo3',
                     "resource_name": stack_name,
                     "resource_status": "%s_IN_PROGRESS" % action,
                     "resource_status_reason": "state changed"})
@@ -225,7 +225,7 @@ class TestCase(testtools.TestCase):
                            {"href": "http://heat.example.com:8004/foo3",
                             "rel": "stack"}],
                  "logical_resource_id": "aResource",
-                 "physical_resource_id": None,
+                 "physical_resource_id": 'foo3',
                  "resource_name": stack_name,
                  "resource_status": "%s_%s" % (action, final_state),
                  "resource_status_reason": "state changed"})