Clean up the changes of os.environ in functional tests

Use fixtures to restore the API version changes of os.environ
in each functional tests, aims to avoid the following test cases
failing in unexpected context.

And make sure setUpClass/tearDownClass call super class's
corresponding methods first.

Change-Id: Ie248fe9d3a9e25f1b076c9f2c363200f29a83817
Closes-Bug: #1696080

Author: kiwik

openstackclient/tests/functional/common/test_extension.py

@@ -25,6 +25,7 @@ class ExtensionTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
+        super(ExtensionTests, cls).setUpClass()
         cls.haz_network = base.is_service_enabled('network')
 
     def test_extension_list_compute(self):

openstackclient/tests/functional/common/test_help.py

@@ -12,6 +12,8 @@
 
 import os
 
+import fixtures
+
 from openstackclient.tests.functional import base
 
 
@@ -76,10 +78,11 @@ def test_networking_commands_help(self):
 
     def test_commands_help_no_auth(self):
         """Check help commands without auth info."""
-        # Pop all auth info
-        auth_info = {key: os.environ.pop(key)
-                     for key in os.environ.keys()
-                     if key.startswith('OS_')}
+        # Pop all auth info. os.environ will be changed in loop, so do not
+        # replace os.environ.keys() to os.environ
+        for key in os.environ.keys():
+            if key.startswith('OS_'):
+                self.useFixture(fixtures.EnvironmentVariable(key, None))
 
         raw_output = self.openstack('help')
         self.assertIn('usage: openstack', raw_output)
@@ -115,6 +118,3 @@ def test_commands_help_no_auth(self):
         self.assertIn('List containers', raw_output)
         raw_output = self.openstack('container list --help')
         self.assertIn('List containers', raw_output)
-
-        # Restore auth info
-        os.environ.update(auth_info)

openstackclient/tests/functional/common/test_quota.py

@@ -26,6 +26,7 @@ class QuotaTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
+        super(QuotaTests, cls).setUpClass()
         cls.haz_network = base.is_service_enabled('network')
         cls.PROJECT_NAME =\
             cls.get_openstack_configuration_value('auth.project_name')

openstackclient/tests/functional/compute/v2/test_flavor.py

@@ -23,6 +23,7 @@ class FlavorTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
+        super(FlavorTests, cls).setUpClass()
         # Make a project
         cmd_output = json.loads(cls.openstack(
             "project create -f json --enable " + cls.PROJECT_NAME
@@ -31,8 +32,11 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        raw_output = cls.openstack("project delete " + cls.PROJECT_NAME)
-        cls.assertOutput('', raw_output)
+        try:
+            raw_output = cls.openstack("project delete " + cls.PROJECT_NAME)
+            cls.assertOutput('', raw_output)
+        finally:
+            super(FlavorTests, cls).tearDownClass()
 
     def test_flavor_delete(self):
         """Test create w/project, delete multiple"""

openstackclient/tests/functional/compute/v2/test_server.py

@@ -25,6 +25,7 @@ class ServerTests(common.ComputeTestCase):
 
     @classmethod
     def setUpClass(cls):
+        super(ServerTests, cls).setUpClass()
         cls.haz_network = base.is_service_enabled('network')
 
     def test_server_list(self):

openstackclient/tests/functional/identity/v2/common.py

@@ -12,6 +12,7 @@
 
 import os
 
+import fixtures
 from tempest.lib.common.utils import data_utils
 from tempest.lib import exceptions as tempest_exceptions
 
@@ -41,17 +42,13 @@ class IdentityTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        # prepare v2 env
-        os.environ['OS_IDENTITY_API_VERSION'] = '2.0'
-        auth_url = os.environ.get('OS_AUTH_URL')
-        if auth_url:
-            os.environ['OS_AUTH_URL'] = auth_url.replace('v3', 'v2.0')
-
+        super(IdentityTests, cls).setUpClass()
         # create dummy project
         cls.project_name = data_utils.rand_name('TestProject')
         cls.project_description = data_utils.rand_name('description')
         try:
             cls.openstack(
+                '--os-identity-api-version 2 '
                 'project create '
                 '--description %(description)s '
                 '--enable '
@@ -69,7 +66,25 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        cls.openstack('project delete %s' % cls.project_name)
+        try:
+            cls.openstack(
+                '--os-identity-api-version 2 '
+                'project delete %s' % cls.project_name)
+        finally:
+            super(IdentityTests, cls).tearDownClass()
+
+    def setUp(self):
+        super(IdentityTests, self).setUp()
+        # prepare v2 env
+        ver_fixture = fixtures.EnvironmentVariable(
+            'OS_IDENTITY_API_VERSION', '2.0')
+        self.useFixture(ver_fixture)
+        auth_url = os.environ.get('OS_AUTH_URL')
+        if auth_url:
+            auth_url_fixture = fixtures.EnvironmentVariable(
+                'OS_AUTH_URL', auth_url.replace('v3', 'v2.0')
+            )
+            self.useFixture(auth_url_fixture)
 
     def _create_dummy_project(self, add_clean_up=True):
         project_name = data_utils.rand_name('TestProject')

openstackclient/tests/functional/identity/v3/common.py

@@ -12,6 +12,7 @@
 
 import os
 
+import fixtures
 from tempest.lib.common.utils import data_utils
 
 from openstackclient.tests.functional import base
@@ -53,16 +54,12 @@ class IdentityTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        # prepare v3 env
-        os.environ['OS_IDENTITY_API_VERSION'] = '3'
-        auth_url = os.environ.get('OS_AUTH_URL')
-        if auth_url:
-            os.environ['OS_AUTH_URL'] = auth_url.replace('v2.0', 'v3')
-
+        super(IdentityTests, cls).setUpClass()
         # create dummy domain
         cls.domain_name = data_utils.rand_name('TestDomain')
         cls.domain_description = data_utils.rand_name('description')
         cls.openstack(
+            '--os-identity-api-version 3 '
             'domain create '
             '--description %(description)s '
             '--enable '
@@ -73,6 +70,7 @@ def setUpClass(cls):
         cls.project_name = data_utils.rand_name('TestProject')
         cls.project_description = data_utils.rand_name('description')
         cls.openstack(
+            '--os-identity-api-version 3 '
             'project create '
             '--domain %(domain)s '
             '--description %(description)s '
@@ -83,11 +81,30 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        # delete dummy project
-        cls.openstack('project delete %s' % cls.project_name)
-        # disable and delete dummy domain
-        cls.openstack('domain set --disable %s' % cls.domain_name)
-        cls.openstack('domain delete %s' % cls.domain_name)
+        try:
+            # delete dummy project
+            cls.openstack('--os-identity-api-version 3 '
+                          'project delete %s' % cls.project_name)
+            # disable and delete dummy domain
+            cls.openstack('--os-identity-api-version 3 '
+                          'domain set --disable %s' % cls.domain_name)
+            cls.openstack('--os-identity-api-version 3 '
+                          'domain delete %s' % cls.domain_name)
+        finally:
+            super(IdentityTests, cls).tearDownClass()
+
+    def setUp(self):
+        super(IdentityTests, self).setUp()
+        # prepare v3 env
+        ver_fixture = fixtures.EnvironmentVariable(
+            'OS_IDENTITY_API_VERSION', '3')
+        self.useFixture(ver_fixture)
+        auth_url = os.environ.get('OS_AUTH_URL')
+        if auth_url:
+            auth_url_fixture = fixtures.EnvironmentVariable(
+                'OS_AUTH_URL', auth_url.replace('v2.0', 'v3')
+            )
+            self.useFixture(auth_url_fixture)
 
     def _create_dummy_user(self, add_clean_up=True):
         username = data_utils.rand_name('TestUser')

openstackclient/tests/functional/image/v1/test_image.py

@@ -11,9 +11,10 @@
 #    under the License.
 
 import json
-import os
 import uuid
 
+import fixtures
+
 from openstackclient.tests.functional import base
 
 
@@ -25,8 +26,9 @@ class ImageTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        os.environ['OS_IMAGE_API_VERSION'] = '1'
+        super(ImageTests, cls).setUpClass()
         json_output = json.loads(cls.openstack(
+            '--os-image-api-version 1 '
             'image create -f json ' +
             cls.NAME
         ))
@@ -35,10 +37,21 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        cls.openstack(
-            'image delete ' +
-            cls.image_id
+        try:
+            cls.openstack(
+                '--os-image-api-version 1 '
+                'image delete ' +
+                cls.image_id
+            )
+        finally:
+            super(ImageTests, cls).tearDownClass()
+
+    def setUp(self):
+        super(ImageTests, self).setUp()
+        ver_fixture = fixtures.EnvironmentVariable(
+            'OS_IMAGE_API_VERSION', '1'
         )
+        self.useFixture(ver_fixture)
 
     def test_image_list(self):
         json_output = json.loads(self.openstack(

openstackclient/tests/functional/image/v2/test_image.py

@@ -11,9 +11,9 @@
 #    under the License.
 
 import json
-import os
 import uuid
 
+import fixtures
 # from glanceclient import exc as image_exceptions
 
 from openstackclient.tests.functional import base
@@ -27,8 +27,9 @@ class ImageTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        os.environ['OS_IMAGE_API_VERSION'] = '2'
+        super(ImageTests, cls).setUpClass()
         json_output = json.loads(cls.openstack(
+            '--os-image-api-version 2 '
             'image create -f json ' +
             cls.NAME
         ))
@@ -37,10 +38,21 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        cls.openstack(
-            'image delete ' +
-            cls.image_id
+        try:
+            cls.openstack(
+                '--os-image-api-version 2 '
+                'image delete ' +
+                cls.image_id
+            )
+        finally:
+            super(ImageTests, cls).tearDownClass()
+
+    def setUp(self):
+        super(ImageTests, self).setUp()
+        ver_fixture = fixtures.EnvironmentVariable(
+            'OS_IMAGE_API_VERSION', '2'
         )
+        self.useFixture(ver_fixture)
 
     def test_image_list(self):
         json_output = json.loads(self.openstack(

openstackclient/tests/functional/network/v2/common.py

@@ -18,5 +18,5 @@ class NetworkTests(base.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        # super(NetworkTests, cls).setUp()
+        super(NetworkTests, cls).setUpClass()
         cls.haz_network = base.is_service_enabled('network')