Merge ~pjdc/ubuntu-mirror-charm/+git/ubuntu-mirror-charm:refactor-testcases into ubuntu-mirror-charm:master

[Paul Collins]

factor out generic TemplateTestCase

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Colin Misare (cmisare)]

LGTM

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Merge proposal is approved, but source revision has changed, setting status to needs review.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision fe82f87fb7f206b81634f27750f59850e608372e

diff --git a/tests/unit/test_linuxcontainers.py b/tests/unit/test_templates.py
similarity index 70%
rename from tests/unit/test_linuxcontainers.py
rename to tests/unit/test_templates.py
index 7e82350..a9cf4e6 100644
--- a/tests/unit/test_linuxcontainers.py
+++ b/tests/unit/test_templates.py
@@ -4,28 +4,18 @@ import unittest
 
 from Cheetah.Template import Template
 
-TEMPLATE = 'apache-linuxcontainers.tmpl'
 
-THIRDPARTY_SEARCH_LIST = {
-    'addresses': ['*'],
-    'name': 'lxd.example.net',
-    'aliases': ['uk.lxd.example.net', 'us.lxd.example.net'],
-    'ports': [80, 443],
-}
-
-LINUXCONTAINERS_SEARCH_LIST = {
-    'addresses': ['91.189.88.247',  '[2001:67c:1360:8001::33]'],
-    'name': 'lxd.images.canonical.com',
-    'aliases': ['uk.lxd.images.canonical.com', 'us.lxd.images.canonical.com'],
-    'ports': [80, 443, 8443],
-}
+class TemplateTestCase(object):
+    """Base class for template test cases.
 
+    IMPORTANT: Must be before `unittest.TestCase` in the class list,
+    otherwise setUp and tearDown will be not called, because TestCase
+    doesn't use super() as it (possibly) should."""
 
-class TestLinuxcontainers(unittest.TestCase):
     def setUp(self):
         self.addTypeEqualityFunc(str, self.assertMultiLineEqual)
         self.maxDiff = None
-        self.testdata_dir = os.path.join(os.path.dirname(__file__), 'testdata', 'linuxcontainers')
+        self.testdata_dir = os.path.join(os.path.dirname(__file__), 'testdata', self._role)
 
     def _template_compare(self, template, search_list, wanted_file):
         template_file = os.path.join(os.getcwd(), template)
@@ -33,16 +23,19 @@ class TestLinuxcontainers(unittest.TestCase):
         wanted = open(wanted_file).read()
         self.assertEqual(str(template), wanted)
 
+    def _template_path(self, role):
+        return os.path.join(os.getcwd(), 'templates', 'apache-{}.tmpl'.format(role))
+
     # Cheetah warns about using the Python version of NameMapper, so
     # we ignore it here.  Matching more closely by the message doesn't
     # seem to work, probably because it begins with a newline and
     # Python's warnings matching code anchors the message regexp.
     @pytest.mark.filterwarnings("ignore::UserWarning:Cheetah")
-    def test_template_linuxcontainers(self):
+    def test_template(self):
         self._template_compare(
-            os.path.join(os.getcwd(), 'templates', TEMPLATE),
-            LINUXCONTAINERS_SEARCH_LIST,
-            os.path.join(self.testdata_dir, 'linuxcontainers.txt'))
+            self._template_path(self._role),
+            self._search_list,
+            os.path.join(self.testdata_dir, self._role + '.txt'))
 
     # Cheetah warns about using the Python version of NameMapper, so
     # we ignore it here.  Matching more closely by the message doesn't
@@ -51,6 +44,27 @@ class TestLinuxcontainers(unittest.TestCase):
     @pytest.mark.filterwarnings("ignore::UserWarning:Cheetah")
     def test_template_thirdparty(self):
         self._template_compare(
-            os.path.join(os.getcwd(), 'templates', TEMPLATE),
-            THIRDPARTY_SEARCH_LIST,
+            self._template_path(self._role),
+            self._thirdparty_search_list,
             os.path.join(self.testdata_dir, 'thirdparty.txt'))
+
+
+LINUXCONTAINERS_THIRDPARTY_SEARCH_LIST = {
+    'addresses': ['*'],
+    'name': 'lxd.example.net',
+    'aliases': ['uk.lxd.example.net', 'us.lxd.example.net'],
+    'ports': [80, 443],
+}
+
+LINUXCONTAINERS_SEARCH_LIST = {
+    'addresses': ['91.189.88.247',  '[2001:67c:1360:8001::33]'],
+    'name': 'lxd.images.canonical.com',
+    'aliases': ['uk.lxd.images.canonical.com', 'us.lxd.images.canonical.com'],
+    'ports': [80, 443, 8443],
+}
+
+
+class TestLinuxcontainers(TemplateTestCase, unittest.TestCase):
+    _role = 'linuxcontainers'
+    _search_list = LINUXCONTAINERS_SEARCH_LIST
+    _thirdparty_search_list = LINUXCONTAINERS_THIRDPARTY_SEARCH_LIST