Merge pull request #330 from midnightconman/jcampbell/s3creds-20241122

Export providers.S3Credentials

Author: k8s-ci-robot

pkg/io/providers/aws.go

@@ -34,9 +34,9 @@ import (
 const S3MinUploadPartSize = 5 * 1024 * 1024 // 5 MiB
 
 // getS3Bucket opens a gocloud blob.Bucket based on given credentials in the format the
-// struct s3Credentials defines (see documentation of GetBucket for an example)
+// struct S3Credentials defines (see documentation of GetBucket for an example)
 func getS3Bucket(ctx context.Context, creds []byte, bucketName string) (*blob.Bucket, error) {
-	s3Creds := &s3Credentials{}
+	s3Creds := &S3Credentials{}
 	if err := json.Unmarshal(creds, s3Creds); err != nil {
 		return nil, fmt.Errorf("error getting S3 credentials from JSON: %w", err)
 	}
@@ -51,7 +51,7 @@ func getS3Bucket(ctx context.Context, creds []byte, bucketName string) (*blob.Bu
 	return bkt, nil
 }
 
-func newS3Client(ctx context.Context, creds *s3Credentials) (*s3.Client, error) {
+func newS3Client(ctx context.Context, creds *S3Credentials) (*s3.Client, error) {
 	var opts []func(*config.LoadOptions) error
 
 	// Use the default credential chain if no credentials are specified

pkg/io/providers/aws_test.go

@@ -29,28 +29,28 @@ import (
 func Test_newS3Client(t *testing.T) {
 	tests := []struct {
 		name  string
-		creds s3Credentials
-		want  s3Credentials
+		creds S3Credentials
+		want  S3Credentials
 	}{
 		{
 			name: "only accesskey and secretkey set",
-			creds: s3Credentials{
+			creds: S3Credentials{
 				AccessKey: "foo",
 				SecretKey: "bar",
 			},
-			want: s3Credentials{},
+			want: S3Credentials{},
 		},
 		{
 			name: "all options set ",
-			creds: s3Credentials{
+			creds: S3Credentials{
 				AccessKey:        "foo",
 				SecretKey:        "bar",
 				Endpoint:         "https://foobar.com",
 				Region:           "eu01",
 				Insecure:         true,
 				S3ForcePathStyle: true,
 			},
-			want: s3Credentials{
+			want: S3Credentials{
 				Endpoint:         "https://foobar.com",
 				Region:           "eu01",
 				Insecure:         true,
@@ -94,7 +94,7 @@ func Test_newS3Client(t *testing.T) {
 			} else {
 				endpoint = *s3opts.BaseEndpoint
 			}
-			got := s3Credentials{
+			got := S3Credentials{
 				Region:           s3opts.Region,
 				Endpoint:         endpoint,
 				S3ForcePathStyle: s3opts.UsePathStyle,

pkg/io/providers/providers.go

@@ -72,13 +72,13 @@ func DisplayName(provider string) string {
 //     "access_key": "access_key",
 //     "secret_key": "secret_key"
 //     }
-func GetBucket(ctx context.Context, s3Credentials []byte, path string) (*blob.Bucket, error) {
+func GetBucket(ctx context.Context, S3Credentials []byte, path string) (*blob.Bucket, error) {
 	storageProvider, bucket, _, err := ParseStoragePath(path)
 	if err != nil {
 		return nil, err
 	}
-	if storageProvider == S3 && len(s3Credentials) > 0 {
-		return getS3Bucket(ctx, s3Credentials, bucket)
+	if storageProvider == S3 && len(S3Credentials) > 0 {
+		return getS3Bucket(ctx, S3Credentials, bucket)
 	}
 
 	bkt, err := blob.OpenBucket(ctx, fmt.Sprintf("%s://%s", storageProvider, bucket))
@@ -88,10 +88,10 @@ func GetBucket(ctx context.Context, s3Credentials []byte, path string) (*blob.Bu
 	return bkt, nil
 }
 
-// s3Credentials are credentials used to access S3 or an S3-compatible storage service
+// S3Credentials are credentials used to access S3 or an S3-compatible storage service
 // Endpoint is an optional property. Default is the AWS S3 endpoint. If set, the specified
 // endpoint will be used instead.
-type s3Credentials struct {
+type S3Credentials struct {
 	Region           string `json:"region"`
 	Endpoint         string `json:"endpoint"`
 	Insecure         bool   `json:"insecure"`