Bug Fixes & Automated Testing - remove_failed_imports.py #patch

tests/utils/nest_functions/test_nest_functions.py

@@ -0,0 +1,53 @@
+# python3 -m pytest
+import pytest
+from src.utils.nest_functions import nested_set, add_keys_nested_dict, nested_get
+
+# import asyncio
+
+# Dictionary that is modified / queried as part of tests
+input_dict =              { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1992, 'actors': ['Weter', 'Waul', 'Wpacey']}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+
+# @pytest.mark.asyncio
+# async def test_nested_set():
+def test_nested_set():
+    expected_output    =  { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1994, 'actors': ['Weter', 'Waul', 'Wpacey']}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+    output = input_dict
+    # await nested_set(output, [2, 'data' ,'year'], 1994)
+    nested_set(output, [2, 'data' ,'year'], 1994)
+    assert expected_output == output
+
+def test_nested_set_conditions():
+    input               = { 1: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}],
+                            2: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}]}
+    expected_output     = { 1: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'high'}],
+                            2: [{'year': 2001, 'rating': 'high'}, {'year': 2002, 'rating': 'high'}, {'year': 2003, 'rating': 'LOW'}]}
+    output = input
+    nested_set(output, [2, 'rating'], 'LOW', {'year': 2003})
+    assert expected_output == output
+
+def test_nested_set_conditions_multiple():
+    input               = { 1: [{'rating': 'high', 'color': 1, 'stack': 1}, {'rating': 'high', 'color': 2, 'stack': 2}, {'rating': 'high', 'color': 2, 'stack': 1}]}
+    expected_output     = { 1: [{'rating': 'high', 'color': 1, 'stack': 1}, {'rating': 'high', 'color': 2, 'stack': 2}, {'rating': 'LOW', 'color': 2, 'stack': 1}]}
+    output = input
+    nested_set(output, [1, 'rating'], 'LOW', {'color': 2, 'stack': 1})
+    assert expected_output == output
+
+def test_add_keys_nested_dict():
+    expected_output    =  { 1: {'name': 'Breaking Bad 1', 'data': {'episodes': 3, 'year': 1991, 'actors': ['Peter', 'Paul', 'Ppacey']}}, 
+                            2: {'name': 'Breaking Bad 2', 'data': {'episodes': 6, 'year': 1994, 'actors': ['Weter', 'Waul', 'Wpacey'], 'spaceship': True}},
+                            3: {'name': 'Breaking Bad 3', 'data': {'episodes': 9, 'year': 1993, 'actors': ['Zeter', 'Zaul', 'Zpacey']}}}
+    output = input_dict
+    add_keys_nested_dict(output, [2, 'data' ,'spaceship'], True)
+    assert expected_output == output
+
+
+def test_nested_get():
+    input               = { 1: [{'name': 'A', 'color': 1, 'stack': 1}, {'name': 'B', 'color': 2, 'stack': 2}, {'name': 'C', 'color': 2, 'stack': 1}]}
+    expected_output     = ['C']
+    output =  nested_get(input[1], 'name', {'color': 2, 'stack': 1})
+    assert expected_output == output
+

tests/utils/remove_download/mock_data/mock_data_1.json

@@ -0,0 +1,11 @@
+{
+    "id": 1,
+    "downloadId": "A",
+    "title": "Sonarr Title 1",
+    "removal_messages": [
+        ">>>>> Tracked Download State: importBlocked",
+        ">>>>> Status Messages (matching specified patterns):",
+        ">>>>> - Episode XYZ was not found in the grabbed release: Sonarr Title 2.mkv",
+        ">>>>> - And yet another message"
+    ]
+}

tests/utils/remove_download/remove_download_utils.py

@@ -0,0 +1,52 @@
+import os
+os.environ['IS_IN_PYTEST'] = 'true'
+import logging
+import json
+import pytest
+from typing import Dict, Set, Any
+from src.utils.shared import remove_download
+from src.utils.trackers import Deleted_Downloads
+
+
+
+# Utility function to load mock data
+def load_mock_data(file_name):
+    with open(file_name, 'r') as file:
+        return json.load(file)
+
+async def mock_rest_delete() -> None:
+    logger.debug(f"Mock rest_delete called with URL")
+
+
+async def run_test(
+    settingsDict: Dict[str, Any], 
+    expected_removal_messages: Set[str],
+    failType: str,
+    removeFromClient: bool,
+    mock_data_file: str,
+    monkeypatch: pytest.MonkeyPatch,
+    caplog: pytest.LogCaptureFixture
+) -> None:
+    # Load mock data
+    affectedItem = load_mock_data(mock_data_file)
+
+    # Mock the `rest_delete` function
+    monkeypatch.setattr('src.utils.shared.rest_delete', mock_rest_delete)
+    
+    # Call the function
+    with caplog.at_level(logging.INFO):
+        # Call the function and assert no exceptions
+        try:   
+            deleted_downloads = Deleted_Downloads([]) 
+            await remove_download(settingsDict=settingsDict, BASE_URL='', API_KEY='', affectedItem=affectedItem, failType=failType, addToBlocklist=True, deleted_downloads=deleted_downloads, removeFromClient=removeFromClient)
+        except Exception as e:
+            pytest.fail(f"remove_download raised an exception: {e}")
+
+    # Assertions:
+    # Check that expected log messages are in the captured log
+    log_messages = {record.message for record in caplog.records if record.levelname == 'INFO'}
+
+    assert expected_removal_messages == log_messages
+
+    # Check that the affectedItem's downloadId was added to deleted_downloads
+    assert affectedItem['downloadId'] in deleted_downloads.dict

tests/utils/remove_download/test_remove_download_1.py

@@ -0,0 +1,33 @@
+
+import pytest
+from remove_download_utils import run_test
+# Parameters identical across all tests
+mock_data_file = 'tests/utils/remove_download/mock_data/mock_data_1.json'
+failType = 'failed import'
+
+@pytest.mark.asyncio
+async def test_removal_with_removal_messages(monkeypatch, caplog):
+    settingsDict = {'TEST_RUN': True}
+    removeFromClient = True
+    expected_removal_messages = {
+        '>>> Removing failed import download: Sonarr Title 1',
+        '>>>>> Tracked Download State: importBlocked',
+        '>>>>> Status Messages (matching specified patterns):',
+        '>>>>> - Episode XYZ was not found in the grabbed release: Sonarr Title 2.mkv',
+        '>>>>> - And yet another message'
+    }
+    await run_test(settingsDict=settingsDict, expected_removal_messages=expected_removal_messages, failType=failType, removeFromClient=removeFromClient, mock_data_file=mock_data_file, monkeypatch=monkeypatch, caplog=caplog)
+    
+
+@pytest.mark.asyncio
+async def test_schizophrenic_removal_with_removal_messages(monkeypatch, caplog):
+    settingsDict = {'TEST_RUN': True}
+    removeFromClient = False
+    expected_removal_messages = {
+        '>>> Removing failed import download (without removing from torrent client): Sonarr Title 1',
+        '>>>>> Tracked Download State: importBlocked',
+        '>>>>> Status Messages (matching specified patterns):',
+        '>>>>> - Episode XYZ was not found in the grabbed release: Sonarr Title 2.mkv',
+        '>>>>> - And yet another message'
+    }    
+    await run_test(settingsDict=settingsDict, expected_removal_messages=expected_removal_messages, failType=failType, removeFromClient=removeFromClient, mock_data_file=mock_data_file, monkeypatch=monkeypatch, caplog=caplog)