Files
skyg-linux-tracker/nix/tests/module-peers.nix
T

174 lines
7.1 KiB
Nix

{ pkgs, module }:
# Evaluation tests for the peers options of nix/module.nix. They render the
# configuration and the unit without building anything, which is why they run
# on any machine: `nix eval` only forces the values below.
#
# nix eval --impure --json --expr '
# let f = builtins.getFlake (toString ./.); in
# import ./nix/tests/module-peers.nix {
# pkgs = f.inputs.nixpkgs.legacyPackages.x86_64-linux;
# module = f.nixosModules.default;
# }'
#
# Every check throws on failure, so a non-zero exit means the module changed
# behaviour; the returned list names the checks that ran.
let
inherit (pkgs) lib;
evalWith = settings:
(import (pkgs.path + "/nixos/lib/eval-config.nix") {
system = "x86_64-linux";
modules = [
module
{
system.stateVersion = "24.11";
services.skyg-linux-tracker = settings;
}
];
}).config;
rendered = settings: (evalWith settings).environment.etc."skyg-linux-tracker.toml".source.value;
service = settings: (evalWith settings).systemd.services.skyg-linux-tracker;
# Only this module's assertions; a bare evalModules has no root filesystem.
failedAssertions = settings:
map (a: a.message) (builtins.filter
(a: !a.assertion && lib.hasPrefix "services.skyg-linux-tracker" a.message)
(evalWith settings).assertions);
expect = name: condition:
if condition then name else throw "module-peers eval test failed: ${name}";
failsWith = settings: needle:
lib.any (m: lib.hasInfix needle m) (failedAssertions settings);
credentialDir = "/run/credentials/skyg-linux-tracker.service";
token = name: "/run/agenix/peer-${name}";
twoPeers = {
enable = true;
peers = {
enable = true;
settings = { tcp_interval_secs = 2; };
peers = {
beta = {
url = "https://beta:1984";
tokenFile = token "beta";
};
gamma = {
url = "http://gamma:1984";
tokenFile = token "gamma";
allowPlainHttp = true;
caFile = "/etc/ssl/private-ca.pem";
};
# Declared but switched off: no entry and no credential may be shipped.
off = {
url = "https://off:1984";
tokenFile = token "off";
enable = false;
};
};
};
};
storePath = pkgs.writeText "peer-token" "placeholder";
plain = rendered { enable = true; };
peersCfg = rendered twoPeers;
peersService = service twoPeers;
tlsOnly = {
enable = true;
tls = {
enable = true;
certFile = "/run/agenix/tls-cert";
keyFile = "/run/agenix/tls-key";
};
};
tlsPeersService = service (twoPeers // {
tls = {
enable = true;
certFile = "/run/agenix/tls-cert";
keyFile = "/run/agenix/tls-key";
};
});
in
[
(expect "a peer-less config gains no [peers] section" (!(plain ? peers)))
(expect "a peer-less unit has no peer credentials"
(!((service { enable = true; }).serviceConfig ? LoadCredential)))
(expect "a peer-less unit restarts on config changes"
((service { enable = true; }).restartTriggers != [ ]
&& ((service { enable = true; }).reloadTriggers == [ ])))
(expect "peers.enable turns the feature on" (peersCfg.peers.enabled == true))
(expect "settings are merged into [peers]" (peersCfg.peers.tcp_interval_secs == 2))
(expect "one [[peers.peer]] per enabled peer, sorted"
((map (p: p.name) peersCfg.peers.peer) == [ "beta" "gamma" ]))
(expect "a disabled peer is not rendered"
(!(lib.any (p: p.name == "off") peersCfg.peers.peer)))
(expect "token_file points into the credential directory"
(lib.all (p: p.token_file == "${credentialDir}/peer-${p.name}") peersCfg.peers.peer))
(expect "the token path never appears in the config"
(!(lib.hasInfix (token "beta") (builtins.toJSON peersCfg))))
(expect "allow_plain_http and ca_file are passed through" (
(let gamma = lib.findFirst (p: p.name == "gamma") null peersCfg.peers.peer; in
gamma.allow_plain_http && (gamma.ca_file == "/etc/ssl/private-ca.pem"))
&& (let beta = lib.findFirst (p: p.name == "beta") null peersCfg.peers.peer; in
(beta.allow_plain_http == false) && !(beta ? ca_file))))
(expect "one LoadCredential per enabled peer"
(peersService.serviceConfig.LoadCredential == [
"peer-beta:/run/agenix/peer-beta"
"peer-gamma:/run/agenix/peer-gamma"
]))
(expect "reload refreshes credentials"
(peersService.serviceConfig.RefreshOnReload == "credentials"))
(expect "peer changes reload instead of restart"
(peersService.reloadTriggers != [ ] && (peersService.restartTriggers == [ ])))
(expect "TLS alone keeps the restart trigger"
((service tlsOnly).restartTriggers != [ ] && ((service tlsOnly).reloadTriggers == [ ])))
(expect "TLS credentials are unchanged"
((service tlsOnly).serviceConfig.LoadCredential == [
"cert:/run/agenix/tls-cert"
"key:/run/agenix/tls-key"
]))
(expect "TLS and peers share the credential list"
(tlsPeersService.serviceConfig.LoadCredential == [
"cert:/run/agenix/tls-cert"
"key:/run/agenix/tls-key"
"peer-beta:/run/agenix/peer-beta"
"peer-gamma:/run/agenix/peer-gamma"
]))
# The pre-F1 freeform style stays valid; nix/tests/peers.nix uses it.
(expect "freeform settings.peers still renders"
(((rendered {
enable = true;
settings.peers = {
enabled = true;
peer = [{ name = "alpha"; url = "http://alpha:1984"; token_file = "/run/creds/alpha"; allow_plain_http = true; }];
};
}).peers.peer) == [{ name = "alpha"; url = "http://alpha:1984"; token_file = "/run/creds/alpha"; allow_plain_http = true; }]))
(expect "enable without peers is rejected"
(failsWith { enable = true; peers.enable = true; } "requires at least one peer"))
(expect "peers without enable are rejected"
(failsWith { enable = true; peers.peers.beta = { url = "https://beta:1984"; tokenFile = token "beta"; }; } "requires peers.enable = true"))
(expect "invalid names are rejected"
(failsWith { enable = true; peers = { enable = true; peers."Beta" = { url = "https://beta:1984"; tokenFile = token "beta"; }; }; } "names must match"))
(expect "store paths are rejected as tokenFile"
(failsWith { enable = true; peers = { enable = true; peers.beta = { url = "https://beta:1984"; tokenFile = "${storePath}"; }; }; } "outside the Nix store"))
(expect "relative tokenFile is rejected"
(failsWith { enable = true; peers = { enable = true; peers.beta = { url = "https://beta:1984"; tokenFile = "peer-beta"; }; }; } "absolute path"))
(expect "relative caFile is rejected"
(failsWith { enable = true; peers = { enable = true; peers.beta = { url = "https://beta:1984"; tokenFile = token "beta"; caFile = "ca.pem"; }; }; } "caFile must be an absolute path"))
(expect "mixing first-class and freeform peers is rejected"
(failsWith {
enable = true;
settings.peers.peer = [{ name = "legacy"; url = "https://legacy:1984"; token_file = "/run/creds/legacy"; }];
peers = { enable = true; peers.beta = { url = "https://beta:1984"; tokenFile = token "beta"; }; };
} "not settings.peers.peer"))
(expect "a valid peer config passes every assertion"
(failedAssertions twoPeers == [ ]))
]