Merge pull request #55 from synkd/implement_session-scoped_inventory

Use session-scoped inventory by default

Author: synkd

manifester/commands.py

@@ -80,7 +80,8 @@ def inventory(details, sync, offline_token):
     border = "-" * 38
     if sync:
         helpers.update_inventory(
-            Manifester(minimal_init=True, offline_token=offline_token).subscription_allocations
+            Manifester(minimal_init=True, offline_token=offline_token).subscription_allocations,
+            sync=True,
         )
     inv = helpers.load_inventory_file(Path(settings.inventory_path))
     if not details:

manifester/helpers.py

@@ -171,15 +171,43 @@ def load_inventory_file(file):
             return yaml.load(f, Loader=yaml.FullLoader) or []
 
 
-def update_inventory(inventory_data):
+def _dump_inventory_file(inventory_path, inventory):
+    """Write inventory data to local inventory file."""
+    with inventory_path.open("w") as inventory_file:
+        yaml.dump(inventory, inventory_file, allow_unicode=True)
+
+
+def _update_inventory(inventory_path, inventory, allocation):
+    """Add new allocation, remove and recreate inventory file."""
+    inventory.append(allocation)
+    inventory_path.unlink()
+    inventory_path.touch()
+    _dump_inventory_file(inventory_path, inventory)
+
+
+def update_inventory(inventory_data, sync=False, remove=False, uuid=None):
     """Replace the existing inventory file with current subscription allocations."""
     inventory_path = Path(settings.inventory_path)
-    if load_inventory_file(inventory_path):
-        inventory_path.unlink()
-    inventory_path.touch()
-    if inventory_data != []:
-        with inventory_path.open("w") as inventory_file:
-            yaml.dump(inventory_data, inventory_file, allow_unicode=True)
+    if sync:
+        if load_inventory_file(inventory_path):
+            inventory_path.unlink()
+        inventory_path.touch()
+        if inventory_data != []:
+            _dump_inventory_file(inventory_path, inventory_data)
+    elif remove:
+        inv = load_inventory_file(inventory_path)
+        _dump_inventory_file(inventory_path, [alloc for alloc in inv if uuid not in alloc["uuid"]])
+    else:
+        current_allocation = next(
+            iter([alloc for alloc in inventory_data if alloc["uuid"] == uuid])
+        )
+        inv = load_inventory_file(inventory_path)
+        uuids = [alloc["uuid"] for alloc in inv]
+        if current_allocation["uuid"] not in uuids:
+            _update_inventory(inventory_path, inv, current_allocation)
+        else:
+            inv = [alloc for alloc in inv if uuid not in alloc["uuid"]]
+            _update_inventory(inventory_path, inv, current_allocation)
 
 
 def fake_http_response_code(good_codes=None, bad_codes=None, fail_rate=0):

manifester/manifester.py

@@ -170,7 +170,9 @@ def create_subscription_allocation(self):
             cmd_kwargs=allocation_data,
         ).json()
         logger.debug(f"Received response {self.allocation} when attempting to create allocation.")
-        self.allocation_uuid = self.allocation["body"]["uuid"]
+        self.allocation_uuid = (
+            self.allocation.uuid if self.is_mock else self.allocation["body"]["uuid"]
+        )
         if self.simple_content_access == "disabled":
             simple_retry(
                 self.requester.put,
@@ -185,7 +187,7 @@ def create_subscription_allocation(self):
             f"Subscription allocation created with name {self.allocation_name} "
             f"and UUID {self.allocation_uuid}"
         )
-        update_inventory(self.subscription_allocations)
+        update_inventory(self.subscription_allocations, uuid=self.allocation_uuid)
         return self.allocation_uuid
 
     def delete_subscription_allocation(self, uuid=None):
@@ -196,14 +198,14 @@ def delete_subscription_allocation(self, uuid=None):
             "proxies": self.manifest_data.get("proxies"),
             "params": {"force": "true"},
         }
-        if self.is_mock:
-            self.allocation_uuid = self.allocation_uuid.uuid
         response = simple_retry(
             self.requester.delete,
             cmd_args=[f"{self.allocations_url}/{uuid if uuid else self.allocation_uuid}"],
             cmd_kwargs=data,
         )
-        update_inventory(self.subscription_allocations)
+        update_inventory(
+            self.subscription_allocations, remove=True, uuid=uuid if uuid else self.allocation_uuid
+        )
         return response
 
     def add_entitlements_to_allocation(self, pool_id, entitlement_quantity):
@@ -322,15 +324,15 @@ def process_subscription_pools(self, subscription_pools, subscription_data):
                             f"{subscription_data['name']} to the allocation."
                         )
                         self._active_pools.append(match)
-                        update_inventory(self.subscription_allocations)
+                        update_inventory(self.subscription_allocations, uuid=self.allocation_uuid)
                         break
                 elif add_entitlements.status_code == SUCCESS_CODE:
                     logger.debug(
                         f"Successfully added {subscription_data['quantity']} entitlements of "
                         f"{subscription_data['name']} to the allocation."
                     )
                     self._active_pools.append(match)
-                    update_inventory(self.subscription_allocations)
+                    update_inventory(self.subscription_allocations, uuid=self.allocation_uuid)
                     break
                 else:
                     raise RuntimeError(
@@ -405,11 +407,8 @@ def trigger_manifest_export(self):
         local_file.write_bytes(manifest.content)
         manifest.path = local_file
         manifest.name = self.manifest_name
-        if self.is_mock:
-            manifest.uuid = self.allocation_uuid.uuid
-        else:
-            manifest.uuid = self.allocation_uuid
-        update_inventory(self.subscription_allocations)
+        manifest.uuid = self.allocation_uuid
+        update_inventory(self.subscription_allocations, uuid=self.allocation_uuid)
         return manifest
 
     def get_manifest(self):
@@ -437,4 +436,3 @@ def __enter__(self):
     def __exit__(self, *tb_args):
         """Deletes subscription allocation on teardown unless using CLI."""
         self.delete_subscription_allocation()
-        update_inventory(self.subscription_allocations)

tests/test_manifester.py

@@ -82,11 +82,13 @@
             + "".join(random.choices(string.ascii_letters, k=8)),
             "type": "Satellite",
             "version": f"{MANIFEST_DATA['sat_version']}",
-            "entitlementQuantity": sum(d["quantity"] for d in MANIFEST_DATA["subscription_data"]),
-            "url": f"{MANIFEST_DATA['url']['allocations']}/{SUB_ALLOCATION_UUID}",
+            "entitlementsAttachedQuantity": sum(
+                d["quantity"] for d in MANIFEST_DATA["subscription_data"]
+            ),
             "simpleContentAccess": f"{MANIFEST_DATA['simple_content_access']}",
         }
-    ]
+    ],
+    "status_code": 200,
 }
 
 
@@ -148,9 +150,9 @@ def get(self, *args, **kwargs):
                 self.pool_response["body"] += SUB_POOL_RESPONSE["body"]
                 return self
         if args[0].endswith("allocations") and self._has_offset:
-            if kwargs["params"]["offset"] != 50:
+            if kwargs["params"]["offset"] != 100:
                 self.allocations_response = {"body": []}
-                for _x in range(50):
+                for _x in range(100):
                     self.allocations_response["body"].append(
                         {
                             "uuid": f"{uuid.uuid4().hex}",
@@ -197,6 +199,15 @@ def delete(self, *args, **kwargs):
             self._good_codes = [204]
             return self
 
+    def __repr__(self):
+        """Return a string representation of the RhsmApiStub instance."""
+        inner = ", ".join(
+            f"{k}={v}"
+            for k, v in self.__dict__.items()
+            if not k.startswith("_") and not callable(v)
+        )
+        return f"{self.__class__.__name__}({inner})"
+
 
 def test_basic_init():
     """Test that manifester can initialize with the minimum required arguments."""
@@ -211,7 +222,7 @@ def test_create_allocation():
     """Test that manifester's create_subscription_allocation method returns a UUID."""
     manifester = Manifester(manifest_category=MANIFEST_DATA, requester=RhsmApiStub(in_dict=None))
     allocation_uuid = manifester.create_subscription_allocation()
-    assert allocation_uuid.uuid == SUB_ALLOCATION_UUID
+    assert allocation_uuid == SUB_ALLOCATION_UUID
 
 
 def test_negative_simple_retry_timeout():
@@ -300,7 +311,7 @@ def test_invalid_sat_version():
 def test_update_inventory():
     """Test that inventory file is populated with expected contents after updating."""
     manifester = Manifester(manifest_category=MANIFEST_DATA, requester=RhsmApiStub(in_dict=None))
-    update_inventory(manifester.subscription_allocations)
+    update_inventory(manifester.subscription_allocations, sync=True, uuid=SUB_ALLOCATION_UUID)
     assert (
         load_inventory_file(Path(MANIFEST_DATA["inventory_path"]))
         == SUB_ALLOCATIONS_RESPONSE["body"]