Skip to content

fix: default stop handler exists only if informer started #1575

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
Oct 27, 2022
Merged

fix: default stop handler exists only if informer started #1575

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
163ecda
fix: default stop handler exists only if informer started
csviri Oct 27, 2022
b4072ae
refactor based on PR comment
csviri Oct 27, 2022
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
4 changes: 3 additions & 1 deletion ...ework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ConfigurationService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,9 @@ default Duration cacheSyncTimeout() {
*/
default Optional<InformerStoppedHandler> getInformerStoppedHandler() {
return Optional.of((informer, ex) -> {
if (ex != null) {
// hasSynced is checked to verify that informer already started. If not started, in case
// of a fatal error the operator will stop, no need for explicit exit.
if (ex != null && informer.hasSynced()) {
Logger log = LoggerFactory.getLogger(ConfigurationService.class);
log.error("Fatal error in informer: {}. Stopping the operator", informer, ex);
System.exit(1);
Expand Down
26 changes: 21 additions & 5 deletions operator-framework/src/test/java/io/javaoperatorsdk/operator/InformerRelatedBehaviorITS.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class InformerRelatedBehaviorITS {
KubernetesClient adminClient = new KubernetesClientBuilder().build();
InformerRelatedBehaviorTestReconciler reconciler;
String actualNamespace;
volatile boolean stopHandlerCalled = false;
volatile boolean stopHandlerCalledReplacement = false;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why replacement?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, there is a default one originally

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
volatile boolean stopHandlerCalledReplacement = false;
volatile boolean replacementStopHandlerCalled = false;

would be more correct, imo, then.

Copy link
Collaborator Author

@csviri csviri Oct 27, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed from IDE


@BeforeEach
void beforeEach(TestInfo testInfo) {
Expand Down Expand Up @@ -136,7 +136,19 @@ void callsStopHandlerOnStartupFail() {

assertThrows(OperatorException.class, () -> startOperator(true));

await().untilAsserted(() -> assertThat(stopHandlerCalled).isTrue());
await().untilAsserted(() -> assertThat(stopHandlerCalledReplacement).isTrue());
}

@Test
void notExitingWithDefaultStopHandlerIfErrorHappensOnStartup() {
setNoCustomResourceAccess();
adminClient.resource(testCustomResource()).createOrReplace();

assertThrows(OperatorException.class, () -> startOperator(true, false));

// note that we just basically check here that the default handler does not call system exit.
// Thus, the test does not terminate before to assert.
await().untilAsserted(() -> assertThat(stopHandlerCalledReplacement).isFalse());
}

private static void waitForWatchReconnect() {
Expand Down Expand Up @@ -183,16 +195,20 @@ KubernetesClient clientUsingServiceAccount() {
}

Operator startOperator(boolean stopOnInformerErrorDuringStartup) {
return startOperator(stopOnInformerErrorDuringStartup, true);
}

Operator startOperator(boolean stopOnInformerErrorDuringStartup, boolean addStopHandler) {
ConfigurationServiceProvider.reset();
reconciler = new InformerRelatedBehaviorTestReconciler();

Operator operator = new Operator(clientUsingServiceAccount(),
co -> {
co.withStopOnInformerErrorDuringStartup(stopOnInformerErrorDuringStartup);
co.withCacheSyncTimeout(Duration.ofMillis(3000));
co.withInformerStoppedHandler((informer, ex) -> {
stopHandlerCalled = true;
});
if (addStopHandler) {
co.withInformerStoppedHandler((informer, ex) -> stopHandlerCalledReplacement = true);
}
});
operator.register(reconciler);
operator.installShutdownHook();
Expand Down