Make corrections as per review comments

zaza/openstack/charm_tests/audit/tests.py

@@ -17,65 +17,77 @@
 """
 Keystone audit middleware API logging testing.
 
-These methods test the
-rendering of the charm's api-paste.ini file to ensure the appropriate sections
-are rendered or not rendered depending on the state of the audit-middleware
-configuration option.
+These methods test the rendering of the charm api-paste.ini file to
+ensure the appropriate sections are rendered or not rendered depending
+on the state of the audit-middleware configuration option.
 """
 
+import textwrap
 import logging
 import zaza.model
 import zaza.openstack.charm_tests.test_utils as test_utils
 
 
-class KeystoneAuditMiddlewareBaseTest(test_utils.OpenStackBaseTest):
-    """Base class for Keystone audit middleware tests."""
+class KeystoneAuditMiddlewareTest(test_utils.OpenStackBaseTest):
+    """Keystone audit middleware test class."""
 
     @classmethod
     def setUpClass(cls):
         """Run class setup for Keystone audit middleware tests."""
-        super(KeystoneAuditMiddlewareBaseTest, cls).setUpClass()
+        super(KeystoneAuditMiddlewareTest, cls).setUpClass()
         test_config = cls.test_config['tests_options']['audit-middleware']
         cls.service_name = test_config['service']
 
-        # For cases when service name and application name differ
-        if not test_config["application"]:
-            cls.application_name = cls.service_name
-        else:
+        if test_config['application']:
             cls.application_name = test_config['application']
-        print(test_config)
-        print(cls.model_name)
-        cls.lead_unit = zaza.model.get_lead_unit_name(
+        else:
+            cls.application_name = cls.service_name
+            logging.info('Application name not set, using service name:\
+                         %s', cls.service_name)
+
+        cls.initial_audit_middleware = zaza.model.get_application_config(
+            cls.application_name)['audit-middleware']['value']
+
+    @classmethod
+    def tearDownClass(cls):
+        """Restore the audit-middleware configuration to its original state."""
+        super(KeystoneAuditMiddlewareTest, cls).tearDownClass()
+        logging.info("Running teardown on %s" % cls.application_name)
+        zaza.model.set_application_config(
             cls.application_name,
+            {'audit-middleware': str(cls.initial_audit_middleware)},
+            model_name=cls.model_name
+        )
+        zaza.model.wait_for_application_states(
+            states={cls.application_name: {
+                'workload-status': 'active',
+                'workload-status-message': 'Unit is ready'}},
             model_name=cls.model_name
         )
-        print(cls.lead_unit)
-        logging.info('Leader unit is %s', cls.lead_unit)
-        logging.info('Service name is %s', cls.service_name)
 
     def fetch_api_paste_content(self):
         """Fetch content of api-paste.ini file."""
         api_paste_ini_path = f"/etc/{self.service_name}/api-paste.ini"
+        lead_unit = zaza.model.get_lead_unit_name(
+            self.application_name,
+            model_name=self.model_name
+        )
         try:
             return zaza.model.file_contents(
-                self.lead_unit,
+                lead_unit,
                 api_paste_ini_path,
             )
         except zaza.model.CommandRunFailed as e:
-            self.fail("Error fetching api-paste.ini: {}".format(str(e)))
-
-
-class KeystoneAuditMiddlewareTest(KeystoneAuditMiddlewareBaseTest):
-    """Keystone audit middleware API logging feature tests."""
+            self.fail("Error fetching api-paste.ini: %s" % e)
 
     def test_101_apipaste_includes_audit_section(self):
         """Test api-paste.ini renders audit section when enabled."""
-        expected_content = [
-            "[filter:audit]",
-            "paste.filter_factory = keystonemiddleware.audit:filter_factory",
-            f"audit_map_file = /etc/{self.service_name}/api_audit_map.conf",
-            f"service_name = {self.service_name}"
-        ]
+        expected_content = textwrap.dedent(f"""\
+            [filter:audit]
+            paste.filter_factory = keystonemiddleware.audit:filter_factory
+            audit_map_file = /etc/{self.service_name}/api_audit_map.conf
+            service_name = {self.service_name}
+            """)
 
         set_default = {'audit-middleware': False}
         set_alternate = {'audit-middleware': True}
@@ -84,15 +96,16 @@ class KeystoneAuditMiddlewareTest(KeystoneAuditMiddlewareBaseTest):
                                 alternate_config=set_alternate,
                                 application_name=self.application_name):
             api_paste_content = self.fetch_api_paste_content()
-            for line in expected_content:
-                self.assertIn(line, api_paste_content)
+            self.assertIn(expected_content, api_paste_content)
 
     def test_102_apipaste_excludes_audit_section(self):
         """Test api_paste.ini does not render audit section when disabled."""
         section_heading = '[filter:audit]'
+        set_default = {'audit-middleware': True}
+        set_alternate = {'audit-middleware': False}
 
-        if not self.config_current(self.application_name)['audit-middleware']:
+        with self.config_change(default_config=set_default,
+                                alternate_config=set_alternate,
+                                application_name=self.application_name):
             api_paste_content = self.fetch_api_paste_content()
             self.assertNotIn(section_heading, api_paste_content)
-        else:
-            self.fail("Config option audit-middleware incorrectly set to true")