fix lint error

Author: LiangquanLi930

pkg/cloud/services/s3/mock_stsiface/doc.go

@@ -0,0 +1,22 @@
+/*
+Copyright 2019 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 mock_stsiface provides a mock implementation for the STSAPI interface.
+// Run go generate to regenerate this mock.
+//
+//go:generate ../../../../../hack/tools/bin/mockgen -destination stsapi_mock.go -package mock_stsiface sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/s3 STSAPI
+//go:generate /usr/bin/env bash -c "cat ../../../../../hack/boilerplate/boilerplate.generatego.txt stsapi_mock.go > _stsapi_mock.go && mv _stsapi_mock.go stsapi_mock.go"
+package mock_stsiface //nolint:stylecheck

pkg/cloud/services/secretsmanager/mock_secretsmanageriface/doc.go

@@ -17,6 +17,6 @@ limitations under the License.
 // Package mock_secretsmanageriface provides a mock interface for the SecretsManager API client.
 // Run go generate to regenerate this mock.
 //
-//go:generate ../../../../../hack/tools/bin/mockgen -destination secretsmanagerapi_mock.go -package mock_secretsmanageriface github.com/aws/aws-sdk-go/service/secretsmanager/secretsmanageriface SecretsManagerAPI
+//go:generate ../../../../../hack/tools/bin/mockgen -destination secretsmanagerapi_mock.go -package mock_secretsmanageriface sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/secretsmanager SecretsManagerAPI
 //go:generate /usr/bin/env bash -c "cat ../../../../../hack/boilerplate/boilerplate.generatego.txt secretsmanagerapi_mock.go > _secretsmanagerapi_mock.go && mv _secretsmanagerapi_mock.go secretsmanagerapi_mock.go"
 package mock_secretsmanageriface //nolint:stylecheck

pkg/cloud/services/secretsmanager/mock_secretsmanageriface/secretsmanagerapi_mock.go

@@ -17,21 +17,22 @@ limitations under the License.
 package secretsmanager
 
 import (
+	"context"
 	"crypto/rand"
 	"sort"
 	"testing"
 
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/service/secretsmanager"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
 	"github.com/golang/mock/gomock"
 	. "github.com/onsi/gomega"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
+	"github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
 	infrav1 "sigs.k8s.io/cluster-api-provider-aws/v2/api/v1beta2"
-	"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/awserrors"
 	"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/scope"
 	"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud/services/secretsmanager/mock_secretsmanageriface"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
@@ -48,13 +49,13 @@ func TestServiceCreate(t *testing.T) {
 		return token
 	}
 
-	sortTagsByKey := func(tags []*secretsmanager.Tag) {
+	sortTagsByKey := func(tags []types.Tag) {
 		sort.Slice(tags, func(i, j int) bool {
 			return *(tags[i].Key) < *(tags[j].Key)
 		})
 	}
 
-	expectedTags := []*secretsmanager.Tag{
+	expectedTags := []types.Tag{
 		{
 			Key:   aws.String("Name"),
 			Value: aws.String("infra-cluster"),
@@ -97,7 +98,7 @@ func TestServiceCreate(t *testing.T) {
 			expectedPrefix: "/awsprefix",
 			wantErr:        false,
 			expect: func(g *WithT, m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.CreateSecret(gomock.Any()).Times(0)
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Times(0)
 			},
 		},
 		{
@@ -107,8 +108,8 @@ func TestServiceCreate(t *testing.T) {
 			expectedPrefix: "prefix",
 			wantErr:        false,
 			expect: func(g *WithT, m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).MinTimes(1).Return(&secretsmanager.CreateSecretOutput{}, nil).Do(
-					func(createSecretInput *secretsmanager.CreateSecretInput) {
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).MinTimes(1).Return(&secretsmanager.CreateSecretOutput{}, nil).Do(
+					func(ctx context.Context, createSecretInput *secretsmanager.CreateSecretInput, optFns ...func(*secretsmanager.Options)) {
 						g.Expect(*(createSecretInput.Name)).To(HavePrefix("prefix-"))
 						sortTagsByKey(createSecretInput.Tags)
 						g.Expect(createSecretInput.Tags).To(Equal(expectedTags))
@@ -123,8 +124,8 @@ func TestServiceCreate(t *testing.T) {
 			expectedPrefix: "/prefix",
 			wantErr:        true,
 			expect: func(g *WithT, m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &secretsmanager.InternalServiceError{}).Do(
-					func(createSecretInput *secretsmanager.CreateSecretInput) {
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &types.InternalServiceError{}).Do(
+					func(ctx context.Context, createSecretInput *secretsmanager.CreateSecretInput, optFns ...func(*secretsmanager.Options)) {
 						g.Expect(*(createSecretInput.Name)).To(HavePrefix("/prefix-"))
 						sortTagsByKey(createSecretInput.Tags)
 						g.Expect(createSecretInput.Tags).To(Equal(expectedTags))
@@ -139,9 +140,9 @@ func TestServiceCreate(t *testing.T) {
 			expectedPrefix: "aws.cluster.x-k8s.io",
 			wantErr:        false,
 			expect: func(g *WithT, m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &secretsmanager.InvalidRequestException{})
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &secretsmanager.ResourceNotFoundException{})
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(&secretsmanager.CreateSecretOutput{}, nil)
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &types.InvalidRequestException{})
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &types.ResourceNotFoundException{})
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(&secretsmanager.CreateSecretOutput{}, nil)
 			},
 		},
 		{
@@ -151,9 +152,9 @@ func TestServiceCreate(t *testing.T) {
 			expectedPrefix: "aws.cluster.x-k8s.io",
 			wantErr:        false,
 			expect: func(g *WithT, m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &secretsmanager.ResourceExistsException{})
-				m.DeleteSecret(gomock.AssignableToTypeOf(&secretsmanager.DeleteSecretInput{})).Return(&secretsmanager.DeleteSecretOutput{}, nil)
-				m.CreateSecret(gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(&secretsmanager.CreateSecretOutput{}, nil)
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(nil, &types.ResourceExistsException{})
+				m.DeleteSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.DeleteSecretInput{})).Return(&secretsmanager.DeleteSecretOutput{}, nil)
+				m.CreateSecret(gomock.Any(), gomock.AssignableToTypeOf(&secretsmanager.CreateSecretInput{})).Return(&secretsmanager.CreateSecretOutput{}, nil)
 			},
 		},
 	}
@@ -202,7 +203,7 @@ func TestServiceDelete(t *testing.T) {
 			name:        "Should not return error when delete is successful",
 			secretCount: 1,
 			expect: func(m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.DeleteSecret(gomock.Eq(&secretsmanager.DeleteSecretInput{
+				m.DeleteSecret(gomock.Any(), gomock.Eq(&secretsmanager.DeleteSecretInput{
 					SecretId:                   aws.String("prefix-0"),
 					ForceDeleteWithoutRecovery: aws.Bool(true),
 				})).Return(&secretsmanager.DeleteSecretOutput{}, nil)
@@ -215,22 +216,22 @@ func TestServiceDelete(t *testing.T) {
 			name:        "Should return all errors except not found errors",
 			secretCount: 3,
 			expect: func(m *mock_secretsmanageriface.MockSecretsManagerAPIMockRecorder) {
-				m.DeleteSecret(gomock.Eq(&secretsmanager.DeleteSecretInput{
+				m.DeleteSecret(gomock.Any(), gomock.Eq(&secretsmanager.DeleteSecretInput{
 					SecretId:                   aws.String("prefix-0"),
 					ForceDeleteWithoutRecovery: aws.Bool(true),
-				})).Return(nil, awserrors.NewFailedDependency("failed dependency"))
-				m.DeleteSecret(gomock.Eq(&secretsmanager.DeleteSecretInput{
+				})).Return(nil, &types.InternalServiceError{})
+				m.DeleteSecret(gomock.Any(), gomock.Eq(&secretsmanager.DeleteSecretInput{
 					SecretId:                   aws.String("prefix-1"),
 					ForceDeleteWithoutRecovery: aws.Bool(true),
-				})).Return(nil, awserrors.NewNotFound("not found"))
-				m.DeleteSecret(gomock.Eq(&secretsmanager.DeleteSecretInput{
+				})).Return(nil, &types.ResourceNotFoundException{})
+				m.DeleteSecret(gomock.Any(), gomock.Eq(&secretsmanager.DeleteSecretInput{
 					SecretId:                   aws.String("prefix-2"),
 					ForceDeleteWithoutRecovery: aws.Bool(true),
-				})).Return(nil, awserrors.NewConflict("new conflict"))
+				})).Return(nil, &types.InvalidRequestException{})
 			},
 			check: func(g *WithT, err error) {
 				g.Expect(err).ToNot(BeNil())
-				g.Expect((err.Error())).To(Equal("[failed dependency, new conflict]"))
+				g.Expect((err.Error())).To(Equal("[InternalServiceError: , InvalidRequestException: ]"))
 			},
 		},
 	}

pkg/cloud/services/secretsmanager/secret_test.go

@@ -18,6 +18,8 @@ limitations under the License.
 package secretsmanager
 
 import (
+	"context"
+
 	"github.com/aws/aws-sdk-go-v2/service/secretsmanager"
 
 	"sigs.k8s.io/cluster-api-provider-aws/v2/pkg/cloud"
@@ -29,9 +31,17 @@ import (
 // One alternative is to have a large list of functions from the ec2 client.
 type Service struct {
 	scope                cloud.ClusterScoper
-	SecretsManagerClient *secretsmanager.Client
+	SecretsManagerClient SecretsManagerAPI
+}
+
+// SecretsManagerAPI is the subset of the AWS Secrets Manager API that is used by CAPA.
+type SecretsManagerAPI interface {
+	CreateSecret(ctx context.Context, params *secretsmanager.CreateSecretInput, optFns ...func(*secretsmanager.Options)) (*secretsmanager.CreateSecretOutput, error)
+	DeleteSecret(ctx context.Context, params *secretsmanager.DeleteSecretInput, optFns ...func(*secretsmanager.Options)) (*secretsmanager.DeleteSecretOutput, error)
 }
 
+var _ SecretsManagerAPI = &secretsmanager.Client{}
+
 // NewService returns a new service given the api clients.
 func NewService(secretsScope cloud.ClusterScoper) *Service {
 	return &Service{