feat: add transfer service adapters

This commit is contained in:
2026-07-23 03:39:33 +00:00
parent 2ec90b6a2d
commit 68db3ec4c5
5 changed files with 610 additions and 4 deletions
+87
View File
@@ -6,6 +6,7 @@ import tempfile
import unittest
from pathlib import Path, PurePosixPath
from unittest.mock import patch
from urllib import error
from archive_clients.bencode import encode
from archive_clients.config import ServiceConfig
@@ -35,6 +36,8 @@ class _Opener:
def open(self, call, timeout):
self.calls.append(call)
response = next(self.values)
if isinstance(response, BaseException):
raise response
if isinstance(response, tuple):
return _Response(*response)
return _Response(response)
@@ -95,6 +98,90 @@ class QBittorrentReaderTests(unittest.TestCase):
self.assertEqual(resources, [])
self.assertEqual(len(opener.calls), 2)
def test_stopped_add_selection_recheck_and_entry_only_delete(self):
torrent_hash = "a" * 40
responses = [
b"Ok.", # login
b"Ok.", # multipart add
b"", # skip all files
b"", # select requested files
b"", # stop before recheck
b'{"total_downloaded":0}',
b"", # recheck
json.dumps([{
"hash": torrent_hash, "state": "checkingUP",
}]).encode(),
b'{"total_downloaded":0}',
b'[{"index":0,"progress":1},{"index":1,"progress":0}]',
json.dumps([{
"hash": torrent_hash, "state": "stoppedUP",
}]).encode(),
b'{"total_downloaded":0}',
b'[{"index":0,"progress":1},{"index":1,"progress":0}]',
b"", # entry-only delete
]
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
password = root / "password"
password.write_text("secret", encoding="utf-8")
os.chmod(password, 0o600)
config = ServiceConfig(
"http://qb", PurePosixPath("/downloads"), root,
username="admin", password_file=password,
)
opener = _Opener(responses)
with patch(
"archive_clients.qbittorrent.request.build_opener",
return_value=opener,
):
adapter = QBittorrentReader(config)
adapter.add_stopped(b"torrent", "/downloads/archive")
adapter.set_selection(torrent_hash, [0], 2)
result = adapter.recheck_and_wait(
torrent_hash, [0], timeout=1, poll_interval=0
)
adapter.delete_entry(torrent_hash)
self.assertEqual(result.final_state, "stoppedUP")
self.assertEqual(result.selected_file_indices, (0,))
calls = [
call for call in opener.calls
if not isinstance(call, str)
]
add = calls[1]
self.assertIn(b'name="stopped"\r\n\r\ntrue', add.data)
form_bodies = [
call.data.decode()
for call in calls[2:]
if getattr(call, "data", None)
]
self.assertIn("priority=0", form_bodies[0])
self.assertIn("priority=1", form_bodies[1])
self.assertIn("deleteFiles=false", form_bodies[-1])
def test_stop_falls_back_to_qbittorrent_4_pause_endpoint(self):
missing = error.HTTPError(
"http://qb/api/v2/torrents/stop", 404, "not found", {}, None
)
responses = [b"Ok.", missing, b""]
with tempfile.TemporaryDirectory() as directory:
root = Path(directory)
password = root / "password"
password.write_text("secret", encoding="utf-8")
os.chmod(password, 0o600)
config = ServiceConfig(
"http://qb", PurePosixPath("/downloads"), root,
username="admin", password_file=password,
)
opener = _Opener(responses)
with patch(
"archive_clients.qbittorrent.request.build_opener",
return_value=opener,
):
QBittorrentReader(config).stop("a" * 40)
self.assertTrue(opener.calls[-1].full_url.endswith("/torrents/pause"))
if __name__ == "__main__":
unittest.main()
+97 -1
View File
@@ -3,14 +3,18 @@ import tempfile
import time
import unittest
from pathlib import Path, PurePosixPath
from uuid import uuid4
from archive_clients.config import ServiceConfig
from archive_clients.state import ClientStore
from archive_clients.syncthing import (
RoutePathConflict,
RouteSetupTimeout,
SyncthingRouteManager,
SyncthingTransferObserver,
)
from archive_control.v1 import route_pb2
from archive_clients.transfer import stage_transfer
from archive_control.v1 import route_pb2, transfer_pb2
class FakeTransport:
@@ -40,6 +44,26 @@ class FakeTransport:
self.posts.append(path)
class FakeTransferTransport:
def __init__(self, completion, need):
self.completion = completion
self.need = need
self.posts = []
def get_json(self, path):
if path.startswith("/rest/db/completion?"):
return self.completion
if path.startswith("/rest/db/need?"):
return self.need
raise AssertionError(path)
def put_json(self, path, payload):
raise AssertionError((path, payload))
def post(self, path):
self.posts.append(path)
class SyncthingRouteManagerTests(unittest.TestCase):
def setUp(self):
self.temp_dir = tempfile.TemporaryDirectory()
@@ -164,6 +188,78 @@ class SyncthingRouteManagerTests(unittest.TestCase):
)
self.assertTrue(self.transport.posts)
def test_job_prefix_rescan_progress_and_completion(self):
source = Path(self.temp_dir.name) / "source"
source.mkdir()
(source / "payload.bin").write_bytes(b"x" * 8192)
metainfo = Path(self.temp_dir.name) / "source.torrent"
metainfo.write_bytes(b"torrent")
store = ClientStore(Path(self.temp_dir.name) / "state.db")
store.initialize()
manifest = transfer_pb2.TransferManifest(
manifest_version=1,
job_id=str(uuid4()),
source_client_id="cache-1",
target_client_id="archive-1",
route_id="route-1",
)
manifest.resource_id.info_hash_v1_hex = "a" * 40
manifest.created_at.seconds = 1_700_000_000
manifest.files.add(
file_index=0,
payload_relative_path="payload/payload.bin",
target_canonical_path="payload.bin",
logical_bytes=8192,
)
manifest.artifacts.add(
kind=transfer_pb2.ARTIFACT_KIND_TORRENT_FILE,
payload_relative_path="metainfo/source.torrent",
logical_bytes=metainfo.stat().st_size,
)
published = stage_transfer(
manifest,
source_root=source,
sync_root=self.root,
store=store,
artifact_sources={"metainfo/source.torrent": metainfo},
)
relative = (
f".archive-control/jobs/{manifest.job_id}"
)
in_progress_transport = FakeTransferTransport(
{"completion": 50},
{
"progress": [{"name": f"{relative}/payload/payload.bin"}],
"queued": [],
"rest": [],
},
)
observer = SyncthingTransferObserver(
in_progress_transport,
"route-1",
relative,
published.job_directory,
)
observer.rescan()
in_progress = observer.status()
self.assertEqual(in_progress.fraction_complete, 0.5)
self.assertFalse(in_progress.complete)
self.assertEqual(in_progress.needed_items, 1)
self.assertIn("folder=route-1", in_progress_transport.posts[0])
self.assertIn("sub=.archive-control%2Fjobs%2F", in_progress_transport.posts[0])
complete = SyncthingTransferObserver(
FakeTransferTransport(
{"completion": 100},
{"progress": [], "queued": [], "rest": []},
),
"route-1",
relative,
published.job_directory,
).status()
self.assertTrue(complete.complete)
self.assertEqual(complete.bytes_complete, complete.bytes_total)
if __name__ == "__main__":
unittest.main()