From d042d3e6a17b2c00bcbae81d31669dd58e7ac07f Mon Sep 17 00:00:00 2001 From: csviri Date: Wed, 27 Jul 2022 10:26:46 +0200 Subject: [PATCH] refactor: naming of resource update method --- .../event/ReconciliationDispatcher.java | 8 ++--- .../event/ReconciliationDispatcherTest.java | 36 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java index 23a31e792a..1520f21134 100644 --- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java +++ b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java @@ -302,13 +302,13 @@ private R updateCustomResourceWithFinalizer(R resource) { log.debug( "Adding finalizer for resource: {} version: {}", getUID(resource), getVersion(resource)); resource.addFinalizer(configuration().getFinalizerName()); - return customResourceFacade.replaceResourceWithLock(resource); + return customResourceFacade.updateResource(resource); } private R updateCustomResource(R resource) { log.debug("Updating resource: {} with version: {}", getUID(resource), getVersion(resource)); log.trace("Resource before update: {}", resource); - return customResourceFacade.replaceResourceWithLock(resource); + return customResourceFacade.updateResource(resource); } ControllerConfiguration configuration() { @@ -326,7 +326,7 @@ public R removeFinalizer(R resource, String finalizer) { if (!removed) { return resource; } - return customResourceFacade.replaceResourceWithLock(resource); + return customResourceFacade.updateResource(resource); } catch (KubernetesClientException e) { log.trace("Exception during finalizer removal for resource: {}", resource); retryIndex++; @@ -360,7 +360,7 @@ public R getResource(String namespace, String name) { return resourceOperation.inNamespace(namespace).withName(name).get(); } - public R replaceResourceWithLock(R resource) { + public R updateResource(R resource) { log.debug( "Trying to replace resource {}, version: {}", getName(resource), diff --git a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java index ddd5ce583b..89dafa9fc4 100644 --- a/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java +++ b/operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java @@ -133,7 +133,7 @@ void addFinalizerOnNewResource() { verify(reconciler, never()) .reconcile(ArgumentMatchers.eq(testCustomResource), any()); verify(customResourceFacade, times(1)) - .replaceResourceWithLock( + .updateResource( argThat(testCustomResource -> testCustomResource.hasFinalizer(DEFAULT_FINALIZER))); assertThat(testCustomResource.hasFinalizer(DEFAULT_FINALIZER)).isTrue(); } @@ -155,7 +155,7 @@ void updatesOnlyStatusSubResourceIfFinalizerSet() { reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); verify(customResourceFacade, times(1)).patchStatus(eq(testCustomResource), any()); - verify(customResourceFacade, never()).replaceResourceWithLock(any()); + verify(customResourceFacade, never()).updateResource(any()); } @Test @@ -163,12 +163,12 @@ void updatesBothResourceAndStatusIfFinalizerSet() { testCustomResource.addFinalizer(DEFAULT_FINALIZER); reconciler.reconcile = (r, c) -> UpdateControl.updateResourceAndStatus(testCustomResource); - when(customResourceFacade.replaceResourceWithLock(testCustomResource)) + when(customResourceFacade.updateResource(testCustomResource)) .thenReturn(testCustomResource); reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); - verify(customResourceFacade, times(1)).replaceResourceWithLock(testCustomResource); + verify(customResourceFacade, times(1)).updateResource(testCustomResource); verify(customResourceFacade, times(1)).updateStatus(testCustomResource); } @@ -182,7 +182,7 @@ void patchesStatus() { verify(customResourceFacade, times(1)).patchStatus(eq(testCustomResource), any()); verify(customResourceFacade, never()).updateStatus(any()); - verify(customResourceFacade, never()).replaceResourceWithLock(any()); + verify(customResourceFacade, never()).updateResource(any()); } @Test @@ -214,7 +214,7 @@ void removesDefaultFinalizerOnDeleteIfSet() { reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); assertThat(postExecControl.isFinalizerRemoved()).isTrue(); - verify(customResourceFacade, times(1)).replaceResourceWithLock(testCustomResource); + verify(customResourceFacade, times(1)).updateResource(testCustomResource); } @Test @@ -223,7 +223,7 @@ void retriesFinalizerRemovalWithFreshResource() { markForDeletion(testCustomResource); var resourceWithFinalizer = TestUtils.testCustomResource(); resourceWithFinalizer.addFinalizer(DEFAULT_FINALIZER); - when(customResourceFacade.replaceResourceWithLock(testCustomResource)) + when(customResourceFacade.updateResource(testCustomResource)) .thenThrow(new KubernetesClientException(null, 409, null)) .thenReturn(testCustomResource); when(customResourceFacade.getResource(any(), any())).thenReturn(resourceWithFinalizer); @@ -232,7 +232,7 @@ void retriesFinalizerRemovalWithFreshResource() { reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); assertThat(postExecControl.isFinalizerRemoved()).isTrue(); - verify(customResourceFacade, times(2)).replaceResourceWithLock(any()); + verify(customResourceFacade, times(2)).updateResource(any()); verify(customResourceFacade, times(1)).getResource(any(), any()); } @@ -240,7 +240,7 @@ void retriesFinalizerRemovalWithFreshResource() { void throwsExceptionIfFinalizerRemovalRetryExceeded() { testCustomResource.addFinalizer(DEFAULT_FINALIZER); markForDeletion(testCustomResource); - when(customResourceFacade.replaceResourceWithLock(any())) + when(customResourceFacade.updateResource(any())) .thenThrow(new KubernetesClientException(null, 409, null)); when(customResourceFacade.getResource(any(), any())) .thenAnswer((Answer) invocationOnMock -> createResourceWithFinalizer()); @@ -252,7 +252,7 @@ void throwsExceptionIfFinalizerRemovalRetryExceeded() { assertThat(postExecControl.getRuntimeException()).isPresent(); assertThat(postExecControl.getRuntimeException().get()) .isInstanceOf(OperatorException.class); - verify(customResourceFacade, times(MAX_FINALIZER_REMOVAL_RETRY)).replaceResourceWithLock(any()); + verify(customResourceFacade, times(MAX_FINALIZER_REMOVAL_RETRY)).updateResource(any()); verify(customResourceFacade, times(MAX_FINALIZER_REMOVAL_RETRY - 1)).getResource(any(), any()); } @@ -261,7 +261,7 @@ void throwsExceptionIfFinalizerRemovalRetryExceeded() { void throwsExceptionIfFinalizerRemovalClientExceptionIsNotConflict() { testCustomResource.addFinalizer(DEFAULT_FINALIZER); markForDeletion(testCustomResource); - when(customResourceFacade.replaceResourceWithLock(any())) + when(customResourceFacade.updateResource(any())) .thenThrow(new KubernetesClientException(null, 400, null)); var res = @@ -269,7 +269,7 @@ void throwsExceptionIfFinalizerRemovalClientExceptionIsNotConflict() { assertThat(res.getRuntimeException()).isPresent(); assertThat(res.getRuntimeException().get()).isInstanceOf(KubernetesClientException.class); - verify(customResourceFacade, times(1)).replaceResourceWithLock(any()); + verify(customResourceFacade, times(1)).updateResource(any()); verify(customResourceFacade, never()).getResource(any(), any()); } @@ -315,7 +315,7 @@ void doesNotRemovesTheSetFinalizerIfTheDeleteNotMethodInstructsIt() { reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); assertEquals(1, testCustomResource.getMetadata().getFinalizers().size()); - verify(customResourceFacade, never()).replaceResourceWithLock(any()); + verify(customResourceFacade, never()).updateResource(any()); } @Test @@ -325,7 +325,7 @@ void doesNotUpdateTheResourceIfNoUpdateUpdateControlIfFinalizerSet() { reconciler.reconcile = (r, c) -> UpdateControl.noUpdate(); reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); - verify(customResourceFacade, never()).replaceResourceWithLock(any()); + verify(customResourceFacade, never()).updateResource(any()); verify(customResourceFacade, never()).updateStatus(testCustomResource); } @@ -333,13 +333,13 @@ void doesNotUpdateTheResourceIfNoUpdateUpdateControlIfFinalizerSet() { void addsFinalizerIfNotMarkedForDeletionAndEmptyCustomResourceReturned() { removeFinalizers(testCustomResource); reconciler.reconcile = (r, c) -> UpdateControl.noUpdate(); - when(customResourceFacade.replaceResourceWithLock(any())).thenReturn(testCustomResource); + when(customResourceFacade.updateResource(any())).thenReturn(testCustomResource); var postExecControl = reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); assertEquals(1, testCustomResource.getMetadata().getFinalizers().size()); - verify(customResourceFacade, times(1)).replaceResourceWithLock(any()); + verify(customResourceFacade, times(1)).updateResource(any()); assertThat(postExecControl.updateIsStatusPatch()).isFalse(); assertThat(postExecControl.getUpdatedCustomResource()).isPresent(); } @@ -351,7 +351,7 @@ void doesNotCallDeleteIfMarkedForDeletionButNotOurFinalizer() { reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource)); - verify(customResourceFacade, never()).replaceResourceWithLock(any()); + verify(customResourceFacade, never()).updateResource(any()); verify(reconciler, never()).cleanup(eq(testCustomResource), any()); } @@ -475,7 +475,7 @@ void updateObservedGenerationOnCustomResourceUpdate() throws Exception { when(config.isGenerationAware()).thenReturn(true); when(reconciler.reconcile(any(), any())) .thenReturn(UpdateControl.updateResource(observedGenResource)); - when(facade.replaceResourceWithLock(any())).thenReturn(observedGenResource); + when(facade.updateResource(any())).thenReturn(observedGenResource); when(facade.updateStatus(observedGenResource)).thenReturn(observedGenResource); var dispatcher = init(observedGenResource, reconciler, config, facade, true);