""" Tests for the Prowlarr source module. Tests the utility functions for parsing release metadata. """ # Import the functions to test import pytest from shelfmark.metadata_providers import BookMetadata from shelfmark.release_sources.prowlarr.api import ProwlarrClient from shelfmark.release_sources.prowlarr.source import ( ProwlarrSource, _detect_content_type_from_categories, _extract_format, _parse_size, ) from shelfmark.release_sources.prowlarr.utils import get_protocol_display, sanitize_download_url class _AvailableSource: display_name = "Prowlarr" def is_available(self): return True @pytest.fixture(autouse=True) def source_available_by_default(monkeypatch): import shelfmark.download.orchestrator as orchestrator monkeypatch.setattr(orchestrator, "get_source", lambda _source: _AvailableSource()) class TestParseSize: """Tests for the _parse_size function.""" def test_parse_size_bytes(self): """Test parsing small byte sizes.""" assert _parse_size(100) == "100 B" assert _parse_size(512) == "512 B" def test_parse_size_kilobytes(self): """Test parsing kilobyte sizes.""" assert _parse_size(1024) == "1.0 KB" assert _parse_size(2048) == "2.0 KB" assert _parse_size(1536) == "1.5 KB" def test_parse_size_megabytes(self): """Test parsing megabyte sizes.""" assert _parse_size(1048576) == "1.0 MB" assert _parse_size(5242880) == "5.0 MB" assert _parse_size(1572864) == "1.5 MB" def test_parse_size_gigabytes(self): """Test parsing gigabyte sizes.""" assert _parse_size(1073741824) == "1.0 GB" assert _parse_size(2147483648) == "2.0 GB" def test_parse_size_terabytes(self): """Test parsing terabyte sizes.""" assert _parse_size(1099511627776) == "1.0 TB" def test_parse_size_none(self): """Test that None returns None.""" assert _parse_size(None) is None def test_parse_size_zero(self): """Test that zero returns None.""" assert _parse_size(0) is None def test_parse_size_negative(self): """Test that negative values return None.""" assert _parse_size(-100) is None class TestExtractFormat: """Tests for the _extract_format function.""" def test_extract_format_from_extension(self): """Test extracting format from file extension.""" assert _extract_format("The Book.epub") == "epub" assert _extract_format("The Book.mobi") == "mobi" assert _extract_format("The Book.pdf") == "pdf" assert _extract_format("The Book.azw3") == "azw3" def test_extract_format_from_brackets(self): """Test extracting format from brackets.""" assert _extract_format("The Book [EPUB]") == "epub" assert _extract_format("The Book (PDF)") == "pdf" assert _extract_format("The Book {MOBI}") == "mobi" def test_extract_format_from_word(self): """Test extracting format as standalone word.""" assert _extract_format("The Book epub version") == "epub" assert _extract_format("mobi edition of the book") == "mobi" def test_extract_format_priority_extension_over_bracket(self): """Test that file extension takes priority over brackets.""" # Extension is more reliable assert _extract_format("The Book [PDF].epub") == "epub" def test_extract_format_case_insensitive(self): """Test that format extraction is case insensitive.""" assert _extract_format("The Book.EPUB") == "epub" assert _extract_format("The Book [PDF]") == "pdf" assert _extract_format("The Book.Mobi") == "mobi" def test_extract_format_none_when_no_format(self): """Test that None is returned when no format found.""" assert _extract_format("The Book by Author") is None assert _extract_format("") is None def test_extract_format_cbz_cbr(self): """Test comic book formats.""" assert _extract_format("Comic Issue 1.cbz") == "cbz" assert _extract_format("Comic Issue 2.cbr") == "cbr" def test_extract_format_fb2(self): """Test FB2 format (common in Russian ebooks).""" assert _extract_format("Russian Book.fb2") == "fb2" assert _extract_format("Book [FB2]") == "fb2" def test_extract_format_djvu(self): """Test DjVu format.""" assert _extract_format("Scanned Book.djvu") == "djvu" def test_extract_format_avoids_false_positives(self): """Test that format extraction doesn't match partial words.""" # "republic" should not match "pdf" or other formats assert _extract_format("The Republic by Plato") is None # "literal" should not match "lit" assert _extract_format("Literal Translation") is None class TestGetProtocolDisplay: """Tests for the get_protocol_display function.""" def test_get_protocol_from_protocol_field_torrent(self): """Test extracting torrent protocol from protocol field.""" result = {"protocol": "torrent", "downloadUrl": "https://example.com"} assert get_protocol_display(result) == "torrent" def test_get_protocol_from_protocol_field_usenet(self): """Test extracting usenet protocol from protocol field.""" result = {"protocol": "usenet", "downloadUrl": "https://example.com"} assert get_protocol_display(result) == "nzb" def test_get_protocol_from_magnet_url(self): """Test inferring torrent from magnet URL.""" result = {"downloadUrl": "magnet:?xt=urn:btih:abc123"} assert get_protocol_display(result) == "torrent" def test_get_protocol_from_torrent_url(self): """Test inferring torrent from .torrent URL.""" result = {"downloadUrl": "https://example.com/file.torrent"} assert get_protocol_display(result) == "torrent" def test_get_protocol_from_nzb_url(self): """Test inferring NZB from .nzb URL.""" result = {"downloadUrl": "https://example.com/file.nzb"} assert get_protocol_display(result) == "nzb" def test_get_protocol_fallback_to_magnet_url(self): """Test fallback to magnetUrl field.""" result = {"magnetUrl": "magnet:?xt=urn:btih:abc123"} assert get_protocol_display(result) == "torrent" def test_get_protocol_unknown(self): """Test unknown protocol for unclear URLs.""" result = {"downloadUrl": "https://example.com/download"} assert get_protocol_display(result) == "unknown" def test_get_protocol_case_insensitive(self): """Test protocol detection is case insensitive.""" result = {"protocol": "TORRENT"} assert get_protocol_display(result) == "torrent" result = {"protocol": "Usenet"} assert get_protocol_display(result) == "nzb" class TestSanitizeDownloadUrl: """Tests for the sanitize_download_url helper.""" def test_sanitizes_apikey_whitespace(self): """Strip whitespace around apikey separators.""" url = "http://prowlarr:9696/5/download?apikey = 12345" assert sanitize_download_url(url) == "http://prowlarr:9696/5/download?apikey=12345" def test_sanitizes_multiple_query_params(self): """Sanitize all query pairs while keeping params.""" url = "http://prowlarr:9696/5/download?apikey = 12345&indexer = 7" assert ( sanitize_download_url(url) == "http://prowlarr:9696/5/download?apikey=12345&indexer=7" ) def test_leaves_non_http_urls_untouched(self): """Do not modify magnet or other non-http URLs.""" url = "magnet:?xt=urn:btih:abc123" assert sanitize_download_url(url) == url def test_leaves_clean_urls_untouched(self): """Return clean URLs as-is.""" url = "https://prowlarr:9696/5/download?apikey=12345" assert sanitize_download_url(url) == url class TestDetectContentType: """Tests for the _detect_content_type_from_categories function.""" def test_fallback_without_categories(self): assert _detect_content_type_from_categories([], "ebook") == "book" assert _detect_content_type_from_categories([], "audiobook") == "audiobook" def test_audiobook_categories(self): assert _detect_content_type_from_categories([{"id": 3030}], "ebook") == "audiobook" assert _detect_content_type_from_categories([3000], "ebook") == "audiobook" def test_book_category_range(self): assert _detect_content_type_from_categories([{"id": 7000}], "ebook") == "book" assert _detect_content_type_from_categories([7020], "audiobook") == "book" assert _detect_content_type_from_categories([7030], "ebook") == "book" def test_non_book_categories_return_other(self): assert _detect_content_type_from_categories([{"id": 2000}], "ebook") == "other" class FakeTorznabClient: def __init__(self, search_results=None, seed_settings=None): self.calls: list[tuple[str, object]] = [] self.queries: list[str] = [] self.seed_settings_calls: list[object] = [] self.search_results = search_results or [] self.seed_settings = seed_settings or {} def get_enabled_indexers_detailed(self): return [ { "id": 1, "enable": True, "capabilities": { "categories": [ {"id": 7000, "subCategories": []}, {"id": 3030, "subCategories": []}, ] }, } ] def torznab_search( self, *, indexer_id: int, query: str, categories=None, search_type="book", limit=100, offset=0, ): del indexer_id, search_type, limit, offset self.calls.append((query, categories)) self.queries.append(query) return self.search_results def get_enriched_indexer_ids(self, restrict_to=None): del restrict_to return [] def get_indexer_seed_settings(self, restrict_to=None): self.seed_settings_calls.append(restrict_to) return self.seed_settings class TestProwlarrIndexerSeedSettings: def test_get_indexer_seed_settings_reads_prowlarr_minutes_field(self, monkeypatch): client = ProwlarrClient("http://prowlarr:9696", "apikey") monkeypatch.setattr( client, "get_enabled_indexers_detailed", lambda: [ { "id": 13, "protocol": "torrent", "fields": [ {"name": "torrentBaseSettings.seedRatio", "value": "2.5"}, {"name": "torrentBaseSettings.seedTime", "value": "7200"}, ], }, { "id": 14, "protocol": "usenet", "fields": [ {"name": "torrentBaseSettings.seedRatio", "value": "3"}, {"name": "torrentBaseSettings.seedTime", "value": "9999"}, ], }, ], ) assert client.get_indexer_seed_settings() == { 13: {"ratio_limit": 2.5, "seeding_time_limit_minutes": 7200} } class TestProwlarrLocalizedQueries: def test_manual_query_still_applies_content_type_categories(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient() source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"], manual_query="my custom") source.search(book, plan, content_type="audiobook") assert fake_client.calls == [("my custom", [3030])] def test_manual_query_expand_removes_categories(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient() source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"], manual_query="my custom") source.search(book, plan, expand_search=True, content_type="audiobook") assert fake_client.calls == [("my custom", None)] def test_search_attaches_configured_seed_time_minutes_to_release(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, "PROWLARR_USE_SEED_PREFERENCES": True, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient( search_results=[ { "guid": "mam-result-1", "protocol": "torrent", "title": "Test Release", "magnetUrl": "magnet:?xt=urn:btih:abc123", "indexerId": 1, "indexer": "MyAnonamouse", "minimumSeedTime": 259200, "minimumRatio": 1, } ], seed_settings={1: {"ratio_limit": 2.0, "seeding_time_limit_minutes": 7200}}, ) source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"]) releases = source.search(book, plan, content_type="ebook") assert len(releases) == 1 assert fake_client.seed_settings_calls == [None] assert releases[0].extra["configured_ratio_limit"] == 2.0 assert releases[0].extra["configured_seed_time_minutes"] == 7200 assert "minimum_seed_time" not in releases[0].extra assert "minimum_ratio" not in releases[0].extra def test_search_ignores_configured_seed_time_when_disabled(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, "PROWLARR_USE_SEED_PREFERENCES": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient( search_results=[ { "guid": "mam-result-1", "protocol": "torrent", "title": "Test Release", "magnetUrl": "magnet:?xt=urn:btih:abc123", "indexerId": 1, "indexer": "MyAnonamouse", } ], seed_settings={1: {"ratio_limit": 2.0, "seeding_time_limit_minutes": 7200}}, ) source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"]) releases = source.search(book, plan, content_type="ebook") assert len(releases) == 1 assert fake_client.seed_settings_calls == [] assert releases[0].extra["configured_ratio_limit"] is None assert releases[0].extra["configured_seed_time_minutes"] is None def test_redacted_search_result_still_builds_private_retry_payload(self, monkeypatch): import shelfmark.download.orchestrator as orchestrator import shelfmark.release_sources.prowlarr.source as prowlarr_source secret_download_url = "https://prowlarr.example.com/1/download?apikey=secret" def fake_get(key: str, default=None, user_id=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, "PROWLARR_USE_SEED_PREFERENCES": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) monkeypatch.setattr(orchestrator.config, "get", fake_get) fake_client = FakeTorznabClient( search_results=[ { "guid": "secret-prowlarr-release", "protocol": "usenet", "title": "Secret Bearing Release", "downloadUrl": secret_download_url, } ] ) source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"]) releases = source.search(book, plan, content_type="ebook") assert len(releases) == 1 assert releases[0].download_url is None captured_tasks = [] def fake_add(task): captured_tasks.append(task) return True monkeypatch.setattr(orchestrator.book_queue, "add", fake_add) success, error = orchestrator.queue_release(releases[0].__dict__) assert success is True assert error is None assert captured_tasks[0].retry_download_url == secret_download_url assert captured_tasks[0].retry_download_protocol == "usenet" assert "retry_download_url" not in orchestrator._task_to_dict(captured_tasks[0]) def test_search_uses_localized_titles_when_available(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient() source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="219252", title="The Lightning Thief", authors=["Rick Riordan"], titles_by_language={"hu": "A villámtolvaj"}, ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en", "hu"]) source.search(book, plan, content_type="ebook") assert "The Lightning Thief" in fake_client.queries assert "A villámtolvaj" in fake_client.queries assert len(fake_client.queries) == 2 def test_search_does_not_override_search_title_for_english(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": False, } return values.get(key, default) monkeypatch.setattr(prowlarr_source.config, "get", fake_get) fake_client = FakeTorznabClient() source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Mistborn: The Final Empire", search_title="The Final Empire", search_author="Brandon Sanderson", authors=["Brandon Sanderson"], titles_by_language={ "en": "Mistborn: The Final Empire", "hu": "A végső birodalom", }, ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en", "hu"]) source.search(book, plan, content_type="ebook") assert "The Final Empire" in fake_client.queries assert "A végső birodalom" in fake_client.queries assert "Mistborn: The Final Empire" not in fake_client.queries def test_auto_expand_logs_query_argument(self, monkeypatch): import shelfmark.release_sources.prowlarr.source as prowlarr_source def fake_get(key: str, default=None): values = { "PROWLARR_INDEXERS": "", "PROWLARR_AUTO_EXPAND": True, } return values.get(key, default) info_calls: list[tuple[str, tuple[object, ...]]] = [] monkeypatch.setattr(prowlarr_source.config, "get", fake_get) monkeypatch.setattr( prowlarr_source.logger, "info", lambda message, *args: info_calls.append((str(message), args)), ) fake_client = FakeTorznabClient() source = ProwlarrSource() monkeypatch.setattr(source, "_get_client", lambda: fake_client) book = BookMetadata( provider="hardcover", provider_id="123", title="Anything", authors=["Someone"], ) from shelfmark.core.search_plan import build_release_search_plan plan = build_release_search_plan(book, languages=["en"]) source.search(book, plan, content_type="ebook") query = fake_client.calls[0][0] assert fake_client.calls == [(query, [7000]), (query, None)] assert info_calls == [ ( "Prowlarr: no results for query '%s' with category filter, auto-expanding search", (query,), ) ] def test_get_column_config_ignores_indexer_lookup_failure(self, monkeypatch): source = ProwlarrSource() class FailingClient: def get_enabled_indexers_detailed(self): raise RuntimeError("indexers unavailable") monkeypatch.setattr(source, "_get_client", lambda: FailingClient()) monkeypatch.setattr(source, "_get_selected_indexer_ids", lambda: None) config = source.get_column_config() assert config.available_indexers is None assert config.default_indexers is None def test_resolve_indexer_ids_from_names_returns_none_on_lookup_failure(self): source = ProwlarrSource() class FailingClient: def get_enabled_indexers_detailed(self): raise RuntimeError("indexers unavailable") assert source._resolve_indexer_ids_from_names(FailingClient(), ["Alpha"]) is None def test_get_search_indexer_ids_returns_empty_on_lookup_failure(self): source = ProwlarrSource() class FailingClient: def get_enabled_indexers_detailed(self): raise RuntimeError("indexers unavailable") assert source._get_search_indexer_ids(FailingClient(), None, [7000]) == []