Merge pull request #1078 from wongma7/reorganizemocks

Move mocks to parent package to avoid import cycle
kubernetes-sigs · Oct 5, 2021 · 869e7f5 · 869e7f5
2 parents aefaa90 + 9022aba
commit 869e7f5
Show file tree

Hide file tree

Showing 11 changed files with 279 additions and 281 deletions.
diff --git a/hack/update-gomock b/hack/update-gomock
@@ -16,7 +16,7 @@
 
 set -euo pipefail
 
-./bin/mockgen -package mocks -destination=./pkg/cloud/mocks/mock_ec2.go -source pkg/cloud/ec2_interface.go
-./bin/mockgen -package mocks -destination=./pkg/driver/mocks/mock_cloud.go -source pkg/cloud/cloud_interface.go
-./bin/mockgen -package mocks -destination=./pkg/driver/mocks/mock_metadata.go -source pkg/cloud/metadata_interface.go
-./bin/mockgen -package mocks -destination=./pkg/driver/mocks/mock_mount.go -source pkg/driver/mount.go
+./bin/mockgen -package cloud -destination=./pkg/cloud/mock_ec2.go -source pkg/cloud/ec2_interface.go
+./bin/mockgen -package cloud -destination=./pkg/cloud/mock_cloud.go -source pkg/cloud/cloud_interface.go
+./bin/mockgen -package cloud -destination=./pkg/cloud/mock_metadata.go -source pkg/cloud/metadata_interface.go
+./bin/mockgen -package driver -destination=./pkg/driver/mock_mount.go -source pkg/driver/mount.go
diff --git a/pkg/cloud/cloud_test.go b/pkg/cloud/cloud_test.go
@@ -30,7 +30,6 @@ import (
 	"github.com/aws/aws-sdk-go/service/ec2"
 	"github.com/golang/mock/gomock"
 	dm "github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/cloud/devicemanager"
-	"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/cloud/mocks"
 	"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/util"
 )
 
@@ -426,7 +425,7 @@ func TestCreateDisk(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			volState := tc.volState
@@ -528,7 +527,7 @@ func TestDeleteDisk(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ctx := context.Background()
@@ -582,7 +581,7 @@ func TestAttachDisk(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			vol := &ec2.Volume{
@@ -644,7 +643,7 @@ func TestDetachDisk(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			vol := &ec2.Volume{
@@ -713,7 +712,7 @@ func TestGetDiskByName(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			vol := &ec2.Volume{
@@ -795,7 +794,7 @@ func TestGetDiskByID(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ctx := context.Background()
@@ -894,7 +893,7 @@ func TestCreateSnapshot(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ec2snapshot := &ec2.Snapshot{
@@ -953,7 +952,7 @@ func TestDeleteSnapshot(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ctx := context.Background()
@@ -1084,7 +1083,7 @@ func TestResizeDisk(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			// reduce number of steps to reduce test time
 			volumeModificationWaitSteps = 3
 			c := newCloud(mockEC2)
@@ -1170,7 +1169,7 @@ func TestGetSnapshotByName(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ec2snapshot := &ec2.Snapshot{
@@ -1226,7 +1225,7 @@ func TestGetSnapshotByID(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			ec2snapshot := &ec2.Snapshot{
@@ -1286,7 +1285,7 @@ func TestListSnapshots(t *testing.T) {
 
 				mockCtl := gomock.NewController(t)
 				defer mockCtl.Finish()
-				mockEC2 := mocks.NewMockEC2(mockCtl)
+				mockEC2 := NewMockEC2(mockCtl)
 				c := newCloud(mockEC2)
 
 				ctx := context.Background()
@@ -1328,7 +1327,7 @@ func TestListSnapshots(t *testing.T) {
 
 				mockCtl := gomock.NewController(t)
 				defer mockCtl.Finish()
-				mockEC2 := mocks.NewMockEC2(mockCtl)
+				mockEC2 := NewMockEC2(mockCtl)
 				c := newCloud(mockEC2)
 
 				ctx := context.Background()
@@ -1375,7 +1374,7 @@ func TestListSnapshots(t *testing.T) {
 
 				mockCtl := gomock.NewController(t)
 				defer mockCtl.Finish()
-				mockEC2 := mocks.NewMockEC2(mockCtl)
+				mockEC2 := NewMockEC2(mockCtl)
 				c := newCloud(mockEC2)
 
 				ctx := context.Background()
@@ -1424,7 +1423,7 @@ func TestListSnapshots(t *testing.T) {
 			testFunc: func(t *testing.T) {
 				mockCtl := gomock.NewController(t)
 				defer mockCtl.Finish()
-				mockEC2 := mocks.NewMockEC2(mockCtl)
+				mockEC2 := NewMockEC2(mockCtl)
 				c := newCloud(mockEC2)
 
 				ctx := context.Background()
@@ -1441,7 +1440,7 @@ func TestListSnapshots(t *testing.T) {
 			testFunc: func(t *testing.T) {
 				mockCtl := gomock.NewController(t)
 				defer mockCtl.Finish()
-				mockEC2 := mocks.NewMockEC2(mockCtl)
+				mockEC2 := NewMockEC2(mockCtl)
 				c := newCloud(mockEC2)
 
 				ctx := context.Background()
@@ -1562,7 +1561,7 @@ func TestWaitForAttachmentState(t *testing.T) {
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
-			mockEC2 := mocks.NewMockEC2(mockCtrl)
+			mockEC2 := NewMockEC2(mockCtrl)
 			c := newCloud(mockEC2)
 
 			attachedVol := &ec2.Volume{

diff --git a/pkg/cloud/ec2_interface.go b/pkg/cloud/ec2_interface.go
@@ -18,7 +18,6 @@ package cloud
 
 import (
 	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/aws/ec2metadata"
 	"github.com/aws/aws-sdk-go/aws/request"
 	"github.com/aws/aws-sdk-go/service/ec2"
 )
@@ -39,10 +38,3 @@ type EC2 interface {
 	DescribeVolumesModificationsWithContext(ctx aws.Context, input *ec2.DescribeVolumesModificationsInput, opts ...request.Option) (*ec2.DescribeVolumesModificationsOutput, error)
 	DescribeAvailabilityZonesWithContext(ctx aws.Context, input *ec2.DescribeAvailabilityZonesInput, opts ...request.Option) (*ec2.DescribeAvailabilityZonesOutput, error)
 }
-
-type EC2Metadata interface {
-	Available() bool
-	// ec2 instance metadata endpoints: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
-	GetMetadata(string) (string, error)
-	GetInstanceIdentityDocument() (ec2metadata.EC2InstanceIdentityDocument, error)
-}
diff --git a/pkg/cloud/metadata_interface.go b/pkg/cloud/metadata_interface.go
@@ -1,6 +1,9 @@
 package cloud
 
-import "github.com/aws/aws-sdk-go/aws/arn"
+import (
+	"github.com/aws/aws-sdk-go/aws/arn"
+	"github.com/aws/aws-sdk-go/aws/ec2metadata"
+)
 
 // MetadataService represents AWS metadata service.
 type MetadataService interface {
@@ -10,3 +13,10 @@ type MetadataService interface {
 	GetAvailabilityZone() string
 	GetOutpostArn() arn.ARN
 }
+
+type EC2Metadata interface {
+	Available() bool
+	// ec2 instance metadata endpoints: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-data-retrieval.html
+	GetMetadata(string) (string, error)
+	GetInstanceIdentityDocument() (ec2metadata.EC2InstanceIdentityDocument, error)
+}
diff --git a/pkg/cloud/metadata_test.go b/pkg/cloud/metadata_test.go
@@ -25,7 +25,6 @@ import (
 	"github.com/aws/aws-sdk-go/aws/arn"
 	"github.com/aws/aws-sdk-go/aws/ec2metadata"
 	"github.com/golang/mock/gomock"
-	"github.com/kubernetes-sigs/aws-ebs-csi-driver/pkg/cloud/mocks"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -285,7 +284,7 @@ func TestNewMetadataService(t *testing.T) {
 			}
 
 			mockCtrl := gomock.NewController(t)
-			mockEC2Metadata := mocks.NewMockEC2Metadata(mockCtrl)
+			mockEC2Metadata := NewMockEC2Metadata(mockCtrl)
 
 			ec2MetadataClient := func() (EC2Metadata, error) { return mockEC2Metadata, nil }
 			k8sAPIClient := func() (kubernetes.Interface, error) { clientsetInitialized = true; return clientset, nil }

diff --git a/pkg/driver/mocks/mock_cloud.go → pkg/cloud/mock_cloud.go b/pkg/driver/mocks/mock_cloud.go → pkg/cloud/mock_cloud.go