aa-ledger 1.0.3__py3-none-any.whl → 2.0.0__py3-none-any.whl

ledger/tests/test_views/test_add_ally.py

@@ -5,8 +5,7 @@ from http import HTTPStatus
 from unittest.mock import Mock, patch
 
 # Django
-from django.contrib.sessions.middleware import SessionMiddleware
-from django.test import RequestFactory, TestCase, override_settings
+from django.test import override_settings
 from django.urls import reverse
 
 # Alliance Auth
@@ -14,33 +13,22 @@ from allianceauth.eveonline.models import EveAllianceInfo
 from allianceauth.eveonline.providers import Alliance, ObjectNotFound
 
 # AA Ledger
-from ledger.tests.testdata.generate_corporationaudit import (
-    create_user_from_evecharacter,
+from ledger.tests import LedgerTestCase
+from ledger.tests.testdata.utils import (
+    add_new_permission_to_user,
 )
-from ledger.tests.testdata.load_allianceauth import load_allianceauth
-from ledger.tests.testdata.load_eveuniverse import load_eveuniverse
-from ledger.views.alliance.add_ally import add_ally
 
 MODULE_PATH = "ledger.views.alliance.add_ally"
 
 
 @patch(MODULE_PATH + ".messages")
 @override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
-class TestAddAllyView(TestCase):
+class TestAddAllyView(LedgerTestCase):
+    """Test Add Ally View."""
+
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
-        load_allianceauth()
-        load_eveuniverse()
-
-        cls.factory = RequestFactory()
-        cls.user, cls.character_ownership = create_user_from_evecharacter(
-            1001,
-            permissions=[
-                "ledger.basic_access",
-                "ledger.advanced_access",
-            ],
-        )
         cls.alliance = Alliance(
             id=3005,
             name="Test Alliance",
@@ -50,22 +38,24 @@ class TestAddAllyView(TestCase):
             faction_id=None,
         )
 
-    def _add_alliance(self, user, token):
-        request = self.factory.get(reverse("ledger:add_ally"))
-        request.user = user
-        request.token = token
-        middleware = SessionMiddleware(Mock())
-        middleware.process_request(request)
-        orig_view = add_ally.__wrapped__.__wrapped__.__wrapped__
-        return orig_view(request, token)
-
     def test_add_ally_already_exist(self, mock_messages):
-        # given
-        user = self.user
-        token = user.token_set.get(character_id=1001)
-        # when
-        response = self._add_alliance(user, token)
-        # then
+        """
+        Test adding an ally that already exists in the system.
+
+        This test ensures that when an ally that already exists in the system is
+        added again, the system correctly identifies it and provides appropriate
+        feedback to the user without attempting to create a duplicate entry.
+
+        ## Results: Redirects to alliance ledger with info message.
+        """
+        # Test Data
+        self.user = add_new_permission_to_user(self.user, "ledger.advanced_access")
+        token = self.user.token_set.get(character_id=1001)
+
+        # Test Action
+        response = self._add_alliance(self.user, token)
+
+        # Expected Results
         self.assertEqual(response.status_code, HTTPStatus.FOUND)
         self.assertEqual(response.url, reverse("ledger:alliance_ledger", args=[3001]))
         self.assertEqual(mock_messages.info.call_count, 1)
@@ -76,7 +66,17 @@ class TestAddAllyView(TestCase):
     def test_add_ally_does_not_exist(
         self, mock_get, mock_get_or_create, mock_provider, mock_messages
     ):
-        # given
+        """
+        Test adding an ally that does not exist in the system.
+
+        This test verifies that when an ally that does not exist in the system is
+        added, the system successfully creates a new entry and provides appropriate
+        feedback to the user.
+
+        ## Results: Ally is added successfully.
+        """
+        # Test Data
+        self.user = add_new_permission_to_user(self.user, "ledger.advanced_access")
         mock_get.side_effect = EveAllianceInfo.DoesNotExist
         mock_provider.get_alliance.return_value = self.alliance
 
@@ -87,11 +87,12 @@ class TestAddAllyView(TestCase):
         mock_ally.alliance_ticker = "T.E.S.T"
         mock_ally.executor_corp_id = 2001
         mock_get_or_create.return_value = (mock_ally, True)
-        user = self.user
-        token = user.token_set.get(character_id=1001)
-        # when
-        response = self._add_alliance(user, token)
-        # then
+        token = self.user.token_set.get(character_id=1001)
+
+        # Test Action
+        response = self._add_alliance(self.user, token)
+
+        # Expected Results
         self.assertEqual(response.status_code, HTTPStatus.FOUND)
         self.assertEqual(response.url, reverse("ledger:alliance_ledger", args=[3005]))
         self.assertEqual(mock_messages.success.call_count, 1)
@@ -105,15 +106,25 @@ class TestAddAllyView(TestCase):
     def test_add_ally_does_not_exist_object_not_found(
         self, mock_get, mock_get_or_create, mock_provider, mock_messages
     ):
-        # given
+        """
+        Test adding an ally that does not exist and is not found by the provider.
+
+        This test ensures that when an ally that does not exist in the system is
+        attempted to be added but is not found by the external provider, the system
+
+        ## Results: Redirects to alliance ledger with warning message.
+        """
+        # Test Data
+        self.user = add_new_permission_to_user(self.user, "ledger.advanced_access")
         mock_get.side_effect = EveAllianceInfo.DoesNotExist
         mock_provider.get_alliance.side_effect = ObjectNotFound(3001, "alliance")
 
-        user = self.user
-        token = user.token_set.get(character_id=1001)
-        # when
-        response = self._add_alliance(user, token)
-        # then
+        token = self.user.token_set.get(character_id=1001)
+
+        # Test Action
+        response = self._add_alliance(self.user, token)
+
+        # Expected Results
         self.assertEqual(response.status_code, HTTPStatus.FOUND)
         self.assertEqual(response.url, reverse("ledger:alliance_ledger", args=[3001]))
         self.assertEqual(mock_messages.warning.call_count, 1)

ledger/tests/test_views/test_add_char.py

@@ -2,21 +2,15 @@
 
 # Standard Library
 from http import HTTPStatus
-from unittest.mock import Mock, patch
+from unittest.mock import patch
 
 # Django
-from django.contrib.sessions.middleware import SessionMiddleware
-from django.test import RequestFactory, TestCase, override_settings
+from django.test import override_settings
 from django.urls import reverse
 
 # AA Ledger
-from ledger.models.characteraudit import CharacterAudit
-from ledger.tests.testdata.generate_characteraudit import (
-    create_user_from_evecharacter_with_access,
-)
-from ledger.tests.testdata.load_allianceauth import load_allianceauth
-from ledger.tests.testdata.load_eveuniverse import load_eveuniverse
-from ledger.views.character.add_char import add_char
+from ledger.models.characteraudit import CharacterOwner
+from ledger.tests import LedgerTestCase
 
 MODULE_PATH = "ledger.views.character.add_char"
 
@@ -24,38 +18,32 @@ MODULE_PATH = "ledger.views.character.add_char"
 @patch(MODULE_PATH + ".messages")
 @patch(MODULE_PATH + ".tasks")
 @override_settings(CELERY_ALWAYS_EAGER=True, CELERY_EAGER_PROPAGATES_EXCEPTIONS=True)
-class TestAddCharView(TestCase):
+class TestAddCharView(LedgerTestCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
-        load_allianceauth()
-        load_eveuniverse()
 
-        cls.factory = RequestFactory()
-        cls.user, cls.character_ownership = create_user_from_evecharacter_with_access(
-            1001
-        )
+    def test_add_char(self, mock_tasks, mock_messages):
+        """
+        Test adding a character that does not exist in the system.
 
-    def _add_character(self, user, token):
-        request = self.factory.get(reverse("ledger:add_char"))
-        request.user = user
-        request.token = token
-        middleware = SessionMiddleware(Mock())
-        middleware.process_request(request)
-        orig_view = add_char.__wrapped__.__wrapped__.__wrapped__
-        return orig_view(request, token)
+        This test verifies that when a character that does not exist in the system is
+        added, the system successfully creates a new entry and provides appropriate
+        feedback to the user.
 
-    def test_add_char(self, mock_tasks, mock_messages):
-        # given
-        user = self.user
-        token = user.token_set.get(character_id=1001)
-        # when
-        response = self._add_character(user, token)
-        # then
+        ## Results: Character is added successfully.
+        """
+        # Test Data
+        token = self.user.token_set.get(character_id=1001)
+
+        # Test Action
+        response = self._add_character(self.user, token)
+
+        # Expected Results
         self.assertEqual(response.status_code, HTTPStatus.FOUND)
         self.assertEqual(response.url, reverse("ledger:character_ledger", args=[1001]))
         self.assertTrue(mock_tasks.update_character.apply_async.called)
         self.assertTrue(mock_messages.info.called)
         self.assertTrue(
-            CharacterAudit.objects.filter(eve_character__character_id=1001).exists()
+            CharacterOwner.objects.filter(eve_character__character_id=1001).exists()
         )

ledger/tests/test_views/test_delete_character.py

@@ -5,40 +5,34 @@ import json
 from http import HTTPStatus
 
 # Django
-from django.test import RequestFactory, TestCase
 from django.urls import reverse
 
 # AA Ledger
-from ledger.tests.testdata.generate_characteraudit import (
-    add_characteraudit_character_to_user,
-    create_user_from_evecharacter_with_access,
+from ledger.tests import LedgerTestCase
+from ledger.tests.testdata.utils import (
+    create_owner_from_user,
 )
-
-# AA Skillfarm
-from ledger.tests.testdata.load_allianceauth import load_allianceauth
-from ledger.tests.testdata.load_eveuniverse import load_eveuniverse
 from ledger.views.character.character_ledger import character_delete
 
 MODULE_PATH = "ledger.views.character.character_ledger"
 
 
-class TestDeleteCharacterView(TestCase):
+class TestDeleteCharacterView(LedgerTestCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
-        load_allianceauth()
-        load_eveuniverse()
-
-        cls.factory = RequestFactory()
-        cls.user, cls.character_ownership = create_user_from_evecharacter_with_access(
-            1001
-        )
-        cls.audit = add_characteraudit_character_to_user(cls.user, 1001)
-        cls.no_audit_user, cls.character_ownership = (
-            create_user_from_evecharacter_with_access(1002)
-        )
+        cls.audit = create_owner_from_user(cls.user, owner_type="character")
 
     def test_delete_character(self):
+        """
+        Test deleting a character that the user has permission to delete.
+
+        This test verifies that when a user with the appropriate permissions
+        attempts to delete a character they own, the system successfully deletes
+        the character and provides appropriate feedback.
+
+        ## Results: Character is deleted successfully.
+        """
         character_id = self.audit.eve_character.character_id
 
         request = self.factory.post(reverse("ledger:delete_char", args=[character_id]))
@@ -53,8 +47,17 @@ class TestDeleteCharacterView(TestCase):
         self.assertEqual(response_data["message"], "Gneuten successfully deleted")
 
     def test_delete_character_no_permission(self):
+        """
+        Test deleting a character that the user does not have permission to delete.
+
+        This test verifies that when a user without the appropriate permissions
+        attempts to delete a character they do not own, the system prevents the
+        deletion and provides an appropriate error message.
+
+        ## Results: Permission Denied error is returned.
+        """
         request = self.factory.post(reverse("ledger:delete_char", args=[1001]))
-        request.user = self.no_audit_user
+        request.user = self.user2
 
         response = character_delete(request, character_id=1001)