refactor: use put_file/put_template helpers across all deployers

Author: hpk42

cmdeploy/src/cmdeploy/dovecot/deployer.py

@@ -33,7 +33,7 @@ def install(self):
 
     def configure(self):
         configure_remote_units(self.config.mail_domain, self.units)
-        self.need_restart, self.daemon_reload = _configure_dovecot(self.config)
+        self.need_restart, self.daemon_reload = _configure_dovecot(self, self.config)
 
     def activate(self):
         activate_remote_units(self.units)
@@ -85,38 +85,30 @@ def _install_dovecot_package(package: str, arch: str):
     apt.deb(name=f"Install dovecot-{package}", src=deb_filename)
 
 
-def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
+
+def _configure_dovecot(deployer, config: Config, debug: bool = False) -> (bool, bool):
     """Configures Dovecot IMAP server."""
-    need_restart = False
+    deployer.need_restart = False
     daemon_reload = False
 
-    main_config = files.template(
+    deployer.put_template(
+        name="Upload dovecot.conf",
         src=get_resource("dovecot/dovecot.conf.j2"),
         dest="/etc/dovecot/dovecot.conf",
-        user="root",
-        group="root",
-        mode="644",
         config=config,
         debug=debug,
         disable_ipv6=config.disable_ipv6,
     )
-    need_restart |= main_config.changed
-    auth_config = files.put(
+    deployer.put_file(
+        name="Upload auth.conf",
         src=get_resource("dovecot/auth.conf"),
         dest="/etc/dovecot/auth.conf",
-        user="root",
-        group="root",
-        mode="644",
     )
-    need_restart |= auth_config.changed
-    lua_push_notification_script = files.put(
+    deployer.put_file(
+        name="Upload push_notification.lua",
         src=get_resource("dovecot/push_notification.lua"),
         dest="/etc/dovecot/push_notification.lua",
-        user="root",
-        group="root",
-        mode="644",
     )
-    need_restart |= lua_push_notification_script.changed
 
     # as per https://doc.dovecot.org/2.3/configuration_manual/os/
     # it is recommended to set the following inotify limits
@@ -139,7 +131,7 @@ def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
         path="/etc/environment",
         line="TZ=:/etc/localtime",
     )
-    need_restart |= timezone_env.changed
+    deployer.need_restart |= timezone_env.changed
 
     restart_conf = files.put(
         name="dovecot: restart automatically on failure",
@@ -149,10 +141,10 @@ def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
     daemon_reload |= restart_conf.changed
 
     # Validate dovecot configuration before restart
-    if need_restart:
+    if deployer.need_restart:
         server.shell(
             name="Validate dovecot configuration",
             commands=["doveconf -n >/dev/null"],
         )
 
-    return need_restart, daemon_reload
+    return deployer.need_restart, daemon_reload

cmdeploy/src/cmdeploy/filtermail/deployer.py

@@ -29,15 +29,13 @@ def install(self):
 
     def configure(self):
         for service in self.services:
-            self.need_restart |= files.template(
+            self.put_template(
+                name=f"Upload {service}.service",
                 src=get_resource(f"filtermail/{service}.service.j2"),
                 dest=f"/etc/systemd/system/{service}.service",
-                user="root",
-                group="root",
-                mode="644",
                 bin_path=self.bin_path,
                 config_path=self.config_path,
-            ).changed
+            )
 
     def activate(self):
         for service in self.services:

cmdeploy/src/cmdeploy/mtail/deployer.py

@@ -1,5 +1,5 @@
 from pyinfra import facts, host
-from pyinfra.operations import apt, files, server, systemd
+from pyinfra.operations import apt, server, systemd
 
 from cmdeploy.basedeploy import (
     Deployer,
@@ -37,25 +37,18 @@ def install(self):
     def configure(self):
         # Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
         # This allows to read from journalctl instead of log files.
-        files.template(
+        self.put_template(
+            name="Upload mtail.service",
             src=get_resource("mtail/mtail.service.j2"),
             dest="/etc/systemd/system/mtail.service",
-            user="root",
-            group="root",
-            mode="644",
             address=self.mtail_address or "127.0.0.1",
             port=3903,
         )
-
-        mtail_conf = files.put(
+        self.put_file(
             name="Mtail configuration",
             src=get_resource("mtail/delivered_mail.mtail"),
             dest="/etc/mtail/delivered_mail.mtail",
-            user="root",
-            group="root",
-            mode="644",
         )
-        self.need_restart = mtail_conf.changed
 
     def activate(self):
         systemd.service(

cmdeploy/src/cmdeploy/nginx/deployer.py

@@ -47,7 +47,7 @@ def install(self):
         files.file("/usr/sbin/policy-rc.d", present=False)
 
     def configure(self):
-        self.need_restart = _configure_nginx(self.config)
+        _configure_nginx(self, self.config)
 
     def activate(self):
         systemd.service(
@@ -60,40 +60,31 @@ def activate(self):
         self.need_restart = False
 
 
-def _configure_nginx(config: Config, debug: bool = False) -> bool:
+def _configure_nginx(deployer, config: Config, debug: bool = False):
     """Configures nginx HTTP server."""
-    need_restart = False
+    deployer.need_restart = False
 
-    main_config = files.template(
+    deployer.put_template(
+        name="Upload nginx.conf",
         src=get_resource("nginx/nginx.conf.j2"),
         dest="/etc/nginx/nginx.conf",
-        user="root",
-        group="root",
-        mode="644",
         config=config,
         disable_ipv6=config.disable_ipv6,
     )
-    need_restart |= main_config.changed
 
-    autoconfig = files.template(
+    deployer.put_template(
+        name="Upload autoconfig.xml",
         src=get_resource("nginx/autoconfig.xml.j2"),
         dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
-        user="root",
-        group="root",
-        mode="644",
         config=config,
     )
-    need_restart |= autoconfig.changed
 
-    mta_sts_config = files.template(
+    deployer.put_template(
+        name="Upload mta-sts.txt",
         src=get_resource("nginx/mta-sts.txt.j2"),
         dest="/var/www/html/.well-known/mta-sts.txt",
-        user="root",
-        group="root",
-        mode="644",
         config=config,
     )
-    need_restart |= mta_sts_config.changed
 
     # install CGI newemail script
     #
@@ -105,13 +96,9 @@ def _configure_nginx(config: Config, debug: bool = False) -> bool:
         group="root",
     )
 
-    files.put(
+    deployer.put_file(
         name="Upload cgi newemail.py script",
         src=get_resource("newemail.py", pkg="chatmaild").open("rb"),
         dest=f"{cgi_dir}/newemail.py",
-        user="root",
-        group="root",
-        mode="755",
+        executable=True,
     )
-
-    return need_restart

cmdeploy/src/cmdeploy/opendkim/deployer.py

@@ -25,35 +25,25 @@ def configure(self):
         domain = self.mail_domain
         dkim_selector = "opendkim"
         """Configures OpenDKIM"""
-        need_restart = False
 
-        main_config = files.template(
+        self.put_template(
+            name="Upload opendkim.conf",
             src=get_resource("opendkim/opendkim.conf"),
             dest="/etc/opendkim.conf",
-            user="root",
-            group="root",
-            mode="644",
             config={"domain_name": domain, "opendkim_selector": dkim_selector},
         )
-        need_restart |= main_config.changed
 
-        screen_script = files.put(
+        self.put_file(
+            name="Upload screen.lua",
             src=get_resource("opendkim/screen.lua"),
             dest="/etc/opendkim/screen.lua",
-            user="root",
-            group="root",
-            mode="644",
         )
-        need_restart |= screen_script.changed
 
-        final_script = files.put(
+        self.put_file(
+            name="Upload final.lua",
             src=get_resource("opendkim/final.lua"),
             dest="/etc/opendkim/final.lua",
-            user="root",
-            group="root",
-            mode="644",
         )
-        need_restart |= final_script.changed
 
         files.directory(
             name="Add opendkim directory to /etc",
@@ -64,25 +54,21 @@ def configure(self):
             present=True,
         )
 
-        keytable = files.template(
+        self.put_template(
+            name="Upload KeyTable",
             src=get_resource("opendkim/KeyTable"),
             dest="/etc/dkimkeys/KeyTable",
-            user="opendkim",
-            group="opendkim",
-            mode="644",
+            owner="opendkim",
             config={"domain_name": domain, "opendkim_selector": dkim_selector},
         )
-        need_restart |= keytable.changed
 
-        signing_table = files.template(
+        self.put_template(
+            name="Upload SigningTable",
             src=get_resource("opendkim/SigningTable"),
             dest="/etc/dkimkeys/SigningTable",
-            user="opendkim",
-            group="opendkim",
-            mode="644",
+            owner="opendkim",
             config={"domain_name": domain, "opendkim_selector": dkim_selector},
         )
-        need_restart |= signing_table.changed
         files.directory(
             name="Add opendkim socket directory to /var/spool/postfix",
             path="/var/spool/postfix/opendkim",
@@ -102,14 +88,11 @@ def configure(self):
                 _su_user="opendkim",
             )
 
-        service_file = files.put(
+        self.put_file(
             name="Configure opendkim to restart once a day",
             src=get_resource("opendkim/systemd.conf"),
             dest="/etc/systemd/system/opendkim.service.d/10-prevent-memory-leak.conf",
         )
-        need_restart |= service_file.changed
-
-        self.need_restart = need_restart
 
     def activate(self):
         systemd.service(

cmdeploy/src/cmdeploy/postfix/deployer.py

@@ -19,71 +19,51 @@ def install(self):
 
     def configure(self):
         config = self.config
-        need_restart = False
 
-        main_config = files.template(
+        self.put_template(
+            name="Upload main.cf",
             src=get_resource("postfix/main.cf.j2"),
             dest="/etc/postfix/main.cf",
-            user="root",
-            group="root",
-            mode="644",
             config=config,
             disable_ipv6=config.disable_ipv6,
         )
-        need_restart |= main_config.changed
 
-        master_config = files.template(
+        self.put_template(
+            name="Upload master.cf",
             src=get_resource("postfix/master.cf.j2"),
             dest="/etc/postfix/master.cf",
-            user="root",
-            group="root",
-            mode="644",
             debug=False,
             config=config,
         )
-        need_restart |= master_config.changed
 
-        header_cleanup = files.put(
+        self.put_file(
+            name="Upload submission_header_cleanup",
             src=get_resource("postfix/submission_header_cleanup"),
             dest="/etc/postfix/submission_header_cleanup",
-            user="root",
-            group="root",
-            mode="644",
         )
-        need_restart |= header_cleanup.changed
 
-        lmtp_header_cleanup = files.put(
+        self.put_file(
+            name="Upload lmtp_header_cleanup",
             src=get_resource("postfix/lmtp_header_cleanup"),
             dest="/etc/postfix/lmtp_header_cleanup",
-            user="root",
-            group="root",
-            mode="644",
         )
-        need_restart |= lmtp_header_cleanup.changed
 
-        tls_policy_map = files.put(
+        tls_policy_changed = self.put_file(
             name="Upload SMTP TLS Policy that accepts self-signed certificates for IP-only hosts",
             src=get_resource("postfix/smtp_tls_policy_map"),
             dest="/etc/postfix/smtp_tls_policy_map",
-            user="root",
-            group="root",
-            mode="644",
-        )
-        need_restart |= tls_policy_map.changed
-        if tls_policy_map.changed:
+        ).changed
+        if tls_policy_changed:
             server.shell(
                 commands=["postmap /etc/postfix/smtp_tls_policy_map"],
             )
 
         # Login map that 1:1 maps email address to login.
-        login_map = files.put(
+        self.put_file(
+            name="Upload login_map",
             src=get_resource("postfix/login_map"),
             dest="/etc/postfix/login_map",
-            user="root",
-            group="root",
-            mode="644",
         )
-        need_restart |= login_map.changed
 
         restart_conf = files.put(
             name="postfix: restart automatically on failure",
@@ -93,13 +73,12 @@ def configure(self):
         self.daemon_reload = restart_conf.changed
 
         # Validate postfix configuration before restart
-        if need_restart:
+        if self.need_restart:
             server.shell(
                 name="Validate postfix configuration",
                 # Extract stderr and quit with error if non-zero
                 commands=["""bash -c 'w=$(postconf 2>&1 >/dev/null); [[ -z "$w" ]] || { echo "$w"; false; }'"""],
             )
-        self.need_restart = need_restart
 
     def activate(self):
         restart = False if self.disable_mail else self.need_restart