|
| 1 | +import json |
| 2 | +from unittest.mock import call |
| 3 | + |
| 4 | +from shared.django_apps.core.models import Pull, PullStates |
| 5 | +from shared.django_apps.core.tests.factories import PullFactory, RepositoryFactory |
| 6 | + |
| 7 | +from tasks.flare_cleanup import FlareCleanupTask |
| 8 | + |
| 9 | + |
| 10 | +class TestFlareCleanupTask(object): |
| 11 | + def test_get_min_seconds_interval_between_executions(self): |
| 12 | + assert isinstance( |
| 13 | + FlareCleanupTask.get_min_seconds_interval_between_executions(), |
| 14 | + int, |
| 15 | + ) |
| 16 | + assert FlareCleanupTask.get_min_seconds_interval_between_executions() > 17000 |
| 17 | + |
| 18 | + def test_successful_run(self, transactional_db, mocker): |
| 19 | + mock_logs = mocker.patch("logging.Logger.info") |
| 20 | + mock_archive_service = mocker.patch( |
| 21 | + "shared.django_apps.utils.model_utils.ArchiveService" |
| 22 | + ) |
| 23 | + archive_value_for_flare = {"some": "data"} |
| 24 | + mock_archive_service.return_value.read_file.return_value = json.dumps( |
| 25 | + archive_value_for_flare |
| 26 | + ) |
| 27 | + mock_path = "path/to/written/object" |
| 28 | + mock_archive_service.return_value.write_json_data_to_storage.return_value = ( |
| 29 | + mock_path |
| 30 | + ) |
| 31 | + mock_archive_service_in_task = mocker.patch( |
| 32 | + "tasks.flare_cleanup.ArchiveService" |
| 33 | + ) |
| 34 | + mock_archive_service_in_task.return_value.delete_file.return_value = None |
| 35 | + |
| 36 | + local_value_for_flare = {"test": "test"} |
| 37 | + open_pull_with_local_flare = PullFactory( |
| 38 | + state=PullStates.OPEN.value, |
| 39 | + _flare=local_value_for_flare, |
| 40 | + repository=RepositoryFactory(), |
| 41 | + ) |
| 42 | + assert open_pull_with_local_flare.flare == local_value_for_flare |
| 43 | + assert open_pull_with_local_flare._flare == local_value_for_flare |
| 44 | + assert open_pull_with_local_flare._flare_storage_path is None |
| 45 | + |
| 46 | + closed_pull_with_local_flare = PullFactory( |
| 47 | + state=PullStates.CLOSED.value, |
| 48 | + _flare=local_value_for_flare, |
| 49 | + repository=RepositoryFactory(), |
| 50 | + ) |
| 51 | + assert closed_pull_with_local_flare.flare == local_value_for_flare |
| 52 | + assert closed_pull_with_local_flare._flare == local_value_for_flare |
| 53 | + assert closed_pull_with_local_flare._flare_storage_path is None |
| 54 | + |
| 55 | + open_pull_with_archive_flare = PullFactory( |
| 56 | + state=PullStates.OPEN.value, |
| 57 | + _flare=None, |
| 58 | + _flare_storage_path=mock_path, |
| 59 | + repository=RepositoryFactory(), |
| 60 | + ) |
| 61 | + assert open_pull_with_archive_flare.flare == archive_value_for_flare |
| 62 | + assert open_pull_with_archive_flare._flare is None |
| 63 | + assert open_pull_with_archive_flare._flare_storage_path == mock_path |
| 64 | + |
| 65 | + merged_pull_with_archive_flare = PullFactory( |
| 66 | + state=PullStates.MERGED.value, |
| 67 | + _flare=None, |
| 68 | + _flare_storage_path=mock_path, |
| 69 | + repository=RepositoryFactory(), |
| 70 | + ) |
| 71 | + assert merged_pull_with_archive_flare.flare == archive_value_for_flare |
| 72 | + assert merged_pull_with_archive_flare._flare is None |
| 73 | + assert merged_pull_with_archive_flare._flare_storage_path == mock_path |
| 74 | + |
| 75 | + task = FlareCleanupTask() |
| 76 | + task.run_cron_task(transactional_db) |
| 77 | + |
| 78 | + mock_logs.assert_has_calls( |
| 79 | + [ |
| 80 | + call("Starting FlareCleanupTask"), |
| 81 | + call("FlareCleanupTask cleared 1 _flares"), |
| 82 | + call("FlareCleanupTask will clear 1 Archive flares"), |
| 83 | + call("FlareCleanupTask cleared 1 Archive flares"), |
| 84 | + ] |
| 85 | + ) |
| 86 | + |
| 87 | + # there is a cache for flare on the object (all ArchiveFields have this), |
| 88 | + # so get a fresh copy of each object without the cached value |
| 89 | + open_pull_with_local_flare = Pull.objects.get(id=open_pull_with_local_flare.id) |
| 90 | + assert open_pull_with_local_flare.flare == local_value_for_flare |
| 91 | + assert open_pull_with_local_flare._flare == local_value_for_flare |
| 92 | + assert open_pull_with_local_flare._flare_storage_path is None |
| 93 | + |
| 94 | + closed_pull_with_local_flare = Pull.objects.get( |
| 95 | + id=closed_pull_with_local_flare.id |
| 96 | + ) |
| 97 | + assert closed_pull_with_local_flare.flare == {} |
| 98 | + assert closed_pull_with_local_flare._flare is None |
| 99 | + assert closed_pull_with_local_flare._flare_storage_path is None |
| 100 | + |
| 101 | + open_pull_with_archive_flare = Pull.objects.get( |
| 102 | + id=open_pull_with_archive_flare.id |
| 103 | + ) |
| 104 | + assert open_pull_with_archive_flare.flare == archive_value_for_flare |
| 105 | + assert open_pull_with_archive_flare._flare is None |
| 106 | + assert open_pull_with_archive_flare._flare_storage_path == mock_path |
| 107 | + |
| 108 | + merged_pull_with_archive_flare = Pull.objects.get( |
| 109 | + id=merged_pull_with_archive_flare.id |
| 110 | + ) |
| 111 | + assert merged_pull_with_archive_flare.flare == {} |
| 112 | + assert merged_pull_with_archive_flare._flare is None |
| 113 | + assert merged_pull_with_archive_flare._flare_storage_path is None |
| 114 | + |
| 115 | + mock_logs.reset_mock() |
| 116 | + # check that once these pulls are corrected they are not corrected again |
| 117 | + task = FlareCleanupTask() |
| 118 | + task.run_cron_task(transactional_db) |
| 119 | + |
| 120 | + mock_logs.assert_has_calls( |
| 121 | + [ |
| 122 | + call("Starting FlareCleanupTask"), |
| 123 | + call("FlareCleanupTask cleared 0 _flares"), |
| 124 | + call("FlareCleanupTask will clear 0 Archive flares"), |
| 125 | + call("FlareCleanupTask cleared 0 Archive flares"), |
| 126 | + ] |
| 127 | + ) |
0 commit comments