Skip to content

Improvement/handle namespace deletion on finalizer gracefully #1988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Improvement/handle namespace deletion on finalizer gracefully #1988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a63ab3
improve: remove deprecated API usage in ReconciliationDispatcher
Donnerbart Jul 31, 2023
c461a84
fix: Fix NPE in ReconciliationDispatcher when custom resource cannot …
Donnerbart Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions .../src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,6 @@ private void updatePostExecutionControlWithReschedule(
baseControl.getScheduleDelay().ifPresent(postExecutionControl::withReSchedule);
}


private PostExecutionControl<P> handleCleanup(P resource,
Context<P> context) {
log.debug(
Expand All @@ -295,12 +294,23 @@ private PostExecutionControl<P> handleCleanup(P resource,
// cleanup is finished, nothing left to done
final var finalizerName = configuration().getFinalizerName();
if (deleteControl.isRemoveFinalizer() && resource.hasFinalizer(finalizerName)) {
P customResource = conflictRetryingUpdate(resource, r -> r.removeFinalizer(finalizerName));
P customResource = conflictRetryingUpdate(resource, r -> {
// the operator might not be allowed to retrieve the resource on a retry, e.g. when its
// permissions are removed by deleting the namespace concurrently
if (r == null) {
log.warn(
"Could not remove finalizer on null resource: {} with version: {}",
getUID(resource),
getVersion(resource));
return false;
}
return r.removeFinalizer(finalizerName);
});
return PostExecutionControl.customResourceFinalizerRemoved(customResource);
}
}
log.debug(
"Skipping finalizer remove for resource: {} with version: {}. delete control: {}, uses finalizer: {} ",
"Skipping finalizer remove for resource: {} with version: {}. delete control: {}, uses finalizer: {}",
getUID(resource),
getVersion(resource),
deleteControl,
Expand Down Expand Up @@ -385,15 +395,14 @@ public R updateResource(R resource) {
getName(resource),
resource.getMetadata().getResourceVersion());
return resource(resource).lockResourceVersion(resource.getMetadata().getResourceVersion())
.replace();
.update();
}

@SuppressWarnings({"rawtypes", "unchecked"})
public R updateStatus(R resource) {
log.trace("Updating status for resource: {}", resource);
return resource(resource)
.lockResourceVersion()
.replaceStatus();
.updateStatus();
}

public R patchStatus(R resource, R originalResource) {
Expand Down
22 changes: 18 additions & 4 deletions .../test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,24 @@ void retriesFinalizerRemovalWithFreshResource() {
verify(customResourceFacade, times(1)).getResource(any(), any());
}

@Test
void nullResourceIsGracefullyHandledOnFinalizerRemovalRetry() {
// simulate the operator not able or not be allowed to get the custom resource during the retry
// of the finalizer removal
testCustomResource.addFinalizer(DEFAULT_FINALIZER);
markForDeletion(testCustomResource);
when(customResourceFacade.updateResource(any()))
.thenThrow(new KubernetesClientException(null, 409, null));
when(customResourceFacade.getResource(any(), any())).thenReturn(null);

var postExecControl =
reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));

assertThat(postExecControl.isFinalizerRemoved()).isTrue();
verify(customResourceFacade, times(1)).updateResource(testCustomResource);
verify(customResourceFacade, times(1)).getResource(any(), any());
}

@Test
void throwsExceptionIfFinalizerRemovalRetryExceeded() {
testCustomResource.addFinalizer(DEFAULT_FINALIZER);
Expand Down Expand Up @@ -307,8 +325,6 @@ void doesNotAddFinalizerIfConfiguredNotTo() {
assertEquals(0, testCustomResource.getMetadata().getFinalizers().size());
}



@Test
void doesNotRemovesTheSetFinalizerIfTheDeleteNotMethodInstructsIt() {
testCustomResource.addFinalizer(DEFAULT_FINALIZER);
Expand Down Expand Up @@ -590,7 +606,6 @@ void errorStatusHandlerCanPatchResource() {
reconciler.errorHandler =
(r, ri, e) -> ErrorStatusUpdateControl.patchStatus(testCustomResource);


reconciliationDispatcher.handleExecution(
new ExecutionScope(null).setResource(testCustomResource));

Expand Down Expand Up @@ -673,7 +688,6 @@ TestCustomResource createResourceWithFinalizer() {
return resourceWithFinalizer;
}


private void removeFinalizers(CustomResource customResource) {
customResource.getMetadata().getFinalizers().clear();
}
Expand Down