Progress refactor

Author: brunorijsman

common/block.py

@@ -126,11 +126,11 @@ def take_data(self, start: int, size: int) -> bytes:
         self._data = self._data[:start] + b"\x00" * size + self._data[end:]
         return data
 
-    def return_data(self, start: int, data: bytes):
+    def give_back_data(self, start: int, data: bytes):
         """
-        Return previously taken data to the block.
+        Give back previously taken data to the block.
         """
-        # Returning data is only used internally; the parameters are decided by the outside world.
+        # Giving back data is only used internally; the parameters are decided by the outside world.
         # Thus, if there is a problem with the parameters it is a bug: we assert rather than raise.
         size = len(data)
         assert size > 0

common/fragment.py

@@ -82,6 +82,14 @@ def allocate(block: Block, desired_size: int) -> Union[None, "Fragment"]:
             data=data,
         )
 
+    def give_back(self):
+        """
+        Return the fragment to the block it was taken from.
+        """
+        assert self._data is not None, "Attempt to return fragment twice"
+        self._block.give_back_data(self._start, self._data)
+        self._data = None
+
     def to_mgmt(self) -> dict:
         """
         Get the management status.
@@ -93,12 +101,6 @@ def to_mgmt(self) -> dict:
             "data": utils.bytes_to_str(self._data, truncate=True),
         }
 
-    def mark_as_returned_to_block(self):
-        """
-        Mark the fragment as returned to the pool.
-        """
-        self._data = None
-
     def to_api(self) -> APIFragment:
         """
         Create an APIFragment from a Fragment.

common/tests/test_block.py

@@ -14,9 +14,6 @@
 )
 
 
-# pylint: disable=missing-function-docstring
-
-
 def _bytes_test_pattern(size):
     return bytes([i % 255 for i in range(size)])
 
@@ -29,6 +26,9 @@ def _create_test_block(size):
 
 
 def test_block_init():
+    """
+    Initialize a block.
+    """
     size = 1000
     uuid = uuid4()
     data = _bytes_test_pattern(size)
@@ -45,6 +45,9 @@ def test_block_properties():
 
 
 def test_block_to_mgmt():
+    """
+    Get the management status.
+    """
     size = 20
     uuid = uuid4()
     data = _bytes_test_pattern(size)
@@ -60,6 +63,9 @@ def test_block_to_mgmt():
 
 
 def test_create_random_block():
+    """
+    Create a block with random data.
+    """
     size = 100
     _block = Block.new_with_random_data(size)
 
@@ -214,7 +220,7 @@ def test_return_data():
     assert block._data == bytes.fromhex("00000000000000000009")
     assert block.nr_used_bytes == 9
     # Return the middle 3 bytes
-    block.return_data(3, bytes.fromhex("030405"))
+    block.give_back_data(3, bytes.fromhex("030405"))
     assert block._data == bytes.fromhex("00000003040500000009")
     assert block.nr_used_bytes == 6
 

common/tests/test_fragment.py

@@ -8,9 +8,6 @@
 from common.utils import bytes_to_str
 
 
-# pylint: disable=missing-function-docstring
-
-
 def _bytes_test_pattern(size):
     return bytes([i % 255 for i in range(size)])
 
@@ -23,6 +20,9 @@ def _create_test_block(size):
 
 
 def test_fragment_init():
+    """
+    Initialize a fragment.
+    """
     block = _create_test_block(100)
     _fragment = Fragment(
         block=block,
@@ -32,7 +32,10 @@ def test_fragment_init():
     )
 
 
-def test_fragment_allocate_full():
+def test_allocate_full():
+    """
+    Allocate a fragment. Requested allocation is fully available.
+    """
     block = _create_test_block(100)
     fragment = Fragment.allocate(block, 10)
     assert fragment.block == block
@@ -41,7 +44,10 @@ def test_fragment_allocate_full():
     assert fragment.data == bytes.fromhex("00010203040506070809")
 
 
-def test_fragment_allocate_partial():
+def test_allocate_partial():
+    """
+    Allocate a fragment. Requested allocation is partially available.
+    """
     block = _create_test_block(5)
     fragment = Fragment.allocate(block, 10)
     assert fragment.block == block
@@ -50,7 +56,10 @@ def test_fragment_allocate_partial():
     assert fragment.data == bytes.fromhex("0001020304")
 
 
-def test_fragment_allocate_none():
+def test_allocate_none():
+    """
+    Allocate a fragment. No allocation is available.
+    """
     block = _create_test_block(5)
     fragment = Fragment.allocate(block, 5)
     assert fragment.block == block
@@ -60,7 +69,41 @@ def test_fragment_allocate_none():
     assert Fragment.allocate(block, 5) is None
 
 
+def test_give_back_success():
+    """
+    Give a fragment back to the block.
+    """
+    # pylint: disable=protected-access
+    block = _create_test_block(16)
+    assert block.nr_used_bytes == 0
+    # Allocate 5 bytes for fragment A
+    assert block._data == bytes.fromhex("000102030405060708090a0b0c0d0e0f")
+    fragment_a = Fragment.allocate(block, 5)
+    assert fragment_a.block == block
+    assert fragment_a.start == 0
+    assert fragment_a.size == 5
+    assert fragment_a.data == bytes.fromhex("0001020304")
+    assert block.nr_used_bytes == 5
+    assert block._data == bytes.fromhex("000000000005060708090a0b0c0d0e0f")
+    # Allocate 3 bytes for fragment B
+    fragment_b = Fragment.allocate(block, 3)
+    assert fragment_b.block == block
+    assert fragment_b.start == 5
+    assert fragment_b.size == 3
+    assert fragment_b.data == bytes.fromhex("050607")
+    assert block.nr_used_bytes == 8
+    assert block._data == bytes.fromhex("000000000000000008090a0b0c0d0e0f")
+    # Give fragment A back
+    fragment_a.give_back()
+    assert fragment_a.data is None
+    assert block.nr_used_bytes == 3
+    assert block._data == bytes.fromhex("000102030400000008090a0b0c0d0e0f")
+
+
 def test_fragment_to_mgmt():
+    """
+    Get the management status of a fragment.
+    """
     block = _create_test_block(5)
     fragment = Fragment.allocate(block, 5)
     fragment_mgmt = fragment.to_mgmt()