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

[Haw Loeung]

Add saving sites config as well as HAProxy & Nginx on changes

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

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

[🤖 Canonical IS Review Bot (canonical-is-reviewbot)]

Proxy approval for alejdg

review: Approve

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

Change successfully merged at revision 289f6fff6634b35408d34b6aa063c084eba3000a

diff --git a/reactive/content_cache.py b/reactive/content_cache.py
index 5e2dcb7..ebbb3ab 100644
--- a/reactive/content_cache.py
+++ b/reactive/content_cache.py
@@ -119,6 +119,25 @@ def service_start_or_reload():
             reactive.clear_flag('content_cache.{}.reload-required'.format(name))
 
 
[e-mail](
+    'content_cache.haproxy.configured',
+    'content_cache.nginx.configured',
+    'content_cache.sysctl.configured',
+    'content_cache.save-config',
+)
+def save_config(conf_path='/etc/content-cache', etckeeper_path='/etc/etckeeper', dot_etckeeper_path='/etc/.etckeeper'):
+    config = hookenv.config()
+
+    if not os.path.exists(conf_path):
+        os.mkdir(conf_path)
+    write_file(config.get('sites'), os.path.join(conf_path, 'sites.yaml'))
+
+    if os.path.exists(etckeeper_path) or os.path.exists(dot_etckeeper_path):
+        subprocess.call(['etckeeper', 'commit', 'Saved updated content-cache charm configs'])
+
+    reactive.clear_flag('content_cache.save-config')
+
+
 def configure_nginx_metrics(ngx_conf, enable_prometheus_metrics, listen_address):
     """Configure nginx to expose metrics.
 
@@ -236,6 +255,7 @@ def configure_nginx(conf_path=None):  # NOQA: C901
 
     if changed:
         reactive.set_flag('content_cache.nginx.reload-required')
+        reactive.set_flag('content_cache.save-config')
 
     update_logrotate('nginx', retention=config.get('log_retention'))
     reactive.set_flag('content_cache.nginx.configured')
@@ -413,6 +433,7 @@ def configure_haproxy():  # NOQA: C901 LP#1825084
         haproxy.save_server_state()
         reactive.set_flag('content_cache.haproxy.reload-required')
         reactive.clear_flag('content_cache.sysctl.configured')
+        reactive.set_flag('content_cache.save-config')
 
     # Save HAProxy calculated max. fds for use with Nginx
     unitdata.kv().set('haproxy_max_conns', haproxy.global_max_connections)
diff --git a/tests/unit/test_content_cache.py b/tests/unit/test_content_cache.py
index fe1ae18..3a39adf 100644
--- a/tests/unit/test_content_cache.py
+++ b/tests/unit/test_content_cache.py
@@ -1,4 +1,6 @@
+import grp
 import os
+import pwd
 import shutil
 import sys
 import tempfile
@@ -199,6 +201,31 @@ class TestCharm(unittest.TestCase):
         service_start.assert_not_called()
         service_reload.assert_called_with('nginx')
 
+    @mock.patch('charms.reactive.clear_flag')
+    @mock.patch('charmhelpers.core.host.write_file')
+    @mock.patch('subprocess.call')
+    def test_save_config(self, call, write_file, clear_flag):
+        '''Test saving config'''
+        self.mock_config.return_value = {'sites': 'site1:'}
+        conf_path = os.path.join(self.tmpdir, 'content-cache')
+        etckeeper_path = os.path.join(self.tmpdir, 'etckeeper')
+        dot_etckeeper_path = os.path.join(self.tmpdir, '.etckeeper')
+        content_cache.save_config(conf_path, etckeeper_path, dot_etckeeper_path)
+        self.assertTrue(os.path.exists(conf_path))
+        clear_flag.assert_called_once_with('content_cache.save-config')
+        write_file.assert_called_once_with(
+            path=os.path.join(conf_path, 'sites.yaml'),
+            content='site1:',
+            owner=pwd.getpwuid(os.getuid()).pw_name,
+            group=grp.getgrgid(os.getgid()).gr_name,
+            perms=0o644,
+        )
+
+        call.reset_mock()
+        os.mkdir(etckeeper_path)
+        content_cache.save_config(conf_path, etckeeper_path, dot_etckeeper_path)
+        call.assert_called_once_with(['etckeeper', 'commit', 'Saved updated content-cache charm configs'])
+
     @mock.patch('charmhelpers.core.host.service_running')
     @mock.patch('charmhelpers.core.host.service_reload')
     @mock.patch('charmhelpers.core.host.service_start')