Merge ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:unit-tests into charm-k8s-bind:master

[Barry Price]

Add more unit tests. This gets us to 90% coverage.

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

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

[Tom Haddon (mthaddon)]

Can you add docstrings for all tests please? And one question inline about whether we need the make_pod_resources method

[Tom Haddon (mthaddon)]

LGTM, but please add trailing "."s to the docstrings

review: Approve

diff --git a/src/charm.py b/src/charm.py
index f4922e3..8754cfa 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -69,7 +69,8 @@ class BindK8sCharm(CharmBase):
             self.model.unit.status = ActiveStatus()
 
     def make_pod_resources(self):
-        resources = {}
+        """LP#1889746: We should define a manual ingress here to work around LP#1889703."""
+        resources = {}  # TODO
         out = io.StringIO()
         pprint(resources, out)
         logger.info("This is the Kubernetes Pod resources <<EOM\n{}\nEOM".format(out.getvalue()))
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index 4b3ae7e..dc53ac0 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -6,6 +6,7 @@ import unittest
 from charm import BindK8sCharm
 
 from ops import testing
+from ops.model import ActiveStatus
 
 CONFIG_EMPTY = {
     'bind_image_path': '',
@@ -27,18 +28,140 @@ CONFIG_IMAGE_PASSWORD_MISSING = {
     'https_proxy': '',
 }
 
+CONFIG_VALID = {
+    'bind_image_path': 'example.com/bind:v1',
+    'bind_image_username': '',
+    'bind_image_password': '',
+    'container_config': '',
+    'container_secrets': '',
+    'custom_config_repo': '',
+    'https_proxy': '',
+}
+
+CONFIG_VALID_WITH_CONTAINER_CONFIG = {
+    'bind_image_path': 'example.com/bind:v1',
+    'bind_image_username': '',
+    'bind_image_password': '',
+    'container_config': '"magic_number": 123',
+    'container_secrets': '',
+    'custom_config_repo': '',
+    'https_proxy': '',
+}
+
+CONFIG_VALID_WITH_CONTAINER_CONFIG_AND_SECRETS = {
+    'bind_image_path': 'example.com/bind:v1',
+    'bind_image_username': '',
+    'bind_image_password': '',
+    'container_config': '"magic_number": 123',
+    'container_secrets': '"secret_password": "xyzzy"',
+    'custom_config_repo': '',
+    'https_proxy': '',
+}
+
+
+class TestBindK8s(unittest.TestCase):
+    maxDiff = None
 
-class TestBindK8sCharmHooksDisabled(unittest.TestCase):
     def setUp(self):
         self.harness = testing.Harness(BindK8sCharm)
         self.harness.begin()
         self.harness.disable_hooks()
 
-    def test_check_for_config_problems(self):
+    def test_check_for_config_problems_empty_image_path(self):
+        """Confirm that we generate an error if we're not told what image to use."""
         self.harness.update_config(CONFIG_EMPTY)
         expected = 'required setting(s) empty: bind_image_path'
         self.assertEqual(self.harness.charm._check_for_config_problems(), expected)
 
+    def test_check_for_config_problems_empty_image_password(self):
+        """Confirm that we generate an error if we're not given valid registry creds."""
         self.harness.update_config(CONFIG_IMAGE_PASSWORD_MISSING)
         expected = 'required setting(s) empty: bind_image_password'
         self.assertEqual(self.harness.charm._check_for_config_problems(), expected)
+
+    def test_check_for_config_problems_none(self):
+        """Confirm that we accept valid config."""
+        self.harness.update_config(CONFIG_VALID)
+        expected = ''
+        self.assertEqual(self.harness.charm._check_for_config_problems(), expected)
+
+    def test_make_pod_resources(self):
+        """Confirm that we generate the expected pod resources (see LP#1889746)."""
+        expected = {}
+        self.assertEqual(self.harness.charm.make_pod_resources(), expected)
+
+    def test_make_pod_spec_basic(self):
+        """Confirm that we generate the expected pod spec from valid config."""
+        self.harness.update_config(CONFIG_VALID)
+        expected = {
+            'version': 2,
+            'containers': [
+                {
+                    'name': 'bind',
+                    'imageDetails': {'imagePath': 'example.com/bind:v1'},
+                    'ports': [
+                        {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
+                        {'containerPort': 53, 'name': 'domain-udp', 'protocol': 'UDP'},
+                    ],
+                    'config': {},
+                    'kubernetes': {'readinessProbe': {'exec': {'command': ['/usr/local/bin/dns-check.sh']}}},
+                }
+            ],
+        }
+        self.assertEqual(self.harness.charm.make_pod_spec(), expected)
+
+    def test_make_pod_spec_with_extra_config(self):
+        """Confirm that we generate the expected pod spec from a more involved valid config."""
+        self.harness.update_config(CONFIG_VALID_WITH_CONTAINER_CONFIG)
+        expected = {
+            'version': 2,
+            'containers': [
+                {
+                    'name': 'bind',
+                    'imageDetails': {'imagePath': 'example.com/bind:v1'},
+                    'ports': [
+                        {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
+                        {'containerPort': 53, 'name': 'domain-udp', 'protocol': 'UDP'},
+                    ],
+                    'config': {'magic_number': 123},
+                    'kubernetes': {'readinessProbe': {'exec': {'command': ['/usr/local/bin/dns-check.sh']}}},
+                }
+            ],
+        }
+        self.assertEqual(self.harness.charm.make_pod_spec(), expected)
+
+    def test_make_pod_spec_with_extra_config_and_secrets(self):
+        """Confirm that we generate the expected pod spec from a more involved valid config that includes secrets."""
+        self.harness.update_config(CONFIG_VALID_WITH_CONTAINER_CONFIG_AND_SECRETS)
+        expected = {
+            'version': 2,
+            'containers': [
+                {
+                    'name': 'bind',
+                    'imageDetails': {'imagePath': 'example.com/bind:v1'},
+                    'ports': [
+                        {'containerPort': 53, 'name': 'domain-tcp', 'protocol': 'TCP'},
+                        {'containerPort': 53, 'name': 'domain-udp', 'protocol': 'UDP'},
+                    ],
+                    'config': {'magic_number': 123, 'secret_password': 'xyzzy'},
+                    'kubernetes': {'readinessProbe': {'exec': {'command': ['/usr/local/bin/dns-check.sh']}}},
+                }
+            ],
+        }
+        self.assertEqual(self.harness.charm.make_pod_spec(), expected)
+
+    def test_configure_pod_as_leader(self):
+        """Confirm that our status is set correctly when we're the leader."""
+        self.harness.enable_hooks()
+        self.harness.set_leader(True)
+        self.harness.update_config(CONFIG_VALID)
+        expected = ActiveStatus('Pod configured')
+        self.assertEqual(self.harness.model.unit.status, expected)
+
+    def test_configure_pod_as_non_leader(self):
+        """Confirm that our status is set correctly when we're not the leader."""
+        self.harness.enable_hooks()
+        self.harness.set_leader(False)
+        self.harness.update_config(CONFIG_VALID)
+        expected = ActiveStatus()
+        self.assertEqual(self.harness.model.unit.status, expected)