increase docstrings coverage and enhance them

Signed-off-by: Emanuele Prella <eprella@redhat.com>

Author: ema-aka-young

tests/storage/cdi_import/conftest.py

@@ -40,12 +40,14 @@
 
 @pytest.fixture()
 def skip_non_shared_storage(storage_class_name_scope_function):
+    """Skip tests if the storage class is non-shared."""
     if storage_class_name_scope_function in HPP_STORAGE_CLASSES:
         pytest.skip("Skipping when storage is non-shared")
 
 
 @pytest.fixture()
 def bridge_on_node(admin_client):
+    """Create a Linux Bridge network device and yield it."""
     with network_device(
         interface_type=LINUX_BRIDGE,
         nncp_name=BRIDGE_NAME,
@@ -57,6 +59,7 @@ def bridge_on_node(admin_client):
 
 @pytest.fixture()
 def linux_nad(admin_client, namespace, bridge_on_node):
+    """Create a Linux Bridge Network Attachment Definition (NAD) and yield it."""
     with network_nad(
         namespace=namespace,
         nad_type=LINUX_BRIDGE,
@@ -71,6 +74,7 @@ def linux_nad(admin_client, namespace, bridge_on_node):
 def cirros_pvc(
     data_volume_template_metadata,
 ):
+    """Create a PVC from the data volume template metadata."""
     return PersistentVolumeClaim(
         name=data_volume_template_metadata["name"],
         namespace=data_volume_template_metadata["namespace"],
@@ -81,11 +85,13 @@ def cirros_pvc(
 def pvc_original_timestamp(
     cirros_pvc,
 ):
+    """Get the original creation timestamp of the Cirros PVC."""
     return cirros_pvc.instance.metadata.creationTimestamp
 
 
 @pytest.fixture()
 def dv_non_exist_url(namespace, storage_class_name_scope_module):
+    """Create a DV with a non-existent URL to test import failure."""
     with create_dv(
         dv_name=f"cnv-876-{storage_class_name_scope_module}",
         namespace=namespace.name,
@@ -104,6 +110,7 @@ def dv_from_http_import(
     storage_class_name_scope_module,
     images_internal_http_server,
 ):
+    """Create a DV from HTTP import with parameters from the test function."""
     with create_dv(
         dv_name=f"{request.param.get('dv_name', 'http-dv')}-{storage_class_name_scope_module}",
         namespace=namespace.name,
@@ -127,6 +134,7 @@ def running_pod_with_dv_pvc(
     storage_class_name_scope_module,
     dv_from_http_import,
 ):
+    """Create a running pod with DV's PVC."""
     dv_from_http_import.wait_for_dv_success()
     with create_pod_for_pvc(
         pvc=dv_from_http_import.pvc,
@@ -137,6 +145,7 @@ def running_pod_with_dv_pvc(
 
 @pytest.fixture()
 def created_blank_dv_list(unprivileged_client, namespace, storage_class_name_scope_module, number_of_dvs):
+    """Create a list of blank DVs."""
     dvs_list = []
     try:
         for dv_index in range(number_of_dvs):
@@ -189,6 +198,7 @@ def created_vm_list(unprivileged_client, created_blank_dv_list, storage_class_na
 
 @pytest.fixture()
 def dvs_and_vms_from_public_registry(unprivileged_client, namespace, storage_class_name_scope_function):
+    """Create DVs from public registry and VMs from those DVs."""
     dvs = []
     vms = []
     try:
@@ -230,6 +240,7 @@ def dvs_and_vms_from_public_registry(unprivileged_client, namespace, storage_cla
 
 @pytest.fixture()
 def dv_with_annotation(admin_client, namespace, linux_nad):
+    """Create a DV with multus annotation and yield the importer pod annotations."""
     with create_dv(
         dv_name="dv-annotation",
         namespace=namespace.name,

tests/storage/cdi_import/test_import_http.py

@@ -429,7 +429,7 @@ def test_successful_vm_from_imported_dv_windows(
 @pytest.mark.polarion("CNV-5509")
 @pytest.mark.s390x
 def test_importer_pod_annotation(dv_with_annotation, linux_nad):
-    """Verify "k8s.v1.cni.cncf.io/networks" can pass to the importer pod"""
+    """Verify "k8s.v1.cni.cncf.io/networks" can be passed to the importer pod"""
     networks_annotation = f"{Resource.ApiGroup.K8S_V1_CNI_CNCF_IO}/networks"
     network_status_annotation = f"{Resource.ApiGroup.K8S_V1_CNI_CNCF_IO}/network-status"
 

tests/storage/general/test_storage_behavior.py

@@ -32,6 +32,26 @@
 @pytest.mark.sno
 @pytest.mark.polarion("CNV-675")
 def test_pvc_recreates_after_deletion(namespace, storage_class_name_scope_function, fedora_data_source_scope_module):
+    """
+    Test that a PVC is automatically recreated by CDI after manual deletion.
+
+    Preconditions:
+        - Fedora DataSource available
+        - Storage class available
+        - DataVolume created from Fedora DataSource
+        - PVC bound and DataVolume import completed
+
+    Steps:
+        1. Record the PVC original creation timestamp
+        2. Delete the PVC
+        3. Wait for PVC to be recreated with a new timestamp
+        4. Create a dummy first consumer pod if storage class uses WaitForFirstConsumer binding mode
+        5. Wait for DataVolume to reach Succeeded status
+
+    Expected:
+        - PVC is recreated automatically
+        - DataVolume status is "Succeeded"
+    """
     with create_dv(
         dv_name=f"cnv-675-{storage_class_name_scope_function}",
         namespace=namespace.name,
@@ -60,6 +80,22 @@ def test_pvc_recreates_after_deletion(namespace, storage_class_name_scope_functi
 def test_disk_falloc(
     storage_class_name_scope_function, unprivileged_client, fedora_data_source_scope_module, namespace
 ):
+    """
+    Test that attempting to allocate more space than available on a disk fails with the expected error.
+
+    Preconditions:
+        - Fedora DataSource available
+        - DataVolume created from Fedora DataSource
+        - VM created and started from the DataVolume with console access
+
+    Steps:
+        1. Connect to VM console
+        2. Execute fallocate command to allocate a file equal to the disk size
+        3. Verify the error message
+
+    Expected:
+        - fallocate command fails with "No space left on device" error
+    """
     size = get_dv_size_from_datasource(data_source=fedora_data_source_scope_module)
     with create_dv(
         client=unprivileged_client,