From 8118aebece8d141a0f675ee6302160a8a38b483a Mon Sep 17 00:00:00 2001
From: Zane Bitter <zbitter@redhat.com>
Date: Fri, 16 Nov 2012 11:36:39 +0100
Subject: [PATCH] Refactor unit tests for ReST API

This makes it easier to add tests for different controllers.

Change-Id: I549295ebdd9a41ca4c184c0ff242c805399656c5
Signed-off-by: Zane Bitter <zbitter@redhat.com>
---
 heat/tests/test_api_openstack_v1.py | 51 +++++++++++++++++------------
 1 file changed, 30 insertions(+), 21 deletions(-)

diff --git a/heat/tests/test_api_openstack_v1.py b/heat/tests/test_api_openstack_v1.py
index 667aab3a..8d5c7eda 100644
--- a/heat/tests/test_api_openstack_v1.py
+++ b/heat/tests/test_api_openstack_v1.py
@@ -36,7 +36,7 @@ from heat.common.wsgi import Request
 import heat.api.openstack.v1.stacks as stacks
 
 
-@attr(tag=['unit', 'api-openstack-v1-stacks'])
+@attr(tag=['unit', 'api-openstack-v1'])
 @attr(speed='fast')
 class InstantiationDataTest(unittest.TestCase):
 
@@ -128,15 +128,14 @@ class InstantiationDataTest(unittest.TestCase):
         self.assertEqual(data.args(), {'timeout_mins': 60})
 
 
-@attr(tag=['unit', 'api-openstack-v1-stacks', 'StackController'])
-@attr(speed='fast')
-class StackControllerTest(unittest.TestCase):
-    '''
-    Tests the API class which acts as the WSGI controller,
-    the endpoint processing API requests after they are routed
-    '''
+class ControllerTest(object):
+    """
+    Common utilities for testing API Controllers.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(ControllerTest, self).__init__(*args, **kwargs)
 
-    def setUp(self):
         self.maxDiff = None
         self.m = mox.Mox()
 
@@ -147,12 +146,6 @@ class StackControllerTest(unittest.TestCase):
         self.api_version = '1.0'
         self.tenant = 't'
 
-        # Create WSGI controller instance
-        class DummyConfig():
-            bind_port = 8004
-        cfgopts = DummyConfig()
-        self.controller = stacks.StackController(options=cfgopts)
-
     def tearDown(self):
         self.m.UnsetStubs()
 
@@ -208,6 +201,22 @@ class StackControllerTest(unittest.TestCase):
         path = '/v1/%(tenant)s/stacks/%(stack_name)s/%(stack_id)s%(path)s' % id
         return 'http://%s%s' % (host, path)
 
+
+@attr(tag=['unit', 'api-openstack-v1', 'StackController'])
+@attr(speed='fast')
+class StackControllerTest(ControllerTest, unittest.TestCase):
+    '''
+    Tests the API class which acts as the WSGI controller,
+    the endpoint processing API requests after they are routed
+    '''
+
+    def setUp(self):
+        # Create WSGI controller instance
+        class DummyConfig():
+            bind_port = 8004
+        cfgopts = DummyConfig()
+        self.controller = stacks.StackController(options=cfgopts)
+
     def test_index(self):
         req = self._get('/stacks')
 
@@ -237,7 +246,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'list_stacks',
                   'args': {},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndReturn(engine_resp)
         self.m.ReplayAll()
 
@@ -268,7 +277,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'list_stacks',
                   'args': {},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndRaise(rpc_common.RemoteError("AttributeError"))
         self.m.ReplayAll()
 
@@ -284,7 +293,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'list_stacks',
                   'args': {},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndRaise(rpc_common.RemoteError("Exception"))
         self.m.ReplayAll()
 
@@ -392,7 +401,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'identify_stack',
                   'args': {'stack_name': identity.stack_name},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndReturn(identity)
 
         self.m.ReplayAll()
@@ -415,7 +424,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'identify_stack',
                   'args': {'stack_name': stack_name},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndRaise(rpc_common.RemoteError("AttributeError"))
         self.m.ReplayAll()
 
@@ -461,7 +470,7 @@ class StackControllerTest(unittest.TestCase):
         rpc.call(req.context, self.topic,
                  {'method': 'show_stack',
                   'args': {'stack_identity': dict(identity)},
-                           'version': self.api_version},
+                  'version': self.api_version},
                  None).AndReturn(engine_resp)
         self.m.ReplayAll()
 
-- 
2.45.2