From 00319e755eb024b6c08437865290abaface30135 Mon Sep 17 00:00:00 2001
From: Mark Bolton <mark.bolton@canonical.com>
Date: Thu, 6 Feb 2025 21:52:50 -0800
Subject: [PATCH] test: Add testing for storage bucket backups

Signed-off-by: Mark Bolton <mark.bolton@canonical.com>
---
 test/main.sh                   |  1 +
 test/suites/storage_buckets.sh | 88 ++++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+)

diff --git a/test/main.sh b/test/main.sh
index 7faf3e26ce4f..af43c1093d68 100755
--- a/test/main.sh
+++ b/test/main.sh
@@ -397,6 +397,7 @@ if [ "${1:-"all"}" != "cluster" ]; then
     run_test test_storage_driver_zfs "zfs storage driver"
     run_test test_storage_driver_pure "pure storage driver"
     run_test test_storage_buckets "storage buckets"
+    run_test test_storage_bucket_export "storage buckets export and import"
     run_test test_storage_volume_import "storage volume import"
     run_test test_storage_volume_initial_config "storage volume initial configuration"
     run_test test_resources "resources"
diff --git a/test/suites/storage_buckets.sh b/test/suites/storage_buckets.sh
index 2165adf89dcf..2536fe66ce06 100644
--- a/test/suites/storage_buckets.sh
+++ b/test/suites/storage_buckets.sh
@@ -159,3 +159,91 @@ EOF
 
   delete_object_storage_pool "${poolName}"
 }
+
+test_storage_bucket_export() {
+  local lxd_backend
+
+  lxd_backend=$(storage_backend "$LXD_DIR")
+
+  if [ "$lxd_backend" = "ceph" ]; then
+    if [ -z "${LXD_CEPH_CEPHOBJECT_RADOSGW:-}" ]; then
+      # Check LXD_CEPH_CEPHOBJECT_RADOSGW specified for ceph bucket tests.
+      export TEST_UNMET_REQUIREMENT="LXD_CEPH_CEPHOBJECT_RADOSGW not specified"
+      return
+    fi
+  elif ! command -v minio ; then
+    # Check minio is installed for local storage pool buckets.
+    export TEST_UNMET_REQUIREMENT="minio command not found"
+    return
+  fi
+
+  poolName=$(lxc profile device get default root pool)
+  bucketPrefix="lxd$$"
+
+  create_object_storage_pool "${poolName}"
+
+  # Check cephobject.radosgw.endpoint is required for cephobject pools.
+  if [ "$lxd_backend" = "ceph" ]; then
+    s3Endpoint="${LXD_CEPH_CEPHOBJECT_RADOSGW}"
+  else
+    s3Endpoint="https://$(lxc config get core.storage_buckets_address)"
+  fi
+
+  # Create test bucket
+  initCreds=$(lxc storage bucket create "${poolName}" "${bucketPrefix}.foo" user.foo=comment)
+  initAccessKey=$(echo "${initCreds}" | awk '{ if ($2 == "access" && $3 == "key:") {print $4}}')
+  initSecretKey=$(echo "${initCreds}" | awk '{ if ($2 == "secret" && $3 == "key:") {print $4}}')
+  s3cmdrun "${s3Endpoint}" "${lxd_backend}" "${initAccessKey}" "${initSecretKey}" ls | grep -F "${bucketPrefix}.foo"
+
+  # Test putting a file into a bucket.
+  lxdTestFile="bucketfile_${bucketPrefix}.txt"
+  echo "hello world"> "${lxdTestFile}"
+  s3cmdrun "${s3Endpoint}" "${lxd_backend}" "${initAccessKey}" "${initSecretKey}" put "${lxdTestFile}" "s3://${bucketPrefix}.foo"
+
+  # Export test bucket
+  lxc storage bucket export "${poolName}" "${bucketPrefix}.foo" "${LXD_DIR}/testbucket.tar.gz"
+  [ -f "${LXD_DIR}/testbucket.tar.gz" ]
+
+  # Extract storage backup tarball.
+  mkdir "${LXD_DIR}/storage-bucket-export"
+  tar -xzf "${LXD_DIR}/testbucket.tar.gz" -C "${LXD_DIR}/storage-bucket-export"
+
+  # Check tarball content.
+  [ -f "${LXD_DIR}/storage-bucket-export/backup/index.yaml" ]
+  [ -f "${LXD_DIR}/storage-bucket-export/backup/bucket/${lxdTestFile}" ]
+  [ "$(cat "${LXD_DIR}/storage-bucket-export/backup/bucket/${lxdTestFile}")" = "hello world" ]
+
+  # Note original bucket size.
+  orig_size="$(lxc storage bucket get ${poolName} ${bucketPrefix}.foo size)"
+  orig_md5sum="$(s3cmdrun "${s3Endpoint}" "${lxd_backend}" "${initAccessKey}" "${initSecretKey}" info "s3://${bucketPrefix}.foo/${lxdTestFile}" | awk '{ if ($1 == "MD5") {print $3}}')  -"
+
+
+  # Delete bucket and import exported bucket.
+  lxc storage bucket delete "${poolName}" "${bucketPrefix}.foo"
+  lxc storage bucket import "${poolName}" "${LXD_DIR}/testbucket.tar.gz" "${bucketPrefix}.bar"
+  rm "${LXD_DIR}/testbucket.tar.gz"
+
+  # Note imported bucket size and md5sum
+  imported_size="$(lxc storage bucket get ${poolName} ${bucketPrefix}.bar size)"
+  imported_md5sum="$(s3cmdrun "${s3Endpoint}" "${lxd_backend}" "${initAccessKey}" "${initSecretKey}" info "s3://${bucketPrefix}.bar/${lxdTestFile}" | awk '{ if ($1 == "MD5") {print $3}}')  -"
+
+  # Ensure original size and md5sum equivalent to imported.
+  [ "${orig_size}" = "${imported_size}" ]
+  [ "${orig_md5sum}" = "${imported_md5sum}" ]  
+
+  # Test listing bucket files via S3.
+  s3cmdrun "${s3Endpoint}" "${lxd_backend}" "${initAccessKey}" "${initSecretKey}" ls "s3://${bucketPrefix}.bar" | grep -F "${lxdTestFile}"
+
+  # Test getting admin key from bucket.
+  lxc storage bucket key list "${poolName}" "${bucketPrefix}.bar" | grep -F "admin"
+
+  # Clean up.
+  lxc storage bucket delete "${poolName}" "${bucketPrefix}.bar"
+  ! lxc storage bucket list "${poolName}" | grep -F "${bucketPrefix}.bar" || false
+  ! lxc storage bucket show "${poolName}" "${bucketPrefix}.bar" || false
+
+  delete_object_storage_pool "${poolName}"
+
+  rm -rf "${LXD_DIR}/storage-bucket-export/"*
+  rmdir "${LXD_DIR}/storage-bucket-export"
+}