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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
#!/usr/bin/python3 -OO
# Copyright 2007-2025 by The SABnzbd-Team (sabnzbd.org)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
"""
tests.test_functional_misc - Functional tests of various functions
"""
import shutil
import subprocess
import sys
import sabnzbd.encoding
from sabnzbd.filesystem import save_compressed
from sabnzbd.constants import JOB_ADMIN
from tests.testhelper import *
class TestShowLogging(SABnzbdBaseTest):
def test_showlog(self):
"""Test the output of the filtered-log button"""
# Basic URL-fetching, easier than Selenium file download
log_result = get_api_result("showlog")
# Make sure it has basic log stuff
assert "The log" in log_result
assert "Full executable path" in log_result
# Make sure sabnzbd.ini was appended
assert "__encoding__ = utf-8" in log_result
assert "[misc]" in log_result
class TestQueueRepair(SABnzbdBaseTest):
def test_queue_repair(self):
"""Test full queue repair by manually adding an orphaned job"""
nzb_fp = create_and_read_nzb_fp("basic_rar5")
test_job_name = "testfile_%s" % time.time()
# Create folder and save compressed NZB like SABnzbd would do
admin_path = os.path.join(SAB_INCOMPLETE_DIR, test_job_name, JOB_ADMIN)
os.makedirs(admin_path)
save_compressed(admin_path, test_job_name, nzb_fp)
assert os.path.exists(os.path.join(admin_path, test_job_name + ".nzb.gz"))
# Pause the queue do we don't download stuff
assert get_api_result("pause") == {"status": True}
# Request queue repair
assert get_api_result("restart_repair") == {"status": True}
# Let's check the queue, this can take long on GitHub Actions
for _ in range(60):
queue_result_slots = {}
try:
# Can give timeout if still restarting
queue_result_slots = get_api_result("queue", extra_arguments={"limit": 10000})["queue"]["slots"]
except requests.exceptions.RequestException:
pass
# Check if the repaired job was added to the queue
if queue_result_slots:
break
time.sleep(1)
else:
# The loop never stopped, so we fail
pytest.fail("Did not find the repaired job in the queue")
return
# Verify filename
assert test_job_name in [slot["filename"] for slot in queue_result_slots]
# Let's remove this thing
get_api_result("queue", extra_arguments={"name": "delete", "value": "all"})
assert len(get_api_result("queue")["queue"]["slots"]) == 0
# Unpause
assert get_api_result("resume") == {"status": True}
class TestSamplePostProc:
def test_sample_post_proc(self):
"""Make sure we don't break things"""
# Set parameters
script_params = [
"somedir222",
"nzbname",
"frènch_german_demö",
"Index12",
"Cat88",
"MyGroup",
"PP0",
"https://example.com/",
]
script_call = [sys.executable, "/usr/share/doc/sabnzbdplus/examples/Sample-PostProc.py", "server"]
script_call.extend(script_params)
# Set parameters via env
env = os.environ.copy()
env["SAB_VERSION"] = "frènch_german_demö_version"
# Run script and check output
script_call = subprocess.Popen(script_call, stdout=subprocess.PIPE, env=env)
script_output, errs = script_call.communicate(timeout=15)
# This is a bit bad, since we use our own function
# But in a way it is also a test if the function does its job!
script_output = sabnzbd.encoding.platform_btou(script_output)
# Check if all parameters are there
for param in script_params:
assert param in script_output
assert env["SAB_VERSION"] in script_output
class TestExtractPot:
def test_extract_pot(self):
"""Simple test if translation extraction still works"""
script_call = [sys.executable, "tools/extract_pot.py"]
# Run script and check output
script_call = subprocess.Popen(script_call, stdout=subprocess.PIPE)
script_output, errs = script_call.communicate(timeout=15)
script_output = sabnzbd.encoding.platform_btou(script_output)
# Success message?
assert "Creating POT file" in script_output
assert "Finished creating POT file" in script_output
assert "Post-process POT file" in script_output
assert "Finished post-process POT file" in script_output
assert "Creating email POT file" in script_output
assert "Finished creating email POT file" in script_output
# Check if the file was modified less than 30 seconds ago
cur_time = time.time()
assert (cur_time - os.path.getmtime("po/main/SABnzbd.pot")) < 30
assert (cur_time - os.path.getmtime("po/email/SABemail.pot")) < 30
# Reset the translation updates
try:
lang_command = "git checkout @ -- %s/../po/main/SABnzbd.pot" % SAB_BASE_DIR
subprocess.Popen(lang_command.split()).communicate(timeout=30)
lang_command = "git checkout @ -- %s/../po/email/SABemail.pot" % SAB_BASE_DIR
subprocess.Popen(lang_command.split()).communicate(timeout=30)
except:
pass
@pytest.mark.skipif(sys.platform.startswith("win"), reason="Skipping on Windows")
@pytest.mark.skipif(sys.platform.startswith("darwin"), reason="Fails for now due to PyObjC problem")
class TestDaemonizing(SABnzbdBaseTest):
def test_daemonizing(self):
"""Simple test to see if daemon-mode still works.
Also test removal of large "sabnzbd.error.log"
We inherit from SABnzbdBaseTest so we can use it's clean-up logic!
"""
daemon_host = "localhost"
daemon_port = 23456
ini_location = os.path.join(SAB_CACHE_DIR, "daemon_test")
# Create large output-file
error_log_path = os.path.join(ini_location, sabnzbd.cfg.log_dir(), sabnzbd.constants.DEF_LOG_ERRFILE)
os.makedirs(os.path.dirname(error_log_path), exist_ok=True)
with open(error_log_path, "wb") as large_log:
large_log.seek(6 * 1024 * 1024)
large_log.write(b"\1")
# We need the basic-config to set the API-key
# Otherwise we can't shut it down at the end
shutil.copyfile(os.path.join(SAB_DATA_DIR, "sabnzbd.basic.ini"), os.path.join(ini_location, "sabnzbd.ini"))
# Combine it all into the script call
script_call = [
sys.executable,
"/usr/bin/sabnzbdplus",
"-d",
"-s",
"%s:%s" % (daemon_host, daemon_port),
"-f",
ini_location,
"--pid",
ini_location,
]
# Run script and check output
script_call = subprocess.Popen(script_call, stdout=subprocess.PIPE)
script_output, errs = script_call.communicate(timeout=15)
# No error or output should be thrown by main process
assert not script_output
assert not errs
# It should be online after 3 seconds
time.sleep(3.0)
assert "version" in get_api_result("version", daemon_host, daemon_port)
# Did it create the PID file
pid_file = os.path.join(ini_location, "sabnzbd-%d.pid" % daemon_port)
assert os.path.exists(pid_file)
# Did it remove the bad log file?
assert os.path.exists(error_log_path)
assert os.path.getsize(error_log_path) < 1024
try:
# Let's shut it down and give it some time to do so
get_url_result("shutdown", daemon_host, daemon_port)
time.sleep(3.0)
except requests.exceptions.RequestException:
# Shutdown can be faster than the request
pass
|
