Merge ~tcuthbert/charm-k8s-wordpress:additional_hostnames into charm-k8s-wordpress:master

[Thomas Cuthbert]

Support sites with multiple hostnames ie fridge.u.c / ubuntu-news.org

[🤖 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)]

Added some comments inline.

[Thomas Cuthbert (tcuthbert)]

comments inline

[Tom Haddon (mthaddon)]

LGTM, thx

review: Approve

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

Change successfully merged at revision 15142081bbd9396aa0b66ba97fbaec1ae8033877

diff --git a/config.yaml b/config.yaml
index b0ee33b..acb10d3 100644
--- a/config.yaml
+++ b/config.yaml
@@ -37,6 +37,10 @@ options:
     type: string
     description: "MySQL database user's password"
     default: "wordpress"
+  additional_hostnames:
+    type: string
+    description: "Space separated list of aditional hostnames for the site."
+    default: ""
   container_config:
     type: string
     description: >
diff --git a/src/charm.py b/src/charm.py
index 3dcb33e..19fe468 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -2,6 +2,7 @@
 
 import io
 import logging
+import re
 import subprocess
 from pprint import pprint
 from yaml import safe_load
@@ -87,6 +88,11 @@ def gather_wordpress_secrets():
     return rv
 
 
+def juju_setting_to_list(config_string, split_char=" "):
+    "Transforms Juju setting strings into a list, defaults to splitting on whitespace."
+    return config_string.split(split_char)
+
+
 class WordpressInitialiseEvent(EventBase):
     """Custom event for signalling Wordpress initialisation.
 
@@ -281,6 +287,20 @@ class WordpressCharm(CharmBase):
             },
         }
 
+        if self.model.config["additional_hostnames"]:
+            additional_hostnames = juju_setting_to_list(self.model.config["additional_hostnames"])
+            rules = resources["kubernetesResources"]["ingressResources"][0]["spec"]["rules"]
+            for hostname in additional_hostnames:
+                rule = {
+                    "host": hostname,
+                    "http": {
+                        "paths": [
+                            {"path": "/", "backend": {"serviceName": self.app.name, "servicePort": 80}}
+                        ]
+                    },
+                }
+                rules.append(rule)
+
         ingress = resources["kubernetesResources"]["ingressResources"][0]
         if self.model.config["tls_secret_name"]:
             ingress["spec"]["tls"] = [
@@ -365,6 +385,16 @@ class WordpressCharm(CharmBase):
             self.model.unit.status = BlockedStatus(message)
             is_valid = False
 
+        if config["additional_hostnames"]:
+            additional_hostnames = juju_setting_to_list(config["additional_hostnames"])
+            valid_domain_name_pattern = re.compile(r"^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$")
+            valid = [re.match(valid_domain_name_pattern, h) for h in additional_hostnames]
+            if not all(valid):
+                message = "Invalid additional hostnames supplied: {}".format(config["additional_hostnames"])
+                logger.info(message)
+                self.model.unit.status = BlockedStatus(message)
+                is_valid = False
+
         return is_valid
 
     def get_service_ip(self):
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index 7f6dc54..155e908 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -98,6 +98,21 @@ class TestWordpressCharm(unittest.TestCase):
         self.assertIsInstance(self.harness.charm.unit.status, BlockedStatus)
         self.assertEqual(self.harness.charm.unit.status.message, expected_msg)
         self.assertLogs(expected_msg, level="INFO")
+        self.harness.update_config(copy.deepcopy(self.test_model_config))
+
+        # Test for empty additional hostnames string.
+        self.harness.update_config({"additional_hostnames": ""})
+        want_true = self.harness.charm.is_valid_config()
+        self.assertTrue(want_true)
+
+        # Test for invalid additional hostnames.
+        invalid_additional_hostnames = "forgot-my-tld invalid+character.com"
+        expected_msg = "Invalid additional hostnames supplied: {}".format(invalid_additional_hostnames)
+        self.harness.update_config({"additional_hostnames": invalid_additional_hostnames})
+        self.harness.charm.is_valid_config()
+        self.assertIsInstance(self.harness.charm.unit.status, BlockedStatus)
+        self.assertEqual(self.harness.charm.unit.status.message, expected_msg)
+        self.assertLogs(expected_msg, level="INFO")
 
     @mock.patch("charm._leader_set")
     @mock.patch("charm._leader_get")
@@ -151,6 +166,28 @@ class TestWordpressCharm(unittest.TestCase):
                                             }
                                         ]
                                     },
+                                },
+                                {
+                                    'host': 'cool-newsite.org',
+                                    'http': {
+                                        'paths': [
+                                            {
+                                                'path': '/',
+                                                'backend': {'serviceName': 'wordpress', 'servicePort': 80},
+                                            }
+                                        ]
+                                    },
+                                },
+                                {
+                                    'host': 'blog.test.com',
+                                    'http': {
+                                        'paths': [
+                                            {
+                                                'path': '/',
+                                                'backend': {'serviceName': 'wordpress', 'servicePort': 80},
+                                            }
+                                        ]
+                                    },
                                 }
                             ],
                             'tls': [{'hosts': ['blog.example.com'], 'secretName': 'blog-example-com-tls'}],
@@ -185,6 +222,28 @@ class TestWordpressCharm(unittest.TestCase):
                                             }
                                         ]
                                     },
+                                },
+                                {
+                                    'host': 'cool-newsite.org',
+                                    'http': {
+                                        'paths': [
+                                            {
+                                                'path': '/',
+                                                'backend': {'serviceName': 'wordpress', 'servicePort': 80},
+                                            }
+                                        ]
+                                    },
+                                },
+                                {
+                                    'host': 'blog.test.com',
+                                    'http': {
+                                        'paths': [
+                                            {
+                                                'path': '/',
+                                                'backend': {'serviceName': 'wordpress', 'servicePort': 80},
+                                            }
+                                        ]
+                                    },
                                 }
                             ],
                         },
diff --git a/tests/unit/test_wordpress.py b/tests/unit/test_wordpress.py
index 47cf8be..6083481 100644
--- a/tests/unit/test_wordpress.py
+++ b/tests/unit/test_wordpress.py
@@ -17,6 +17,7 @@ TEST_MODEL_CONFIG = {
     "db_name": "wordpress",
     "db_user": "admin",
     "db_password": "letmein123",
+    "additional_hostnames": "cool-newsite.org blog.test.com",
     "wp_plugin_openid_team_map": True,
     "wp_plugin_akismet_key": "somerandomstring",
     "container_config": "test-key: test",