kserve/pkg/credentials/s3/s3_secret_test.go at master

mirror of https://github.com/hanzo-ml/kserve.git synced 2026-10-30 20:53:49 +00:00

Files

T

Brett ThompsonandGitHub bdf8fc5cd7 Add Support For Protocol in S3 Endpoint (#4797 )

Signed-off-by: Brett Thompson <[email protected]>

2025-12-02 12:48:26 -05:00

540 lines

12 KiB

Go

Raw Permalink Blame History

 /*
 Copyright 2021 The KServe 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 s3
 import (
 	"testing"
 	"github.com/google/go-cmp/cmp"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 func TestS3Secret(t *testing.T) {
 	scenarios := map[string]struct {
 		config   S3Config
 		secret   *corev1.Secret
 		expected []corev1.EnvVar
 	}{
 		"S3SecretAnnotationEnvs": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 					Annotations: map[string]string{
 						InferenceServiceS3SecretEndpointAnnotation: "s3.aws.com",
 					},
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "https://s3.aws.com",
 				},
 			},
 		},
 		"S3SecretDataEnvs": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 				Data: map[string][]byte{
 					S3Endpoint: []byte("s3.aws.com"),
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "https://s3.aws.com",
 				},
 			},
 		},
 		"S3SecretAnnotationHttpsOverrideEnvs": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 					Annotations: map[string]string{
 						InferenceServiceS3SecretEndpointAnnotation: "s3.aws.com",
 						InferenceServiceS3SecretHttpsAnnotation:    "0",
 						InferenceServiceS3SecretSSLAnnotation:      "0",
 					},
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "0",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "http://s3.aws.com",
 				},
 				{
 					Name:  S3VerifySSL,
 					Value: "0",
 				},
 			},
 		},
 		"S3SecretDataHttpsOverrideEnvs": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 				Data: map[string][]byte{
 					S3Endpoint:  []byte("s3.aws.com"),
 					S3UseHttps:  []byte("0"),
 					S3VerifySSL: []byte("0"),
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "0",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "http://s3.aws.com",
 				},
 				{
 					Name:  S3VerifySSL,
 					Value: "0",
 				},
 			},
 		},
 		"S3SecretAnnotationEndpointWithProtocol": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 					Annotations: map[string]string{
 						InferenceServiceS3SecretEndpointAnnotation: "https://s3.aws.com",
 						InferenceServiceS3SecretHttpsAnnotation:    "0",
 						InferenceServiceS3SecretSSLAnnotation:      "1",
 					},
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "1",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "https://s3.aws.com",
 				},
 				{
 					Name:  S3VerifySSL,
 					Value: "1",
 				},
 			},
 		},
 		"S3SecretDataEndpointWithProtocol": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 				Data: map[string][]byte{
 					S3Endpoint:  []byte("http://s3.aws.com"),
 					S3UseHttps:  []byte("1"),
 					S3VerifySSL: []byte("0"),
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "0",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "http://s3.aws.com",
 				},
 				{
 					Name:  S3VerifySSL,
 					Value: "0",
 				},
 			},
 		},
 		"S3SecretAnnotationEnvsWithAnonymousCredentials": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 					Annotations: map[string]string{
 						InferenceServiceS3SecretEndpointAnnotation: "s3.aws.com",
 						InferenceServiceS3UseAnonymousCredential:   "true",
 					},
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "https://s3.aws.com",
 				},
 				{
 					Name:  AWSAnonymousCredential,
 					Value: "true",
 				},
 			},
 		},
 		"S3SecretDataEnvsWithAnonymousCredentials": {
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 				Data: map[string][]byte{
 					S3Endpoint:             []byte("s3.aws.com"),
 					AWSAnonymousCredential: []byte("true"),
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSAccessKeyIdName,
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: AWSSecretAccessKeyName,
 						},
 					},
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "https://s3.aws.com",
 				},
 				{
 					Name:  AWSAnonymousCredential,
 					Value: "true",
 				},
 			},
 		},
 		"S3Config": {
 			config: S3Config{
 				S3AccessKeyIDName:     "test-keyId",
 				S3SecretAccessKeyName: "test-access-key",
 				S3UseHttps:            "0",
 				S3Endpoint:            "s3.aws.com",
 			},
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: "test-keyId",
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: "test-access-key",
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "0",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "http://s3.aws.com",
 				},
 			},
 		},
 		"S3ConfigWithProtocol": {
 			config: S3Config{
 				S3AccessKeyIDName:     "test-keyId",
 				S3SecretAccessKeyName: "test-access-key",
 				S3UseHttps:            "1",
 				S3Endpoint:            "http://s3.aws.com",
 			},
 			secret: &corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: "s3-secret",
 				},
 			},
 			expected: []corev1.EnvVar{
 				{
 					Name: AWSAccessKeyId,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: "test-keyId",
 						},
 					},
 				},
 				{
 					Name: AWSSecretAccessKey,
 					ValueFrom: &corev1.EnvVarSource{
 						SecretKeyRef: &corev1.SecretKeySelector{
 							LocalObjectReference: corev1.LocalObjectReference{
 								Name: "s3-secret",
 							},
 							Key: "test-access-key",
 						},
 					},
 				},
 				{
 					Name:  S3UseHttps,
 					Value: "0",
 				},
 				{
 					Name:  S3Endpoint,
 					Value: "s3.aws.com",
 				},
 				{
 					Name:  AWSEndpointUrl,
 					Value: "http://s3.aws.com",
 				},
 			},
 		},
 	}
 	for name, scenario := range scenarios {
 		envs := BuildSecretEnvs(scenario.secret, &scenario.config)
 		if diff := cmp.Diff(scenario.expected, envs); diff != "" {
 			t.Errorf("Test %q unexpected result (-want +got): %v", name, diff)
 		}
 	}
 }

540 lines 12 KiB Go Raw Permalink Blame History

540 lines

12 KiB

Go

Raw Permalink Blame History