Merge ~kotodama/smtp-relay-charm/+git/smtp-relay-charm:relay_recipient_maps into smtp-relay-charm:master

[Loïc Gomez]

Add relay_recipient_maps_combined: use transport/aliases as relay_recipient_maps

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

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

[Haw Loeung (hloeung)]

LGTM

review: Approve (+1)

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

Change successfully merged at revision 7b47dbb2599a043c21354ede1f83cdb54139b76e

diff --git a/config.yaml b/config.yaml
index a9daa9b..cc05bde 100644
--- a/config.yaml
+++ b/config.yaml
@@ -83,6 +83,15 @@ options:
       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.
+
+      Allows for all configured aliases and transports to be valid
+      recipients for relay_domains.
   restrict_recipients:
     type: string
     default: ''
diff --git a/reactive/smtp_relay.py b/reactive/smtp_relay.py
index dc13259..5e8354b 100644
--- a/reactive/smtp_relay.py
+++ b/reactive/smtp_relay.py
@@ -115,6 +115,7 @@ 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',
@@ -218,6 +219,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']),
         'restrict_recipients': bool(config['restrict_recipients']),
         'restrict_senders': bool(config['restrict_senders']),
         'restrict_sender_access': bool(config['restrict_sender_access']),
diff --git a/templates/postfix_main_cf.tmpl b/templates/postfix_main_cf.tmpl
index 6748faf..1f62150 100644
--- a/templates/postfix_main_cf.tmpl
+++ b/templates/postfix_main_cf.tmpl
@@ -103,18 +103,21 @@ non_smtpd_milters = {{milter}}
 header_checks = regexp:/etc/postfix/header_checks
 {% endif -%}
 
+{%- if virtual_alias_domains %}
+virtual_alias_domains = {{virtual_alias_domains}}
+{%- endif %}
 {%- if relay_domains %}
 relay_domains = {{relay_domains}}
-{% endif -%}
-{%- if relay_recipient_maps -%}
-relay_recipient_maps = hash:/etc/postfix/relay_recipient
-{% endif -%}
+{% endif %}
+
 {%- if transport_maps %}
 transport_maps = hash:/etc/postfix/transport
-{% endif -%}
-{%- if virtual_alias_domains %}
-virtual_alias_domains = {{virtual_alias_domains}}
-{%- endif -%}
-{%- if virtual_alias_maps %}
+{% endif %}
+{%- if virtual_alias_maps -%}
 virtual_alias_maps = hash:/etc/postfix/virtual_alias
 {% endif %}
+{%- if relay_recipient_maps_combined -%}
+relay_recipient_maps = ${virtual_alias_maps}, ${transport_maps}
+{% elif relay_recipient_maps %}
+relay_recipient_maps = hash:/etc/postfix/relay_recipient
+{% endif %}
diff --git a/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps.cf b/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps.cf
index 5bc2414..d43ca81 100644
--- a/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps.cf
+++ b/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps.cf
@@ -57,4 +57,5 @@ smtpd_tls_auth_only = yes
 smtpd_sender_restrictions = reject_unknown_sender_domain, check_sender_access hash:/etc/postfix/access
 
 relay_domains = mydomain.local mydomain2.local
+
 relay_recipient_maps = hash:/etc/postfix/relay_recipient
diff --git a/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps_combined.cf b/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps_combined.cf
new file mode 100644
index 0000000..d686512
--- /dev/null
+++ b/tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps_combined.cf
@@ -0,0 +1,63 @@
+## This file is Juju managed - do not edit by hand #
+
+
+smtpd_banner = $myhostname ESMTP $mail_name (Ubuntu)
+biff = no
+
+append_dot_mydomain = no
+
+readme_directory = no
+
+# See http://www.postfix.org/COMPATIBILITY_README.html -- default to 2 on
+# fresh installs.
+compatibility_level = 2
+
+# TLS parameters
+tls_preempt_cipherlist = yes
+smtpd_tls_cert_file = /etc/ssl/certs/ssl-cert-snakeoil.pem
+smtpd_tls_key_file = /etc/ssl/private/ssl-cert-snakeoil.key
+smtpd_tls_dh1024_param_file = /etc/ssl/private/dhparams.pem
+smtpd_tls_ciphers = HIGH
+smtpd_tls_exclude_ciphers = aNULL, eNULL, DES, 3DES, MD5, RC4, CAMELLIA
+smtpd_tls_loglevel = 1
+smtpd_tls_mandatory_ciphers = HIGH
+smtpd_tls_mandatory_protocols = !SSLv2 !SSLv3
+smtpd_tls_protocols = !SSLv2 !SSLv3
+smtpd_tls_received_header = yes
+smtpd_tls_security_level = may
+smtpd_tls_session_cache_database = btree:${data_directory}/smtpd_scache
+
+smtp_tls_CApath = /etc/ssl/certs
+smtp_tls_loglevel = 1
+smtp_tls_security_level = may
+smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
+
+message_size_limit = 61440000
+strict_rfc821_envelopes = yes
+smtpd_client_connection_count_limit = 100
+smtpd_helo_required = yes
+smtpd_relay_restrictions = permit_mynetworks, permit_sasl_authenticated, defer_unauth_destination
+myhostname = juju-87625f-hloeung-94.openstacklocal
+alias_maps = hash:/etc/aliases
+alias_database = hash:/etc/aliases
+mydestination = $myhostname, juju-87625f-hloeung-94, localhost.localdomain, localhost
+relayhost =
+mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
+mailbox_size_limit = 0
+recipient_delimiter = +
+inet_interfaces = all
+inet_protocols = all
+
+broken_sasl_auth_clients = yes
+smtpd_sasl_auth_enable = yes
+smtpd_sasl_security_options = noanonymous
+smtpd_sasl_type = dovecot
+smtpd_sasl_path = private/auth
+smtpd_tls_auth_only = yes
+smtpd_sender_restrictions = reject_unknown_sender_domain, check_sender_access hash:/etc/postfix/access
+
+relay_domains = mydomain.local mydomain2.local
+
+transport_maps = hash:/etc/postfix/transport
+virtual_alias_maps = hash:/etc/postfix/virtual_alias
+relay_recipient_maps = ${virtual_alias_maps}, ${transport_maps}
diff --git a/tests/unit/files/postfix_main_transport_maps_with_virtual_alias_maps.cf b/tests/unit/files/postfix_main_transport_maps_with_virtual_alias_maps.cf
index a53e353..dc25f1f 100644
--- a/tests/unit/files/postfix_main_transport_maps_with_virtual_alias_maps.cf
+++ b/tests/unit/files/postfix_main_transport_maps_with_virtual_alias_maps.cf
@@ -56,9 +56,8 @@ smtpd_sasl_path = private/auth
 smtpd_tls_auth_only = yes
 smtpd_sender_restrictions = reject_unknown_sender_domain, check_sender_access hash:/etc/postfix/access
 
+virtual_alias_domains = mydomain.local mydomain2.local
 relay_domains = mydomain.local mydomain2.local
 
 transport_maps = hash:/etc/postfix/transport
-
-virtual_alias_domains = mydomain.local mydomain2.local
 virtual_alias_maps = hash:/etc/postfix/virtual_alias
diff --git a/tests/unit/test_smtp_relay.py b/tests/unit/test_smtp_relay.py
index 6324706..58ab466 100644
--- a/tests/unit/test_smtp_relay.py
+++ b/tests/unit/test_smtp_relay.py
@@ -69,6 +69,7 @@ class TestCharm(unittest.TestCase):
             'relay_domains': '',
             'relay_host': '',
             'relay_recipient_maps': '',
+            'relay_recipient_maps_combined': False,
             'restrict_recipients': '',
             'restrict_senders': '',
             'restrict_sender_access': '',
@@ -950,6 +951,30 @@ someplace.local encrypt
     @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_combined(
+        self, call, get_milters, get_cn, set_flag, clear_flag
+    ):
+        postfix_main_cf = os.path.join(self.tmpdir, 'main.cf')
+        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['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)
+        with open(
+            'tests/unit/files/postfix_main_relay_domains_with_relay_recipient_maps_combined.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)
+
+    @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_transport_maps(self, call, get_milters, get_cn, set_flag, clear_flag):
         postfix_main_cf = os.path.join(self.tmpdir, 'main.cf')
         postfix_transport_maps = os.path.join(self.tmpdir, 'transport')