Add stack id and resource id in logs

Where applicable, the stack and resource id's will be added in the logs
that reference those stacks and/or resources.

blueprint log-resource-stack-id

Change-Id: I70958ddd4904d70ff26c7ad28e2f7fe951881198
Co-Authored-By: Daniel Givens <daniel.givens@rackspace.com>

heat/engine/parser.py

@@ -282,7 +282,7 @@ class Stack(collections.Mapping):
 
     def __str__(self):
         '''Return a human-readable string representation of the stack.'''
-        return 'Stack "%s"' % self.name
+        return 'Stack "%s" [%s]' % (self.name, self.id)
 
     def resource_by_refid(self, refid):
         '''

heat/engine/resource.py

@@ -323,6 +323,12 @@ class Resource(object):
                     for k in changed_properties_set)
 
     def __str__(self):
+        if self.stack.id:
+            if self.resource_id:
+                return '%s "%s" [%s] %s' % (self.__class__.__name__, self.name,
+                                            self.resource_id, str(self.stack))
+            return '%s "%s" %s' % (self.__class__.__name__, self.name,
+                                   str(self.stack))
         return '%s "%s"' % (self.__class__.__name__, self.name)
 
     def _add_dependencies(self, deps, path, fragment):

heat/tests/test_parser.py

@@ -714,6 +714,12 @@ class StackTest(HeatTestCase):
 
         self.m.ReplayAll()
 
+    def test_stack_string_repr(self):
+        stack = parser.Stack(self.ctx, 'test_stack', parser.Template({}))
+        expected = 'Stack "%s" [%s]' % (stack.name, stack.id)
+        observed = str(stack)
+        self.assertEqual(expected, observed)
+
     def test_state_defaults(self):
         stack = parser.Stack(self.ctx, 'test_stack', parser.Template({}))
         self.assertEqual(stack.state, (None, None))

heat/tests/test_resource.py

@@ -87,6 +87,37 @@ class ResourceTest(HeatTestCase):
         self.assertEqual(res.state, (res.INIT, res.COMPLETE))
         self.assertEqual(res.status_reason, '')
 
+    def test_resource_str_repr_stack_id_resource_id(self):
+        tmpl = {'Type': 'Foo'}
+        res = generic_rsrc.GenericResource('test_res_str_repr', tmpl,
+                                           self.stack)
+        res.stack.id = "123"
+        res.resource_id = "456"
+        expected = ('GenericResource "test_res_str_repr" [456] Stack '
+                    '"test_stack" [123]')
+        observed = str(res)
+        self.assertEqual(expected, observed)
+
+    def test_resource_str_repr_stack_id_no_resource_id(self):
+        tmpl = {'Type': 'Foo'}
+        res = generic_rsrc.GenericResource('test_res_str_repr', tmpl,
+                                           self.stack)
+        res.stack.id = "123"
+        res.resource_id = None
+        expected = ('GenericResource "test_res_str_repr" Stack "test_stack" '
+                    '[123]')
+        observed = str(res)
+        self.assertEqual(expected, observed)
+
+    def test_resource_str_repr_no_stack_id(self):
+        tmpl = {'Type': 'Foo'}
+        res = generic_rsrc.GenericResource('test_res_str_repr', tmpl,
+                                           self.stack)
+        res.stack.id = None
+        expected = ('GenericResource "test_res_str_repr"')
+        observed = str(res)
+        self.assertEqual(expected, observed)
+
     def test_state_set(self):
         tmpl = {'Type': 'Foo'}
         res = generic_rsrc.GenericResource('test_resource', tmpl, self.stack)