Add Getter interface for getting resources in other services

Author: Cecile Robert-Michon

azure/services/async/interfaces.go

@@ -36,11 +36,16 @@ type FutureHandler interface {
 	Result(ctx context.Context, future azureautorest.FutureAPI, futureType string) (result interface{}, err error)
 }
 
+// Getter is an interface that can get a resource.
+type Getter interface {
+	Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
+}
+
 // Creator is a client that can create or update a resource asynchronously.
 type Creator interface {
 	FutureHandler
+	Getter
 	CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, parameters interface{}) (result interface{}, future azureautorest.FutureAPI, err error)
-	Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
 }
 
 // Deleter is a client that can delete a resource asynchronously.

azure/services/async/mock_async/async_mock.go

@@ -41,7 +41,7 @@ type AvailabilitySetScope interface {
 // Service provides operations on Azure resources.
 type Service struct {
 	Scope AvailabilitySetScope
-	Client
+	async.Getter
 	async.Reconciler
 	resourceSKUCache *resourceskus.Cache
 }
@@ -51,7 +51,7 @@ func New(scope AvailabilitySetScope, skuCache *resourceskus.Cache) *Service {
 	client := NewClient(scope)
 	return &Service{
 		Scope:            scope,
-		Client:           client,
+		Getter:           client,
 		resourceSKUCache: skuCache,
 		Reconciler:       async.New(scope, client, client),
 	}
@@ -88,7 +88,7 @@ func (s *Service) Delete(ctx context.Context) error {
 	if setSpec := s.Scope.AvailabilitySetSpec(); setSpec == nil {
 		log.V(2).Info("skip deletion when no availability set spec is found")
 	} else {
-		existingSet, err := s.Client.Get(ctx, setSpec)
+		existingSet, err := s.Get(ctx, setSpec)
 		if err != nil {
 			if !azure.ResourceNotFound(err) {
 				resultingErr = errors.Wrapf(err, "failed to get availability set %s in resource group %s", setSpec.ResourceName(), setSpec.ResourceGroupName())

azure/services/availabilitysets/availabilitysets.go

@@ -149,12 +149,12 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 	testcases := []struct {
 		name          string
 		expectedError string
-		expect        func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder)
+		expect        func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder)
 	}{
 		{
 			name:          "deletes availability set",
 			expectedError: "",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return(compute.AvailabilitySet{}, nil),
@@ -166,15 +166,15 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "noop if AvailabilitySetSpec returns nil",
 			expectedError: "",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(nil)
 				s.UpdateDeleteStatus(infrav1.AvailabilitySetReadyCondition, serviceName, nil)
 			},
 		},
 		{
 			name:          "delete proceeds with missing required value in availability set spec",
 			expectedError: "",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpecMissing)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpecMissing).Return(compute.AvailabilitySet{}, nil),
@@ -186,7 +186,7 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "noop if availability set has vms",
 			expectedError: "",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return(fakeSetWithVMs, nil),
@@ -197,7 +197,7 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "availability set not found",
 			expectedError: "",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return(nil, notFoundError),
@@ -208,7 +208,7 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "error in getting availability set",
 			expectedError: "failed to get availability set test-as in resource group test-rg: #: Internal Server Error: StatusCode=500",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return(nil, internalError),
@@ -219,7 +219,7 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "availability set get result is not an availability set",
 			expectedError: "string is not a compute.AvailabilitySet",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return("not an availability set", nil),
@@ -230,7 +230,7 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 		{
 			name:          "error in deleting availability set",
 			expectedError: "#: Internal Server Error: StatusCode=500",
-			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_availabilitysets.MockClientMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
+			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, m *mock_async.MockGetterMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
 				gomock.InOrder(
 					m.Get(gomockinternal.AContext(), &fakeSetSpec).Return(compute.AvailabilitySet{}, nil),
@@ -249,14 +249,14 @@ func TestDeleteAvailabilitySets(t *testing.T) {
 			mockCtrl := gomock.NewController(t)
 			defer mockCtrl.Finish()
 			scopeMock := mock_availabilitysets.NewMockAvailabilitySetScope(mockCtrl)
-			clientMock := mock_availabilitysets.NewMockClient(mockCtrl)
+			getterMock := mock_async.NewMockGetter(mockCtrl)
 			asyncMock := mock_async.NewMockReconciler(mockCtrl)
 
-			tc.expect(scopeMock.EXPECT(), clientMock.EXPECT(), asyncMock.EXPECT())
+			tc.expect(scopeMock.EXPECT(), getterMock.EXPECT(), asyncMock.EXPECT())
 
 			s := &Service{
 				Scope:      scopeMock,
-				Client:     clientMock,
+				Getter:     getterMock,
 				Reconciler: asyncMock,
 			}
 

azure/services/availabilitysets/availabilitysets_test.go

@@ -28,22 +28,11 @@ import (
 	"sigs.k8s.io/cluster-api-provider-azure/util/tele"
 )
 
-// Client wraps go-sdk.
-type Client interface {
-	Get(ctx context.Context, spec azure.ResourceSpecGetter) (result interface{}, err error)
-	CreateOrUpdateAsync(ctx context.Context, spec azure.ResourceSpecGetter, parameters interface{}) (result interface{}, future azureautorest.FutureAPI, err error)
-	DeleteAsync(ctx context.Context, spec azure.ResourceSpecGetter) (future azureautorest.FutureAPI, err error)
-	IsDone(ctx context.Context, future azureautorest.FutureAPI) (isDone bool, err error)
-	Result(ctx context.Context, future azureautorest.FutureAPI, futureType string) (result interface{}, err error)
-}
-
 // AzureClient contains the Azure go-sdk Client.
 type AzureClient struct {
 	availabilitySets compute.AvailabilitySetsClient
 }
 
-var _ Client = (*AzureClient)(nil)
-
 // NewClient creates a new Resource SKUs Client from subscription ID.
 func NewClient(auth azure.Authorizer) *AzureClient {
 	return &AzureClient{

azure/services/availabilitysets/client.go

@@ -31,23 +31,10 @@ import (
 	"sigs.k8s.io/cluster-api-provider-azure/util/tele"
 )
 
-type (
-	// Client wraps go-sdk.
-	Client interface {
-		Get(context.Context, azure.ResourceSpecGetter) (result interface{}, err error)
-		CreateOrUpdateAsync(context.Context, azure.ResourceSpecGetter, interface{}) (result interface{}, future azureautorest.FutureAPI, err error)
-		DeleteAsync(context.Context, azure.ResourceSpecGetter) (future azureautorest.FutureAPI, err error)
-		IsDone(context.Context, azureautorest.FutureAPI) (isDone bool, err error)
-		Result(context.Context, azureautorest.FutureAPI, string) (result interface{}, err error)
-	}
-
-	// AzureClient contains the Azure go-sdk Client.
-	AzureClient struct {
-		interfaces network.InterfacesClient
-	}
-)
-
-var _ Client = &AzureClient{}
+// AzureClient contains the Azure go-sdk Client.
+type AzureClient struct {
+	interfaces network.InterfacesClient
+}
 
 // NewClient creates a new VM client from subscription ID.
 func NewClient(auth azure.Authorizer) *AzureClient {