Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use ephemeral S3 buckets for E2E tests #17157

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions tests/e2e/kubetest2-kops/aws/s3.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
/*
Copyright 2024 The Kubernetes Authors.

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 aws

import (
"context"
"errors"
"fmt"
"regexp"
"strings"
"time"

"github.com/aws/aws-sdk-go-v2/aws"
awsconfig "github.com/aws/aws-sdk-go-v2/config"
"github.com/aws/aws-sdk-go-v2/service/s3"
"github.com/aws/aws-sdk-go-v2/service/s3/types"
"github.com/aws/aws-sdk-go-v2/service/sts"
"k8s.io/klog/v2"
)

// It contains S3Client, an Amazon S3 service client that is used to perform bucket
// and object actions.
type awsClient struct {
S3Client *s3.Client
}

// AWSBucketName constructs an unique bucket name using the AWS account ID
func AWSBucketName(ctx context.Context) (string, error) {
config, err := awsconfig.LoadDefaultConfig(ctx)
if err != nil {
return "", fmt.Errorf("failed to load AWS config: %w", err)
}

stsSvc := sts.NewFromConfig(config)
callerIdentity, err := stsSvc.GetCallerIdentity(ctx, &sts.GetCallerIdentityInput{})
if err != nil {
return "", fmt.Errorf("building AWS STS presigned request: %w", err)
}

// Add timestamp suffix
timestamp := time.Now().Format("01022006")
bucket := fmt.Sprintf("k8s-infra-kops-%s", *callerIdentity.Account)
bucket = fmt.Sprintf("%s-%s", bucket, timestamp)

bucket = strings.ToLower(bucket)
bucket = regexp.MustCompile("[^a-z0-9-]").ReplaceAllString(bucket, "") // Only allow lowercase letters, numbers, and hyphens

if len(bucket) > 63 {
bucket = bucket[:63] // Max length is 63
}

return bucket, nil
}

func (client awsClient) EnsureS3Bucket(ctx context.Context, bucketName string, publicRead bool) error {
_, err := client.S3Client.CreateBucket(ctx, &s3.CreateBucketInput{
Bucket: aws.String(bucketName),
CreateBucketConfiguration: &types.CreateBucketConfiguration{
LocationConstraint: types.BucketLocationConstraintUsEast2,
},
})

var exists *types.BucketAlreadyExists
if err != nil {
if errors.As(err, &exists) {
klog.Infof("Bucket %s already exists.\n", bucketName)
err = exists
}
} else {
err := s3.NewBucketExistsWaiter(client.S3Client).Wait(
ctx, &s3.HeadBucketInput{
Bucket: aws.String(bucketName),
},
time.Minute)
if err != nil {
klog.Infof("Failed attempt to wait for bucket %s to exist.", bucketName)
}
}

klog.Infof("Bucket %s created successfully", bucketName)

if err == nil && publicRead {
err = client.setPublicReadPolicy(ctx, bucketName)
if err != nil {
klog.Errorf("Failed to set public read policy on bucket %s: %v", bucketName, err)
return err
}
klog.Infof("Public read policy set on bucket %s", bucketName)
}

return err
}

func (client awsClient) DeleteS3Bucket(ctx context.Context, bucketName string) error {
Copy link
Member

@BenTheElder BenTheElder Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: boskos? (fallback)

_, err := client.S3Client.DeleteBucket(ctx, &s3.DeleteBucketInput{
Bucket: aws.String(bucketName),
})
if err != nil {
var noBucket *types.NoSuchBucket
if errors.As(err, &noBucket) {
klog.Infof("Bucket %s does not exits", bucketName)
err = noBucket
} else {
klog.Infof("Couldn't delete bucket %s. Reason: %v", bucketName, err)
}
} else {
err = s3.NewBucketNotExistsWaiter(client.S3Client).Wait(
ctx, &s3.HeadBucketInput{
Bucket: aws.String(bucketName),
},
time.Minute)
if err != nil {
klog.Infof("Failed attempt to wait for bucket %s to be deleted", bucketName)
} else {
klog.Infof("Bucket %s deleted", bucketName)
}
}
return err
}

func (client awsClient) setPublicReadPolicy(ctx context.Context, bucketName string) error {
policy := fmt.Sprintf(`{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "PublicReadGetObject",
"Effect": "Allow",
"Principal": "*",
"Action": "s3:GetObject",
"Resource": "arn:aws:s3:::%s/*"
}
]
}`, bucketName)

_, err := client.S3Client.PutBucketPolicy(ctx, &s3.PutBucketPolicyInput{
Bucket: aws.String(bucketName),
Policy: aws.String(policy),
})
if err != nil {
return fmt.Errorf("failed to put bucket policy for %s: %w", bucketName, err)
}

return err
}
10 changes: 9 additions & 1 deletion tests/e2e/kubetest2-kops/deployer/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ limitations under the License.
package deployer

import (
"context"
"errors"
"fmt"
"os"
"path/filepath"
"strings"

"k8s.io/klog/v2"
"k8s.io/kops/tests/e2e/kubetest2-kops/aws"
"k8s.io/kops/tests/e2e/kubetest2-kops/gce"
"k8s.io/kops/tests/e2e/pkg/target"
"k8s.io/kops/tests/e2e/pkg/util"
Expand Down Expand Up @@ -320,7 +322,13 @@ func (d *deployer) stateStore() string {
if ss == "" {
switch d.CloudProvider {
case "aws":
ss = "s3://k8s-kops-prow"
ctx := context.TODO()
bucketName, err := aws.AWSBucketName(ctx)
if err := aws.EnsureS3Bucket(ctx, bucketName); err != nil {
return err
}
klog.Infof("Generated bucket name:", bucketName)
ss = "s3://" + bucketName
case "gce":
d.createBucket = true
ss = "gs://" + gce.GCSBucketName(d.GCPProject, "state")
Expand Down
Loading