From 23259ded2c35d6af2784fa510db1b75091fc8fc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Janne=20He=C3=9F?= Date: Sun, 28 Nov 2021 21:18:45 +0100 Subject: [PATCH] Remove restart logic from README and test The required code in nixpkgs was reverted so we should not advertise a feature that does not work. We can revert this commit if the feature is re-merged into 22.05 with the proper version in it. --- README.md | 14 -- pkgs/sops-install-secrets/nixos-test.nix | 178 +++++++++++------------ 2 files changed, 89 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index bfb3edf..7ba9bba 100644 --- a/README.md +++ b/README.md @@ -561,20 +561,6 @@ the service needs a token and a SSH private key to function. -## Restarting/reloading systemd units on secret change - -**With NixOS 21.11**, it is possible to restart or reload units when a secret changes or is newly initialized. -This behaviour can be configured per-secret: -```nix -{ - sops.secrets."home-assistant-secrets.yaml" = { - restartUnits = [ "home-assistant.service" ]; - }; -} -``` - -This logic respects units that prefer to be reloaded or not to be restarted at all. - ## Symlinks to other directories Some services might expect files in certain locations. diff --git a/pkgs/sops-install-secrets/nixos-test.nix b/pkgs/sops-install-secrets/nixos-test.nix index 3862ff0..27dd5d5 100644 --- a/pkgs/sops-install-secrets/nixos-test.nix +++ b/pkgs/sops-install-secrets/nixos-test.nix @@ -205,108 +205,108 @@ }; } // pkgs.lib.optionalAttrs (pkgs.lib.versionAtLeast (pkgs.lib.versions.majorMinor pkgs.lib.version) "21.11") { + # This feature got reverted in nixpkgs... + #restart-and-reload = makeTest { + # name = "sops-restart-and-reload"; + # machine = { pkgs, lib, config, ... }: { + # imports = [ + # ../../modules/sops + # ]; - restart-and-reload = makeTest { - name = "sops-restart-and-reload"; - machine = { pkgs, lib, config, ... }: { - imports = [ - ../../modules/sops - ]; + # sops = { + # age.keyFile = ./test-assets/age-keys.txt; + # defaultSopsFile = ./test-assets/secrets.yaml; + # secrets.test_key = { + # restartUnits = [ "restart-unit.service" "reload-unit.service" ]; + # }; + # }; - sops = { - age.keyFile = ./test-assets/age-keys.txt; - defaultSopsFile = ./test-assets/secrets.yaml; - secrets.test_key = { - restartUnits = [ "restart-unit.service" "reload-unit.service" ]; - }; - }; + # systemd.services."restart-unit" = { + # description = "Restart unit"; + # # not started on boot + # serviceConfig = { + # ExecStart = "/bin/sh -c 'echo ok > /restarted'"; + # }; + # }; + # systemd.services."reload-unit" = { + # description = "Restart unit"; + # wantedBy = [ "multi-user.target" ]; + # reloadIfChanged = true; + # serviceConfig = { + # Type = "oneshot"; + # RemainAfterExit = true; + # ExecStart = "/bin/sh -c true"; + # ExecReload = "/bin/sh -c 'echo ok > /reloaded'"; + # }; + # }; + # }; + # testScript = '' + # machine.wait_for_unit("multi-user.target") + # machine.fail("test -f /restarted") + # machine.fail("test -f /reloaded") - systemd.services."restart-unit" = { - description = "Restart unit"; - # not started on boot - serviceConfig = { - ExecStart = "/bin/sh -c 'echo ok > /restarted'"; - }; - }; - systemd.services."reload-unit" = { - description = "Restart unit"; - wantedBy = [ "multi-user.target" ]; - reloadIfChanged = true; - serviceConfig = { - Type = "oneshot"; - RemainAfterExit = true; - ExecStart = "/bin/sh -c true"; - ExecReload = "/bin/sh -c 'echo ok > /reloaded'"; - }; - }; - }; - testScript = '' - machine.wait_for_unit("multi-user.target") - machine.fail("test -f /restarted") - machine.fail("test -f /reloaded") + # # Nothing is to be restarted after boot + # machine.fail("ls /run/nixos/*-list") - # Nothing is to be restarted after boot - machine.fail("ls /run/nixos/*-list") + # # Nothing happens when the secret is not changed + # machine.succeed("/run/current-system/bin/switch-to-configuration test") + # machine.fail("test -f /restarted") + # machine.fail("test -f /reloaded") - # Nothing happens when the secret is not changed - machine.succeed("/run/current-system/bin/switch-to-configuration test") - machine.fail("test -f /restarted") - machine.fail("test -f /reloaded") + # # Ensure the secret is changed + # machine.succeed(": > /run/secrets/test_key") - # Ensure the secret is changed - machine.succeed(": > /run/secrets/test_key") + # # The secret is changed, now something should happen + # machine.succeed("/run/current-system/bin/switch-to-configuration test") - # The secret is changed, now something should happen - machine.succeed("/run/current-system/bin/switch-to-configuration test") + # # Ensure something happened + # machine.succeed("test -f /restarted") + # machine.succeed("test -f /reloaded") - # Ensure something happened - machine.succeed("test -f /restarted") - machine.succeed("test -f /reloaded") + # with subtest("change detection"): + # machine.succeed("rm /run/secrets/test_key") + # out = machine.succeed("/run/current-system/bin/switch-to-configuration test") + # if "adding secret" not in out: + # raise Exception("Addition detection does not work") - with subtest("change detection"): - machine.succeed("rm /run/secrets/test_key") - out = machine.succeed("/run/current-system/bin/switch-to-configuration test") - if "adding secret" not in out: - raise Exception("Addition detection does not work") + # machine.succeed(": > /run/secrets/test_key") + # out = machine.succeed("/run/current-system/bin/switch-to-configuration test") + # if "modifying secret" not in out: + # raise Exception("Modification detection does not work") - machine.succeed(": > /run/secrets/test_key") - out = machine.succeed("/run/current-system/bin/switch-to-configuration test") - if "modifying secret" not in out: - raise Exception("Modification detection does not work") + # machine.succeed(": > /run/secrets/another_key") + # out = machine.succeed("/run/current-system/bin/switch-to-configuration test") + # if "removing secret" not in out: + # raise Exception("Removal detection does not work") - machine.succeed(": > /run/secrets/another_key") - out = machine.succeed("/run/current-system/bin/switch-to-configuration test") - if "removing secret" not in out: - raise Exception("Removal detection does not work") + # with subtest("dry activation"): + # machine.succeed("rm /run/secrets/test_key") + # machine.succeed(": > /run/secrets/another_key") + # out = machine.succeed("/run/current-system/bin/switch-to-configuration dry-activate") + # if "would add secret" not in out: + # raise Exception("Dry addition detection does not work") + # if "would remove secret" not in out: + # raise Exception("Dry removal detection does not work") - with subtest("dry activation"): - machine.succeed("rm /run/secrets/test_key") - machine.succeed(": > /run/secrets/another_key") - out = machine.succeed("/run/current-system/bin/switch-to-configuration dry-activate") - if "would add secret" not in out: - raise Exception("Dry addition detection does not work") - if "would remove secret" not in out: - raise Exception("Dry removal detection does not work") + # machine.fail("test -f /run/secrets/test_key") + # machine.succeed("test -f /run/secrets/another_key") - machine.fail("test -f /run/secrets/test_key") - machine.succeed("test -f /run/secrets/another_key") + # machine.succeed("/run/current-system/bin/switch-to-configuration test") + # machine.succeed("test -f /run/secrets/test_key") + # machine.succeed("rm /restarted /reloaded") + # machine.fail("test -f /run/secrets/another_key") - machine.succeed("/run/current-system/bin/switch-to-configuration test") - machine.succeed("test -f /run/secrets/test_key") - machine.succeed("rm /restarted /reloaded") - machine.fail("test -f /run/secrets/another_key") + # machine.succeed(": > /run/secrets/test_key") + # out = machine.succeed("/run/current-system/bin/switch-to-configuration dry-activate") + # if "would modify secret" not in out: + # raise Exception("Dry modification detection does not work") + # machine.succeed("[ $(cat /run/secrets/test_key | wc -c) = 0 ]") - machine.succeed(": > /run/secrets/test_key") - out = machine.succeed("/run/current-system/bin/switch-to-configuration dry-activate") - if "would modify secret" not in out: - raise Exception("Dry modification detection does not work") - machine.succeed("[ $(cat /run/secrets/test_key | wc -c) = 0 ]") - - machine.fail("test -f /restarted") # not done in dry mode - machine.fail("test -f /reloaded") # not done in dry mode - ''; - } { - inherit pkgs; - inherit (pkgs) system; - }; + # machine.fail("test -f /restarted") # not done in dry mode + # machine.fail("test -f /reloaded") # not done in dry mode + # ''; + #} { + # inherit pkgs; + # inherit (pkgs) system; + #}; }