aa-killtracker 0.17.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

killtracker/tests/test_tasks.py

@@ -1,26 +1,31 @@
+import datetime as dt
 from unittest.mock import patch
 
-import celery
-import dhooks_lite
+from celery.exceptions import Retry
 
 from django.core.cache import cache
 from django.test import TestCase
-from django.test.utils import override_settings
+from django.utils.timezone import now
 
-from killtracker.exceptions import WebhookTooManyRequests
+from killtracker.core.discord import (
+    DiscordMessage,
+    HTTPError,
+    WebhookRateLimitExhausted,
+)
 from killtracker.models import EveKillmail
 from killtracker.tasks import (
+    ZKBTooManyRequestsError,
     delete_stale_killmails,
     generate_killmail_message,
     run_killtracker,
     run_tracker,
     send_messages_to_webhook,
-    send_test_message_to_webhook,
     store_killmail,
 )
 
 from .testdata.factories import TrackerFactory
 from .testdata.helpers import LoadTestDataMixin, load_eve_killmails, load_killmail
+from .utils import reset_celery_once_locks
 
 MODULE_PATH = "killtracker.tasks"
 
@@ -48,16 +53,13 @@ class TestTrackerBase(LoadTestDataMixin, TestCase):
         )
 
 
-@override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
+@patch(MODULE_PATH + ".workers.is_shutting_down", spec=True)
 @patch(MODULE_PATH + ".is_esi_online", spec=True)
 @patch(MODULE_PATH + ".delete_stale_killmails", spec=True)
 @patch(MODULE_PATH + ".store_killmail", spec=True)
 @patch(MODULE_PATH + ".Killmail.create_from_zkb_redisq")
 @patch(MODULE_PATH + ".run_tracker", spec=True)
 class TestRunKilltracker(TestTrackerBase):
-    def setUp(self) -> None:
-        cache.clear()
-
     @staticmethod
     def my_fetch_from_zkb():
         for killmail_id in [10000001, 10000002, 10000003, None]:
@@ -66,6 +68,9 @@ class TestRunKilltracker(TestTrackerBase):
             else:
                 yield None
 
+    def setUp(self):
+        reset_celery_once_locks()
+
     @patch(MODULE_PATH + ".KILLTRACKER_STORING_KILLMAILS_ENABLED", False)
     def test_should_run_normally(
         self,
@@ -74,35 +79,41 @@ class TestRunKilltracker(TestTrackerBase):
         mock_store_killmail,
         mock_delete_stale_killmails,
         mock_is_esi_online,
+        mock_is_shutting_down,
     ):
         # given
+        mock_is_shutting_down.return_value = False
         mock_create_from_zkb_redisq.side_effect = self.my_fetch_from_zkb()
         mock_is_esi_online.return_value = True
-        self.webhook_1.error_queue.enqueue(load_killmail(10000004).asjson())
+        self.webhook_1._error_queue.enqueue(load_killmail(10000004).asjson())
         # when
-        run_killtracker.delay()
+        got = run_killtracker()
         # then
+        self.assertEqual(got, 3)
         self.assertEqual(mock_run_tracker.delay.call_count, 6)
         self.assertEqual(mock_store_killmail.si.call_count, 0)
         self.assertFalse(mock_delete_stale_killmails.delay.called)
-        self.assertEqual(self.webhook_1.main_queue.size(), 1)
-        self.assertEqual(self.webhook_1.error_queue.size(), 0)
+        self.assertEqual(self.webhook_1._main_queue.size(), 1)
+        self.assertEqual(self.webhook_1._error_queue.size(), 0)
 
     @patch(MODULE_PATH + ".KILLTRACKER_STORING_KILLMAILS_ENABLED", False)
-    def test_should_stop_when_esi_is_offline(
+    def test_should_abort_when_esi_is_offline(
         self,
         mock_run_tracker,
         mock_create_from_zkb_redisq,
         mock_store_killmail,
         mock_delete_stale_killmails,
         mock_is_esi_online,
+        mock_is_shutting_down,
     ):
         # given
+        mock_is_shutting_down.return_value = False
         mock_create_from_zkb_redisq.side_effect = self.my_fetch_from_zkb()
         mock_is_esi_online.return_value = False
         # when
-        run_killtracker.delay()
+        got = run_killtracker()
         # then
+        self.assertEqual(got, 0)
         self.assertEqual(mock_run_tracker.delay.call_count, 0)
         self.assertEqual(mock_store_killmail.si.call_count, 0)
         self.assertFalse(mock_delete_stale_killmails.delay.called)
@@ -115,13 +126,16 @@ class TestRunKilltracker(TestTrackerBase):
         mock_store_killmail,
         mock_delete_stale_killmails,
         mock_is_esi_online,
+        mock_is_shutting_down,
     ):
         # given
+        mock_is_shutting_down.return_value = False
         mock_create_from_zkb_redisq.side_effect = self.my_fetch_from_zkb()
         mock_is_esi_online.return_value = True
         # when
-        run_killtracker.delay()
+        got = run_killtracker()
         # then
+        self.assertEqual(got, 2)
         self.assertEqual(mock_run_tracker.delay.call_count, 4)
 
     @patch(MODULE_PATH + ".KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS", 30)
@@ -133,17 +147,63 @@ class TestRunKilltracker(TestTrackerBase):
         mock_store_killmail,
         mock_delete_stale_killmails,
         mock_is_esi_online,
+        mock_is_shutting_down,
     ):
         # given
+        mock_is_shutting_down.return_value = False
         mock_create_from_zkb_redisq.side_effect = self.my_fetch_from_zkb()
         mock_is_esi_online.return_value = True
         # when
-        run_killtracker.delay()
+        run_killtracker()
         # then
         self.assertEqual(mock_run_tracker.delay.call_count, 6)
         self.assertEqual(mock_store_killmail.si.call_count, 3)
         self.assertTrue(mock_delete_stale_killmails.delay.called)
 
+    @patch(MODULE_PATH + ".KILLTRACKER_MAX_KILLMAILS_PER_RUN", 2)
+    def test_should_retry_when_too_many_errors_received(
+        self,
+        mock_run_tracker,
+        mock_create_from_zkb_redisq,
+        mock_store_killmail,
+        mock_delete_stale_killmails,
+        mock_is_esi_online,
+        mock_is_shutting_down,
+    ):
+        # given
+        mock_is_shutting_down.return_value = False
+        mock_create_from_zkb_redisq.side_effect = ZKBTooManyRequestsError(
+            now() + dt.timedelta(minutes=1)
+        )
+        mock_is_esi_online.return_value = True
+        # when/then
+        with self.assertRaises(Retry):
+            run_killtracker()
+        # then
+        self.assertEqual(mock_run_tracker.delay.call_count, 0)
+
+    @patch(MODULE_PATH + ".KILLTRACKER_STORING_KILLMAILS_ENABLED", False)
+    def test_should_abort_when_worker_is_offline(
+        self,
+        mock_run_tracker,
+        mock_create_from_zkb_redisq,
+        mock_store_killmail,
+        mock_delete_stale_killmails,
+        mock_is_esi_online,
+        mock_is_shutting_down,
+    ):
+        # given
+        mock_is_shutting_down.return_value = True
+        mock_create_from_zkb_redisq.side_effect = self.my_fetch_from_zkb()
+        mock_is_esi_online.return_value = True
+        # when
+        got = run_killtracker()
+        # then
+        self.assertEqual(got, 0)
+        self.assertEqual(mock_run_tracker.delay.call_count, 0)
+        self.assertEqual(mock_store_killmail.si.call_count, 0)
+        self.assertFalse(mock_delete_stale_killmails.delay.called)
+
 
 @patch(MODULE_PATH + ".retry_task_if_esi_is_down", lambda x: None)
 @patch(MODULE_PATH + ".send_messages_to_webhook", spec=True)
@@ -189,7 +249,7 @@ class TestRunTracker(TestTrackerBase):
         # given
         killmail = load_killmail(10000003)
         killmail.save()
-        self.webhook_1.enqueue_message(content="test")
+        self.webhook_1.enqueue_message(DiscordMessage(content="test"))
         # when
         run_tracker(self.tracker_1.pk, killmail.id)
         # then
@@ -222,7 +282,7 @@ class TestGenerateKillmailMessage(TestTrackerBase):
         generate_killmail_message(self.tracker_1.pk, self.killmail_id)
         # then
         self.assertTrue(mock_send_messages_to_webhook.delay.called)
-        self.assertEqual(self.webhook_1.main_queue.size(), 1)
+        self.assertEqual(self.webhook_1._main_queue.size(), 1)
         self.assertFalse(mock_retry.called)
 
     @patch(MODULE_PATH + ".KILLTRACKER_GENERATE_MESSAGE_MAX_RETRIES", 3)
@@ -238,87 +298,114 @@ class TestGenerateKillmailMessage(TestTrackerBase):
         with self.assertRaises(RuntimeError):
             generate_killmail_message(self.tracker_1.pk, self.killmail_id)
         self.assertFalse(mock_send_messages_to_webhook.delay.called)
-        self.assertEqual(self.webhook_1.main_queue.size(), 0)
+        self.assertEqual(self.webhook_1._main_queue.size(), 0)
         self.assertEqual(mock_retry.call_count, 4)
 
 
-@patch("celery.app.task.Context.called_directly", False)  # make retry work with eager
-@override_settings(CELERY_ALWAYS_EAGER=True)
-@patch(MODULE_PATH + ".Webhook.send_message_to_webhook", spec=True)
+# @patch("celery.app.task.Context.called_directly", False)  # make retry work with eager
+# @override_settings(CELERY_ALWAYS_EAGER=True)
+
+
+@patch(MODULE_PATH + ".workers.is_shutting_down", spec=True)
+@patch(MODULE_PATH + ".Webhook.send_message", spec=True)
 class TestSendMessagesToWebhook(TestTrackerBase):
     def setUp(self) -> None:
         cache.clear()
 
-    def test_one_message(self, mock_send_message_to_webhook):
-        """when one message in queue, then send it and retry with delay"""
+    def test_should_send_one_message(self, mock_send_message, mock_is_shutting_down):
         # given
-        mock_send_message_to_webhook.return_value = dhooks_lite.WebhookResponse(
-            {}, status_code=200
-        )
-        self.webhook_1.enqueue_message(content="Test message")
+        mock_is_shutting_down.return_value = False
+        mock_send_message.return_value = 42
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
         # when
-        send_messages_to_webhook.delay(self.webhook_1.pk)
+        send_messages_to_webhook(self.webhook_1.pk)
         # then
-        self.assertEqual(mock_send_message_to_webhook.call_count, 1)
-        self.assertEqual(self.webhook_1.main_queue.size(), 0)
-        self.assertEqual(self.webhook_1.error_queue.size(), 0)
+        self.assertEqual(mock_send_message.call_count, 1)
+        self.assertEqual(self.webhook_1._main_queue.size(), 0)
+        self.assertEqual(self.webhook_1._error_queue.size(), 0)
 
-    def test_three_message(self, mock_send_message_to_webhook):
-        """when three messages in queue, then sends them and returns 3"""
+    def test_should_send_three_messages(self, mock_send_message, mock_is_shutting_down):
         # given
-        mock_send_message_to_webhook.return_value = dhooks_lite.WebhookResponse(
-            {}, status_code=200
-        )
-        self.webhook_1.enqueue_message(content="Test message")
-        self.webhook_1.enqueue_message(content="Test message")
-        self.webhook_1.enqueue_message(content="Test message")
+        mock_is_shutting_down.return_value = False
+        mock_send_message.return_value = [1, 2, 3]
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
         # when
-        send_messages_to_webhook.delay(self.webhook_1.pk)
+        send_messages_to_webhook(self.webhook_1.pk)
         # then
-        self.assertEqual(mock_send_message_to_webhook.call_count, 3)
-        self.assertEqual(self.webhook_1.main_queue.size(), 0)
-        self.assertEqual(self.webhook_1.error_queue.size(), 0)
+        self.assertEqual(mock_send_message.call_count, 3)
+        self.assertEqual(self.webhook_1._main_queue.size(), 0)
+        self.assertEqual(self.webhook_1._error_queue.size(), 0)
 
-    def test_no_messages(self, mock_send_message_to_webhook):
-        """when no messages in queue, then do nothing"""
+    def test_should_do_nothing_when_queue_is_empty(
+        self, mock_send_message, mock_is_shutting_down
+    ):
         # given
-        mock_send_message_to_webhook.return_value = dhooks_lite.WebhookResponse(
-            {}, status_code=200
-        )
+        mock_is_shutting_down.return_value = False
         # when
-        send_messages_to_webhook.delay(self.webhook_1.pk)
+        send_messages_to_webhook(self.webhook_1.pk)
         # then
-        self.assertEqual(mock_send_message_to_webhook.call_count, 0)
-        self.assertEqual(self.webhook_1.main_queue.size(), 0)
-        self.assertEqual(self.webhook_1.error_queue.size(), 0)
+        self.assertEqual(mock_send_message.call_count, 0)
+        self.assertEqual(self.webhook_1._main_queue.size(), 0)
+        self.assertEqual(self.webhook_1._error_queue.size(), 0)
 
-    def test_failed_message(self, mock_send_message_to_webhook):
-        """when message sending failed, then put message in error queue"""
+    def test_should_put_failed_message_in_error_queue(
+        self, mock_send_message, mock_is_shutting_down
+    ):
         # given
-        mock_send_message_to_webhook.return_value = dhooks_lite.WebhookResponse(
-            {}, status_code=404
-        )
-        self.webhook_1.enqueue_message(content="Test message")
+        mock_is_shutting_down.return_value = False
+        mock_send_message.side_effect = HTTPError(404)
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
         # when
-        send_messages_to_webhook.delay(self.webhook_1.pk)
+        send_messages_to_webhook(self.webhook_1.pk)
         # then
-        self.assertEqual(mock_send_message_to_webhook.call_count, 1)
-        self.assertEqual(self.webhook_1.main_queue.size(), 0)
-        self.assertEqual(self.webhook_1.error_queue.size(), 1)
+        self.assertEqual(mock_send_message.call_count, 1)
+        self.assertEqual(self.webhook_1._main_queue.size(), 0)
+        self.assertEqual(self.webhook_1._error_queue.size(), 1)
 
-    def test_abort_on_too_many_requests(self, mock_send_message_to_webhook):
-        """
-        when WebhookTooManyRequests exception is raised
-        then message is re-queued and retry once
-        """
+    def test_should_retry_on_too_many_requests_error(
+        self, mock_send_message, mock_is_shutting_down
+    ):
         # given
-        mock_send_message_to_webhook.side_effect = WebhookTooManyRequests(10)
-        self.webhook_1.enqueue_message(content="Test message")
+        mock_is_shutting_down.return_value = False
+        mock_send_message.side_effect = WebhookRateLimitExhausted(10)
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
         # when
-        send_messages_to_webhook.delay(self.webhook_1.pk)
+        with self.assertRaises(Retry):
+            send_messages_to_webhook(self.webhook_1.pk)
         # then
-        self.assertEqual(mock_send_message_to_webhook.call_count, 1)
-        self.assertEqual(self.webhook_1.main_queue.size(), 1)
+        self.assertEqual(mock_send_message.call_count, 1)
+        self.assertEqual(self.webhook_1._main_queue.size(), 1)
+
+    def test_should_abort_when_worker_is_shutting_down(
+        self, mock_send_message, mock_is_shutting_down
+    ):
+        # given
+        mock_is_shutting_down.return_value = True
+        mock_send_message.return_value = 42
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
+        # when
+        send_messages_to_webhook(self.webhook_1.pk)
+        # then
+        self.assertEqual(mock_send_message.call_count, 0)
+        self.assertEqual(self.webhook_1._main_queue.size(), 1)
+
+    @patch(MODULE_PATH + ".KILLTRACKER_MAX_MESSAGES_SENT_PER_RUN", 1)
+    def test_retry_when_limit_is_reached(
+        self, mock_send_message, mock_is_shutting_down
+    ):
+        # given
+        mock_is_shutting_down.return_value = False
+        mock_send_message.return_value = [1, 2]
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
+        self.webhook_1.enqueue_message(DiscordMessage(content="Test message"))
+        # when
+        with self.assertRaises(Retry):
+            send_messages_to_webhook(self.webhook_1.pk)
+        # then
+        self.assertEqual(mock_send_message.call_count, 1)
+        self.assertEqual(self.webhook_1._main_queue.size(), 1)
 
 
 @patch(MODULE_PATH + ".logger", spec=True)
@@ -347,24 +434,6 @@ class TestStoreKillmail(TestTrackerBase):
         self.assertTrue(mock_logger.warning.called)
 
 
-@override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
-@patch("killtracker.models.webhooks.dhooks_lite.Webhook.execute", spec=True)
-@patch(MODULE_PATH + ".logger", spec=True)
-class TestSendTestKillmailsToWebhook(TestTrackerBase):
-    def setUp(self) -> None:
-        self.webhook_1.main_queue.clear()
-
-    def test_run_normal(self, mock_logger, mock_execute):
-        # given
-        mock_execute.return_value = dhooks_lite.WebhookResponse({}, status_code=200)
-        # when
-        with self.assertRaises(celery.exceptions.Retry):
-            send_test_message_to_webhook.delay(self.webhook_1.pk)
-        # then
-        self.assertTrue(mock_execute.called)
-        self.assertFalse(mock_logger.error.called)
-
-
 @patch(MODULE_PATH + ".EveKillmail.objects.delete_stale")
 class TestDeleteStaleKillmails(TestTrackerBase):
     def test_normal(self, mock_delete_stale):

killtracker/tests/test_utils.py

@@ -0,0 +1,39 @@
+from unittest import TestCase
+
+from .utils import CacheFake
+
+
+class TestCacheFake(TestCase):
+    def test_get_should_return_value_when_found(self):
+        cache = CacheFake()
+        cache.set("alpha", 5)
+        got = cache.get("alpha")
+        self.assertEqual(got, 5)
+
+    def test_get_should_return_default_when_not_found(self):
+        cache = CacheFake()
+        cache.set("alpha", 5)
+        got = cache.get("bravo", 99)
+        self.assertEqual(got, 99)
+
+    def test_delete_should_remove_key(self):
+        cache = CacheFake()
+        cache.set("alpha", 5)
+        cache.delete("alpha")
+        self.assertIsNone(cache.get("alpha"))
+
+    def test_delete_should_ignore_when_key_does_not_exist(self):
+        cache = CacheFake()
+        cache.delete("alpha")
+
+    def test_clear_should_remove_all_keys(self):
+        cache = CacheFake()
+        cache.set("alpha", 5)
+        cache.clear()
+        self.assertIsNone(cache.get("alpha"))
+
+    def test_set_with_timeout(self):
+        cache = CacheFake()
+        cache.set("alpha", "django", timeout=5)
+        got = cache.get("alpha")
+        self.assertEqual(got, "django")

killtracker/tests/testdata/factories.py

@@ -14,7 +14,7 @@ from allianceauth.eveonline.models import EveFactionInfo
 
 from killtracker.app_settings import KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER
 from killtracker.constants import EveCategoryId
-from killtracker.core.killmails import (
+from killtracker.core.zkb import (
     Killmail,
     KillmailAttacker,
     KillmailPosition,

killtracker/tests/testdata/helpers.py

@@ -8,7 +8,7 @@ from eveuniverse.models import EveEntity, EveType, EveUniverseEntityModel
 from allianceauth.eveonline.models import EveAllianceInfo, EveCorporationInfo
 from allianceauth.tests.auth_utils import AuthUtils
 
-from killtracker.core.killmails import Killmail
+from killtracker.core.zkb import Killmail
 from killtracker.models import EveKillmail, Webhook
 
 from . import _current_dir

killtracker/tests/utils.py

@@ -0,0 +1,44 @@
+import logging
+from typing import Any, Dict
+
+from app_utils.allianceauth import get_redis_client
+
+logger = logging.getLogger(__name__)
+
+
+def reset_celery_once_locks():
+    """Reset celery once locks for given tasks."""
+    r = get_redis_client()
+    app_label = "killtracker"
+    if keys := r.keys(f":?:qo_{app_label}.*"):
+        deleted_count = r.delete(*keys)
+        logger.info("Removed %d stuck celery once keys", deleted_count)
+    else:
+        deleted_count = 0
+
+
+class CacheFake:
+    """A fake for replacing Django's cache in tests."""
+
+    def __init__(self):
+        self._cache: Dict[str, Any] = {}
+
+    def clear(self) -> None:
+        self._cache.clear()
+
+    def delete(self, key: str, version: int = None) -> None:
+        try:
+            del self._cache[key]
+        except KeyError:
+            pass
+
+    def get(self, key: str, default: Any = None, version: int = None) -> Any:
+        try:
+            return self._cache[key]
+        except KeyError:
+            return default
+
+    def set(
+        self, key: str, value: Any, timeout: int = None, version: int = None
+    ) -> None:
+        self._cache[key] = value

killtracker/exceptions.py

@@ -1,32 +0,0 @@
-"""Custom exceptions for killtracker."""
-
-from typing import Optional
-
-
-class KilltrackerException(Exception):
-    """Exception from Killtracker"""
-
-
-class WebhookTooManyRequests(KilltrackerException):
-    """Webhook is temporarily blocked."""
-
-    DEFAULT_RESET_AFTER = 600
-
-    def __init__(self, retry_after: Optional[int] = None) -> None:
-        """
-        Parameters:
-        - retry_after: time in seconds until this blockage will be reset
-        """
-        super().__init__()
-        if retry_after is None:
-            retry_after = self.DEFAULT_RESET_AFTER
-        self._reset_after = int(retry_after)
-
-    @property
-    def retry_after(self) -> int:
-        """Return in how many seconds to retry."""
-        return self._reset_after
-
-
-class KillmailDoesNotExist(KilltrackerException):
-    """Killmail does not exist in storage."""