2024-04-01 13:19:38 +00:00
|
|
|
import gzip
|
|
|
|
|
import os
|
|
|
|
|
import subprocess
|
2024-04-07 09:11:14 +00:00
|
|
|
from unittest import mock
|
2024-04-01 13:19:38 +00:00
|
|
|
|
2024-04-07 18:21:59 +00:00
|
|
|
from django.test import TestCase, override_settings
|
2024-04-01 13:19:38 +00:00
|
|
|
|
|
|
|
|
from bookmarks.services import singlefile
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class SingleFileServiceTestCase(TestCase):
|
|
|
|
|
html_content = "<html><body><h1>Hello, World!</h1></body></html>"
|
|
|
|
|
html_filepath = "temp.html.gz"
|
|
|
|
|
temp_html_filepath = "temp.html.gz.tmp"
|
|
|
|
|
|
|
|
|
|
def tearDown(self):
|
|
|
|
|
if os.path.exists(self.html_filepath):
|
|
|
|
|
os.remove(self.html_filepath)
|
|
|
|
|
if os.path.exists(self.temp_html_filepath):
|
|
|
|
|
os.remove(self.temp_html_filepath)
|
|
|
|
|
|
|
|
|
|
def create_test_file(self, *args, **kwargs):
|
|
|
|
|
with open(self.temp_html_filepath, "w") as file:
|
|
|
|
|
file.write(self.html_content)
|
|
|
|
|
|
|
|
|
|
def test_create_snapshot(self):
|
2024-04-07 09:11:14 +00:00
|
|
|
mock_process = mock.Mock()
|
|
|
|
|
mock_process.wait.return_value = 0
|
|
|
|
|
self.create_test_file()
|
2024-04-01 13:19:38 +00:00
|
|
|
|
2024-04-07 09:11:14 +00:00
|
|
|
with mock.patch("subprocess.Popen", return_value=mock_process):
|
2024-04-01 13:19:38 +00:00
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
|
|
|
|
self.assertTrue(os.path.exists(self.html_filepath))
|
|
|
|
|
self.assertFalse(os.path.exists(self.temp_html_filepath))
|
|
|
|
|
|
|
|
|
|
with gzip.open(self.html_filepath, "rt") as file:
|
|
|
|
|
content = file.read()
|
|
|
|
|
self.assertEqual(content, self.html_content)
|
|
|
|
|
|
|
|
|
|
def test_create_snapshot_failure(self):
|
|
|
|
|
# subprocess fails - which it probably doesn't as single-file doesn't return exit codes
|
2024-04-07 09:11:14 +00:00
|
|
|
with mock.patch("subprocess.Popen") as mock_popen:
|
|
|
|
|
mock_popen.side_effect = subprocess.CalledProcessError(1, "command")
|
2024-04-01 13:19:38 +00:00
|
|
|
|
|
|
|
|
with self.assertRaises(singlefile.SingeFileError):
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
|
|
|
|
# so also check that it raises error if output file isn't created
|
2024-04-07 09:11:14 +00:00
|
|
|
with mock.patch("subprocess.Popen"):
|
2024-04-01 13:19:38 +00:00
|
|
|
with self.assertRaises(singlefile.SingeFileError):
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
2024-04-07 18:21:59 +00:00
|
|
|
|
2024-04-09 18:22:14 +00:00
|
|
|
def test_create_snapshot_empty_options(self):
|
|
|
|
|
mock_process = mock.Mock()
|
|
|
|
|
mock_process.wait.return_value = 0
|
|
|
|
|
self.create_test_file()
|
|
|
|
|
|
|
|
|
|
with mock.patch("subprocess.Popen") as mock_popen:
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
|
|
|
|
expected_args = [
|
|
|
|
|
"single-file",
|
2024-04-14 11:09:46 +00:00
|
|
|
'--browser-arg="--headless=new"',
|
|
|
|
|
'--browser-arg="--user-data-dir=./chromium-profile"',
|
|
|
|
|
'--browser-arg="--no-sandbox"',
|
|
|
|
|
'--browser-arg="--load-extension=uBlock0.chromium"',
|
2024-04-09 18:22:14 +00:00
|
|
|
"http://example.com",
|
|
|
|
|
self.html_filepath + ".tmp",
|
|
|
|
|
]
|
|
|
|
|
mock_popen.assert_called_with(expected_args, start_new_session=True)
|
|
|
|
|
|
|
|
|
|
@override_settings(
|
|
|
|
|
LD_SINGLEFILE_OPTIONS='--some-option "some value" --another-option "another value" --third-option="third value"'
|
|
|
|
|
)
|
|
|
|
|
def test_create_snapshot_custom_options(self):
|
|
|
|
|
mock_process = mock.Mock()
|
|
|
|
|
mock_process.wait.return_value = 0
|
|
|
|
|
self.create_test_file()
|
|
|
|
|
|
|
|
|
|
with mock.patch("subprocess.Popen") as mock_popen:
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
|
|
|
|
expected_args = [
|
|
|
|
|
"single-file",
|
2024-04-14 11:09:46 +00:00
|
|
|
'--browser-arg="--headless=new"',
|
|
|
|
|
'--browser-arg="--user-data-dir=./chromium-profile"',
|
|
|
|
|
'--browser-arg="--no-sandbox"',
|
|
|
|
|
'--browser-arg="--load-extension=uBlock0.chromium"',
|
2024-04-09 18:22:14 +00:00
|
|
|
"--some-option",
|
|
|
|
|
"some value",
|
|
|
|
|
"--another-option",
|
|
|
|
|
"another value",
|
|
|
|
|
"--third-option=third value",
|
|
|
|
|
"http://example.com",
|
|
|
|
|
self.html_filepath + ".tmp",
|
|
|
|
|
]
|
|
|
|
|
mock_popen.assert_called_with(expected_args, start_new_session=True)
|
|
|
|
|
|
2024-04-07 18:21:59 +00:00
|
|
|
def test_create_snapshot_default_timeout_setting(self):
|
|
|
|
|
mock_process = mock.Mock()
|
|
|
|
|
mock_process.wait.return_value = 0
|
|
|
|
|
self.create_test_file()
|
|
|
|
|
|
|
|
|
|
with mock.patch("subprocess.Popen", return_value=mock_process):
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
2024-04-14 11:09:46 +00:00
|
|
|
mock_process.wait.assert_called_with(timeout=120)
|
2024-04-07 18:21:59 +00:00
|
|
|
|
2024-04-14 11:09:46 +00:00
|
|
|
@override_settings(LD_SINGLEFILE_TIMEOUT_SEC=180)
|
2024-04-07 18:21:59 +00:00
|
|
|
def test_create_snapshot_custom_timeout_setting(self):
|
|
|
|
|
mock_process = mock.Mock()
|
|
|
|
|
mock_process.wait.return_value = 0
|
|
|
|
|
self.create_test_file()
|
|
|
|
|
|
|
|
|
|
with mock.patch("subprocess.Popen", return_value=mock_process):
|
|
|
|
|
singlefile.create_snapshot("http://example.com", self.html_filepath)
|
|
|
|
|
|
2024-04-14 11:09:46 +00:00
|
|
|
mock_process.wait.assert_called_with(timeout=180)
|
