Skip to content

fix: PerResourcePollingEventSource issue with resources #1417

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.

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 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,8 @@ public final synchronized void registerEventSource(String name, EventSource even
@SuppressWarnings("unchecked")
public void broadcastOnResourceEvent(ResourceAction action, R resource, R oldResource) {
eventSources.additionalNamedEventSources().forEach(eventSource -> {
if (eventSource instanceof ResourceEventAware) {
var lifecycleAwareES = ((ResourceEventAware<R>) eventSource);
if (eventSource.original() instanceof ResourceEventAware) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are there possibly other spots where a similar change would be needed?

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, good question, probably not, since it works. Just this did not have a integration test.

var lifecycleAwareES = ((ResourceEventAware<R>) eventSource.original());
switch (action) {
case ADDED:
lifecycleAwareES.onResourceCreated(resource);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package io.javaoperatorsdk.operator;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.sample.perresourceeventsource.PerResourceEventSourceCustomResource;
import io.javaoperatorsdk.operator.sample.perresourceeventsource.PerResourcePollingEventSourceTestReconciler;

import static org.assertj.core.api.Assertions.assertThat;
import static org.awaitility.Awaitility.await;

class PerResourcePollingEventSourceIT {

public static final String NAME_1 = "name1";
public static final String NAME_2 = "name2";

@RegisterExtension
LocallyRunOperatorExtension operator =
LocallyRunOperatorExtension.builder()
.withReconciler(new PerResourcePollingEventSourceTestReconciler())
.build();

/**
* This is kinda some test to verify that the implementation of PerResourcePollingEventSource
* works with the underling mechanisms in event source manager and other parts of the system.
**/
@Test
void fetchedAndReconciledMultipleTimes() {
operator.create(PerResourceEventSourceCustomResource.class, resource(NAME_1));
operator.create(PerResourceEventSourceCustomResource.class, resource(NAME_2));

var reconciler =
operator.getReconcilerOfType(PerResourcePollingEventSourceTestReconciler.class);
await().untilAsserted(() -> {
assertThat(reconciler.getNumberOfExecutions(NAME_1)).isGreaterThan(2);
assertThat(reconciler.getNumberOfFetchExecution(NAME_1)).isGreaterThan(2);
assertThat(reconciler.getNumberOfExecutions(NAME_2)).isGreaterThan(2);
assertThat(reconciler.getNumberOfFetchExecution(NAME_2)).isGreaterThan(2);
});
}

private PerResourceEventSourceCustomResource resource(String name) {
var res = new PerResourceEventSourceCustomResource();
res.setMetadata(new ObjectMetaBuilder()
.withName(name)
.build());
return res;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package io.javaoperatorsdk.operator.sample.perresourceeventsource;

import io.fabric8.kubernetes.api.model.Namespaced;
import io.fabric8.kubernetes.client.CustomResource;
import io.fabric8.kubernetes.model.annotation.Group;
import io.fabric8.kubernetes.model.annotation.ShortNames;
import io.fabric8.kubernetes.model.annotation.Version;

@Group("sample.javaoperatorsdk")
@Version("v1")
@ShortNames("pres")
public class PerResourceEventSourceCustomResource
extends CustomResource<Void, Void>
implements Namespaced {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package io.javaoperatorsdk.operator.sample.perresourceeventsource;

import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;

import io.fabric8.kubernetes.client.KubernetesClient;
import io.javaoperatorsdk.operator.api.reconciler.*;
import io.javaoperatorsdk.operator.junit.KubernetesClientAware;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;
import io.javaoperatorsdk.operator.processing.event.source.polling.PerResourcePollingEventSource;

@ControllerConfiguration
public class PerResourcePollingEventSourceTestReconciler
implements Reconciler<PerResourceEventSourceCustomResource>,
EventSourceInitializer<PerResourceEventSourceCustomResource>,
KubernetesClientAware {

public static final int POLL_PERIOD = 100;
private final Map<String, Integer> numberOfExecutions = new ConcurrentHashMap<>();
private final Map<String, Integer> numberOfFetchExecutions = new ConcurrentHashMap<>();

private KubernetesClient client;
private PerResourcePollingEventSource<String, PerResourceEventSourceCustomResource> eventSource;

@Override
public UpdateControl<PerResourceEventSourceCustomResource> reconcile(
PerResourceEventSourceCustomResource resource,
Context<PerResourceEventSourceCustomResource> context) throws Exception {
numberOfExecutions.putIfAbsent(resource.getMetadata().getName(), 0);
numberOfExecutions.compute(resource.getMetadata().getName(), (s, v) -> v + 1);
return UpdateControl.noUpdate();
}

@Override
public Map<String, EventSource> prepareEventSources(
EventSourceContext<PerResourceEventSourceCustomResource> context) {
this.eventSource =
new PerResourcePollingEventSource<>(resource -> {
numberOfFetchExecutions.putIfAbsent(resource.getMetadata().getName(), 0);
numberOfFetchExecutions.compute(resource.getMetadata().getName(), (s, v) -> v + 1);
return Set.of(UUID.randomUUID().toString());
},
context.getPrimaryCache(), POLL_PERIOD, String.class);
return EventSourceInitializer.nameEventSources(eventSource);
}

@Override
public KubernetesClient getKubernetesClient() {
return client;
}

@Override
public void setKubernetesClient(KubernetesClient kubernetesClient) {
this.client = kubernetesClient;
}

public int getNumberOfExecutions(String name) {
return numberOfExecutions.get(name);
}

public int getNumberOfFetchExecution(String name) {
return numberOfFetchExecutions.get(name);
}

}