Merge ~hloeung/ubuntu-repository-cache:reduce-cron-spam into ubuntu-repository-cache:master

[Haw Loeung]

Reduce cron spam

These are the changes from testing:

| ubuntu@ip-172-31-17-35:/etc$ sudo bzr st
| modified:
| .bzrignore
| cron.monthly/ieee-data
| etckeeper/etckeeper.conf
| ubuntu@ip-172-31-17-35:/etc$ sudo bzr di
| === modified file '.bzrignore'
| --- .bzrignore 2022-07-25 02:20:44 +0000
| +++ .bzrignore 2022-10-20 02:33:52 +0000
| @@ -102,3 +102,12 @@
| DEADJOE
|
| # end section managed by etckeeper
| +# ignore due to LP#1598304
| +apparmor.d/snap.core.*.usr.lib.snapd.snap-confine
| +systemd/system/multi-user.target.wants/snap-*.mount
| +systemd/system/multi-user.target.wants/snap.*.service
| +systemd/system/default.target.wants/snap-*.mount
| +systemd/system/default.target.wants/snap-*.service
| +systemd/system/snap-*.mount
| +systemd/system/snap.*.service
| +# end section ignore due to LP#1598304
|
| === modified file 'cron.monthly/ieee-data'
| --- cron.monthly/ieee-data 2017-10-26 01:43:49 +0000
| +++ cron.monthly/ieee-data 2022-10-20 02:08:30 +0000
| @@ -1,3 +1,2 @@
| #!/bin/sh
| -test -x /usr/bin/update-oui || exit 0
| -BASEDIR=/var/lib/ieee-data/ /usr/bin/update-oui -f -q
| +# https://bugs.launchpad.net/ubuntu/+source/ieee-data/+bug/1922960
|
| === modified file 'etckeeper/etckeeper.conf'
| --- etckeeper/etckeeper.conf 2022-07-25 02:20:44 +0000
| +++ etckeeper/etckeeper.conf 2022-10-20 02:03:16 +0000
| @@ -11,7 +11,7 @@
| HG_COMMIT_OPTIONS=""
|
| # Options passed to bzr commit when run by etckeeper.
| -BZR_COMMIT_OPTIONS=""
| +BZR_COMMIT_OPTIONS="--quiet"
|
| # Options passed to darcs record when run by etckeeper.
| DARCS_COMMIT_OPTIONS="-a"
|
| ubuntu@ip-172-31-17-35:/etc$

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

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

[Barry Price (barryprice)]

LGTM +1

review: Approve

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

Change successfully merged at revision 95ec8b03d9d440fc0267af381ab5b0d5130e2a49

diff --git a/reactive/ubuntu_repository_cache.py b/reactive/ubuntu_repository_cache.py
index 12ff100..5ec909d 100755
--- a/reactive/ubuntu_repository_cache.py
+++ b/reactive/ubuntu_repository_cache.py
@@ -48,6 +48,7 @@ def config_changed():
     reactive.clear_flag('ubuntu-repository-cache.active')
     reactive.clear_flag('ubuntu-repository-cache.configured')
     reactive.clear_flag('nagios-nrpe.configured')
+    reactive.clear_flag('reduce-cron-spam.configured')
 
 
 @reactive.when_any(
@@ -372,6 +373,61 @@ def update_systemd_mtr(etc_systemd_path='/etc/systemd/system'):
     reactive.clear_flag('ubuntu-repository-cache.update-systemd-mtr-required')
 
 
[e-mail]_not('reduce-cron-spam.configured')
+def reduce_cron_spam(etc_path='/etc'):
+    # https://bugs.launchpad.net/ubuntu/+source/ieee-data/+bug/1922960
+    ieee_data_path = os.path.join(etc_path, 'cron.monthly/ieee-data')
+    if os.path.exists(ieee_data_path):
+        source = '''#!/bin/sh
+# https://bugs.launchpad.net/ubuntu/+source/ieee-data/+bug/1922960
+'''
+        _write_file(source, ieee_data_path, perms=0o755)
+
+    etckeeper_conf_path = os.path.join(etc_path, 'etckeeper/etckeeper.conf')
+    if os.path.exists(etckeeper_conf_path) and os.path.exists(os.path.join(etc_path, '.bzr')):
+        # https://bugs.launchpad.net/etckeeper/+bug/1986739
+        etckeeper_conf = []
+        with open(etckeeper_conf_path, 'r', encoding='utf-8') as f:
+            etckeeper_conf = f.read().split('\n')
+        new = []
+        for line in etckeeper_conf:
+            if line == 'BZR_COMMIT_OPTIONS=""':
+                new.append('BZR_COMMIT_OPTIONS="--quiet"')
+            else:
+                new.append(line)
+        _write_file('\n'.join(new), etckeeper_conf_path)
+
+        # https://bugs.launchpad.net/snappy/+bug/1598304
+        bzrignore_path = os.path.join(etc_path, '.bzrignore')
+        bzrignore = []
+        if os.path.exists(bzrignore_path):
+            with open(bzrignore_path, 'r', encoding='utf-8') as f:
+                bzrignore = f.read().split('\n')
+        new = []
+        pause = False
+        for line in bzrignore:
+            if line == "# ignore due to LP#1598304":
+                pause = True
+            elif line == "# end section ignore due to LP#1598304":
+                pause = False
+            elif not pause:
+                new.append(line)
+
+        ignore_snaps = '''# ignore due to LP#1598304
+apparmor.d/snap.core.*.usr.lib.snapd.snap-confine
+systemd/system/multi-user.target.wants/snap-*.mount
+systemd/system/multi-user.target.wants/snap.*.service
+systemd/system/default.target.wants/snap-*.mount
+systemd/system/default.target.wants/snap-*.service
+systemd/system/snap-*.mount
+systemd/system/snap.*.service
+# end section ignore due to LP#1598304
+'''
+        _write_file('\n'.join(new) + ignore_snaps, bzrignore_path, perms=0o600)
+
+    reactive.set_flag('reduce-cron-spam.configured')
+
+
 # LP:1770071: Work around charm-helper's unison ownership
 #             https://github.com/juju/charm-helpers/issues/487
 def _fix_ssh_ownership(user='www-sync'):
diff --git a/tests/unit/test_ubuntu_repository_cache.py b/tests/unit/test_ubuntu_repository_cache.py
index db0424a..5f70bb4 100644
--- a/tests/unit/test_ubuntu_repository_cache.py
+++ b/tests/unit/test_ubuntu_repository_cache.py
@@ -78,6 +78,107 @@ class TestCharm(unittest.TestCase):
         clear_flag.assert_has_calls(want, any_order=True)
         set_flag.assert_called_once_with('ubuntu-repository-cache.update-systemd-mtr-required')
 
+    @mock.patch('charms.reactive.set_flag')
+    def test_reduce_cron_spam(self, set_flag):
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        set_flag.assert_called_once_with('reduce-cron-spam.configured')
+
+    @mock.patch('charms.reactive.set_flag')
+    def test_reduce_cron_spam_ieee_data(self, set_flag):
+        ieee_data_path = os.path.join(self.tmpdir, 'cron.monthly/ieee-data')
+        os.mkdir(os.path.join(self.tmpdir, 'cron.monthly'))
+        with open(ieee_data_path, 'w') as f:
+            f.write("Testing")
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        set_flag.assert_called_once_with('reduce-cron-spam.configured')
+        want = '''#!/bin/sh
+# https://bugs.launchpad.net/ubuntu/+source/ieee-data/+bug/1922960
+'''
+        with open(ieee_data_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
+
+    @mock.patch('charms.reactive.set_flag')
+    def test_reduce_cron_spam_etckeeper(self, set_flag):
+        etckeeper_conf_path = os.path.join(self.tmpdir, 'etckeeper/etckeeper.conf')
+        os.mkdir(os.path.join(self.tmpdir, 'etckeeper'))
+        with open(etckeeper_conf_path, 'w') as f:
+            f.write('# Options passed to bzr commit when run by etckeeper.\nBZR_COMMIT_OPTIONS=""\n')
+        os.mkdir(os.path.join(self.tmpdir, '.bzr'))
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        set_flag.assert_called_once_with('reduce-cron-spam.configured')
+        want = '''# Options passed to bzr commit when run by etckeeper.
+BZR_COMMIT_OPTIONS="--quiet"
+'''
+        with open(etckeeper_conf_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
+
+    @mock.patch('charms.reactive.set_flag')
+    def test_reduce_cron_spam_bzrignore(self, set_flag):
+        bzrignore_path = os.path.join(self.tmpdir, '.bzrignore')
+        etckeeper_conf_path = os.path.join(self.tmpdir, 'etckeeper/etckeeper.conf')
+        os.mkdir(os.path.join(self.tmpdir, 'etckeeper'))
+        with open(etckeeper_conf_path, 'w') as f:
+            f.write('# Options passed to bzr commit when run by etckeeper.\nBZR_COMMIT_OPTIONS=""\n')
+        os.mkdir(os.path.join(self.tmpdir, '.bzr'))
+
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        set_flag.assert_called_once_with('reduce-cron-spam.configured')
+        want = '''# ignore due to LP#1598304
+apparmor.d/snap.core.*.usr.lib.snapd.snap-confine
+systemd/system/multi-user.target.wants/snap-*.mount
+systemd/system/multi-user.target.wants/snap.*.service
+systemd/system/default.target.wants/snap-*.mount
+systemd/system/default.target.wants/snap-*.service
+systemd/system/snap-*.mount
+systemd/system/snap.*.service
+# end section ignore due to LP#1598304
+'''
+        with open(bzrignore_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
+
+        # No current snap ignores.
+        test = 'blahblah\nblah\n'
+        with open(bzrignore_path, 'w') as f:
+            f.write(test)
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        want2 = test + want
+        with open(bzrignore_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want2, got)
+
+        # Snap ignores exist and at the end.
+        test = 'blahblah\nblah\n'
+        with open(bzrignore_path, 'w') as f:
+            f.write(test + want)
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        want2 = test + want
+        with open(bzrignore_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want2, got)
+
+        # Snap ignores exist in between other things, move it to the end.
+        test = 'blahblah\nblah\n'
+        with open(bzrignore_path, 'w') as f:
+            f.write(test + want + test)
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        want2 = test + test + want
+        with open(bzrignore_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want2, got)
+
+        # Snap ignores exist at the start, move it to the end.
+        test = 'blahblah\nblah\n'
+        with open(bzrignore_path, 'w') as f:
+            f.write(want + test)
+        ubuntu_repository_cache.reduce_cron_spam(self.tmpdir)
+        want2 = test + want
+        with open(bzrignore_path, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want2, got)
+
     @mock.patch('charmhelpers.core.hookenv.leader_get')
     @mock.patch('charms.reactive.set_flag')
     def test_set_active(self, set_flag, leader_get):