Merge ~hloeung/smtp-relay-charm:mx into smtp-relay-charm:master

[Haw Loeung]

Overload relay_recipient_maps config

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

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

[James Simpson (jsimpso)]

LGTM

review: Approve

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

Change successfully merged at revision f45de6b42d00e78a442ff5bc2b6737231176702f

diff --git a/config.yaml b/config.yaml
index cc05bde..494ec54 100644
--- a/config.yaml
+++ b/config.yaml
@@ -82,16 +82,13 @@ options:
       domains to other local or remote addresses (use 'MANUAL' to
       indicate it is managed outside of juju configs).
 
-      http://www.postfix.org/postconf.5.html#relay_recipient_maps
-  relay_recipient_maps_combined:
-    type: boolean
-    default: false
-    description: |
-      Use virtual_alias_maps and transport_maps as value for
-      relay_recipient_maps.
+      Use 'COMBINED' to use both virtual_alias_maps and transport_maps
+      as value for relay_recipient_maps.
 
       Allows for all configured aliases and transports to be valid
       recipients for relay_domains.
+
+      http://www.postfix.org/postconf.5.html#relay_recipient_maps
   restrict_recipients:
     type: string
     default: ''
diff --git a/reactive/smtp_relay.py b/reactive/smtp_relay.py
index 5e8354b..1f715c3 100644
--- a/reactive/smtp_relay.py
+++ b/reactive/smtp_relay.py
@@ -115,7 +115,6 @@ def configure_smtp_auth(dovecot_config='/etc/dovecot/dovecot.conf', dovecot_user
     'config.changed.relay_domains',
     'config.changed.relay_host',
     'config.changed.relay_recipient_maps',
-    'config.changed.relay_recipient_maps_combined',
     'config.changed.restrict_recipients',
     'config.changed.restrict_senders',
     'config.changed.restrict_sender_access',
@@ -160,6 +159,8 @@ def _create_update_map(content, postmap):
 
     if content.startswith('MANUAL'):
         hookenv.log('Map {} manually managed'.format(pmfname))
+    elif content.startswith('COMBINED'):
+        hookenv.log('Map {} using combined maps'.format(pmfname))
     else:
         contents = JUJU_HEADER + content + '\n'
         changed = _write_file(contents, pmfname) or changed
@@ -219,7 +220,7 @@ def configure_smtp_relay(postfix_conf_dir='/etc/postfix', tls_dh_params='/etc/ss
         'relayhost': config['relay_host'],
         'relay_domains': config['relay_domains'],
         'relay_recipient_maps': bool(config['relay_recipient_maps']),
-        'relay_recipient_maps_combined': bool(config['relay_recipient_maps_combined']),
+        'relay_recipient_maps_combined': config['relay_recipient_maps'] == 'COMBINED',
         'restrict_recipients': bool(config['restrict_recipients']),
         'restrict_senders': bool(config['restrict_senders']),
         'restrict_sender_access': bool(config['restrict_sender_access']),
diff --git a/tests/unit/test_smtp_relay.py b/tests/unit/test_smtp_relay.py
index 58ab466..ddc851c 100644
--- a/tests/unit/test_smtp_relay.py
+++ b/tests/unit/test_smtp_relay.py
@@ -69,7 +69,6 @@ class TestCharm(unittest.TestCase):
             'relay_domains': '',
             'relay_host': '',
             'relay_recipient_maps': '',
-            'relay_recipient_maps_combined': False,
             'restrict_recipients': '',
             'restrict_senders': '',
             'restrict_sender_access': '',
@@ -933,6 +932,34 @@ someplace.local encrypt
         self, call, get_milters, get_cn, set_flag, clear_flag
     ):
         postfix_main_cf = os.path.join(self.tmpdir, 'main.cf')
+        postfix_relay_recipient_maps = os.path.join(self.tmpdir, 'relay_recipient')
+        get_cn.return_value = ''
+        get_milters.return_value = ''
+        self.mock_config.return_value['relay_domains'] = 'mydomain.local mydomain2.local'
+        self.mock_config.return_value['relay_recipient_maps'] = '[e-mail] [e-mail]'
+        smtp_relay.configure_smtp_relay(self.tmpdir)
+        with open(
+            'tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps.cf', 'r', encoding='utf-8'
+        ) as f:
+            want = f.read()
+        with open(postfix_main_cf, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
+        want = smtp_relay.JUJU_HEADER + '[e-mail] [e-mail]' + "\n"
+        with open(postfix_relay_recipient_maps, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
+
+    @mock.patch('charms.reactive.clear_flag')
+    @mock.patch('charms.reactive.set_flag')
+    @mock.patch('reactive.smtp_relay._get_autocert_cn')
+    @mock.patch('reactive.smtp_relay._get_milters')
+    @mock.patch('subprocess.call')
+    def test_configure_smtp_relay_config_relay_domains_with_relay_recipient_maps_manual(
+        self, call, get_milters, get_cn, set_flag, clear_flag
+    ):
+        postfix_main_cf = os.path.join(self.tmpdir, 'main.cf')
+        postfix_relay_recipient_maps = os.path.join(self.tmpdir, 'relay_recipient')
         get_cn.return_value = ''
         get_milters.return_value = ''
         self.mock_config.return_value['relay_domains'] = 'mydomain.local mydomain2.local'
@@ -945,6 +972,10 @@ someplace.local encrypt
         with open(postfix_main_cf, 'r', encoding='utf-8') as f:
             got = f.read()
         self.assertEqual(want, got)
+        want = ''
+        with open(postfix_relay_recipient_maps, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
 
     @mock.patch('charms.reactive.clear_flag')
     @mock.patch('charms.reactive.set_flag')
@@ -955,10 +986,11 @@ someplace.local encrypt
         self, call, get_milters, get_cn, set_flag, clear_flag
     ):
         postfix_main_cf = os.path.join(self.tmpdir, 'main.cf')
+        postfix_relay_recipient_maps = os.path.join(self.tmpdir, 'relay_recipient')
         get_cn.return_value = ''
         get_milters.return_value = ''
         self.mock_config.return_value['relay_domains'] = 'mydomain.local mydomain2.local'
-        self.mock_config.return_value['relay_recipient_maps_combined'] = True
+        self.mock_config.return_value['relay_recipient_maps'] = 'COMBINED'
         self.mock_config.return_value['transport_maps'] = '.mydomain.local  smtp:[smtp.mydomain.local]'
         self.mock_config.return_value['virtual_alias_maps'] = '[e-mail] [e-mail]'
         smtp_relay.configure_smtp_relay(self.tmpdir)
@@ -969,6 +1001,10 @@ someplace.local encrypt
         with open(postfix_main_cf, 'r', encoding='utf-8') as f:
             got = f.read()
         self.assertEqual(want, got)
+        want = ''
+        with open(postfix_relay_recipient_maps, 'r', encoding='utf-8') as f:
+            got = f.read()
+        self.assertEqual(want, got)
 
     @mock.patch('charms.reactive.clear_flag')
     @mock.patch('charms.reactive.set_flag')