Merge branch 'dovecot-unit-name-migration' into 'master'

dovecot: use marker option as unit name migration indicator

See merge request simple-nixos-mailserver/nixos-mailserver!426

mail-server/common.nix

@@ -16,6 +16,7 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
 }:
@@ -86,4 +87,6 @@ in
       chmod 600 ${destination}
     '';
 
+  dovecotUnitName = if options.services.dovecot2 ? hasNewUnitName then "dovecot" else "dovecot2";
+
 }

mail-server/dovecot.nix

@@ -16,22 +16,24 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
   ...
 }:
 
-with (import ./common.nix { inherit config pkgs lib; });
+with (import ./common.nix {
+  inherit
+    config
+    options
+    pkgs
+    lib
+    ;
+});
 
 let
   cfg = config.mailserver;
 
-  dovecotPreStart =
-    ''
-      ${genPasswdScript}
-    ''
-    + (lib.optionalString cfg.ldap.enable setPwdInLdapConfFile);
-
   passwdDir = "/run/dovecot2";
   passwdFile = "${passwdDir}/passwd";
   userdbFile = "${passwdDir}/userdb";
@@ -445,10 +447,13 @@ in
       '';
     };
 
-    systemd.services.dovecot.preStart = lib.mkIf (config.systemd.services ? "dovecot") dovecotPreStart;
-    systemd.services.dovecot2.preStart = lib.mkIf (
-      config.systemd.services ? "dovecot2"
-    ) dovecotPreStart;
+    systemd.services.${dovecotUnitName} = {
+      preStart =
+        ''
+          ${genPasswdScript}
+        ''
+        + (lib.optionalString cfg.ldap.enable setPwdInLdapConfFile);
+    };
 
     systemd.services.postfix.restartTriggers = [
       genPasswdScript

mail-server/nginx.nix

@@ -16,12 +16,20 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
   ...
 }:
 
-with (import ./common.nix { inherit config lib pkgs; });
+with (import ./common.nix {
+  inherit
+    config
+    options
+    lib
+    pkgs
+    ;
+});
 
 let
   cfg = config.mailserver;
@@ -42,7 +50,7 @@ in
 
         security.acme.certs."${cfg.acmeCertificateName}".reloadServices = [
           "postfix.service"
-          "dovecot2.service"
+          "${dovecotUnitName}.service"
         ];
       };
 }

mail-server/postfix.nix

@@ -16,12 +16,20 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
   ...
 }:
 
-with (import ./common.nix { inherit config pkgs lib; });
+with (import ./common.nix {
+  inherit
+    config
+    options
+    lib
+    pkgs
+    ;
+});
 
 let
   inherit (lib.strings) concatStringsSep;

mail-server/systemd.nix

@@ -16,11 +16,21 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
   ...
 }:
 
+with (import ./common.nix {
+  inherit
+    config
+    options
+    lib
+    pkgs
+    ;
+});
+
 let
   cfg = config.mailserver;
   certificatesDeps =
@@ -31,25 +41,6 @@ let
     else
       [ "acme-finished-${cfg.fqdn}.target" ];
 
-  dovecotUnitSettings = {
-    wants = certificatesDeps;
-    after = certificatesDeps;
-    preStart =
-      let
-        directories = lib.strings.escapeShellArgs (
-          [ cfg.mailDirectory ] ++ lib.optional (cfg.indexDir != null) cfg.indexDir
-        );
-      in
-      ''
-        # Create mail directory and set permissions. See
-        # <https://doc.dovecot.org/main/core/config/shared_mailboxes.html#filesystem-permissions-1>.
-        # Prevent world-readable paths, even temporarily.
-        umask 007
-        mkdir -p ${directories}
-        chgrp "${cfg.vmailGroupName}" ${directories}
-        chmod 02770 ${directories}
-      '';
-  };
 in
 {
   config = lib.mkIf cfg.enable {
@@ -80,15 +71,34 @@ in
         };
 
     # Create maildir folder before dovecot startup
-    systemd.services.dovecot = dovecotUnitSettings;
-    # TODO: remove after 25.11 release
-    systemd.services.dovecot2 = dovecotUnitSettings;
+    systemd.services.${dovecotUnitName} = {
+      wants = certificatesDeps;
+      after = certificatesDeps;
+      preStart =
+        let
+          directories = lib.strings.escapeShellArgs (
+            [ cfg.mailDirectory ] ++ lib.optional (cfg.indexDir != null) cfg.indexDir
+          );
+        in
+        ''
+          # Create mail directory and set permissions. See
+          # <https://doc.dovecot.org/main/core/config/shared_mailboxes.html#filesystem-permissions-1>.
+          # Prevent world-readable paths, even temporarily.
+          umask 007
+          mkdir -p ${directories}
+          chgrp "${cfg.vmailGroupName}" ${directories}
+          chmod 02770 ${directories}
+        '';
+    };
 
     # Postfix requires dovecot lmtp socket, dovecot auth socket and certificate to work
     systemd.services.postfix = {
       wants = certificatesDeps;
-      after = [ "dovecot2.service" ] ++ lib.optional cfg.dkimSigning "rspamd.service" ++ certificatesDeps;
-      requires = [ "dovecot2.service" ] ++ lib.optional cfg.dkimSigning "rspamd.service";
+      after =
+        [ "${dovecotUnitName}.service" ]
+        ++ lib.optional cfg.dkimSigning "rspamd.service"
+        ++ certificatesDeps;
+      requires = [ "${dovecotUnitName}.service" ] ++ lib.optional cfg.dkimSigning "rspamd.service";
     };
   };
 }

mail-server/users.nix

@@ -16,11 +16,21 @@
 
 {
   config,
+  options,
   pkgs,
   lib,
   ...
 }:
 
+with (import ./common.nix {
+  inherit
+    config
+    options
+    lib
+    pkgs
+    ;
+});
+
 with config.mailserver;
 
 let
@@ -107,7 +117,7 @@ in
 
     systemd.services.activate-virtual-mail-users = {
       wantedBy = [ "multi-user.target" ];
-      before = [ "dovecot2.service" ];
+      before = [ "${dovecotUnitName}.service" ];
       serviceConfig = {
         ExecStart = virtualMailUsersActivationScript;
       };

tests/external.nix

@@ -490,9 +490,9 @@
         server.wait_until_fails('[ "$(postqueue -p)" != "Mail queue is empty" ]')
 
         client.succeed("imap-mark-spam >&2")
-        server.wait_until_succeeds("journalctl -u dovecot2 | grep -i rspamd-learn-spam.sh >&2")
+        server.wait_until_succeeds("journalctl -u dovecot -u dovecot2 | grep -i rspamd-learn-spam.sh >&2")
         client.succeed("imap-mark-ham >&2")
-        server.wait_until_succeeds("journalctl -u dovecot2 | grep -i rspamd-learn-ham.sh >&2")
+        server.wait_until_succeeds("journalctl -u dovecot -u dovecot2 | grep -i rspamd-learn-ham.sh >&2")
 
     with subtest("full text search and indexation"):
         # send 2 email from user2 to user1
@@ -510,9 +510,9 @@
         # should fail because this folder is not indexed
         client.fail("search Junk a >&2")
         # check that search really goes through the indexer
-        server.succeed("journalctl -u dovecot2 | grep 'fts-flatcurve(INBOX): Query ' >&2")
+        server.succeed("journalctl -u dovecot -u dovecot2 | grep 'fts-flatcurve(INBOX): Query ' >&2")
         # check that Junk is not indexed
-        server.fail("journalctl -u dovecot2 | grep 'fts-flatcurve(JUNK): Indexing ' >&2")
+        server.fail("journalctl -u dovecot -u dovecot2 | grep 'fts-flatcurve(JUNK): Indexing ' >&2")
 
     with subtest("dmarc reporting"):
         server.systemctl("start rspamd-dmarc-reporter.service")
@@ -520,10 +520,10 @@
     with subtest("no warnings or errors"):
         server.fail("journalctl -u postfix | grep -i error >&2")
         server.fail("journalctl -u postfix | grep -i warning >&2")
-        server.fail("journalctl -u dovecot2 | grep -v 'imap-login: Debug: SSL error: Connection closed' | grep -i error >&2")
+        server.fail("journalctl -u dovecot -u dovecot2 | grep -v 'imap-login: Debug: SSL error: Connection closed' | grep -i error >&2")
         # harmless ? https://dovecot.org/pipermail/dovecot/2020-August/119575.html
         server.fail(
-          "journalctl -u dovecot2 | \
+          "journalctl -u dovecot -u dovecot2 | \
             grep -v 'Expunged message reappeared, giving a new UID' | \
             grep -v 'Time moved forwards' | \
             grep -i warning >&2"