test: implement backupstore setup

(1) add backupstore.py for robot test cases
(2) only support s3 now, the subprocess parts in
    backupstore.py need to be refined to make
    nfs work

Signed-off-by: Yang Chiu <[email protected]>

e2e/keywords/common.resource

@@ -9,6 +9,8 @@ Library             ../libs/keywords/statefulset_keywords.py
 Library             ../libs/keywords/stress_keywords.py
 Library             ../libs/keywords/volume_keywords.py
 Library             ../libs/keywords/workload_keywords.py
+Library             ../libs/keywords/network_keywords.py
+Library             ../libs/keywords/backupstore_keywords.py
 
 *** Keywords ***
 Set test environment
@@ -17,6 +19,7 @@ Set test environment
     init_storageclasses
 
     setup_control_plane_network_latency
+    set_backupstore
 
 Cleanup test resources
     cleanup_control_plane_network_latency
@@ -28,3 +31,4 @@ Cleanup test resources
     cleanup_persistentvolumeclaims
     cleanup_volumes
     cleanup_storageclasses
+    cleanup_backupstore

e2e/libs/backupstore/__init__.py

@@ -0,0 +1,2 @@
+from backupstore.nfs import Nfs
+from backupstore.minio import Minio

e2e/libs/backupstore/base.py

@@ -0,0 +1,135 @@
+from abc import ABC, abstractmethod
+import os
+import time
+import hashlib
+from utility.utility import get_retry_count_and_interval
+
+class Base(ABC):
+
+    def is_backupTarget_s3(self, s):
+        return s.startswith("s3://")
+
+    def is_backupTarget_nfs(self, s):
+        return s.startswith("nfs://")
+
+    def backup_volume_path(self, volume_name):
+        volume_name_sha512 = \
+            hashlib.sha512(volume_name.encode('utf-8')).hexdigest()
+
+        volume_dir_level_1 = volume_name_sha512[0:2]
+        volume_dir_level_2 = volume_name_sha512[2:4]
+
+        backupstore_bv_path = "/backupstore/volumes/" + \
+            volume_dir_level_1 + "/" + \
+            volume_dir_level_2 + "/" + \
+            volume_name
+
+        return backupstore_bv_path
+
+    @abstractmethod
+    def get_backup_volume_prefix(self, client, volume_name):
+        return NotImplemented
+
+    def get_backup_target(self, client):
+        backup_target_setting = client.by_id_setting(SETTING_BACKUP_TARGET)
+        return backup_target_setting.value
+
+    def get_secret(self, client):
+        backup_target_credential_setting = client.by_id_setting(
+            SETTING_BACKUP_TARGET_CREDENTIAL_SECRET)
+        return backup_target_credential_setting.value
+
+    @abstractmethod
+    def get_backup_cfg_file_path(self, client, volume_name, backup_name):
+        return NotImplemented
+
+    @abstractmethod
+    def get_volume_cfg_file_path(self, client, volume_name):
+        return NotImplemented
+
+    @abstractmethod
+    def get_backup_blocks_dir(self, client, volume_name):
+        return NotImplemented
+
+    @abstractmethod
+    def create_file_in_backupstore(self):
+        return NotImplemented
+
+    @abstractmethod
+    def write_backup_cfg_file(self, client, core_api, volume_name, backup_name, data):
+        return NotImplemented
+
+    @abstractmethod
+    def delete_file_in_backupstore(self):
+        return NotImplemented
+
+    @abstractmethod
+    def delete_backup_cfg_file(self):
+        return NotImplemented
+
+    @abstractmethod
+    def delete_volume_cfg_file(self):
+        return NotImplemented
+
+    @abstractmethod
+    def delete_random_backup_block(self):
+        return NotImplemented
+
+    @abstractmethod
+    def count_backup_block_files(self):
+        return NotImplemented
+
+    def delete_backup_volume(self, client, volume_name):
+        bv = client.by_id_backupVolume(volume_name)
+        client.delete(bv)
+        self.wait_for_backup_volume_delete(client, volume_name)
+
+    def wait_for_backup_volume_delete(self, client, name):
+        retry_count, retry_interval = get_retry_count_and_interval()
+        for _ in range(retry_count):
+            bvs = client.list_backupVolume()
+            found = False
+            for bv in bvs:
+                if bv.name == name:
+                    found = True
+                    break
+            if not found:
+                break
+            time.sleep(retry_interval)
+        assert not found
+
+    def cleanup_backup_volumes(self, client):
+        backup_volumes = client.list_backup_volume()
+
+        # we delete the whole backup volume, which skips block gc
+        for backup_volume in backup_volumes:
+            self.delete_backup_volume(client, backup_volume.name)
+
+        backup_volumes = client.list_backup_volume()
+        assert backup_volumes.data == []
+
+    def cleanup_system_backups(self, client):
+        """
+        Clean up all system backups
+        :param client: The Longhorn client to use in the request.
+        """
+
+        system_backups = client.list_system_backup()
+        for system_backup in system_backups:
+            # ignore the error when clean up
+            try:
+                client.delete(system_backup)
+            except Exception as e:
+                name = system_backup['name']
+                print("\nException when cleanup system backup ", name)
+                print(e)
+
+        ok = False
+        retry_count, retry_interval = get_retry_count_and_interval()
+        for _ in range(retry_count):
+            system_backups = client.list_system_backup()
+            if len(system_backups) == 0:
+                ok = True
+                break
+            time.sleep(retry_interval)
+        assert ok

e2e/libs/backupstore/minio.py

@@ -0,0 +1,185 @@
+from backupstore.base import Base
+import os
+import base64
+import json
+import tempfile
+from minio import Minio
+from minio.error import ResponseError
+from urllib.parse import urlparse
+
+class Minio(Base):
+
+    def get_api_client(self, client, core_api, minio_secret_name):
+        secret = core_api.read_namespaced_secret(name=minio_secret_name,
+                                                 namespace='longhorn-system')
+
+        base64_minio_access_key = secret.data['AWS_ACCESS_KEY_ID']
+        base64_minio_secret_key = secret.data['AWS_SECRET_ACCESS_KEY']
+        base64_minio_endpoint_url = secret.data['AWS_ENDPOINTS']
+        base64_minio_cert = secret.data['AWS_CERT']
+
+        minio_access_key = \
+            base64.b64decode(base64_minio_access_key).decode("utf-8")
+        minio_secret_key = \
+            base64.b64decode(base64_minio_secret_key).decode("utf-8")
+
+        minio_endpoint_url = \
+            base64.b64decode(base64_minio_endpoint_url).decode("utf-8")
+        minio_endpoint_url = minio_endpoint_url.replace('https://', '')
+
+        return Minio(minio_endpoint_url,
+                     access_key=minio_access_key,
+                     secret_key=minio_secret_key,
+                     secure=True)
+
+    def get_backupstore_bucket_name(self, client):
+        backupstore = self.backupstore_get_backup_target(client)
+        assert self.is_backupTarget_s3(backupstore)
+        bucket_name = urlparse(backupstore).netloc.split('@')[0]
+        return bucket_name
+
+    def get_backupstore_path(self, client):
+        backupstore = self.backupstore_get_backup_target(client)
+        assert self.is_backupTarget_s3(backupstore)
+        backupstore_path = urlparse(backupstore).path.split('$')[0].strip("/")
+        return backupstore_path
+
+    def get_backup_volume_prefix(self, client, volume_name):
+        backupstore_bv_path = self.backup_volume_path(volume_name)
+        backupstore_path = self.get_backupstore_path(client)
+        return backupstore_path + backupstore_bv_path
+
+    def get_backup_cfg_file_path(self, client, volume_name, backup_name):
+        prefix = self.get_backup_volume_prefix(client, volume_name)
+        return prefix + "/backups/backup_" + backup_name + ".cfg"
+
+    def get_volume_cfg_file_path(self, client, volume_name):
+        prefix = self.get_backup_volume_prefix(client, volume_name)
+        return prefix + "/volume.cfg"
+
+    def get_backup_blocks_dir(self, client, volume_name):
+        prefix = self.get_backup_volume_prefix(client, volume_name)
+        return prefix + "/blocks"
+
+    def create_file_in_backupstore(self, client, core_api, file_path, data={}): # NOQA
+        backup_target_credential_setting = client.by_id_setting(
+            SETTING_BACKUP_TARGET_CREDENTIAL_SECRET)
+
+        secret_name = backup_target_credential_setting.value
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+
+        if len(data) == 0:
+            data = {"testkey": "test data from mino_create_file_in_backupstore()"}
+
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            json.dump(data, fp)
+            try:
+                with open(fp.name, mode='rb') as f:
+                    temp_file_stat = os.stat(fp.name)
+                    minio_api.put_object(bucket_name,
+                                         file_path,
+                                         f,
+                                         temp_file_stat.st_size)
+            except ResponseError as err:
+                print(err)
+
+    def write_backup_cfg_file(self, client, core_api, volume_name, backup_name, backup_cfg_data): # NOQA
+        secret_name = self.get_secret(client)
+        assert secret_name != ''
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+        minio_backup_cfg_file_path = self.get_backup_cfg_file_path(volume_name,
+                                                                   backup_name)
+
+        with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
+            fp.write(str(backup_cfg_data))
+            fp.close()
+            try:
+                with open(fp.name, mode='rb') as f:
+                    tmp_bkp_cfg_file_stat = os.stat(fp.name)
+                    minio_api.put_object(bucket_name,
+                                         minio_backup_cfg_file_path,
+                                         f,
+                                         tmp_bkp_cfg_file_stat.st_size)
+            except ResponseError as err:
+                print(err)
+
+    def delete_file_in_backupstore(self, client, core_api, file_path):
+        backup_target_credential_setting = client.by_id_setting(
+            SETTING_BACKUP_TARGET_CREDENTIAL_SECRET)
+
+        secret_name = backup_target_credential_setting.value
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+
+        try:
+            minio_api.remove_object(bucket_name, file_path)
+        except ResponseError as err:
+            print(err)
+
+    def delete_backup_cfg_file(self, client, core_api, volume_name, backup_name):
+        secret_name = self.get_secret(client)
+        assert secret_name != ''
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+        minio_backup_cfg_file_path = self.get_backup_cfg_file_path(volume_name,
+                                                                   backup_name)
+
+        try:
+            minio_api.remove_object(bucket_name, minio_backup_cfg_file_path)
+        except ResponseError as err:
+            print(err)
+
+    def delete_volume_cfg_file(self, client, core_api, volume_name):
+        secret_name = self.get_secret(client)
+        assert secret_name != ''
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+        minio_volume_cfg_file_path = self.get_volume_cfg_file_path(volume_name)
+
+        try:
+            minio_api.remove_object(bucket_name, minio_volume_cfg_file_path)
+        except ResponseError as err:
+            print(err)
+
+    def delete_random_backup_block(self, client, core_api, volume_name):
+        secret_name = self.get_secret(client)
+        assert secret_name != ''
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+
+        bucket_name = self.get_backupstore_bucket_name(client)
+        backup_blocks_dir = self.get_backup_blocks_dir(volume_name)
+
+        block_object_files = minio_api.list_objects(bucket_name,
+                                                    prefix=backup_blocks_dir,
+                                                    recursive=True)
+
+        object_file = block_object_files.__next__().object_name
+
+        try:
+            minio_api.remove_object(bucket_name, object_file)
+        except ResponseError as err:
+            print(err)
+
+    def count_backup_block_files(self, client, core_api, volume_name):
+        secret_name = self.get_secret(client)
+        assert secret_name != ''
+
+        minio_api = self.get_api_client(client, core_api, secret_name)
+        bucket_name = self.get_backupstore_bucket_name(client)
+        backup_blocks_dir = self.get_backup_blocks_dir(volume_name)
+
+        block_object_files = minio_api.list_objects(bucket_name,
+                                                    prefix=backup_blocks_dir,
+                                                    recursive=True)
+
+        block_object_files_list = list(block_object_files)
+
+        return len(block_object_files_list)