Merge ~hloeung/ubuntu-syncproxy-charm:master into ubuntu-syncproxy-charm:master

[Haw Loeung]

Rename rsync-* configs in preparation for local rsync confs

[🤖 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 has no commit message, setting status to needs review.

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

Change successfully merged at revision 676417cf36493a497fe1f8002ed302e7ae49c91a

diff --git a/config.yaml b/config.yaml
index 15da353..8acc1c9 100644
--- a/config.yaml
+++ b/config.yaml
@@ -4,44 +4,44 @@ options:
     default: 120
     description: |
       Number of days of syslog logs to retain during rotation.
-  rsync-host:
+  sync-script:
+    type: string
+    default: ''
+    description: |
+      Sync script to trigger, see wiki page for examples.
+      https://wiki.ubuntu.com/Mirrors/Scripts
+  sync-user:
+    type: string
+    default: 'archvsync'
+    description: |
+      Archive sync user.
+  sync-user-ssh-authorized-keys:
+    type:
+    default: ''
+    description: |
+      List of SSH authorized keys with triggers for sync-user.
+  upstream-rsync-host:
     type: string
     default: 'archive.syncproxy.ubuntu.com'
     description: |
       Rsync host to sync contents from (source).
-  rsync-module:
+  upstream-rsync-module:
     type: string
     default: 'ftp'
     description: |
       Rsync module to sync contents from (source).
-  rsync-target:
+  upstream-rsync-target:
     type: string
     default: '/srv/ftp.root/ubuntu'
     description: |
       Target or destination directory on local host to sync to.
-  rsync-user:
+  upstream-rsync-user:
     type: string
     default: 'syncproxy'
     description: |
       Rsync user to authenticate with rsync host.
-  rsync-password:
+  upstream-rsync-password:
     type: string
     default: ''
     description: |
       Rsync password to authenticate with rsync host.
-  sync-script:
-    type: string
-    default: ''
-    description: |
-      Sync script to trigger, see wiki page for examples.
-      https://wiki.ubuntu.com/Mirrors/Scripts
-  sync-user:
-    type: string
-    default: 'archvsync'
-    description: |
-      Archive sync user.
-  sync-user-ssh-authorized-keys:
-    type:
-    default: ''
-    description: |
-      List of SSH authorized keys with triggers for sync-user.
diff --git a/reactive/ubuntu_syncproxy.py b/reactive/ubuntu_syncproxy.py
index 1041201..8d03712 100644
--- a/reactive/ubuntu_syncproxy.py
+++ b/reactive/ubuntu_syncproxy.py
@@ -36,14 +36,14 @@ def install(script_dir='/usr/local/bin'):
 
 
 @reactive.when_any(
-    'config.changed.rsync-host',
-    'config.changed.rsync-module',
-    'config.changed.rsync-password',
-    'config.changed.rsync-target',
-    'config.changed.rsync-user',
     'config.changed.sync-script',
     'config.changed.sync-user',
     'config.changed.sync-user-ssh-authorized-keys',
+    'config.changed.upstream-rsync-host',
+    'config.changed.upstream-rsync-module',
+    'config.changed.upstream-rsync-password',
+    'config.changed.upstream-rsync-target',
+    'config.changed.upstream-rsync-user',
 )
 def config_changed():
     reactive.clear_flag('ubuntu-syncproxy.configured')
@@ -82,21 +82,21 @@ def configure_ubuntu_syncproxy(home_path=''):
     home_path = home_path or os.path.expanduser('~{}'.format(user))
 
     rsync_conf = {
-        'host': config['rsync-host'],
-        'module': config['rsync-module'],
-        'target': config['rsync-target'],
-        'user': config['rsync-user'],
-        'password': config['rsync-password'],
+        'host': config['upstream-rsync-host'],
+        'module': config['upstream-rsync-module'],
+        'target': config['upstream-rsync-target'],
+        'user': config['upstream-rsync-user'],
+        'password': config['upstream-rsync-password'],
     }
     for k in sorted(rsync_conf.keys()):
         if not rsync_conf[k]:
-            status.blocked('Required rsync configs missing ({})'.format(k))
+            status.blocked('Required sync rsync configs missing ({})'.format(k))
             reactive.set_flag('ubuntu-syncproxy.configured')
             return
     if _setup_archive_sync_conf(rsync_conf, user, home_path):
         status.maintenance('Wrote out updated archive sync conf (rsync)')
 
-    _setup_archive_sync_target(config['rsync-target'], user)
+    _setup_archive_sync_target(config['upstream-rsync-target'], user)
 
     user_ssh_keys = config['sync-user-ssh-authorized-keys']
     if user_ssh_keys:
diff --git a/tests/unit/test_ubuntu_syncproxy.py b/tests/unit/test_ubuntu_syncproxy.py
index 068ebfb..5a1b43e 100644
--- a/tests/unit/test_ubuntu_syncproxy.py
+++ b/tests/unit/test_ubuntu_syncproxy.py
@@ -61,14 +61,14 @@ class TestCharm(unittest.TestCase):
         self.mock_config = patcher.start()
         self.addCleanup(patcher.stop)
         self.mock_config.return_value = {
-            'rsync-host': 'ftpmaster.internal',
-            'rsync-module': 'ftp',
-            'rsync-user': 'syncproxy',
-            'rsync-password': 'my-secure-rsync-password',
-            'rsync-target': os.path.join(self.tmpdir, 'ubuntu-archive'),
             'sync-script': '#!/bin/sh\necho "test"\n',
             'sync-user': self.user,
             'sync-user-ssh-authorized-keys': '',
+            'upstream-rsync-host': 'ftpmaster.internal',
+            'upstream-rsync-module': 'ftp',
+            'upstream-rsync-user': 'syncproxy',
+            'upstream-rsync-password': 'my-secure-rsync-password',
+            'upstream-rsync-target': os.path.join(self.tmpdir, 'ubuntu-archive'),
         }
 
         patcher = mock.patch('charmhelpers.core.hookenv.close_port')
@@ -207,41 +207,41 @@ class TestCharm(unittest.TestCase):
     @mock.patch('reactive.ubuntu_syncproxy._setup_archive_sync_conf')
     @mock.patch('reactive.ubuntu_syncproxy._setup_archive_sync_target')
     def test_configure_ubuntu_rsync_missing(self, setup_target, setup, set_flag, clear_flag):
-        self.mock_config.return_value['rsync-host'] = ''
-        self.mock_config.return_value['rsync-module'] = ''
-        self.mock_config.return_value['rsync-user'] = ''
-        self.mock_config.return_value['rsync-password'] = ''
-        self.mock_config.return_value['rsync-target'] = ''
+        self.mock_config.return_value['upstream-rsync-host'] = ''
+        self.mock_config.return_value['upstream-rsync-module'] = ''
+        self.mock_config.return_value['upstream-rsync-user'] = ''
+        self.mock_config.return_value['upstream-rsync-password'] = ''
+        self.mock_config.return_value['upstream-rsync-target'] = ''
 
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
-        status.blocked.assert_called_with('Required rsync configs missing (host)')
+        status.blocked.assert_called_with('Required sync rsync configs missing (host)')
 
         status.blocked.reset_mock()
-        self.mock_config.return_value['rsync-host'] = 'ftpmaster.internal'
+        self.mock_config.return_value['upstream-rsync-host'] = 'ftpmaster.internal'
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
-        status.blocked.assert_called_with('Required rsync configs missing (module)')
+        status.blocked.assert_called_with('Required sync rsync configs missing (module)')
 
         status.blocked.reset_mock()
-        self.mock_config.return_value['rsync-module'] = 'ftp'
+        self.mock_config.return_value['upstream-rsync-module'] = 'ftp'
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
-        status.blocked.assert_called_with('Required rsync configs missing (password)')
+        status.blocked.assert_called_with('Required sync rsync configs missing (password)')
 
         status.blocked.reset_mock()
-        self.mock_config.return_value['rsync-password'] = 'my-secure-rsync-password'
+        self.mock_config.return_value['upstream-rsync-password'] = 'my-secure-rsync-password'
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
-        status.blocked.assert_called_with('Required rsync configs missing (target)')
+        status.blocked.assert_called_with('Required sync rsync configs missing (target)')
 
         status.blocked.reset_mock()
-        self.mock_config.return_value['rsync-target'] = '/srv/ftp.root/ubuntu'
+        self.mock_config.return_value['upstream-rsync-target'] = '/srv/ftp.root/ubuntu'
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
-        status.blocked.assert_called_with('Required rsync configs missing (user)')
+        status.blocked.assert_called_with('Required sync rsync configs missing (user)')
 
         setup.assert_not_called()
         want = [mock.call('ubuntu-syncproxy.configured')]
         set_flag.assert_has_calls(want, any_order=True)
 
         status.blocked.reset_mock()
-        self.mock_config.return_value['rsync-user'] = 'syncproxy'
+        self.mock_config.return_value['upstream-rsync-user'] = 'syncproxy'
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
         status.blocked.assert_not_called()
 
@@ -278,16 +278,16 @@ class TestCharm(unittest.TestCase):
         self.mock_config.return_value[
             'sync-user-ssh-authorized-keys'
         ] = """
-- from="91.189.88.154,185.125.188.80" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA-my-test-key-data-FF8/ArKew== archvsync@syowa
-- ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA7l6nWM6Z2KfR4KmwF29Fv9nAgTLwHM5H/TWh-my-test-key-data-jRMlhyb6Q== archvsync@syowa
-- ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABB-my-test-key-data-AxToEYNa/E= hloeung testing
+- from="10.1.2.3" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA-my-test-key-data-FF8/ArKew== archvsync@my-test-upstream-host
+- ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA7l6nWM6Z2KfR4KmwF29Fv9nAgTLwHM5H/TWh-my-test-key-data-jRMlhyb6Q== archvsync@my-test-upstream-host
+- ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABB-my-test-key-data-AxToEYNa/E= testing
 """  # NOQA: E501
         ubuntu_syncproxy.configure_ubuntu_syncproxy(self.tmpdir)
         ssh_auth_keys_path = os.path.join(self.tmpdir, '.ssh', 'authorized_keys')
         self.assertTrue(os.path.exists(ssh_auth_keys_path))
-        want = """no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &",from="91.189.88.154,185.125.188.80" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA-my-test-key-data-FF8/ArKew== archvsync@syowa
-no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA7l6nWM6Z2KfR4KmwF29Fv9nAgTLwHM5H/TWh-my-test-key-data-jRMlhyb6Q== archvsync@syowa
-no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &" ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABB-my-test-key-data-AxToEYNa/E= hloeung testing"""  # NOQA: E501
+        want = """no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &",from="10.1.2.3" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA-my-test-key-data-FF8/ArKew== archvsync@my-test-upstream-host
+no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &" ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA7l6nWM6Z2KfR4KmwF29Fv9nAgTLwHM5H/TWh-my-test-key-data-jRMlhyb6Q== archvsync@my-test-upstream-host
+no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,command="~/archive-sync &" ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABB-my-test-key-data-AxToEYNa/E= testing"""  # NOQA: E501
         with open(ssh_auth_keys_path, 'r', encoding='utf-8') as f:
             got = f.read()
         self.assertEqual(want, got)