imapnotify: Add launchd agent

[dbaynard]

Description

This extends the imapnotify (goimapnotify) configuration with a launchd agent that matches the systemd unit (and shares as much code as possible).

Annoyingly I'd forgotten that goimapnotify is malconfigured in nixpkgs, in that it works (and is supported) on macos, but the metadata platforms are linux only. So while this is blocked on that, I'm making the PR now, and I'll update it when the upstream change is merged.

Edit: NixOS/nixpkgs#193797 (now merged, awaiting and deployed deployment to nixos-unstable)

I added a semi-golden test: it uses the goimapnotify store path, so I've passed that as a parameter. I've seen the pkgs.writeText pattern used in other tests, but I didn't spot this case, so I hope it's ok.

I've seen that #2915 is still open; if this is merged first, there'll be additonal redundant platform checking, from this.

I've a few comments that I'll put in a self-review.

Checklist

• Change is backwards compatible. (but the version of goimapnotify that lists darwin in platforms is only in master, at the moment)

• Code formatted with ./format.

• Code tested through nix-shell --pure tests -A run.all.

• Test cases updated/added. See example.

• Commit messages are formatted like

  {component}: {description}
  
  {long description}
  

  See CONTRIBUTING for more information and recent commit messages for examples.

• If this PR adds a new module

  • Added myself as module maintainer. See example.

  • Added myself and the module files to .github/CODEOWNERS.

[dbaynard]

goimapnotify at master has the correct platforms for darwin (though I'm not sure this is being backported). All builds in nixpkgs suported by home-manager should work, but require the following override to build (I'm sure there's a more elegant way of doing it with lib.recursiveUpdate but 🤷 ). I’m not sure how to handle these circumstances (specifically, CI failing).

drv: drv.overrideAttrs (old: {
    meta = old.meta or { } // {
      platforms = old.meta.platforms or [ ] ++ lib.platforms.darwin;
    };
  });

[dbaynard]

I'm just pushing a commit that should get macos CI showing green.

[dbaynard]

NixOS 22.11 has the working version of goimapnotify so I'll make the necessary changes to this in the next week.

[dbaynard]

I'm happy with this, the tests work, and the upstream dependency requires no changes. Ready to go!

[stale]

Thank you for your contribution! I marked this pull request as stale due to inactivity. Please read the relevant sections below before commenting.

If you are the original author of the PR

• GitHub sometimes doesn't notify people who commented / reviewed a PR previously when you (force) push commits. If you have addressed the reviews you can officially ask for a review from those who commented to you or anyone else.
• If it is unfinished but you plan to finish it, please mark it as a draft.
• If you don't expect to work on it any time soon, please consider closing it with a short comment encouraging someone else to pick up your work.
• To get things rolling again, rebase the PR against the target branch and address valid comments.

If you are not the original author of the PR

• If you want to pick up the work on this PR, please create a new PR and indicate that it supercedes and closes this PR.

[dbaynard]

Thanks for the review — I'll rebase, make the changes and confirm everything is ok, then ping for re-review.

[dbaynard]

This is still on my roadmap; I'll get to it in the next few months (hopefully soon).

[dbaynard]

I've rebased but I haven't been able to figure out the test failure.

Here's my test.

    nmt.script = let
      serviceFileName =
        "org.nix-community.home.imapnotify-hm-example.com.plist";
    in ''
      serviceFile=LaunchAgents/${serviceFileName}
      assertFileExists $serviceFile
      assertFileContent $serviceFile ${./launchd.plist}
    '';

Expected LaunchAgents/org.nix-community.home.imapnotify-hm-example.com.plist to be same as /nix/store/shpsifrkxyil9gd65295q5kx0ihyqvwx-launchd.plist but were different:
--- actual
+++ expected
@@ -17,7 +17,7 @@
        <string>Background</string>
        <key>ProgramArguments</key>
        <array>
-               <string>/nix/store/ib1yskg8kk1hxzn32yi3sjjpphq45sna-goimapnotify/bin/goimapnotify</string>
+               <string>@goimapnotify@/bin/goimapnotify</string>
                <string>-conf</string>
                <string>/home/hm-user/.config/imapnotify/imapnotify-hm-example.com-config.json</string>
        </array>

I don't see how the call to assertFileContent differs from the helix example.

''
      assertFileContent \
        home-files/.config/helix/languages.toml \
        ${./languages-expected.toml}
''

In both cases the relevant parameter comes from lib.test.mkStubPackage { name = "pkgname" }. I tried with the argument outPath, with name and with both, and in all cases it generated (a variant of) the error here, where the generated code includes a store path, not the path relative to @goimapnotify@.

It's plausible that this behaves differently on launchd units — I haven't looked through the code for the tests. Given the tests did pass, this seems like a regression. (Edit: Perhaps something to do with canonicalizing paths, as that would explain why it prints the nix store path rather than the one relative to outDir.)

Any suggestions?

[ncfavier]

The problem is that getExe/getBin does not play well with our stubs, because we just naively override outPath but this does not take care of pkg.out. I'll try a fix later.

[dbaynard]

OK; no rush on my part. Let me know if you'd like me to take a look at it, too. Thanks!

[ncfavier]

#4050

This was not the only problem with this PR: you'll also have to pass outPath = "@goimapnotify@"; to mkStubPackage, as the other tests do.

[ncfavier]

Rebasing to master should fix the tests now.

[kciredor]

Very eager to use this! Thanks @dbaynard and @ncfavier for the upcoming review 😀

[kciredor]

That was fast, thanks 🥳