Skip to content

fix: ReconcilerUtils.isFinalizerValid should account for NO_FINALIZER #819

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 1 commit into from
Jan 13, 2022
+12 −4
Merged

fix: ReconcilerUtils.isFinalizerValid should account for NO_FINALIZER #819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions operator-framework-core/src/main/java/io/javaoperatorsdk/operator/ReconcilerUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public void setApiVersion(String s) {
throw new UnsupportedOperationException();
}
};
return validator.isFinalizerValid(finalizer);
return Constants.NO_FINALIZER.equals(finalizer) || validator.isFinalizerValid(finalizer);
}

public static String getResourceTypeName(Class<? extends HasMetadata> resourceClass) {
Expand All @@ -49,7 +49,10 @@ public static String getResourceTypeName(Class<? extends HasMetadata> resourceCl
}

public static String getDefaultFinalizerName(Class<? extends HasMetadata> resourceClass) {
var resourceName = getResourceTypeName(resourceClass);
return getDefaultFinalizerName(getResourceTypeName(resourceClass));
}

public static String getDefaultFinalizerName(String resourceName) {
// resource names for historic resources such as Pods are missing periods and therefore do not
// constitute valid domain names as mandated by Kubernetes so generate one that does
if (resourceName.indexOf('.') < 0) {
Expand Down
6 changes: 6 additions & 0 deletions operator-framework-core/src/test/java/io/javaoperatorsdk/operator/ReconcilerUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import org.junit.jupiter.api.Test;

import io.fabric8.kubernetes.api.model.Pod;
import io.javaoperatorsdk.operator.api.reconciler.Constants;
import io.javaoperatorsdk.operator.sample.simple.TestCustomReconciler;
import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;

Expand Down Expand Up @@ -33,4 +34,9 @@ void defaultFinalizerShouldWork() {
assertTrue(isFinalizerValid(getDefaultFinalizerName(Pod.class)));
assertTrue(isFinalizerValid(getDefaultFinalizerName(TestCustomResource.class)));
}

@Test
void noFinalizerMarkerShouldWork() {
assertTrue(isFinalizerValid(Constants.NO_FINALIZER));
}
}
3 changes: 1 addition & 2 deletions ...ork/src/main/java/io/javaoperatorsdk/operator/config/runtime/AnnotationConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.javaoperatorsdk.operator.ReconcilerUtils;
import io.javaoperatorsdk.operator.api.config.ConfigurationService;
import io.javaoperatorsdk.operator.api.reconciler.Constants;
import io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration;
import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
import io.javaoperatorsdk.operator.processing.event.source.controller.ResourceEventFilter;
Expand Down Expand Up @@ -35,7 +34,7 @@ public String getFinalizer() {
return ReconcilerUtils.getDefaultFinalizerName(getResourceClass());
} else {
final var finalizer = annotation.finalizerName();
if (Constants.NO_FINALIZER.equals(finalizer) || ReconcilerUtils.isFinalizerValid(finalizer)) {
if (ReconcilerUtils.isFinalizerValid(finalizer)) {
return finalizer;
} else {
throw new IllegalArgumentException(finalizer
Expand Down