Merge ~hloeung/content-cache-charm:yaml into content-cache-charm:master

[Haw Loeung]

Allow specifying configs for use with YAML anchors and references - LP:1895614

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

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

[Paul Collins (pjdc)]

review: Approve (lgtm)

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

Change successfully merged at revision 043986307ab2aa9e5a9f1690cdde4ae7aaee8926

diff --git a/reactive/content_cache.py b/reactive/content_cache.py
index 97ce35f..5b15f8a 100644
--- a/reactive/content_cache.py
+++ b/reactive/content_cache.py
@@ -541,6 +541,8 @@ def ports_map_lookup(ports_map, site, base_port, blacklist_ports=None, key=None)
 
 def sites_from_config(sites_yaml, sites_secrets=None, blacklist_ports=None):
     conf = yaml.safe_load(sites_yaml)
+    # 'configs' is special and used to host YAML anchors so let's remove it
+    conf.pop('configs', '')
     sites = interpolate_secrets(conf, sites_secrets)
     cache_port = 0
     backend_port = 0
diff --git a/tests/unit/files/config_test_config.txt b/tests/unit/files/config_test_config.txt
index 25d69c9..bae4473 100644
--- a/tests/unit/files/config_test_config.txt
+++ b/tests/unit/files/config_test_config.txt
@@ -1,13 +1,14 @@
+configs:
+  backends: &BACKENDS ['127.0.1.10:80', '127.0.1.11:80', '127.0.1.12:80']
+  hmac_key: &HMAC_KEY SrRorTsImr92B6FfSKBFrSIiR5NYGS+gdjd8oGoVH44=
+
 # Test 1: The basic port and backends (HTTP)
 site1.local:
   port: 80
   locations:
     /:
-      backends:
-        - 127.0.1.10:80
-        - 127.0.1.11:80
-        - 127.0.1.12:80
-      signed-url-hmac-key: SrRorTsImr92B6FfSKBFrSIiR5NYGS+gdjd8oGoVH44=
+      backends: *BACKENDS
+      signed-url-hmac-key: *HMAC_KEY
       origin-headers:
         - X-Origin-Key: Sae6oob2aethuosh
         - X-Some-Header-1: something one two three
@@ -43,10 +44,7 @@ site3.local:
   default: True
   locations:
     /:
-      backends:
-        - 127.0.1.10:80
-        - 127.0.1.11:80
-        - 127.0.1.12:80
+      backends: *BACKENDS
       backend-options:
         - forwardfor except 127.0.0.1
         - forceclose
diff --git a/tests/unit/test_haproxy.py b/tests/unit/test_haproxy.py
index 198879d..22e07d6 100644
--- a/tests/unit/test_haproxy.py
+++ b/tests/unit/test_haproxy.py
@@ -20,6 +20,8 @@ class TestLibHAProxy(unittest.TestCase):
         self.charm_dir = os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
         with open('tests/unit/files/config_test_config.txt', 'r', encoding='utf-8') as f:
             self.site_config = yaml.safe_load(f.read())
+            # 'configs' is special and used to host YAML anchors so let's remove it
+            self.site_config.pop('configs', '')
 
         patcher = mock.patch('multiprocessing.cpu_count')
         self.mock_cpu_count = patcher.start()
diff --git a/tests/unit/test_nginx.py b/tests/unit/test_nginx.py
index c7bcfe3..5ec7fbe 100644
--- a/tests/unit/test_nginx.py
+++ b/tests/unit/test_nginx.py
@@ -44,6 +44,8 @@ class TestLibNginx(unittest.TestCase):
 
         with open('tests/unit/files/config_test_config.txt', 'r', encoding='utf-8') as f:
             sites = yaml.safe_load(f.read())
+            # 'configs' is special and used to host YAML anchors so let's remove it
+            sites.pop('configs', '')
 
         conf = {}
         conf['cache_inactive_time'] = '2h'
@@ -128,6 +130,8 @@ class TestLibNginx(unittest.TestCase):
 
         with open('tests/unit/files/config_test_basic_config.txt', 'r', encoding='utf-8') as f:
             sites = yaml.safe_load(f.read())
+            # 'configs' is special and used to host YAML anchors so let's remove it
+            sites.pop('configs', '')
 
         conf = {
             'cache_inactive_time': '2h',