Files
my-rook-config/tests/integration/ceph_object_test.go
T
Joshua Hoblitt b4d6335368 test: convert the object bucket read/write suite to the shared store
Add tests/integration/object/bucket/rw, the first slice carved from the
legacy testObjectStoreOperations. It provisions an OBC on the shared store,
writes, reads back, and deletes an object over S3, and checks the OBC stays
Bound. It runs against the shared store in both the TLS and non-TLS passes.

Drop the converted put/get and OBC-revert subtests from the legacy test;
the user quota subtest now seeds both of the objects it needs. The
remaining quota, policy, lifecycle, and dependents slices convert in later
PRs.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
2026-07-02 08:41:59 -07:00

1096 lines
41 KiB
Go

/*
Copyright 2021 The Rook Authors. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package integration
import (
"context"
"encoding/json"
"errors"
"fmt"
"strings"
"testing"
"time"
"github.com/aws/aws-sdk-go-v2/service/s3"
s3types "github.com/aws/aws-sdk-go-v2/service/s3/types"
smithy "github.com/aws/smithy-go"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/kube-object-storage/lib-bucket-provisioner/pkg/apis/objectbucket.io/v1alpha1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
v1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/daemon/ceph/client"
rgw "github.com/rook/rook/pkg/operator/ceph/object"
"github.com/rook/rook/tests/framework/clients"
"github.com/rook/rook/tests/framework/installer"
"github.com/rook/rook/tests/framework/utils"
bucketowner "github.com/rook/rook/tests/integration/object/bucket/owner"
bucketrw "github.com/rook/rook/tests/integration/object/bucket/rw"
"github.com/rook/rook/tests/integration/object/cosi"
"github.com/rook/rook/tests/integration/object/notification"
topickafka "github.com/rook/rook/tests/integration/object/topic/kafka"
usercaps "github.com/rook/rook/tests/integration/object/user/caps"
userkeys "github.com/rook/rook/tests/integration/object/user/keys"
useropmask "github.com/rook/rook/tests/integration/object/user/opmask"
"github.com/rook/rook/tests/integration/object/util/sharedstore"
)
const (
objectStoreServicePrefixUniq = "rook-ceph-rgw-"
objectStoreTLSName = "tls-test-store"
)
var objectStoreServicePrefix = "rook-ceph-rgw-"
var lifecycleCmpOpts = cmp.Options{
cmpopts.IgnoreUnexported(
s3types.LifecycleRule{},
s3types.LifecycleExpiration{},
s3types.LifecycleRuleFilter{},
s3types.LifecycleRuleAndOperator{},
s3types.AbortIncompleteMultipartUpload{},
s3types.NoncurrentVersionExpiration{},
s3types.NoncurrentVersionTransition{},
s3types.Transition{},
s3types.Tag{},
),
}
func TestCephObjectSuite(t *testing.T) {
s := new(ObjectSuite)
defer func(s *ObjectSuite) {
HandlePanics(recover(), s.TearDownSuite, s.T)
}(s)
suite.Run(t, s)
}
type ObjectSuite struct {
suite.Suite
helper *clients.TestClient
settings *installer.TestCephSettings
installer *installer.CephInstaller
k8sh *utils.K8sHelper
}
func (s *ObjectSuite) SetupSuite() {
namespace := "object-ns"
s.settings = &installer.TestCephSettings{
ClusterName: "object-cluster",
Namespace: namespace,
OperatorNamespace: installer.SystemNamespace(namespace),
StorageClassName: installer.StorageClassName(),
UseHelm: false,
UsePVC: installer.UsePVC(),
Mons: 3,
SkipOSDCreation: false,
UseCrashPruner: true,
EnableVolumeReplication: false,
RookVersion: installer.LocalBuildTag,
CephVersion: installer.ReturnCephVersion(),
}
s.settings.ApplyEnvVars()
s.installer, s.k8sh = StartTestCluster(s.T, s.settings)
s.helper = clients.CreateTestClient(s.k8sh, s.installer.Manifests)
}
func (s *ObjectSuite) AfterTest(suiteName, testName string) {
s.installer.CollectOperatorLog(suiteName, testName)
}
func (s *ObjectSuite) TearDownSuite() {
s.installer.UninstallRook()
}
func (s *ObjectSuite) TestWithTLS() {
if utils.IsPlatformOpenShift() {
s.T().Skip("object store tests skipped on openshift")
}
tls := true
swiftAndKeystone := false
objectStoreServicePrefix = objectStoreServicePrefixUniq
runObjectE2ETest(s.helper, s.k8sh, s.installer, &s.Suite, s.settings, tls, swiftAndKeystone)
cleanUpTLS(s)
}
func cleanUpTLS(s *ObjectSuite) {
err := s.k8sh.Clientset.CoreV1().Secrets(s.settings.Namespace).Delete(context.TODO(), objectTLSSecretName, metav1.DeleteOptions{})
if err != nil {
if !k8serrors.IsNotFound(err) {
logger.Fatal("failed to deleted store TLS secret")
}
}
logger.Info("successfully deleted store TLS secret")
}
func (s *ObjectSuite) TestWithoutTLS() {
if utils.IsPlatformOpenShift() {
s.T().Skip("object store tests skipped on openshift")
}
tls := false
swiftAndKeystone := false
objectStoreServicePrefix = objectStoreServicePrefixUniq
runObjectE2ETest(s.helper, s.k8sh, s.installer, &s.Suite, s.settings, tls, swiftAndKeystone)
}
// Smoke Test for ObjectStore - Test check the following operations on ObjectStore in order
// Create object store, Create User, Connect to Object Store, Create Bucket, Read/Write/Delete to bucket,
// Check issues in MGRs, Delete Bucket and Delete user
// Test for ObjectStore with and without TLS enabled
func runObjectE2ETest(helper *clients.TestClient, k8sh *utils.K8sHelper, installer *installer.CephInstaller, s *suite.Suite, settings *installer.TestCephSettings, tlsEnable bool, swiftAndKeystone bool) {
namespace := settings.Namespace
storeName := "test-store"
if tlsEnable {
storeName = objectStoreTLSName
}
logger.Infof("Running on Rook Cluster %s", namespace)
// a single gateway makes quota enforcement deterministic: rgw quota checks
// run against per-instance cached stats, and with multiple gateways an
// instance can be blind to writes served by its peers for up to
// rgw_user_quota_bucket_sync_interval; multi-instance deployment is still
// covered by the keystone suite
createCephObjectStore(s.T(), helper, k8sh, installer, namespace, storeName, 1, tlsEnable, swiftAndKeystone)
// Canary test: verify all *_pool fields in zone.json are covered by Rook's zonePoolNSSuffix map.
// This catches new RGW pool fields added in newer Ceph versions that Rook doesn't yet handle,
// which would cause ghost default pools when shared pools are configured.
// Run right after store creation when the zone is fresh and definitely accessible.
s.T().Run("all zone.json pool fields are covered by Rook shared pool mapping", func(t *testing.T) {
output, err := installer.Execute("radosgw-admin",
[]string{"zone", "get", fmt.Sprintf("--rgw-zone=%s", storeName), fmt.Sprintf("--rgw-realm=%s", storeName)}, namespace)
require.NoError(t, err, "failed to get zone config; output: %s", output)
require.NotEmpty(t, output, "zone config is empty")
var zoneConfig map[string]interface{}
err = json.Unmarshal([]byte(output), &zoneConfig)
require.NoError(t, err, "failed to parse zone config JSON; output: %s", output)
knownPools := rgw.ZoneJsonPoolKeys()
for field, val := range zoneConfig {
if _, ok := val.(string); !ok {
continue
}
if !strings.HasSuffix(field, "_pool") {
continue
}
assert.Contains(t, knownPools, field,
"RGW zone.json contains unknown pool field %q — add it to zonePoolNSSuffix in pkg/operator/ceph/object/objectstore.go", field)
}
})
// test that a second object store can be created (and deleted) while the first exists
s.T().Run("run a second object store", func(t *testing.T) {
otherStoreName := "other-" + storeName
// The lite e2e test is perfect, as it only creates a cluster, checks that it is healthy,
// and then deletes it.
deleteStore := true
runObjectE2ETestLite(t, helper, k8sh, installer, namespace, otherStoreName, 1, deleteStore, tlsEnable, swiftAndKeystone)
})
// now test operation of the first object store
testObjectStoreOperations(s, helper, k8sh, settings, storeName, swiftAndKeystone)
sharedObjectStore := sharedstore.Create(s.T(), k8sh, installer, tlsEnable,
bucketowner.Namespace,
bucketrw.Namespace,
userkeys.Namespace,
topickafka.Namespace,
useropmask.Namespace,
usercaps.Namespace,
cosi.Namespace,
notification.Namespace,
)
defer sharedObjectStore.Destroy()
bucketowner.TestObjectBucketClaimBucketOwner(s.T(), k8sh, sharedObjectStore)
bucketrw.TestObjectBucketClaimReadWrite(s.T(), k8sh, sharedObjectStore)
userkeys.TestObjectStoreUserKeys(s.T(), k8sh, sharedObjectStore)
topickafka.TestBucketTopicKafka(s.T(), k8sh, sharedObjectStore)
useropmask.TestObjectStoreUserOpMask(s.T(), k8sh, sharedObjectStore)
usercaps.TestObjectStoreUserCaps(s.T(), k8sh, sharedObjectStore)
// the ceph-cosi driver cannot reach a TLS object store endpoint, so this
// suite skips itself in the TLS pass
cosi.TestCephCOSIDriver(s.T(), k8sh, sharedObjectStore)
notification.TestBucketNotification(s.T(), k8sh, sharedObjectStore)
}
func testObjectStoreOperations(s *suite.Suite, helper *clients.TestClient, k8sh *utils.K8sHelper, settings *installer.TestCephSettings, storeName string, swiftAndKeystone bool) {
ctx := context.TODO()
namespace := settings.Namespace
clusterInfo := client.AdminTestClusterInfo(namespace)
t := s.T()
logger.Infof("Testing Object Operations on %s", storeName)
t.Run("create CephObjectStoreUser", func(t *testing.T) {
createCephObjectUser(s, helper, k8sh, namespace, storeName, userid, true)
i := 0
for i = 0; i < 4; i++ {
if helper.ObjectUserClient.UserSecretExists(namespace, storeName, userid) {
break
}
logger.Info("waiting 5 more seconds for user secret to exist")
time.Sleep(5 * time.Second)
}
assert.NotEqual(t, 4, i)
})
context := k8sh.MakeContext()
objectStore, err := k8sh.RookClientset.CephV1().CephObjectStores(namespace).Get(ctx, storeName, metav1.GetOptions{})
assert.Nil(t, err)
rgwcontext, err := rgw.NewMultisiteContext(context, clusterInfo, objectStore)
assert.Nil(t, err)
t.Run("create ObjectBucketClaim", func(t *testing.T) {
logger.Infof("create OBC %q with storageclass %q - using reclaim policy 'delete' so buckets don't block deletion", obcName, bucketStorageClassName)
cobErr := helper.BucketClient.CreateBucketStorageClass(namespace, storeName, bucketStorageClassName, "Delete")
assert.Nil(t, cobErr)
cobcErr := helper.BucketClient.CreateObc(obcName, bucketStorageClassName, bucketname, maxObject, true)
assert.Nil(t, cobcErr)
created := utils.Retry(20, 2*time.Second, "OBC is created", func() bool {
return helper.BucketClient.CheckOBC(obcName, "bound")
})
assert.True(t, created)
logger.Info("OBC created successfully")
var bkt rgw.ObjectBucket
i := 0
for i = 0; i < 4; i++ {
b, code, err := rgw.GetBucket(rgwcontext, bucketname)
if b != nil && err == nil {
bkt = *b
break
}
logger.Warningf("cannot get bucket %q, retrying... bucket: %v. code: %d, err: %v", bucketname, b, code, err)
logger.Infof("(%d) check bucket exists, sleeping for 5 seconds ...", i)
time.Sleep(5 * time.Second)
}
assert.NotEqual(t, 4, i)
assert.Equal(t, bucketname, bkt.Name)
logger.Info("OBC, Secret and ConfigMap created")
})
t.Run("S3 access to OBC bucket", func(t *testing.T) {
var s3client *rgw.S3Agent
s3endpoint, _ := helper.ObjectClient.GetEndPointUrl(namespace, storeName)
s3AccessKey, _ := helper.BucketClient.GetAccessKey(obcName)
s3SecretKey, _ := helper.BucketClient.GetSecretKey(obcName)
insecure := objectStore.Spec.IsTLSEnabled()
s3client, err = rgw.NewS3Agent(s3AccessKey, s3SecretKey, s3endpoint, true, nil, insecure, nil)
assert.Nil(t, err)
logger.Infof("endpoint (%s) Accesskey (%s) secret (%s)", s3endpoint, s3AccessKey, s3SecretKey)
t.Run("user quota enforcement", func(t *testing.T) {
_, poErr := s3client.PutObjectInBucket(ctx, bucketname, ObjBody, ObjectKey1, contentType)
assert.Nil(t, poErr)
_, poErr = s3client.PutObjectInBucket(ctx, bucketname, ObjBody, ObjectKey2, contentType)
assert.Nil(t, poErr)
logger.Infof("Testing the max object limit")
quotaEnforced := utils.Retry(30, 2*time.Second, "user quota enforced", func() bool {
_, err := s3client.PutObjectInBucket(ctx, bucketname, ObjBody, ObjectKey3, contentType)
if err != nil {
return true
}
// delete so next attempt creates a new object rather than overwriting
s3client.DeleteObjectInBucket(ctx, bucketname, ObjectKey3) //nolint:errcheck
return false
})
assert.True(t, quotaEnforced)
})
t.Run("update user quota limits", func(t *testing.T) {
poErr := helper.BucketClient.UpdateObc(obcName, bucketStorageClassName, bucketname, newMaxObject, true)
assert.Nil(t, poErr)
updated := utils.Retry(20, 2*time.Second, "OBC is updated", func() bool {
return helper.BucketClient.CheckOBMaxObject(obcName, newMaxObject)
})
assert.True(t, updated)
logger.Infof("Testing the updated object limit")
_, poErr = s3client.PutObjectInBucket(ctx, bucketname, ObjBody, ObjectKey3, contentType)
assert.NoError(t, poErr)
quotaEnforced := utils.Retry(30, 2*time.Second, "updated user quota enforced", func() bool {
_, putErr := s3client.PutObjectInBucket(ctx, bucketname, ObjBody, ObjectKey4, contentType)
if putErr != nil {
return true
}
// delete so next attempt creates a new object rather than overwriting
s3client.DeleteObjectInBucket(ctx, bucketname, ObjectKey4) //nolint:errcheck
return false
})
assert.True(t, quotaEnforced)
})
t.Run("delete objects", func(t *testing.T) {
_, delobjErr := s3client.DeleteObjectInBucket(ctx, bucketname, ObjectKey1)
assert.Nil(t, delobjErr)
_, delobjErr = s3client.DeleteObjectInBucket(ctx, bucketname, ObjectKey2)
assert.Nil(t, delobjErr)
_, delobjErr = s3client.DeleteObjectInBucket(ctx, bucketname, ObjectKey3)
assert.Nil(t, delobjErr)
logger.Info("Objects deleted on bucket successfully")
})
})
// this test deviates from the others in this package in that it does not
// rely on kubectl and uses the k8s api directly
t.Run("OBC bucket quota enforcement", func(t *testing.T) {
bucketName := "bucket-quota-test"
var obName string
var s3client *rgw.S3Agent
t.Run("create obc with bucketMaxObjects", func(t *testing.T) {
newObc := v1alpha1.ObjectBucketClaim{
ObjectMeta: metav1.ObjectMeta{
Name: bucketName,
Namespace: namespace,
},
Spec: v1alpha1.ObjectBucketClaimSpec{
BucketName: bucketName,
StorageClassName: bucketStorageClassName,
AdditionalConfig: map[string]string{
"bucketMaxObjects": "1",
},
},
}
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Create(ctx, &newObc, metav1.CreateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, 2*time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, 2*time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketMaxObjects is set
assert.True(t, obc.Spec.AdditionalConfig["bucketMaxObjects"] == "1")
// as the tests are running external to k8s, the internal svc can't be used
labelSelector := "rgw=" + storeName
services, err := k8sh.Clientset.CoreV1().Services(namespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelector})
assert.Nil(t, err)
assert.Equal(t, 1, len(services.Items))
s3endpoint := services.Items[0].Spec.ClusterIP + ":80"
secret, err := k8sh.Clientset.CoreV1().Secrets(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
s3AccessKey := string(secret.Data["AWS_ACCESS_KEY_ID"])
s3SecretKey := string(secret.Data["AWS_SECRET_ACCESS_KEY"])
insecure := objectStore.Spec.IsTLSEnabled()
s3client, err = rgw.NewS3Agent(s3AccessKey, s3SecretKey, s3endpoint, true, nil, insecure, nil)
assert.Nil(t, err)
logger.Infof("endpoint (%s) Accesskey (%s) secret (%s)", s3endpoint, s3AccessKey, s3SecretKey)
})
t.Run("bucketMaxObjects quota is enforced", func(t *testing.T) {
// first object should succeed
_, err := s3client.PutObjectInBucket(ctx, bucketName, ObjBody, ObjectKey1, contentType)
assert.Nil(t, err)
// second object should fail as bucket quota is 1
_, err = s3client.PutObjectInBucket(ctx, bucketName, ObjBody, ObjectKey2, contentType)
assert.Error(t, err)
// cleanup bucket
_, err = s3client.DeleteObjectInBucket(ctx, bucketName, ObjectKey1)
assert.Nil(t, err)
_, err = s3client.DeleteObjectInBucket(ctx, bucketName, ObjectKey2)
assert.Nil(t, err)
})
t.Run("change quota to bucketMaxSize", func(t *testing.T) {
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obc.Spec.AdditionalConfig = map[string]string{"bucketMaxSize": "4Ki"}
_, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Update(ctx, obc, metav1.UpdateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, 2*time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, 2*time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketMaxSize is set
assert.True(t, obc.Spec.AdditionalConfig["bucketMaxSize"] == "4Ki")
})
t.Run("bucketMaxSize quota is enforced", func(t *testing.T) {
// first ~3KiB Object should succeed
_, err := s3client.PutObjectInBucket(ctx, bucketName, strings.Repeat("1", 3072), ObjectKey1, contentType)
assert.Nil(t, err)
// second ~2KiB Object should fail as bucket quota is 4KiB
_, err = s3client.PutObjectInBucket(ctx, bucketName, strings.Repeat("2", 2048), ObjectKey2, contentType)
assert.Error(t, err)
// cleanup bucket
_, err = s3client.DeleteObjectInBucket(ctx, bucketName, ObjectKey1)
assert.Nil(t, err)
_, err = s3client.DeleteObjectInBucket(ctx, bucketName, ObjectKey2)
assert.Nil(t, err)
})
t.Run("delete bucket", func(t *testing.T) {
err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Delete(ctx, bucketName, metav1.DeleteOptions{})
assert.Nil(t, err)
absent := utils.Retry(20, 2*time.Second, "OBC is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
absent = utils.Retry(20, 2*time.Second, "OB is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
})
})
t.Run("OBC bucket policy management", func(t *testing.T) {
bucketName := "bucket-policy-test"
var obName string
var s3client *rgw.S3Agent
bucketPolicy1 := `
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam:::user/foo"
},
"Action": [
"s3:GetObject",
"s3:PutObject",
"s3:DeleteObject",
"s3:ListBucket",
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::bucket-policy-test/*"
]
}
]
}
`
bucketPolicy2 := `
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam:::user/bar"
},
"Action": [
"s3:GetObject",
"s3:ListBucket",
"s3:GetBucketLocation"
],
"Resource": [
"arn:aws:s3:::bucket-policy-test/*"
]
}
]
}
`
t.Run("create obc with bucketPolicy", func(t *testing.T) {
newObc := v1alpha1.ObjectBucketClaim{
ObjectMeta: metav1.ObjectMeta{
Name: bucketName,
Namespace: namespace,
},
Spec: v1alpha1.ObjectBucketClaimSpec{
BucketName: bucketName,
StorageClassName: bucketStorageClassName,
AdditionalConfig: map[string]string{
"bucketPolicy": bucketPolicy1,
},
},
}
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Create(ctx, &newObc, metav1.CreateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, 2*time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, 2*time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketPolicy is set
assert.Equal(t, bucketPolicy1, obc.Spec.AdditionalConfig["bucketPolicy"])
// as the tests are running external to k8s, the internal svc can't be used
labelSelector := "rgw=" + storeName
services, err := k8sh.Clientset.CoreV1().Services(namespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelector})
assert.Nil(t, err)
assert.Equal(t, 1, len(services.Items))
s3endpoint := services.Items[0].Spec.ClusterIP + ":80"
secret, err := k8sh.Clientset.CoreV1().Secrets(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
s3AccessKey := string(secret.Data["AWS_ACCESS_KEY_ID"])
s3SecretKey := string(secret.Data["AWS_SECRET_ACCESS_KEY"])
insecure := objectStore.Spec.IsTLSEnabled()
s3client, err = rgw.NewS3Agent(s3AccessKey, s3SecretKey, s3endpoint, true, nil, insecure, nil)
assert.Nil(t, err)
logger.Infof("endpoint (%s) Accesskey (%s) secret (%s)", s3endpoint, s3AccessKey, s3SecretKey)
})
t.Run("policy was applied verbatim to bucket", func(t *testing.T) {
policyResp, err := s3client.Client.GetBucketPolicy(ctx, &s3.GetBucketPolicyInput{
Bucket: &bucketName,
})
require.NoError(t, err)
assert.Equal(t, bucketPolicy1, *policyResp.Policy)
})
t.Run("update obc bucketPolicy", func(t *testing.T) {
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obc.Spec.AdditionalConfig["bucketPolicy"] = bucketPolicy2
_, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Update(ctx, obc, metav1.UpdateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that updated bucketPolicy is set
assert.Equal(t, bucketPolicy2, obc.Spec.AdditionalConfig["bucketPolicy"])
})
t.Run("policy update applied verbatim to bucket", func(t *testing.T) {
var livePolicy string
utils.Retry(20, time.Second, "policy changed", func() bool {
policyResp, err := s3client.Client.GetBucketPolicy(ctx, &s3.GetBucketPolicyInput{
Bucket: &bucketName,
})
if err != nil {
return false
}
livePolicy = *policyResp.Policy
return bucketPolicy2 == livePolicy
})
assert.Equal(t, bucketPolicy2, livePolicy)
})
t.Run("remove obc bucketPolicy", func(t *testing.T) {
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obc.Spec.AdditionalConfig = map[string]string{}
_, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Update(ctx, obc, metav1.UpdateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketPolicy is unset
assert.NotContains(t, obc.Spec.AdditionalConfig, "bucketPolicy")
})
t.Run("policy was removed from bucket", func(t *testing.T) {
var err error
utils.Retry(20, time.Second, "policy is gone", func() bool {
_, err = s3client.Client.GetBucketPolicy(ctx, &s3.GetBucketPolicyInput{
Bucket: &bucketName,
})
return err != nil
})
require.Error(t, err)
var apiErr smithy.APIError
require.True(t, errors.As(err, &apiErr))
assert.Equal(t, "NoSuchBucketPolicy", apiErr.ErrorCode())
})
t.Run("delete bucket", func(t *testing.T) {
err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Delete(ctx, bucketName, metav1.DeleteOptions{})
assert.Nil(t, err)
absent := utils.Retry(20, time.Second, "OBC is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
absent = utils.Retry(20, time.Second, "OB is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
})
})
t.Run("OBC bucket lifecycle management", func(t *testing.T) {
bucketName := "bucket-lifecycle-test"
var obName string
var s3client *rgw.S3Agent
bucketLifecycle1 := `
{
"Rules":[
{
"ID": "AbortIncompleteMultipartUploads",
"Status": "Enabled",
"Prefix": "",
"AbortIncompleteMultipartUpload": {
"DaysAfterInitiation": 1
}
}
]
}
`
// rules must be sorted by ID to be idempotent
bucketLifecycle2 := `
{
"Rules": [
{
"ID": "AbortIncompleteMultipartUploads",
"Status": "Enabled",
"Prefix": "",
"AbortIncompleteMultipartUpload": {
"DaysAfterInitiation": 1
}
},
{
"ID": "ExpireAfter30Days",
"Status": "Enabled",
"Prefix": "",
"Expiration": {
"Days": 30
}
}
]
}
`
t.Run("create obc with bucketLifecycle", func(t *testing.T) {
newObc := v1alpha1.ObjectBucketClaim{
ObjectMeta: metav1.ObjectMeta{
Name: bucketName,
Namespace: namespace,
},
Spec: v1alpha1.ObjectBucketClaimSpec{
BucketName: bucketName,
StorageClassName: bucketStorageClassName,
AdditionalConfig: map[string]string{
"bucketLifecycle": bucketLifecycle1,
},
},
}
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Create(ctx, &newObc, metav1.CreateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, 2*time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, 2*time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketLifecycle is set
assert.Equal(t, bucketLifecycle1, obc.Spec.AdditionalConfig["bucketLifecycle"])
// as the tests are running external to k8s, the internal svc can't be used
labelSelector := "rgw=" + storeName
services, err := k8sh.Clientset.CoreV1().Services(namespace).List(ctx, metav1.ListOptions{LabelSelector: labelSelector})
assert.Nil(t, err)
assert.Equal(t, 1, len(services.Items))
s3endpoint := services.Items[0].Spec.ClusterIP + ":80"
secret, err := k8sh.Clientset.CoreV1().Secrets(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
s3AccessKey := string(secret.Data["AWS_ACCESS_KEY_ID"])
s3SecretKey := string(secret.Data["AWS_SECRET_ACCESS_KEY"])
insecure := objectStore.Spec.IsTLSEnabled()
s3client, err = rgw.NewS3Agent(s3AccessKey, s3SecretKey, s3endpoint, true, nil, insecure, nil)
assert.Nil(t, err)
logger.Infof("endpoint (%s) Accesskey (%s) secret (%s)", s3endpoint, s3AccessKey, s3SecretKey)
})
t.Run("lifecycle was applied verbatim to bucket", func(t *testing.T) {
liveLc, err := s3client.Client.GetBucketLifecycleConfiguration(ctx, &s3.GetBucketLifecycleConfigurationInput{
Bucket: &bucketName,
})
require.NoError(t, err)
confLc := &s3types.BucketLifecycleConfiguration{}
err = json.Unmarshal([]byte(bucketLifecycle1), confLc)
require.NoError(t, err)
assert.True(t, cmp.Equal(confLc.Rules, liveLc.Rules, lifecycleCmpOpts...), cmp.Diff(confLc.Rules, liveLc.Rules, lifecycleCmpOpts...))
})
t.Run("update obc bucketLifecycle", func(t *testing.T) {
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obc.Spec.AdditionalConfig["bucketLifecycle"] = bucketLifecycle2
_, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Update(ctx, obc, metav1.UpdateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that updated bucketLifecycle is set
assert.Equal(t, bucketLifecycle2, obc.Spec.AdditionalConfig["bucketLifecycle"])
})
t.Run("lifecycle update applied verbatim to bucket", func(t *testing.T) {
var liveLc *s3.GetBucketLifecycleConfigurationOutput
confLc := &s3types.BucketLifecycleConfiguration{}
err = json.Unmarshal([]byte(bucketLifecycle2), confLc)
require.NoError(t, err)
utils.Retry(20, time.Second, "lifecycle changed", func() bool {
liveLc, err = s3client.Client.GetBucketLifecycleConfiguration(ctx, &s3.GetBucketLifecycleConfigurationInput{
Bucket: &bucketName,
})
if err != nil {
return false
}
return cmp.Equal(confLc.Rules, liveLc.Rules, lifecycleCmpOpts...)
})
assert.True(t, cmp.Equal(confLc.Rules, liveLc.Rules, lifecycleCmpOpts...), cmp.Diff(confLc.Rules, liveLc.Rules, lifecycleCmpOpts...))
})
t.Run("remove obc bucketLifecycle", func(t *testing.T) {
obc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obc.Spec.AdditionalConfig = map[string]string{}
_, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Update(ctx, obc, metav1.UpdateOptions{})
assert.Nil(t, err)
obcBound := utils.Retry(20, time.Second, "OBC is Bound", func() bool {
liveObc, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
if err != nil {
return false
}
return liveObc.Status.Phase == v1alpha1.ObjectBucketClaimStatusPhaseBound
})
assert.True(t, obcBound)
// wait until obc is Bound to lookup the ob name
obc, err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
assert.Nil(t, err)
obName = obc.Spec.ObjectBucketName
obBound := utils.Retry(20, time.Second, "OB is Bound", func() bool {
liveOb, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
if err != nil {
return false
}
return liveOb.Status.Phase == v1alpha1.ObjectBucketStatusPhaseBound
})
assert.True(t, obBound)
// verify that bucketLifecycle is unset
assert.NotContains(t, obc.Spec.AdditionalConfig, "bucketLifecycle")
})
t.Run("lifecycle was removed from bucket", func(t *testing.T) {
cephcluster, err := k8sh.RookClientset.CephV1().CephClusters(namespace).Get(ctx, settings.ClusterName, metav1.GetOptions{})
if err != nil {
t.Fatalf("failed to get CephCluster: %v", err)
}
logger.Infof("CephCluster version: %s", cephcluster.Status.CephVersion.Version)
if strings.HasPrefix(cephcluster.Status.CephVersion.Version, "19.2.3") {
t.Skip("Waiting for rgw fix from regression in v19.2.3")
}
utils.Retry(20, time.Second, "lifecycle is gone", func() bool {
_, err = s3client.Client.GetBucketLifecycleConfiguration(ctx, &s3.GetBucketLifecycleConfigurationInput{
Bucket: &bucketName,
})
var apiErr smithy.APIError
if errors.As(err, &apiErr) {
return apiErr.ErrorCode() == "NoSuchLifecycleConfiguration"
}
return false
})
require.Error(t, err)
var apiErr smithy.APIError
require.True(t, errors.As(err, &apiErr))
assert.Equal(t, "NoSuchLifecycleConfiguration", apiErr.ErrorCode())
})
t.Run("delete bucket", func(t *testing.T) {
err = k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Delete(ctx, bucketName, metav1.DeleteOptions{})
assert.Nil(t, err)
absent := utils.Retry(20, time.Second, "OBC is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBucketClaims(namespace).Get(ctx, bucketName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
absent = utils.Retry(20, time.Second, "OB is absent", func() bool {
_, err := k8sh.BucketClientset.ObjectbucketV1alpha1().ObjectBuckets().Get(ctx, obName, metav1.GetOptions{})
return err != nil
})
assert.True(t, absent)
})
})
t.Run("delete CephObjectStore should be blocked by OBC bucket and CephObjectStoreUser", func(t *testing.T) {
deleteObjectStore(t, k8sh, namespace, storeName)
store := &cephv1.CephObjectStore{}
i := 0
for i = 0; i < 4; i++ {
storeStr, err := k8sh.GetResource("-n", namespace, "CephObjectStore", storeName, "-o", "json")
assert.NoError(t, err)
err = json.Unmarshal([]byte(storeStr), &store)
assert.NoError(t, err)
cond := cephv1.FindStatusCondition(store.Status.Conditions, cephv1.ConditionDeletionIsBlocked)
if cond != nil {
break
}
logger.Info("waiting 2 more seconds for CephObjectStore to reach Deleting state")
time.Sleep(2 * time.Second)
}
assert.NotEqual(t, 4, i)
assert.Equal(t, cephv1.ConditionDeleting, store.Status.Phase) // phase == "Deleting"
// verify deletion is blocked b/c object has dependents
cond := cephv1.FindStatusCondition(store.Status.Conditions, cephv1.ConditionDeletionIsBlocked)
logger.Infof("condition: %+v", cond)
assert.Equal(t, v1.ConditionTrue, cond.Status)
assert.Equal(t, cephv1.ObjectHasDependentsReason, cond.Reason)
// the CephObjectStoreUser and the bucket should both block deletion
assert.Contains(t, cond.Message, "CephObjectStoreUsers")
assert.Contains(t, cond.Message, userid)
assert.Contains(t, cond.Message, "buckets")
assert.Contains(t, cond.Message, bucketname)
// The event is created by the same method that adds that condition, so we can be pretty
// sure it exists here. No need to do extra work to validate the event.
})
t.Run("delete OBC", func(t *testing.T) {
i := 0
dobcErr := helper.BucketClient.DeleteObc(obcName, bucketStorageClassName, bucketname, maxObject, true)
assert.Nil(t, dobcErr)
logger.Info("Checking to see if the obc, secret, and cm have all been deleted")
for i = 0; i < 4 && !helper.BucketClient.CheckOBC(obcName, "deleted"); i++ {
logger.Infof("(%d) obc deleted check, sleeping for 5 seconds ...", i)
time.Sleep(5 * time.Second)
}
assert.NotEqual(t, 4, i)
logger.Info("ensure OBC bucket was deleted")
var rgwErr int
for i = 0; i < 4; i++ {
_, rgwErr, _ = rgw.GetBucket(rgwcontext, bucketname)
if rgwErr == rgw.RGWErrorNotFound {
break
}
logger.Infof("(%d) check bucket deleted, sleeping for 5 seconds ...", i)
time.Sleep(5 * time.Second)
}
assert.NotEqual(t, 4, i)
assert.Equal(t, rgwErr, rgw.RGWErrorNotFound)
dobErr := helper.BucketClient.DeleteBucketStorageClass(namespace, storeName, bucketStorageClassName, "Delete")
assert.Nil(t, dobErr)
})
t.Run("delete CephObjectStoreUser", func(t *testing.T) {
dosuErr := helper.ObjectUserClient.Delete(namespace, userid)
assert.Nil(t, dosuErr)
logger.Info("Object store user deleted successfully")
logger.Info("Checking to see if the user secret has been deleted")
i := 0
for i = 0; i < 4 && helper.ObjectUserClient.UserSecretExists(namespace, storeName, userid) == true; i++ {
logger.Infof("(%d) secret check sleeping for 5 seconds ...", i)
time.Sleep(5 * time.Second)
}
assert.False(t, helper.ObjectUserClient.UserSecretExists(namespace, storeName, userid))
})
t.Run("Regression check: mgrs are not in a crashloop", func(t *testing.T) {
assert.True(t, k8sh.CheckPodCountAndState("rook-ceph-mgr", namespace, 1, "Running"))
})
// tests are complete, now delete the objectstore
s.T().Run("CephObjectStore should delete now that dependents are gone", func(t *testing.T) {
// wait initially since it will almost never detect on the first try without this.
time.Sleep(3 * time.Second)
assertObjectStoreDeletion(t, k8sh, namespace, storeName)
})
// TODO : Add case for brownfield/cleanup s3 client}
}