Merge pull request #2710 from jackfrancis/async-createorupdate

refactor: rename CreateResource to CreateOrUpdateResource

Author: k8s-ci-robot

.codespellignore

@@ -3,3 +3,4 @@ witht
 geting
 ot
 intepreted
+updat

azure/services/agentpools/agentpools.go

@@ -74,7 +74,7 @@ func (s *Service) Reconcile(ctx context.Context) error {
 
 	var resultingErr error
 	if agentPoolSpec := s.scope.AgentPoolSpec(); agentPoolSpec != nil {
-		result, err := s.CreateResource(ctx, agentPoolSpec, serviceName)
+		result, err := s.CreateOrUpdateResource(ctx, agentPoolSpec, serviceName)
 		if err != nil {
 			resultingErr = err
 		} else {

azure/services/agentpools/agentpools_test.go

@@ -70,7 +70,7 @@ func TestReconcileAgentPools(t *testing.T) {
 			expectedError: "",
 			expect: func(s *mock_agentpools.MockAgentPoolScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AgentPoolSpec().Return(&fakeAgentPoolSpec)
-				r.CreateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(fakeAgentPoolWithAutoscalingAndCount(true, 1), nil)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(fakeAgentPoolWithAutoscalingAndCount(true, 1), nil)
 				s.SetCAPIMachinePoolAnnotation(azure.ReplicasManagedByAutoscalerAnnotation, "true")
 				s.SetCAPIMachinePoolReplicas(fakeAgentPoolWithAutoscalingAndCount(true, 1).Count)
 				s.UpdatePutStatus(infrav1.AgentPoolsReadyCondition, serviceName, nil)
@@ -81,7 +81,7 @@ func TestReconcileAgentPools(t *testing.T) {
 			expectedError: "",
 			expect: func(s *mock_agentpools.MockAgentPoolScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AgentPoolSpec().Return(&fakeAgentPoolSpec)
-				r.CreateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(fakeAgentPoolWithAutoscalingAndCount(false, 1), nil)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(fakeAgentPoolWithAutoscalingAndCount(false, 1), nil)
 				s.RemoveCAPIMachinePoolAnnotation(azure.ReplicasManagedByAutoscalerAnnotation)
 
 				s.UpdatePutStatus(infrav1.AgentPoolsReadyCondition, serviceName, nil)
@@ -99,7 +99,7 @@ func TestReconcileAgentPools(t *testing.T) {
 			expectedError: internalError.Error(),
 			expect: func(s *mock_agentpools.MockAgentPoolScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AgentPoolSpec().Return(&fakeAgentPoolSpec)
-				r.CreateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(nil, internalError)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeAgentPoolSpec, serviceName).Return(nil, internalError)
 				s.UpdatePutStatus(infrav1.AgentPoolsReadyCondition, serviceName, internalError)
 			},
 		},

azure/services/async/async.go

@@ -18,6 +18,7 @@ package async
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 	"strconv"
 	"time"
@@ -96,9 +97,9 @@ func processOngoingOperation(ctx context.Context, scope FutureScope, client Futu
 	return client.Result(ctx, sdkFuture, future.Type)
 }
 
-// CreateResource implements the logic for creating a resource Asynchronously.
-func (s *Service) CreateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error) {
-	ctx, log, done := tele.StartSpanWithLogger(ctx, "async.Service.CreateResource")
+// CreateOrUpdateResource implements the logic for creating a new, or updating an existing, resource Asynchronously.
+func (s *Service) CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error) {
+	ctx, log, done := tele.StartSpanWithLogger(ctx, "async.Service.CreateOrUpdateResource")
 	defer done()
 
 	resourceName := spec.ResourceName()
@@ -132,20 +133,25 @@ func (s *Service) CreateResource(ctx context.Context, spec azure.ResourceSpecGet
 	}
 
 	// Create or update the resource with the desired parameters.
-	log.V(2).Info("creating resource", "service", serviceName, "resource", resourceName, "resourceGroup", rgName)
+	logMessageVerbPrefix := "creat"
+	if existingResource != nil {
+		logMessageVerbPrefix = "updat"
+	}
+	log.V(2).Info(fmt.Sprintf("%sing resource", logMessageVerbPrefix), "service", serviceName, "resource", resourceName, "resourceGroup", rgName)
 	result, sdkFuture, err := s.Creator.CreateOrUpdateAsync(ctx, spec, parameters)
+	errWrapped := errors.Wrapf(err, fmt.Sprintf("failed to %se resource %s/%s (service: %s)", logMessageVerbPrefix, rgName, resourceName, serviceName))
 	if sdkFuture != nil {
 		future, err := converters.SDKToFuture(sdkFuture, infrav1.PutFuture, serviceName, resourceName, rgName)
 		if err != nil {
-			return nil, errors.Wrapf(err, "failed to create resource %s/%s (service: %s)", rgName, resourceName, serviceName)
+			return nil, errWrapped
 		}
 		s.Scope.SetLongRunningOperationState(future)
 		return nil, azure.WithTransientError(azure.NewOperationNotDoneError(future), getRequeueAfterFromFuture(sdkFuture))
 	} else if err != nil {
-		return nil, errors.Wrapf(err, "failed to create resource %s/%s (service: %s)", rgName, resourceName, serviceName)
+		return nil, errWrapped
 	}
 
-	log.V(2).Info("successfully created resource", "service", serviceName, "resource", resourceName, "resourceGroup", rgName)
+	log.V(2).Info(fmt.Sprintf("successfully %sed resource", logMessageVerbPrefix), "service", serviceName, "resource", resourceName, "resourceGroup", rgName)
 	return result, nil
 }
 

azure/services/async/async_test.go

@@ -205,8 +205,8 @@ func TestProcessOngoingOperation(t *testing.T) {
 	}
 }
 
-// TestCreateResource tests the CreateResource function.
-func TestCreateResource(t *testing.T) {
+// TestCreateOrUpdateResource tests the CreateOrUpdateResource function.
+func TestCreateOrUpdateResource(t *testing.T) {
 	testcases := []struct {
 		name           string
 		serviceName    string
@@ -291,7 +291,7 @@ func TestCreateResource(t *testing.T) {
 		},
 		{
 			name:          "error occurs while running async create",
-			expectedError: "failed to create resource test-group/test-resource (service: test-service)",
+			expectedError: "failed to update resource test-group/test-resource (service: test-service)",
 			serviceName:   "test-service",
 			expect: func(s *mock_async.MockFutureScopeMockRecorder, c *mock_async.MockCreatorMockRecorder, r *mock_azure.MockResourceSpecGetterMockRecorder) {
 				r.ResourceName().Return("test-resource")
@@ -333,7 +333,7 @@ func TestCreateResource(t *testing.T) {
 			tc.expect(scopeMock.EXPECT(), creatorMock.EXPECT(), specMock.EXPECT())
 
 			s := New(scopeMock, creatorMock, nil)
-			result, err := s.CreateResource(context.TODO(), specMock, tc.serviceName)
+			result, err := s.CreateOrUpdateResource(context.TODO(), specMock, tc.serviceName)
 			if tc.expectedError != "" {
 				g.Expect(err).To(HaveOccurred())
 				g.Expect(err.Error()).To(ContainSubstring(tc.expectedError))

azure/services/async/interfaces.go

@@ -56,6 +56,6 @@ type Deleter interface {
 
 // Reconciler is a generic interface used to perform asynchronous reconciliation of Azure resources.
 type Reconciler interface {
-	CreateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)
+	CreateOrUpdateResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (result interface{}, err error)
 	DeleteResource(ctx context.Context, spec azure.ResourceSpecGetter, serviceName string) (err error)
 }

azure/services/async/mock_async/async_mock.go

@@ -62,7 +62,7 @@ func (s *Service) Name() string {
 	return serviceName
 }
 
-// Reconcile creates or updates availability sets.
+// Reconcile idempotently creates or updates an availability set.
 func (s *Service) Reconcile(ctx context.Context) error {
 	ctx, log, done := tele.StartSpanWithLogger(ctx, "availabilitysets.Service.Reconcile")
 	defer done()
@@ -72,7 +72,7 @@ func (s *Service) Reconcile(ctx context.Context) error {
 
 	var err error
 	if setSpec := s.Scope.AvailabilitySetSpec(); setSpec != nil {
-		_, err = s.CreateResource(ctx, setSpec, serviceName)
+		_, err = s.CreateOrUpdateResource(ctx, setSpec, serviceName)
 	} else {
 		log.V(2).Info("skip creation when no availability set spec is found")
 		return nil

azure/services/availabilitysets/availabilitysets.go

@@ -84,7 +84,7 @@ func TestReconcileAvailabilitySets(t *testing.T) {
 			expectedError: "",
 			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
-				r.CreateResource(gomockinternal.AContext(), &fakeSetSpec, serviceName).Return(nil, nil)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeSetSpec, serviceName).Return(nil, nil)
 				s.UpdatePutStatus(infrav1.AvailabilitySetReadyCondition, serviceName, nil)
 			},
 		},
@@ -100,7 +100,7 @@ func TestReconcileAvailabilitySets(t *testing.T) {
 			expectedError: "some error with parameters",
 			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpecMissing)
-				r.CreateResource(gomockinternal.AContext(), &fakeSetSpecMissing, serviceName).Return(nil, parameterError)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeSetSpecMissing, serviceName).Return(nil, parameterError)
 				s.UpdatePutStatus(infrav1.AvailabilitySetReadyCondition, serviceName, parameterError)
 			},
 		},
@@ -109,7 +109,7 @@ func TestReconcileAvailabilitySets(t *testing.T) {
 			expectedError: "#: Internal Server Error: StatusCode=500",
 			expect: func(s *mock_availabilitysets.MockAvailabilitySetScopeMockRecorder, r *mock_async.MockReconcilerMockRecorder) {
 				s.AvailabilitySetSpec().Return(&fakeSetSpec)
-				r.CreateResource(gomockinternal.AContext(), &fakeSetSpec, serviceName).Return(nil, internalError)
+				r.CreateOrUpdateResource(gomockinternal.AContext(), &fakeSetSpec, serviceName).Return(nil, internalError)
 				s.UpdatePutStatus(infrav1.AvailabilitySetReadyCondition, serviceName, internalError)
 			},
 		},

azure/services/availabilitysets/availabilitysets_test.go

@@ -55,7 +55,7 @@ func (s *Service) Name() string {
 	return serviceName
 }
 
-// Reconcile gets/creates/updates a bastion host.
+// Reconcile idempotently creates or updates a bastion host.
 func (s *Service) Reconcile(ctx context.Context) error {
 	ctx, _, done := tele.StartSpanWithLogger(ctx, "bastionhosts.Service.Reconcile")
 	defer done()
@@ -65,7 +65,7 @@ func (s *Service) Reconcile(ctx context.Context) error {
 
 	var resultingErr error
 	if bastionSpec := s.Scope.AzureBastionSpec(); bastionSpec != nil {
-		_, resultingErr = s.CreateResource(ctx, bastionSpec, serviceName)
+		_, resultingErr = s.CreateOrUpdateResource(ctx, bastionSpec, serviceName)
 	} else {
 		return nil
 	}