ci: support azurtize on pytest and e2e

longhorn/longhorn-9699

Signed-off-by: Chris <[email protected]>

e2e/README.md

@@ -14,11 +14,14 @@ curl -sSfL https://raw.githubusercontent.com/longhorn/longhorn/master/scripts/en
 
 ### Run the test
 
-1. Deploy all backupstore servers (including `NFS` server and `Minio` as s3 server) for test purposes.
+1. Deploy all backupstore servers (including `NFS` server and `Minio` as s3 server, `CIFS` and `Azurite` server) for test purposes.
+
+   For Azurite, there are some manual steps need to be done after manifest deployed(https://confluence.suse.com/display/LON/Setup+Azurite+Backupstore+For+Testing).
 ```
 kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/minio-backupstore.yaml \
                -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/nfs-backupstore.yaml \
-               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml
+               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml \
+               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/azurite-backupstore.yaml
 ```
 
 1. Expose Longhorn API:

manager/integration/Dockerfile

@@ -2,12 +2,12 @@
 
 FROM registry.suse.com/bci/python:3.11
 
-ARG TARGETPLATFORM
-RUN if [ "$TARGETPLATFORM" != "linux/amd64" ] && [ "$TARGETPLATFORM" != "linux/arm64" ]; then \
-    echo "Error: Unsupported TARGETPLATFORM: $TARGETPLATFORM" && \
-    exit 1; \
-    fi
-ENV ARCH ${TARGETPLATFORM#linux/}
+#ARG TARGETPLATFORM
+#RUN if [ "$TARGETPLATFORM" != "linux/amd64" ] && [ "$TARGETPLATFORM" != "linux/arm64" ]; then \
+#    echo "Error: Unsupported TARGETPLATFORM: $TARGETPLATFORM" && \
+#    exit 1; \
+#    fi
+ENV ARCH amd64
 
 ARG KUBECTL_VERSION=v1.30.0
 ARG YQ_VERSION=v4.24.2

manager/integration/README.md

@@ -16,11 +16,14 @@ Requirement:
 6. Make sure `nfs-common` or equivalent has been installed on the node to allow the NFS client to work.
 
 Run the test:
-1. Deploy all backupstore servers(including `NFS` server and `Minio` as s3 server) for test purposes.
+1. Deploy all backupstore servers(including `NFS` server and `Minio` as s3 server `CIFS` and `Azurite` server) for test purposes.
+
+   For Azurite, there are some manual steps need to be done after manifest deployed(https://confluence.suse.com/display/LON/Setup+Azurite+Backupstore+For+Testing).
 ```
 kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/minio-backupstore.yaml \
                -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/nfs-backupstore.yaml \
-               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml
+               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml \
+               -f https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/azurite-backupstore.yaml
 ```
 2. Deploy the test script to the Kubernetes cluster.
 ```

manager/integration/deploy/test.yaml

@@ -42,7 +42,7 @@ spec:
     - name: LONGHORN_JUNIT_REPORT_PATH
       value: /tmp/test-report/longhorn-test-junit-report.xml
     - name: LONGHORN_BACKUPSTORES
-      value: "s3://backupbucket@us-east-1/backupstore$minio-secret, nfs://longhorn-test-nfs-svc.default:/opt/backupstore, cifs://longhorn-test-cifs-svc.default/backupstore$cifs-secret"
+      value: "s3://backupbucket@us-east-1/backupstore$minio-secret, nfs://longhorn-test-nfs-svc.default:/opt/backupstore, cifs://longhorn-test-cifs-svc.default/backupstore$cifs-secret, azblob://[email protected]/$azblob-secret"
     - name: LONGHORN_BACKUPSTORE_POLL_INTERVAL
       value: "30"
     - name: LONGHORN_DISK_TYPE

manager/integration/tests/backupstore.py

@@ -18,6 +18,7 @@
 from common import is_backupTarget_s3
 from common import is_backupTarget_nfs
 from common import is_backupTarget_cifs
+from common import is_backupTarget_azurite
 from common import get_longhorn_api_client
 from common import delete_backup_volume
 from common import delete_backup_backing_image
@@ -67,8 +68,10 @@ def set_random_backupstore(request, client):
         mount_nfs_backupstore(client)
     elif request.param == "cifs":
         set_backupstore_cifs(client)
+    elif request.param == "azblob":
+        set_backupstore_azurite(client)
 
-    yield
+    yield request.param
     cleanup_all_volumes(client)
     backupstore_cleanup(client)
     system_backups_cleanup(client)
@@ -131,6 +134,18 @@ def set_backupstore_cifs(client):
             break
 
 
+def set_backupstore_azurite(client):
+    backupstores = get_backupstore_url()
+    poll_interval = get_backupstore_poll_interval()
+    for backupstore in backupstores:
+        if is_backupTarget_azurite(backupstore):
+            backupsettings = backupstore.split("$")
+            set_backupstore_url(client, backupsettings[0])
+            set_backupstore_credential_secret(client, backupsettings[1])
+            set_backupstore_poll_interval(client, poll_interval)
+            break
+
+
 def set_backupstore_url(client, url):
     backup_target_setting = client.by_id_setting(SETTING_BACKUP_TARGET)
     backup_target_setting = client.update(backup_target_setting,
@@ -289,7 +304,7 @@ def backupstore_get_backup_volume_prefix(client, volume_name):
         return nfs_get_backup_volume_prefix(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def minio_get_backup_volume_prefix(volume_name):
@@ -326,7 +341,7 @@ def backupstore_get_backup_cfg_file_path(client, volume_name, backup_name):
         return nfs_get_backup_cfg_file_path(client, volume_name, backup_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def minio_get_backup_cfg_file_path(volume_name, backup_name):
@@ -349,7 +364,7 @@ def backupstore_get_volume_cfg_file_path(client, volume_name):
         return nfs_get_volume_cfg_file_path(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_get_volume_cfg_file_path(client, volume_name):
@@ -372,7 +387,7 @@ def backupstore_get_backup_blocks_dir(client, volume_name):
         return nfs_get_backup_blocks_dir(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def minio_get_backup_blocks_dir(volume_name):
@@ -398,7 +413,7 @@ def backupstore_create_file(client, core_api, file_path, data={}):
         return nfs_create_file_in_backupstore(file_path, data={})
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def mino_create_file_in_backupstore(client, core_api, file_path, data={}): # NOQA
@@ -448,7 +463,7 @@ def backupstore_write_backup_cfg_file(client, core_api, volume_name, backup_name
                                   data)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_write_backup_cfg_file(client, volume_name, backup_name, data):
@@ -496,7 +511,7 @@ def backupstore_delete_file(client, core_api, file_path):
         return nfs_delete_file_in_backupstore(file_path)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def mino_delete_file_in_backupstore(client, core_api, file_path):
@@ -536,7 +551,7 @@ def backupstore_delete_backup_cfg_file(client, core_api, volume_name, backup_nam
         nfs_delete_backup_cfg_file(client, volume_name, backup_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_delete_backup_cfg_file(client, volume_name, backup_name):
@@ -578,7 +593,7 @@ def backupstore_delete_volume_cfg_file(client, core_api, volume_name):  # NOQA
         nfs_delete_volume_cfg_file(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_delete_volume_cfg_file(client, volume_name):
@@ -647,7 +662,7 @@ def backupstore_delete_random_backup_block(client, core_api, volume_name):
         nfs_delete_random_backup_block(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_delete_random_backup_block(client, volume_name):
@@ -696,7 +711,7 @@ def backupstore_count_backup_block_files(client, core_api, volume_name):
         return nfs_count_backup_block_files(client, volume_name)
 
     else:
-        raise NotImplementedError
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
 
 
 def nfs_count_backup_block_files(client, volume_name):

manager/integration/tests/common.py

@@ -3899,6 +3899,10 @@ def is_backupTarget_cifs(s):
     return s.startswith("cifs://")
 
 
+def is_backupTarget_azurite(s):
+    return s.startswith("azblob://")
+
+
 def wait_for_backup_volume(client, vol_name, backing_image=""):
     for _ in range(RETRY_BACKUP_COUNTS):
         bv = client.by_id_backupVolume(vol_name)

manager/integration/tests/test_basic.py

@@ -673,6 +673,10 @@ def test_backup_block_deletion(set_random_backupstore, client, core_api, volume_
     17. Delete the backup volume
     18. Cleanup the volume
     """
+    backup_store_type = set_random_backupstore
+    if backup_store_type not in ["nfs", "s3"]:
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
+
     backupstore_cleanup(client)
 
     volume = create_and_check_volume(client, volume_name)
@@ -1106,6 +1110,10 @@ def test_backup_volume_list(set_random_backupstore, client, core_api):  # NOQA
     11. delete backup volumes(1 & 2)
     12. cleanup
     """
+    backup_store_type = set_random_backupstore
+    if backup_store_type not in ["nfs", "s3"]:
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
+
     backupstore_cleanup(client)
 
     # create 2 volumes.
@@ -1200,6 +1208,10 @@ def test_backup_metadata_deletion(set_random_backupstore, client, core_api, volu
     18. verify that volume(1) has been deleted in the backupstore.
     19. cleanup
     """
+    backup_store_type = set_random_backupstore
+    if backup_store_type not in ["nfs", "s3"]:
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
+
     backupstore_cleanup(client)
 
     volume1_name = volume_name + "-1"

manager/integration/tests/test_ha.py

@@ -1409,6 +1409,10 @@ def test_all_replica_restore_failure(set_random_backupstore, client, core_api, v
     15. Verify the faulted volume cannot be attached to a node.
     16. Verify this faulted volume can be deleted.
     """
+    backup_store_type = set_random_backupstore
+    if backup_store_type not in ["nfs", "s3"]:
+        pytest.skip("Skip test case because the backup store type is not supported") # NOQA
+
     auto_salvage_setting = client.by_id_setting(SETTING_AUTO_SALVAGE)
     assert auto_salvage_setting.name == SETTING_AUTO_SALVAGE
     assert auto_salvage_setting.value == "true"

pipelines/gke/scripts/longhorn-setup.sh

@@ -141,10 +141,8 @@ create_longhorn_namespace(){
 install_backupstores(){
   MINIO_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/minio-backupstore.yaml"
   NFS_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/nfs-backupstore.yaml"
-  CIFS_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml"
   kubectl create -f ${MINIO_BACKUPSTORE_URL} \
-               -f ${NFS_BACKUPSTORE_URL} \
-               -f ${CIFS_BACKUPSTORE_URL}
+               -f ${NFS_BACKUPSTORE_URL}
 }
 
 
@@ -180,9 +178,6 @@ run_longhorn_upgrade_test(){
   elif [[ $BACKUP_STORE_TYPE = "nfs" ]]; then
     BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $2}' | sed 's/ *//'`
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}
-  elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
-    BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $3}' | sed 's/ *//'`
-    yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}
   fi
 
   yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[4].value="'${LONGHORN_UPGRADE_TYPE}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}
@@ -231,9 +226,6 @@ run_longhorn_tests(){
   elif [[ $BACKUP_STORE_TYPE = "nfs" ]]; then
     BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $2}' | sed 's/ *//'`
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
-  elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
-    BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $3}' | sed 's/ *//'`
-    yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
   fi
 
   # set MANAGED_K8S_CLUSTER to true

pipelines/utilities/install_backupstores.sh

@@ -2,7 +2,33 @@ install_backupstores(){
   MINIO_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/minio-backupstore.yaml"
   NFS_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/nfs-backupstore.yaml"
   CIFS_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/cifs-backupstore.yaml"
+  AZURITE_BACKUPSTORE_URL="https://raw.githubusercontent.com/longhorn/longhorn/master/deploy/backupstores/azurite-backupstore.yaml"
   kubectl create -f ${MINIO_BACKUPSTORE_URL} \
                  -f ${NFS_BACKUPSTORE_URL} \
-                 -f ${CIFS_BACKUPSTORE_URL}
+                 -f ${CIFS_BACKUPSTORE_URL} \
+                 -f ${AZURITE_BACKUPSTORE_URL}
+  setup_azuitize_backup_store
 }
+
+setup_azuitize_backup_store(){
+  RETRY=0
+  MAX_RETRY=60
+  until (kubectl get pods | grep 'longhorn-test-azblob' | grep 'Running'); do
+    echo 'Waiting azurite pod running'
+    sleep 5
+    if [ $RETRY -eq $MAX_RETRY ]; then
+      break
+    fi
+    RETRY=$((RETRY+1))
+  done
+
+  AZBLOB_ENDPOINT=$(echo -n "http://$(kubectl get svc azblob-service -o jsonpath='{.spec.clusterIP}'):10000/" | base64)
+  kubectl -n longhorn-system patch secret azblob-secret \
+    --type=json \
+    -p="[{'op': 'replace', 'path': '/data/AZBLOB_ENDPOINT', 'value': \"${AZBLOB_ENDPOINT}\"}]"
+
+  CONTROL_PLANE_PUBLIC_IP=$(cat /tmp/controlplane_public_ip)
+  # port forward and az container create need to be run on control node
+  ssh ec2-user@${CONTROL_PLANE_PUBLIC_IP} "nohup kubectl port-forward --address 0.0.0.0 service/azblob-service 20001:10000 > /dev/null 2>&1 &"
+  ssh ec2-user@${CONTROL_PLANE_PUBLIC_IP} "az storage container create -n longhorn-test-azurite --connection-string 'DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://0.0.0.0:20001/devstoreaccount1;'"
+}

pipelines/utilities/run_longhorn_e2e_test.sh

@@ -1,6 +1,7 @@
 S3_BACKUP_STORE='s3://backupbucket@us-east-1/backupstore$minio-secret'
 NFS_BACKUP_STORE='nfs://longhorn-test-nfs-svc.default:/opt/backupstore'
 CIFS_BACKUP_STORE='cifs://longhorn-test-cifs-svc.default/backupstore$cifs-secret'
+AZURITE_BACKUP_STORE='azblob://[email protected]/$azblob-secret'
 
 run_longhorn_e2e_test(){
 
@@ -25,6 +26,8 @@ run_longhorn_e2e_test(){
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${NFS_BACKUP_STORE}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
   elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${CIFS_BACKUP_STORE}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
+  elif [[ $BACKUP_STORE_TYPE = "azurite" ]]; then
+    yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${AZURITE_BACKUP_STORE}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
   fi
 
   if [[ "${TF_VAR_use_hdd}" == true ]]; then
@@ -80,6 +83,8 @@ run_longhorn_e2e_test_out_of_cluster(){
     LONGHORN_BACKUPSTORES=${NFS_BACKUP_STORE}
   elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
     LONGHORN_BACKUPSTORES=${CIFS_BACKUP_STORE}
+  elif [[ $BACKUP_STORE_TYPE = "azurite" ]]; then
+    LONGHORN_BACKUPSTORES=${AZURITE_BACKUP_STORE}
   fi
   LONGHORN_BACKUPSTORE_POLL_INTERVAL="30"
 

pipelines/utilities/run_longhorn_test.sh

@@ -27,6 +27,9 @@ run_longhorn_test(){
   elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
     BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $3}' | sed 's/ *//'`
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
+  elif [[ $BACKUP_STORE_TYPE = "azurite" ]]; then
+    BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $4}' | sed 's/ *//'`
+    yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_TESTS_MANIFEST_FILE_PATH}
   fi
 
   if [[ "${TF_VAR_use_hdd}" == true ]]; then
@@ -113,6 +116,9 @@ run_longhorn_upgrade_test(){
   elif [[ $BACKUP_STORE_TYPE = "cifs" ]]; then
     BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $3}' | sed 's/ *//'`
     yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}
+  elif [[ $BACKUP_STORE_TYPE = "azurite" ]]; then
+    BACKUP_STORE_FOR_TEST=`yq e 'select(.spec.containers[0] != null).spec.containers[0].env[1].value' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH} | awk -F ',' '{print $4}' | sed 's/ *//'`
+    yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[1].value="'${BACKUP_STORE_FOR_TEST}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}
   fi
 
   yq e -i 'select(.spec.containers[0] != null).spec.containers[0].env[4].value="'${LONGHORN_UPGRADE_TYPE}'"' ${LONGHORN_UPGRADE_TESTS_MANIFEST_FILE_PATH}