1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
{ pkgs, lib, ... }:
{
name = "qbittorrent";
meta = with pkgs.lib.maintainers; {
maintainers = [
fsnkty
undefined-landmark
];
};
nodes = {
simple = {
services.qbittorrent.enable = true;
specialisation.portChange.configuration = {
services.qbittorrent = {
enable = true;
webuiPort = 5555;
torrentingPort = 44444;
};
};
specialisation.openPorts.configuration = {
services.qbittorrent = {
enable = true;
openFirewall = true;
webuiPort = 8080;
torrentingPort = 55555;
};
};
specialisation.serverConfig.configuration = {
services.qbittorrent = {
enable = true;
webuiPort = null;
serverConfig.Preferences.WebUI.Port = "8181";
};
};
};
# Seperate vm because it's not possible to reboot into a specialisation with
# switch-to-configuration: https://github.com/NixOS/nixpkgs/issues/82851
# For one of the test we check if manual changes are overridden during
# reboot, therefore it's necessary to reboot into a declarative setup.
declarative = {
services.qbittorrent = {
enable = true;
webuiPort = null;
serverConfig = {
Preferences = {
WebUI = {
Username = "user";
# Default password: adminadmin
Password_PBKDF2 = "@ByteArray(6DIf26VOpTCYbgNiO6DAFQ==:e6241eaAWGzRotQZvVA5/up9fj5wwSAThLgXI2lVMsYTu1StUgX9MgmElU3Sa/M8fs+zqwZv9URiUOObjqJGNw==)";
Port = lib.mkDefault "8181";
};
};
};
};
specialisation.serverConfigChange.configuration = {
services.qbittorrent = {
enable = true;
webuiPort = null;
serverConfig.Preferences.WebUI.Port = "7171";
};
};
};
};
testScript =
{ nodes, ... }:
let
simpleSpecPath = "${nodes.simple.system.build.toplevel}/specialisation";
declarativeSpecPath = "${nodes.declarative.system.build.toplevel}/specialisation";
portChange = "${simpleSpecPath}/portChange";
openPorts = "${simpleSpecPath}/openPorts";
serverConfig = "${simpleSpecPath}/serverConfig";
serverConfigChange = "${declarativeSpecPath}/serverConfigChange";
in
''
simple.start(allow_reboot=True)
declarative.start(allow_reboot=True)
def test_webui(machine, port):
machine.wait_for_unit("qbittorrent.service")
machine.wait_for_open_port(port)
machine.wait_until_succeeds(f"curl --fail http://localhost:{port}")
# To simulate an interactive change in the settings
def setPreferences_api(machine, port, post_creds, post_data):
qb_url = f"http://localhost:{port}"
api_url = f"{qb_url}/api/v2"
cookie_path = "/tmp/qbittorrent.cookie"
machine.succeed(
f'curl --header "Referer: {qb_url}" \
--data "{post_creds}" {api_url}/auth/login \
-c {cookie_path}'
)
machine.succeed(
f'curl --header "Referer: {qb_url}" \
--data "{post_data}" {api_url}/app/setPreferences \
-b {cookie_path}'
)
# A randomly generated password is printed in the service log when no
# password it set
def get_temp_pass(machine):
_, password = machine.execute(
"journalctl -u qbittorrent.service |\
grep 'The WebUI administrator password was not set.' |\
awk '{ print $NF }' | tr -d '\n'"
)
return password
# Non declarative tests
with subtest("webui works with all default settings"):
test_webui(simple, 8080)
with subtest("check if manual changes in settings are saved correctly"):
temp_pass = get_temp_pass(simple)
## Change some settings
api_post = [r"json={\"listen_port\": 33333}", r"json={\"web_ui_port\": 9090}"]
for x in api_post:
setPreferences_api(
machine=simple,
port=8080,
post_creds=f"username=admin&password={temp_pass}",
post_data=x,
)
simple.wait_for_open_port(33333)
test_webui(simple, 9090)
## Test which settings are reset
## As webuiPort is passed as an cli it should reset after reboot
## As torrentingPort is not passed as an cli it should not reset after
## reboot
simple.reboot()
test_webui(simple, 8080)
simple.wait_for_open_port(33333)
with subtest("ports are changed on config change"):
simple.succeed("${portChange}/bin/switch-to-configuration test")
test_webui(simple, 5555)
simple.wait_for_open_port(44444)
with subtest("firewall is opened correctly"):
simple.succeed("${openPorts}/bin/switch-to-configuration test")
test_webui(simple, 8080)
declarative.wait_until_succeeds("curl --fail http://simple:8080")
declarative.wait_for_open_port(55555, "simple")
with subtest("switching from simple to declarative works"):
simple.succeed("${serverConfig}/bin/switch-to-configuration test")
test_webui(simple, 8181)
# Declarative tests
with subtest("serverConfig is applied correctly"):
test_webui(declarative, 8181)
with subtest("manual changes are overridden during reboot"):
## Change some settings
setPreferences_api(
machine=declarative,
port=8181, # as set through serverConfig
post_creds="username=user&password=adminadmin",
post_data=r"json={\"web_ui_port\": 9191}",
)
test_webui(declarative, 9191)
## Test which settings are reset
## The generated qBittorrent.conf is, apparently, reapplied after reboot.
## Because the port is set in `serverConfig` this overrides the manually
## set port.
declarative.reboot()
test_webui(declarative, 8181)
with subtest("changes in serverConfig are applied correctly"):
declarative.succeed("${serverConfigChange}/bin/switch-to-configuration test")
test_webui(declarative, 7171)
'';
}
|
