storage: extract device population and validation helpers

Extract reusable functions for partially populating and validating disk
contents to reduce code duplication in storage tests.

Signed-off-by: Gaëtan Lehmann <gaetan.lehmann@vates.tech>

Author: glehmann

tests/storage/storage.py

@@ -12,7 +12,7 @@
 from lib.vdi import VDI, ImageFormat
 from lib.vm import VM
 
-from typing import Literal
+from typing import Literal, Tuple
 
 def try_to_create_sr_with_missing_device(sr_type, label, host) -> None:
     try:
@@ -25,6 +25,28 @@ def try_to_create_sr_with_missing_device(sr_type, label, host) -> None:
         return
     assert False, 'SR creation should not have succeeded!'
 
+def partial_stream_size(vdi_size: int) -> int:
+    return min((vdi_size // 16 // (32 * KiB)) * (32 * KiB), 2 * GiB)
+
+def partially_populate_device(vm: VM, dev_path: str, dev_size: int) -> Tuple[str, str, str]:
+    logging.info(f"Generate {dev_path} content")
+    size = partial_stream_size(dev_size)
+    # generate at the start, in the middle and the end of the disk
+    # use seeds unlikely to collide with other usages
+    checksum1 = randstream(vm, f'generate --seed 10 --size {size} {dev_path}')
+    checksum2 = randstream(vm, f'generate --seed 11 --position {dev_size // 2} --size {size} {dev_path}')
+    checksum3 = randstream(vm, f'generate --seed 12 --position {dev_size - size} --size {size} {dev_path}')
+    return (checksum1, checksum2, checksum3)
+
+def validate_partially_populated_device(vm: VM, dev_path: str, dev_size: int, checksums: Tuple[str, str, str]) -> None:
+    logging.info(f"Validate {dev_path} content")
+    size = partial_stream_size(dev_size)
+    checksum1, checksum2, checksum3 = checksums
+    randstream(vm, f'validate --expected-checksum {checksum1} --size {size} {dev_path}')
+    randstream(vm, f'validate --expected-checksum {checksum2} --position {dev_size // 2} --size {size} {dev_path}')
+    randstream(vm, f'validate --expected-checksum {checksum3} --position {dev_size - size} --size {size} {dev_path}')
+
+
 def cold_migration_then_come_back(vm: VM, prov_host: Host, dest_host: Host, dest_sr: SR) -> None:
     """ Storage migration of a shutdown VM, then migrate it back. """
     prov_sr = vm.get_sr()
@@ -197,22 +219,15 @@ def randstream(vm: VM, args: str) -> str:
 
 def coalesce_integrity(vm: VM, vdi: VDI, vdi_op: CoalesceOperation, defer: Defer) -> None:
     vdi_size = vdi.get_virtual_size()
-    # second stream is 1/16 of the full one, truncated to a multiple of 32KiB
-    stream_size = min((vdi_size // 16 // (32 * KiB)) * (32 * KiB), 2 * GiB)
+    stream_size = partial_stream_size(vdi_size)
     vbd = vm.connect_vdi(vdi)
     defer(lambda: vm.disconnect_vdi(vdi))
 
     dev = f'/dev/{vbd.param_get("device")}'
     # generate at the start, in the middle and the end of the disk
-    checksum1 = randstream(vm, f'generate --size {stream_size} {dev}')
-    checksum2 = randstream(vm, f'generate --position {vdi_size // 2} --size {stream_size} {dev}')
-    checksum3 = randstream(vm, f'generate --position {vdi_size - stream_size} --size {stream_size} {dev}')
+    checksum1, checksum2, checksum3 = partially_populate_device(vm, dev, vdi_size)
     # make sure we can read that exact data before the snapshot/clone
-    randstream(vm, f'validate --expected-checksum {checksum1} --size {stream_size} {dev}')
-    randstream(vm, f'validate --expected-checksum {checksum2} --position {vdi_size // 2} --size {stream_size} {dev}')
-    randstream(
-        vm, f'validate --expected-checksum {checksum3} --position {vdi_size - stream_size} --size {stream_size} {dev}'
-    )
+    validate_partially_populated_device(vm, dev, vdi_size, (checksum1, checksum2, checksum3))
     new_vdi: VDI | None = None
     match vdi_op:
         case 'clone': new_vdi = vdi.clone()
@@ -221,8 +236,8 @@ def coalesce_integrity(vm: VM, vdi: VDI, vdi_op: CoalesceOperation, defer: Defer
     assert vdi is not None
 
     # add some data in a non-used place, and overwrite an already used one
-    checksum2bis = randstream(vm, f'generate --seed 1 --position {vdi_size // 2} --size {stream_size} {dev}')
-    checksum4 = randstream(vm, f'generate --position {stream_size} --size {stream_size} {dev}')
+    checksum2bis = randstream(vm, f'generate --seed 0 --position {vdi_size // 2} --size {stream_size} {dev}')
+    checksum4 = randstream(vm, f'generate --seed 1 --position {stream_size} --size {stream_size} {dev}')
     # make sure we can write that data before the coalesce
     randstream(
         vm, f'validate --expected-checksum {checksum2bis} --position {vdi_size // 2} --size {stream_size} {dev}',
@@ -236,13 +251,7 @@ def coalesce_integrity(vm: VM, vdi: VDI, vdi_op: CoalesceOperation, defer: Defer
     new_vdi = None
 
     # verify the data is still as expected
-    randstream(vm, f'validate --expected-checksum {checksum1} --size {stream_size} {dev}')
-    randstream(
-        vm, f'validate --expected-checksum {checksum2bis} --position {vdi_size // 2} --size {stream_size} {dev}',
-    )
-    randstream(
-        vm, f'validate --expected-checksum {checksum3} --position {vdi_size - stream_size} --size {stream_size} {dev}'
-    )
+    validate_partially_populated_device(vm, dev, vdi_size, (checksum1, checksum2bis, checksum3))
     randstream(
         vm, f'validate --expected-checksum {checksum4} --position {stream_size} --size {stream_size} {dev}'
     )