aa-structures 2.15.0__tar.gz → 2.16.0__tar.gz

{aa_structures-2.15.0 → aa_structures-2.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aa-structures
-Version: 2.15.0
+Version: 2.16.0
 Summary: App for managing Eve Online structures with Alliance Auth.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/__init__.py

@@ -3,5 +3,5 @@
 # pylint: disable = invalid-name
 default_app_config = "structures.apps.StructuresConfig"
 
-__version__ = "2.15.0"
+__version__ = "2.16.0"
 __title__ = "Structures"

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/constants.py

@@ -16,6 +16,7 @@ class EveCategoryId(IntEnum):
     ORBITAL = 46
     STARBASE = 23
     STRUCTURE = 65
+    STRUCTURE_MODULE = 66
 
 
 class EveGroupId(IntEnum):
@@ -26,11 +27,13 @@ class EveGroupId(IntEnum):
     ENGINEERING_COMPLEX = 1404
     FUEL_BLOCK = 1136
     ICE_PRODUCT = 423
-    REFINERY = 1406
+    MOON = 8
     PLANET = 7
+    QUANTUM_CORES = 4086
+    REFINERY = 1406
     STRUCTURE_CITADEL_SERVICE_MODULE = 1321
     UNCOMMON_MOON_ASTEROIDS = 1921
-    QUANTUM_CORES = 4086
+    UPWELL_MOON_DRILL = 4744
 
 
 class EveTypeId(IntEnum):
@@ -42,8 +45,8 @@ class EveTypeId(IntEnum):
     IHUB = 32458
     JUMP_GATE = 35841
     LIQUID_OZONE = 16273
-    ORBITAL_SKYHOOK = 81080
     NITROGEN_FUEL_BLOCK = 4051
+    ORBITAL_SKYHOOK = 81080
     STRONTIUM = 16275
     TCU = 32226
 

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/managers.py

@@ -392,7 +392,7 @@ class StructureManagerBase(models.Manager):
     def update_or_create_from_dict(
         self, structure: dict, owner: Owner
     ) -> Tuple[Any, bool]:
-        """update or create structure from given dict"""
+        """Update or create a structure from a dict."""
 
         eve_type: EveType = EveType.objects.get_or_create_esi(id=structure["type_id"])[
             0

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/models/owners.py

@@ -585,14 +585,10 @@ class Owner(models.Model):
         return positions
 
     def _fetch_upwell_structures(self, token: Token) -> bool:
-        """Fetch Upwell structures from ESI for self.
-
-        Return True if successful, else False.
-        """
-        is_ok = True
+        """Fetches Upwell structures from ESI an reports whether it was successful."""
         # fetch main list of structure for this corporation
         try:
-            structures: List[dict] = (
+            structures = (
                 esi.client.Corporation.get_corporations_corporation_id_structures(
                     corporation_id=self.corporation.corporation_id,
                     token=token.valid_access_token(),
@@ -604,58 +600,12 @@ class Owner(models.Model):
 
         # fetch additional information for structures
         if not structures:
+            is_ok = True
             logger.info("%s: No Upwell structures retrieved from ESI", self)
         else:
-            logger.info(
-                "%s: Fetching additional infos for %d Upwell structures from ESI",
-                self,
-                len(structures),
-            )
-            for structure in structures:
-                try:
-                    structure_info = (
-                        esi.client.Universe.get_universe_structures_structure_id(
-                            structure_id=structure["structure_id"],
-                            token=token.valid_access_token(),
-                        )
-                    ).results()
-                except OSError as ex:
-                    if isinstance(ex, HTTPForbidden):
-                        logger.error(
-                            "Failed to fetch structure with ID #%d belonging to %s, "
-                            "because the character '%s' is missing "
-                            "docking rights for it.",
-                            structure["structure_id"],
-                            self,
-                            token.character_name,
-                        )
-                    else:
-                        self._report_esi_issue(
-                            f"fetch structure #{structure['structure_id']}", ex, token
-                        )
-                    structure["name"] = "(no data)"
-                    is_ok = False
-                else:
-                    structure["name"] = Structure.extract_name_from_esi_response(
-                        structure_info["name"]
-                    )
-                    structure["position"] = structure_info["position"]
-
-            logger.info(
-                "%s: Storing updates for %d upwell structures",
-                self,
-                len(structures),
-            )
-            for structure in structures:
-                try:
-                    Structure.objects.update_or_create_from_dict(structure, self)
-                except OSError:
-                    logger.warning(
-                        "%s: Failed to store update for structure with ID %s",
-                        self,
-                        structure["structure_id"],
-                    )
-                    is_ok = False
+            is_ok = self._fetch_universe_infos_for_structures(token, structures)
+            is_ok &= self._store_structure_updates(structures)
+            self._resolve_metenox_moons()
 
         if STRUCTURES_DEVELOPER_MODE:
             self._store_raw_data("structures", structures)
@@ -666,6 +616,95 @@ class Owner(models.Model):
         )
         return is_ok
 
+    def _fetch_universe_infos_for_structures(
+        self, token, structures: List[dict]
+    ) -> bool:
+        count = 0
+        for s in structures:
+            try:
+                structure_info = (
+                    esi.client.Universe.get_universe_structures_structure_id(
+                        structure_id=s["structure_id"],
+                        token=token.valid_access_token(),
+                    )
+                ).results()
+            except OSError as ex:
+                if isinstance(ex, HTTPForbidden):
+                    logger.error(
+                        "Failed to fetch structure with ID #%d belonging to %s, "
+                        "because the character '%s' is missing docking rights.",
+                        s["structure_id"],
+                        self,
+                        token.character_name,
+                    )
+                else:
+                    self._report_esi_issue(
+                        f"fetch structure #{s['structure_id']}", ex, token
+                    )
+                s["name"] = "(no data)"
+            else:
+                count += 1
+                s["name"] = Structure.extract_name_from_esi_response(
+                    structure_info["name"]
+                )
+                s["position"] = structure_info["position"]
+
+        logger.info(
+            "%s: Fetched universe infos for %d / %d Upwell structures from ESI",
+            self,
+            count,
+            len(structures),
+        )
+        return count == len(structures)
+
+    def _store_structure_updates(self, structures: List[dict]) -> bool:
+        count = 0
+        for s in structures:
+            try:
+                Structure.objects.update_or_create_from_dict(s, self)
+            except OSError:
+                logger.warning(
+                    "%s: Failed to store update for structure with ID %s",
+                    self,
+                    s["structure_id"],
+                )
+            else:
+                count += 1
+        logger.info(
+            "%s: Stored updates for %d/%d upwell structures",
+            self,
+            count,
+            len(structures),
+        )
+        return count == len(structures)
+
+    def _resolve_metenox_moons(self):
+        """Add moons to all unresolved metenox structures."""
+        s: Structure
+        for s in self.structures.filter(
+            eve_type__eve_group=EveGroupId.UPWELL_MOON_DRILL,
+            eve_moon__isnull=True,
+            position_x__isnull=False,
+            position_y__isnull=False,
+            position_z__isnull=False,
+        ):
+            try:
+                celestial = s.eve_solar_system.nearest_celestial(
+                    x=s.position_x,
+                    y=s.position_y,
+                    z=s.position_z,
+                    group_id=EveGroupId.MOON,
+                )
+            except OSError:
+                continue
+
+            if not celestial or not isinstance(celestial.eve_object, EveMoon):
+                continue
+
+            s.eve_moon = celestial.eve_object
+            s.save()
+            logger.info("%s: Resolved moon for Metenox: %d", self, s.name)
+
     def _fetch_custom_offices(self, token: Token) -> bool:
         """Fetch custom offices from ESI for this owner.
 
@@ -1375,6 +1414,7 @@ class Owner(models.Model):
             s.eve_planet = celestial.eve_object
             s.name = celestial.eve_type.name
             s.save()
+            logger.info("%s: Resolved moon for Skyhook at: %s", self, s.eve_planet.name)
 
     @staticmethod
     def get_esi_scopes() -> List[str]:

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/tests/models/test_owners_2.py

@@ -2,6 +2,7 @@ import datetime as dt
 from unittest.mock import patch
 
 from django.utils.timezone import now, utc
+from eveuniverse.models import EveMoon
 
 from app_utils.esi_testing import EsiClientStub, EsiEndpoint
 from app_utils.testing import NoSocketsTestCase
@@ -10,6 +11,7 @@ from structures.constants import EveCorporationId
 from structures.core.notification_types import NotificationType
 from structures.models import Structure, StructureService
 from structures.tests import to_json
+from structures.tests.testdata.constants import EveMoonId, EveSolarSystemId, EveTypeId
 from structures.tests.testdata.factories import (
     EveEntityCorporationFactory,
     FuelAlertConfigFactory,
@@ -20,6 +22,7 @@ from structures.tests.testdata.factories import (
     UserMainDefaultOwnerFactory,
     WebhookFactory,
 )
+from structures.tests.testdata.helpers import NearestCelestial
 from structures.tests.testdata.load_eveuniverse import load_eveuniverse
 
 MODULE_PATH = "structures.models.owners"
@@ -40,54 +43,6 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
             id=EveCorporationId.DED, name="DED"
         )  # for notifications
         cls.endpoints = [
-            EsiEndpoint(
-                "Assets",
-                "get_corporations_corporation_id_assets",
-                "corporation_id",
-                needs_token=True,
-                data={
-                    str(cls.corporation_id): [
-                        {
-                            "is_singleton": False,
-                            "item_id": 1300000001001,
-                            "location_flag": "QuantumCoreRoom",
-                            "location_id": 1000000000001,
-                            "location_type": "item",
-                            "quantity": 1,
-                            "type_id": 56201,  # Astrahus Upwell Quantum Core
-                        },
-                        {
-                            "is_singleton": True,
-                            "item_id": 1300000001002,
-                            "location_flag": "ServiceSlot0",
-                            "location_id": 1000000000001,
-                            "location_type": "item",
-                            "quantity": 1,
-                            "type_id": 35894,  # Standup Cloning Center I
-                        },
-                        {
-                            "is_singleton": True,
-                            "item_id": 1300000002001,
-                            "location_flag": "ServiceSlot0",
-                            "location_id": 1000000000002,
-                            "location_type": "item",
-                            "quantity": 1,
-                            "type_id": 35894,  # Standup Cloning Center I
-                        },
-                    ],
-                    "2102": [
-                        {
-                            "is_singleton": False,
-                            "item_id": 1300000003001,
-                            "location_flag": "StructureFuel",
-                            "location_id": 1000000000004,
-                            "location_type": "item",
-                            "quantity": 5000,
-                            "type_id": 16273,  # Liquid Ozone
-                        }
-                    ],
-                },
-            ),
             EsiEndpoint(
                 "Corporation",
                 "get_corporations_corporation_id_structures",
@@ -110,8 +65,8 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                             "state_timer_end": None,
                             "state_timer_start": None,
                             "structure_id": 1000000000002,
-                            "system_id": 30002537,
-                            "type_id": 35835,  # Athanor
+                            "system_id": EveSolarSystemId.AMAMAKE,
+                            "type_id": EveTypeId.ATHANOR,
                             "unanchors_at": None,
                         },
                         {
@@ -131,8 +86,8 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                                 2020, 4, 5, 6, 30, tzinfo=utc
                             ),
                             "structure_id": 1000000000001,
-                            "system_id": 30002537,
-                            "type_id": 35832,  # Astrahus
+                            "system_id": EveSolarSystemId.AMAMAKE,
+                            "type_id": EveTypeId.ASTRAHUS,
                             "unanchors_at": dt.datetime(2020, 5, 5, 6, 30, tzinfo=utc),
                         },
                         {
@@ -148,7 +103,7 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                             "state_timer_start": None,
                             "structure_id": 1000000000003,
                             "system_id": 30000476,
-                            "type_id": 35832,  # Astrahus
+                            "type_id": EveTypeId.ASTRAHUS,
                             "unanchors_at": None,
                         },
                     ],
@@ -168,8 +123,8 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                             "y": 7310316270.0,
                             "z": -163686684205.0,
                         },
-                        "solar_system_id": 30002537,
-                        "type_id": 35832,  # Astrahus
+                        "solar_system_id": EveSolarSystemId.AMAMAKE,
+                        "type_id": EveTypeId.ASTRAHUS,
                     },
                     "1000000000002": {
                         "corporation_id": cls.corporation_id,
@@ -179,8 +134,8 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                             "y": -130157937025.56424,
                             "z": -442026427345.6355,
                         },
-                        "solar_system_id": 30002537,
-                        "type_id": 35835,  # Athanor
+                        "solar_system_id": EveSolarSystemId.AMAMAKE,
+                        "type_id": EveTypeId.ATHANOR,
                     },
                     "1000000000003": {
                         "corporation_id": cls.corporation_id,
@@ -191,7 +146,7 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
                             "z": -442026427345.6355,
                         },
                         "solar_system_id": 30000476,
-                        "type_id": 35832,  # Astrahus
+                        "type_id": EveTypeId.ASTRAHUS,
                     },
                 },
             ),
@@ -221,7 +176,7 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
         self.assertEqual(structure.position_x, 55028384780.0)
         self.assertEqual(structure.position_y, 7310316270.0)
         self.assertEqual(structure.position_z, -163686684205.0)
-        self.assertEqual(structure.eve_solar_system_id, 30002537)
+        self.assertEqual(structure.eve_solar_system_id, EveSolarSystemId.AMAMAKE)
         self.assertEqual(structure.eve_type_id, 35832)
         self.assertEqual(
             int(structure.owner.corporation.corporation_id), self.corporation_id
@@ -550,3 +505,92 @@ class TestUpdateStructuresEsi(NoSocketsTestCase):
             owner.update_structures_esi()
         # then
         self.assertEqual(structure.structure_fuel_alerts.count(), 0)
+
+
+@patch(MODULE_PATH + ".STRUCTURES_FEATURE_STARBASES", False)
+@patch(MODULE_PATH + ".STRUCTURES_FEATURE_CUSTOMS_OFFICES", False)
+@patch(MODULE_PATH + ".esi")
+class TestUpdateSpecificUpwellStructuresEsi(NoSocketsTestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        load_eveuniverse()
+        cls.user = UserMainDefaultOwnerFactory()
+        cls.owner = OwnerFactory(user=cls.user, structures_last_update_at=None)
+        cls.corporation_id = cls.owner.corporation.corporation_id
+        EveEntityCorporationFactory(
+            id=EveCorporationId.DED, name="DED"
+        )  # for notifications
+
+    def test_can_update_metenox(self, mock_esi):
+        structure_id = 1000000000111
+        type_id = EveTypeId.METENOX
+        solar_system_id = EveSolarSystemId.AMAMAKE
+        endpoints = [
+            EsiEndpoint(
+                "Corporation",
+                "get_corporations_corporation_id_structures",
+                "corporation_id",
+                needs_token=True,
+                data={
+                    str(self.corporation_id): [
+                        {
+                            "corporation_id": self.corporation_id,
+                            "fuel_expires": dt.datetime(2020, 3, 5, 5, tzinfo=utc),
+                            "next_reinforce_apply": None,
+                            "next_reinforce_hour": None,
+                            "profile_id": 101853,
+                            "reinforce_hour": 18,
+                            "services": [
+                                {"name": "Moon Drill", "state": "online"},
+                            ],
+                            "state": "shield_vulnerable",
+                            "state_timer_end": dt.datetime(2020, 4, 5, 7, tzinfo=utc),
+                            "state_timer_start": dt.datetime(
+                                2020, 4, 5, 6, 30, tzinfo=utc
+                            ),
+                            "structure_id": structure_id,
+                            "system_id": solar_system_id,
+                            "type_id": type_id,
+                            "unanchors_at": dt.datetime(2020, 5, 5, 6, 30, tzinfo=utc),
+                        },
+                    ],
+                },
+            ),
+            EsiEndpoint(
+                "Universe",
+                "get_universe_structures_structure_id",
+                "structure_id",
+                needs_token=True,
+                data={
+                    str(structure_id): {
+                        "corporation_id": self.corporation_id,
+                        "name": "Amamake - Mining",
+                        "position": {
+                            "x": 55028384780.0,
+                            "y": 7310316270.0,
+                            "z": -163686684205.0,
+                        },
+                        "solar_system_id": solar_system_id,
+                        "type_id": type_id,
+                    },
+                },
+            ),
+        ]
+        # given
+        mock_esi.client = EsiClientStub.create_from_endpoints(endpoints)
+        owner = OwnerFactory(user=self.user, structures_last_update_at=None)
+        moon = EveMoon.objects.get(id=EveMoonId.AMAMAKE_P2_M1)
+        # when
+        with patch(MODULE_PATH + ".EveSolarSystem.nearest_celestial") as m:
+            m.return_value = NearestCelestial(None, moon, 100)
+            owner.update_structures_esi()
+        # then
+        owner.refresh_from_db()
+        self.assertTrue(owner.is_structure_sync_fresh)
+        s = Structure.objects.get(id=structure_id)
+        self.assertEqual(s.name, "Mining")
+        self.assertEqual(s.eve_solar_system.id, EveSolarSystemId.AMAMAKE)
+        services = set(s.services.values_list("name", flat=True))
+        self.assertSetEqual({"Moon Drill"}, services)
+        self.assertEqual(s.eve_moon, moon)

aa_structures-2.16.0/structures/tests/testdata/constants.py

@@ -0,0 +1,22 @@
+from enum import IntEnum
+
+
+class EveTypeId(IntEnum):
+    """An EVE type ID."""
+
+    ASTRAHUS = 35832
+    ASTRAHUS_UPWELL_QUANTUM_CORE = 56201
+    ATHANOR = 35835
+    LIQUID_OZONE = 16273
+    METENOX = 81826
+    STANDUP_CLONING_CENTER_I = 35894
+    STANDUP_METENOX_MOON_DRILL = 82941
+    INTEGRATED_MOON_DRILL_ARMATURE = 81920
+
+
+class EveMoonId(IntEnum):
+    AMAMAKE_P2_M1 = 40161465
+
+
+class EveSolarSystemId(IntEnum):
+    AMAMAKE = 30002537

{aa_structures-2.15.0 → aa_structures-2.16.0}/structures/tests/testdata/create_eveuniverse.py

@@ -18,7 +18,7 @@ class CreateEveUniverseTestData(TestCase):
             ),
             ModelSpec(
                 "EveCategory",
-                ids=[EveCategoryId.ORBITAL],
+                ids=[EveCategoryId.ORBITAL, EveCategoryId.STRUCTURE_MODULE],
                 include_children=True,
             ),
             ModelSpec(
@@ -40,12 +40,10 @@ class CreateEveUniverseTestData(TestCase):
                     EveGroupId.FUEL_BLOCK,
                     EveGroupId.ICE_PRODUCT,
                     EveGroupId.QUANTUM_CORES,
-                    EveGroupId.STRUCTURE_CITADEL_SERVICE_MODULE,
                     EveGroupId.UNCOMMON_MOON_ASTEROIDS,
                 ],
                 include_children=True,
             ),
-            ModelSpec("EveType", ids=[], include_children=False),
             ModelSpec(
                 "EveSolarSystem",
                 ids=[30002506, 31000005, 30002537, 30000474, 30000476],