Refactor progress

Author: brunorijsman

client/peer_hub.py

@@ -159,12 +159,12 @@ def start_request_psrd_task_if_needed(self) -> None:
         Start request PSRD task(s) if needed.
         """
         if self._local_pool_request_psrd_task is None:
-            if self._local_pool.bytes_available < START_REQUEST_PSRD_THRESHOLD:
+            if self._local_pool.nr_unused_bytes < START_REQUEST_PSRD_THRESHOLD:
                 self._local_pool_request_psrd_task = asyncio.create_task(
                     self.request_psrd_task(self._local_pool)
                 )
         if self._peer_pool_request_psrd_task is None:
-            if self._peer_pool.bytes_available < START_REQUEST_PSRD_THRESHOLD:
+            if self._peer_pool.nr_unused_bytes < START_REQUEST_PSRD_THRESHOLD:
                 self._peer_pool_request_psrd_task = asyncio.create_task(
                     self.request_psrd_task(self._peer_pool)
                 )
@@ -176,7 +176,7 @@ async def request_psrd_task(self, pool: Pool) -> None:
         task_name = f"request PSRD task for peer hub {self._hub_name} and pool owner {pool.owner}"
         LOGGER.info(f"Begin {task_name}")
         try:
-            while pool.bytes_available < STOP_REQUEST_PSRD_THRESHOLD:
+            while pool.nr_unused_bytes < STOP_REQUEST_PSRD_THRESHOLD:
                 if not await self.attempt_request_psrd(pool):
                     await asyncio.sleep(_GET_PSRD_RETRY_DELAY)
         except asyncio.CancelledError:

common/pool.py

@@ -11,9 +11,6 @@
 from .exceptions import OutOfPreSharedRandomDataError, InvalidBlockUUIDError
 
 
-# TODO: Unit tests for newly added _owner attribute.
-
-
 class Pool:
     """
     A pool of blocks.
@@ -49,9 +46,9 @@ def owner(self) -> Owner:
         return self._owner
 
     @property
-    def bytes_available(self):
+    def nr_unused_bytes(self):
         """
-        Return the number of bytes available for allocation in the pool.
+        Return the total number of unused bytes in the pool.
         """
         return sum(block.nr_unused_bytes for block in self._blocks)
 
@@ -85,7 +82,7 @@ def allocate(self, size: PositiveInt, purpose: str) -> Allocation:
         This either returns an Allocation object for the full requested `size` or None if there is
         not enough unallocated data left in the pool.
         """
-        available = self.bytes_available
+        available = self.nr_unused_bytes
         if available < size:
             LOGGER.error(
                 f"PSRD allocation failed: pool={self._name} owner={self._owner} purpose={purpose} "

common/tests/test_block.py

@@ -25,7 +25,7 @@ def _create_test_block(size):
     return block
 
 
-def test_block_init():
+def test_init():
     """
     Initialize a block.
     """
@@ -35,7 +35,7 @@ def test_block_init():
     _block = Block(uuid, data)
 
 
-def test_block_properties():
+def test_properties():
     """ "
     Test the properties of a block.
     """
@@ -47,7 +47,7 @@ def test_block_properties():
     assert block.nr_unused_bytes == size
 
 
-def test_block_to_mgmt():
+def test_to_mgmt():
     """
     Get the management status.
     """

common/tests/test_fragment.py

@@ -29,7 +29,7 @@ def _create_test_pool_and_block(block_size):
     return (pool, block)
 
 
-def test_fragment_init():
+def test_init():
     """
     Initialize a fragment.
     """
@@ -73,7 +73,7 @@ def test_give_back_success():
     assert block._data == bytes.fromhex("000102030400000008090a0b0c0d0e0f")
 
 
-def test_fragment_to_mgmt():
+def test_to_mgmt():
     """
     Get the management status of a fragment.
     """

common/tests/test_pool.py

@@ -0,0 +1,53 @@
+"""
+Unit tests for the Fragment class.
+"""
+
+from uuid import uuid4
+from common.pool import Pool
+from common.block import Block
+
+
+def _bytes_test_pattern(size):
+    return bytes([i % 255 for i in range(size)])
+
+
+def _create_test_block(size):
+    uuid = uuid4()
+    data = _bytes_test_pattern(size)
+    block = Block(uuid, data)
+    return block
+
+
+def _create_test_pool_and_block(block_sizes: [int]):
+    pool = Pool(name="test_pool", owner=Pool.Owner.LOCAL)
+    blocks = []
+    for block_size in block_sizes:
+        block = _create_test_block(block_size)
+        pool.add_block(block)
+        blocks.append(block)
+    return (pool, blocks)
+
+
+def test_init():
+    """
+    Initialize a pool.
+    """
+    _pool = Pool(name="test_pool", owner=Pool.Owner.LOCAL)
+
+
+def test_properties():
+    """
+    Properties of the pool.
+    """
+    pool = Pool(name="test_pool", owner=Pool.Owner.LOCAL)
+    assert pool.owner == Pool.Owner.LOCAL
+
+
+def test_nr_unused_bytes():
+    """
+    Number of unused bytes in the pool.
+    """
+    pool, _blocks = _create_test_pool_and_block([10, 20, 30])
+    assert pool.nr_unused_bytes == 60
+    _allocation = pool.allocate(10, purpose="test")
+    assert pool.nr_unused_bytes == 50