feat(backup): add cleanup snapshot after backup test case

ref: longhorn/longhorn 9213

Signed-off-by: James Lu <[email protected]>

e2e/keywords/backup.resource

@@ -15,6 +15,10 @@ Create backup ${backup_id} for ${workload_kind} ${workload_id} volume
     ${volume_name}=    get_workload_volume_name    ${workload_name}
     create_backup  ${volume_name}  ${backup_id}
 
+Create backup ${backup_id} for volume ${volume_id} with cleanup snapshot ${cleanup_snapshot}
+    ${volume_name} =    generate_name_with_suffix    volume    ${volume_id}
+    create_backup    ${volume_name}    ${backup_id}    ${cleanup_snapshot}
+
 Verify backup list contains no error for volume ${volume_id}
     ${volume_name} =    generate_name_with_suffix    volume    ${volume_id}
     verify_no_error    ${volume_name}
@@ -53,3 +57,7 @@ Volume ${volume_id} backup ${backup_id} should be able to create
     Create backup ${backup_id} for volume ${volume_id}
     Verify backup list contains no error for volume ${volume_id}
     Verify backup list contains backup ${backup_id} of volume ${volume_id}
+
+Check snapshot for backup ${backup_id} of volume ${volume_id} exists ${exists}
+    ${volume_name} =    generate_name_with_suffix    volume    ${volume_id}
+    check_snapshot_exists_for_backup    ${volume_name}    ${backup_id}    ${exists}

e2e/libs/backup/backup.py

@@ -15,8 +15,8 @@ def __init__(self):
         else:
             self.backup = Rest()
 
-    def create(self, volume_name, backup_id):
-        return self.backup.create(volume_name, backup_id)
+    def create(self, volume_name, backup_id, cleanup_snapshot=False):
+        return self.backup.create(volume_name, backup_id, cleanup_snapshot)
 
     def get(self, backup_id, volume_name):
         return self.backup.get(backup_id, volume_name)
@@ -66,3 +66,13 @@ def cleanup_backup_volumes(self):
 
     def cleanup_system_backups(self):
         return self.backup.cleanup_system_backups()
+
+    def check_snapshot_exists_for_backup(self, volume_name, backup_id,
+                                         exists=True):
+        backup = self.backup.get(backup_id, volume_name)
+        snap_name = backup.snapshotName
+        snapshot_id = self.backup.snapshot.get_snapshot_id(snap_name)
+        snap = self.backup.snapshot.get(volume_name, snapshot_id)
+        snap_exists = False if snap.removed else True
+        assert snap_exists == exists, \
+            f"Snapshot {snap_name} exists: {snap_exists}, expected: {exists}"

e2e/libs/backup/rest.py

@@ -19,12 +19,13 @@ def __init__(self):
         self.snapshot = RestSnapshot()
         self.retry_count, self.retry_interval = get_retry_count_and_interval()
 
-    def create(self, volume_name, backup_id):
+    def create(self, volume_name, backup_id, cleanup_snapshot=False):
         # create snapshot
         snapshot = self.snapshot.create(volume_name, backup_id)
 
         volume = self.volume.get(volume_name)
-        volume.snapshotBackup(name=snapshot.name)
+        volume.snapshotBackup(name=snapshot.name,
+                              cleanupBackupSnapshot=cleanup_snapshot)
         # after backup request we need to wait for completion of the backup
         # since the backup.cfg will only be available once the backup operation
         # has been completed
@@ -44,7 +45,8 @@ def create(self, volume_name, backup_id):
             f"expect volume lastBackupAt is not empty, but it's {volume.lastBackupAt}"
 
         self.set_backup_id(backup.name, backup_id)
-        self.set_data_checksum(backup.name, self.volume.get_last_data_checksum(volume_name))
+        self.set_data_checksum(backup.name,
+                               self.volume.get_last_data_checksum(volume_name))
 
         return backup
 

e2e/libs/keywords/backup_keywords.py

@@ -9,8 +9,8 @@ class backup_keywords:
     def __init__(self):
         self.backup = Backup()
 
-    def create_backup(self, volume_name, backup_id):
-        self.backup.create(volume_name, backup_id)
+    def create_backup(self, volume_name, backup_id, cleanup_snapshot=False):
+        self.backup.create(volume_name, backup_id, cleanup_snapshot)
 
     def verify_no_error(self, volume_name):
         self.backup.verify_no_error(volume_name)
@@ -57,3 +57,9 @@ def list_all_backups(self):
 
     def assert_all_backups_before_uninstall_exist(self, backups_before_uninstall):
         self.backup.assert_all_backups_before_uninstall_exist(backups_before_uninstall)
+
+    def check_snapshot_exists_for_backup(self, volume_name, backup_id,
+                                         exists=True):
+        self.backup.check_snapshot_exists_for_backup(volume_name,
+                                                     backup_id,
+                                                     exists)

e2e/tests/regression/test_backup.robot

@@ -106,3 +106,17 @@ Test Incremental Restore
     And Delete pod 0
     And Delete persistentvolumeclaim for volume 3
     And Delete persistentvolume for volume 3
+
+Test Cleanup Snapshot After Backup Completed
+    [Documentation]    Test cleanup snapshot after backup completed
+    Given Create volume 0 with    dataEngine=${DATA_ENGINE}
+    And Attach volume 0
+    And Wait for volume 0 healthy
+
+    When Write data 0 to volume 0
+    And Create backup 0 for volume 0
+    And Check snapshot for backup 0 of volume 0 exists True
+
+    When Write data 1 to volume 0
+    And Create backup 1 for volume 0 with cleanup snapshot True
+    And Check snapshot for backup 1 of volume 0 exists False