Adds services.arrInit.<name>.configXml for declaratively ensuring XML elements exist in a Servarr config.xml before the service starts. Generates a preStart hook on the main service that runs a Python helper to patch or create config.xml. Undeclared elements are preserved; declared elements are written with exact values. Primary use case: preventing recurring Prowlarr 'not listening on port' failures when config.xml loses the <Port> element — now guaranteed to exist before Prowlarr starts. Hardening: - Atomic writes (tmp + rename): power loss cannot corrupt config.xml - Malformed XML recovery: fresh <Config> root instead of blocking boot - Secure default mode (0600) for new files containing ApiKey - Preserves existing file mode on rewrite - Assertion against duplicate serviceName targeting Tests (10 subtests): creates-from-missing, patches-existing, preserves- undeclared, corrects-tampered, idempotent, malformed-recovery, ownership-preserved, not-world-readable.
156 lines
4.9 KiB
Nix
156 lines
4.9 KiB
Nix
{
|
|
pkgs,
|
|
lib,
|
|
self,
|
|
}:
|
|
|
|
pkgs.testers.runNixOSTest {
|
|
name = "arr-init-multiple-clients";
|
|
|
|
nodes.machine =
|
|
{ pkgs, lib, ... }:
|
|
let
|
|
mocks = import ./lib/mocks.nix { inherit pkgs; };
|
|
in
|
|
{
|
|
imports = [ self.nixosModules.default ];
|
|
|
|
system.stateVersion = "24.11";
|
|
|
|
virtualisation.memorySize = 4096;
|
|
|
|
environment.systemPackages = with pkgs; [
|
|
curl
|
|
jq
|
|
gnugrep
|
|
];
|
|
|
|
# Mock qBittorrent on port 6011
|
|
systemd.services.mock-qbittorrent = mocks.mkMockQbittorrent {
|
|
initialCategories = {
|
|
tv = {
|
|
name = "tv";
|
|
savePath = "/downloads";
|
|
};
|
|
};
|
|
};
|
|
|
|
# Mock SABnzbd on port 6012
|
|
systemd.services.mock-sabnzbd = mocks.mkMockSabnzbd { };
|
|
|
|
systemd.tmpfiles.rules = [
|
|
"d /media/tv 0755 sonarr sonarr -"
|
|
];
|
|
|
|
services.sonarr = {
|
|
enable = true;
|
|
dataDir = "/var/lib/sonarr/.config/NzbDrone";
|
|
settings.server.port = lib.mkDefault 8989;
|
|
};
|
|
|
|
# Sonarr with TWO download clients: qBittorrent + SABnzbd
|
|
services.arrInit.sonarr = {
|
|
enable = true;
|
|
serviceName = "sonarr";
|
|
dataDir = "/var/lib/sonarr/.config/NzbDrone";
|
|
port = 8989;
|
|
downloadClients = [
|
|
{
|
|
name = "qBittorrent";
|
|
implementation = "QBittorrent";
|
|
configContract = "QBittorrentSettings";
|
|
protocol = "torrent";
|
|
fields = {
|
|
host = "127.0.0.1";
|
|
port = 6011;
|
|
useSsl = false;
|
|
tvCategory = "tv";
|
|
};
|
|
}
|
|
{
|
|
name = "SABnzbd";
|
|
implementation = "Sabnzbd";
|
|
configContract = "SabnzbdSettings";
|
|
protocol = "usenet";
|
|
fields = {
|
|
host = "127.0.0.1";
|
|
port = 6012;
|
|
useSsl = false;
|
|
apiKey = "test-api-key";
|
|
tvCategory = "tv";
|
|
};
|
|
}
|
|
];
|
|
rootFolders = [ "/media/tv" ];
|
|
};
|
|
};
|
|
|
|
testScript = ''
|
|
start_all()
|
|
|
|
# Wait for mock services
|
|
machine.wait_for_unit("mock-qbittorrent.service")
|
|
machine.wait_for_unit("mock-sabnzbd.service")
|
|
machine.wait_until_succeeds("curl -sf http://localhost:6011/api/v2/app/version", timeout=30)
|
|
|
|
# Wait for Sonarr
|
|
machine.wait_for_unit("sonarr.service")
|
|
machine.wait_until_succeeds(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/system/status -H \"X-Api-Key: $API_KEY\"",
|
|
timeout=120,
|
|
)
|
|
|
|
# Trigger init
|
|
machine.succeed("systemctl restart sonarr-init.service")
|
|
machine.wait_for_unit("sonarr-init.service")
|
|
|
|
# Verify both download clients exist
|
|
result = machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq '. | length'"
|
|
).strip()
|
|
assert result == "2", f"Expected 2 Sonarr download clients, got {result}"
|
|
|
|
# Verify qBittorrent client
|
|
machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq -e '.[] | select(.name == \"qBittorrent\")'"
|
|
)
|
|
|
|
# Verify SABnzbd client
|
|
machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq -e '.[] | select(.name == \"SABnzbd\")'"
|
|
)
|
|
|
|
# Idempotency test: restart init and verify still exactly 2 clients
|
|
machine.succeed("systemctl restart sonarr-init.service")
|
|
machine.wait_for_unit("sonarr-init.service")
|
|
|
|
result = machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq '. | length'"
|
|
).strip()
|
|
assert result == "2", f"Expected 2 Sonarr download clients after idempotency test, got {result}"
|
|
|
|
# Verify qBittorrent has correct configuration
|
|
machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq -e '.[] | select(.name == \"qBittorrent\") | .protocol == \"torrent\"'"
|
|
)
|
|
|
|
# Verify SABnzbd has correct configuration
|
|
machine.succeed(
|
|
"API_KEY=$(grep -oP '(?<=<ApiKey>)[^<]+' /var/lib/sonarr/.config/NzbDrone/config.xml) && "
|
|
"curl -sf http://localhost:8989/api/v3/downloadclient -H \"X-Api-Key: $API_KEY\" | "
|
|
"jq -e '.[] | select(.name == \"SABnzbd\") | .protocol == \"usenet\"'"
|
|
)
|
|
'';
|
|
}
|