Merge ~hloeung/content-cache-charm:nginx-config into content-cache-charm:master

[Haw Loeung]

Add support for multiple cache validities - LP:1873116

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

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

[Stuart Bishop (stub)]

Code all looks fine.

review: Approve

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

Change successfully merged at revision 5f5a1f7e20b74277696ffab710320d890a96e031

diff --git a/lib/nginx.py b/lib/nginx.py
index e583107..e05f727 100644
--- a/lib/nginx.py
+++ b/lib/nginx.py
@@ -19,7 +19,7 @@ PROXY_CACHE_DEFAULTS = {
     'min-uses': 1,
     'revalidate': 'on',
     'use-stale': 'error timeout updating http_500 http_502 http_503 http_504',
-    'valid': '200 1d',
+    'valid': ['200 1d'],
 }
 
 
@@ -105,11 +105,26 @@ class NginxConf:
                 lc['backend'] = utils.generate_uri('localhost', backend_port, backend_path)
                 for k, v in self.proxy_cache_configs.items():
                     cache_key = 'cache-{}'.format(k)
+                    if cache_key == 'cache-valid':
+                        # Skip and set the default later.
+                        continue
                     lc.setdefault(cache_key, v)
+
+                cache_val = self.proxy_cache_configs['valid']
                 # Backwards compatibility
                 if 'cache-validity' in lc:
-                    lc['cache-valid'] = lc.get('cache-validity', self.proxy_cache_configs['valid'])
+                    cache_val = lc['cache-validity']
                     lc.pop('cache-validity')
+                elif 'cache-valid' in lc:
+                    cache_val = lc['cache-valid']
+
+                lc['cache-valid'] = []
+                # Support multiple cache-validities per LP:1873116.
+                if isinstance(cache_val, str):
+                    lc['cache-valid'].append(cache_val)
+                else:
+                    lc['cache-valid'] += cache_val
+
             lc['force_ranges'] = 'on'
             extra_config = lc.get('extra-config', [])
             for ext in extra_config:
diff --git a/templates/nginx_cfg.tmpl b/templates/nginx_cfg.tmpl
index 78888f7..70be061 100644
--- a/templates/nginx_cfg.tmpl
+++ b/templates/nginx_cfg.tmpl
@@ -16,9 +16,15 @@ server {
         add_header X-Cache-Status "$upstream_cache_status from {{juju_unit}}";
         proxy_force_ranges {{conf['force_ranges']}};
         proxy_cache {{keys_zone}};
-{%- for key, value in conf.items() -%}
+{%- for key, value in conf.items()|sort(attribute='0') -%}
 {%- if key.startswith('cache-') and value != 'None' %}
+        {%- if key == 'cache-valid' %}
+            {%- for cache_valid in value %}
+        proxy_cache_valid {{cache_valid}};
+            {%- endfor -%}
+        {%- else %}
         proxy_{{key|replace("-", "_")}} {{value}};
+        {%- endif %}
 {%- endif %}
 {%- endfor -%}
 {%- endif %}
diff --git a/tests/unit/files/config_test_config.txt b/tests/unit/files/config_test_config.txt
index ed4f6c7..fb0e4fb 100644
--- a/tests/unit/files/config_test_config.txt
+++ b/tests/unit/files/config_test_config.txt
@@ -101,10 +101,12 @@ site8.local:
       backend-tls: False
       backends:
         - 127.0.1.10:80
+      cache-valid: '200 6h'
     /auth:
       backend-tls: True
       backends:
         - 127.0.1.10:443
+      cache-valid: ['200 1h', '401 15m']
       site-name: auth.site8.local
 
 # Test 9: Custom backend-inter-time
@@ -115,6 +117,7 @@ site9.local:
       backend-inter-time: '1m'
       backends:
         - 127.0.1.15:80
+      cache-validity: ['200 1h', '401 30m']
       extra-config:
         - proxy_force_ranges off
     /private/content:
diff --git a/tests/unit/files/nginx_config_rendered_test_output-site3.local.txt b/tests/unit/files/nginx_config_rendered_test_output-site3.local.txt
index 32bcd50..fba7847 100644
--- a/tests/unit/files/nginx_config_rendered_test_output-site3.local.txt
+++ b/tests/unit/files/nginx_config_rendered_test_output-site3.local.txt
@@ -13,9 +13,9 @@ server {
         add_header X-Cache-Status "$upstream_cache_status from mock-content-cache/0";
         proxy_force_ranges on;
         proxy_cache d515cd6e60b1-cache;
-        proxy_cache_maxconn 4096;
         proxy_cache_background_update on;
         proxy_cache_lock on;
+        proxy_cache_maxconn 4096;
         proxy_cache_min_uses 1;
         proxy_cache_revalidate on;
         proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
diff --git a/tests/unit/files/nginx_config_rendered_test_output-site8.local.txt b/tests/unit/files/nginx_config_rendered_test_output-site8.local.txt
index 986504b..5e324e8 100644
--- a/tests/unit/files/nginx_config_rendered_test_output-site8.local.txt
+++ b/tests/unit/files/nginx_config_rendered_test_output-site8.local.txt
@@ -18,7 +18,7 @@ server {
         proxy_cache_min_uses 1;
         proxy_cache_revalidate on;
         proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
-        proxy_cache_valid 200 1d;
+        proxy_cache_valid 200 6h;
     }
 
 
@@ -33,7 +33,8 @@ server {
         proxy_cache_min_uses 1;
         proxy_cache_revalidate on;
         proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
-        proxy_cache_valid 200 1d;
+        proxy_cache_valid 200 1h;
+        proxy_cache_valid 401 15m;
     }
 
 
diff --git a/tests/unit/files/nginx_config_rendered_test_output-site9.local.txt b/tests/unit/files/nginx_config_rendered_test_output-site9.local.txt
index f664e9e..80dbdfa 100644
--- a/tests/unit/files/nginx_config_rendered_test_output-site9.local.txt
+++ b/tests/unit/files/nginx_config_rendered_test_output-site9.local.txt
@@ -18,7 +18,8 @@ server {
         proxy_cache_min_uses 1;
         proxy_cache_revalidate on;
         proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
-        proxy_cache_valid 200 1d;
+        proxy_cache_valid 200 1h;
+        proxy_cache_valid 401 30m;
     }