Merge remote-tracking branch 'origin/event-sources' into event-sources

csviri · csviri · commit f276ff656358 · 2020-11-30T10:27:21.000+01:00
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/EventListUtils.java
@@ -1,21 +1,13 @@
-package io.javaoperatorsdk.operator.processing;
+package io.javaoperatorsdk.operator;
 
-import io.fabric8.kubernetes.client.CustomResource;
+import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.Watcher;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEvent;
 
 import java.util.List;
 
-public class ProcessingUtils {
-
-    public static String getUID(CustomResource customResource) {
-        return customResource.getMetadata().getUid();
-    }
-
-    public static String getVersion(CustomResource customResource) {
-        return customResource.getMetadata().getResourceVersion();
-    }
+public class EventListUtils {
 
     public static boolean containsCustomResourceDeletedEvent(List<Event> events) {
         return events.stream().anyMatch(e -> {
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/DefaultEventHandler.java
@@ -12,7 +12,7 @@
 import java.util.concurrent.ThreadFactory;
 import java.util.concurrent.locks.ReentrantLock;
 
-import static io.javaoperatorsdk.operator.processing.ProcessingUtils.containsCustomResourceDeletedEvent;
+import static io.javaoperatorsdk.operator.EventListUtils.containsCustomResourceDeletedEvent;
 
 /**
  * Event handler that makes sure that events are processed in a "single threaded" way per resource UID, while buffering
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/EventDispatcher.java
@@ -15,7 +15,8 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-import static io.javaoperatorsdk.operator.processing.ProcessingUtils.*;
+import static io.javaoperatorsdk.operator.EventListUtils.containsCustomResourceDeletedEvent;
+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.*;
 
 /**
  * Dispatches events to the Controller and handles Finalizers for a single type of Custom Resource.
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/KubernetesResourceUtils.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/KubernetesResourceUtils.java
@@ -0,0 +1,15 @@
+package io.javaoperatorsdk.operator.processing;
+
+import io.fabric8.kubernetes.api.model.HasMetadata;
+
+public class KubernetesResourceUtils {
+
+    public static String getUID(HasMetadata customResource) {
+        return customResource.getMetadata().getUid();
+    }
+
+    public static String getVersion(HasMetadata customResource) {
+        return customResource.getMetadata().getResourceVersion();
+    }
+
+}
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/DefaultEventSourceManager.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/DefaultEventSourceManager.java
@@ -2,7 +2,7 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.processing.DefaultEventHandler;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
+import io.javaoperatorsdk.operator.processing.KubernetesResourceUtils;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEventSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -34,14 +34,14 @@ public void registerCustomResourceEventSource(CustomResourceEventSource customRe
     public <T extends EventSource> void registerEventSource(CustomResource customResource, String name, T eventSource) {
         try {
             lock.lock();
-            Map<String, EventSource> eventSourceList = eventSources.get(ProcessingUtils.getUID(customResource));
+            Map<String, EventSource> eventSourceList = eventSources.get(KubernetesResourceUtils.getUID(customResource));
             if (eventSourceList == null) {
                 eventSourceList = new HashMap<>(1);
-                eventSources.put(ProcessingUtils.getUID(customResource), eventSourceList);
+                eventSources.put(KubernetesResourceUtils.getUID(customResource), eventSourceList);
             }
             if (eventSourceList.get(name) != null) {
                 throw new IllegalStateException("Event source with name already registered. Resource id: "
-                        + ProcessingUtils.getUID(customResource) + ", event source name: " + name);
+                        + KubernetesResourceUtils.getUID(customResource) + ", event source name: " + name);
             }
             eventSourceList.put(name, eventSource);
             eventSource.setEventHandler(defaultEventHandler);
@@ -55,13 +55,13 @@ public <T extends EventSource> void registerEventSource(CustomResource customRes
     public <T extends EventSource> T registerEventSourceIfNotRegistered(CustomResource customResource, String name, Supplier<T> eventSourceSupplier) {
         try {
             lock.lock();
-            if (eventSources.get(ProcessingUtils.getUID(customResource)) == null ||
-                    eventSources.get(ProcessingUtils.getUID(customResource)).get(name) == null) {
+            if (eventSources.get(KubernetesResourceUtils.getUID(customResource)) == null ||
+                    eventSources.get(KubernetesResourceUtils.getUID(customResource)).get(name) == null) {
                 EventSource eventSource = eventSourceSupplier.get();
                 registerEventSource(customResource, name, eventSource);
                 return (T) eventSource;
             }
-            return (T) eventSources.get(ProcessingUtils.getUID(customResource)).get(name);
+            return (T) eventSources.get(KubernetesResourceUtils.getUID(customResource)).get(name);
         } finally {
             lock.unlock();
         }
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEvent.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEvent.java
@@ -2,7 +2,7 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.client.Watcher;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
+import io.javaoperatorsdk.operator.processing.KubernetesResourceUtils;
 import io.javaoperatorsdk.operator.processing.event.AbstractEvent;
 
 public class CustomResourceEvent extends AbstractEvent<CustomResourceEventSource> {
@@ -15,7 +15,7 @@ public class CustomResourceEvent extends AbstractEvent<CustomResourceEventSource
 
     public CustomResourceEvent(Watcher.Action action, CustomResource resource,
                                CustomResourceEventSource customResourceEventSource) {
-        super(ProcessingUtils.getUID(resource), customResourceEventSource);
+        super(KubernetesResourceUtils.getUID(resource), customResourceEventSource);
         this.action = action;
         this.customResource = resource;
     }
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEventSource.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceEventSource.java
@@ -5,13 +5,12 @@
 import io.fabric8.kubernetes.client.Watcher;
 import io.fabric8.kubernetes.client.dsl.MixedOperation;
 import io.fabric8.kubernetes.client.dsl.internal.CustomResourceOperationsImpl;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
 import io.javaoperatorsdk.operator.processing.ResourceCache;
 import io.javaoperatorsdk.operator.processing.event.AbstractEventSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static io.javaoperatorsdk.operator.processing.ProcessingUtils.*;
+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.*;
 import static java.net.HttpURLConnection.HTTP_GONE;
 
 /**
@@ -66,8 +65,8 @@ private void registerWatch() {
 
     @Override
     public void eventReceived(Watcher.Action action, CustomResource customResource) {
-        log.debug("Event received for action: {}, resource: {}",
-                customResource.getMetadata().getName(), customResource);
+        log.debug("Event received for action: {}, resource: {}", action.name(), customResource.getMetadata().getName());
+
         resourceCache.cacheResource(customResource); // always store the latest event. Outside the sync block is intentional.
         if (action == Action.ERROR) {
             log.debug("Skipping {} event for custom resource uid: {}, version: {}", action,
diff --git a/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/TimerEventSource.java b/operator-framework/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/TimerEventSource.java
@@ -1,7 +1,7 @@
 package io.javaoperatorsdk.operator.processing.event.internal;
 
 import io.fabric8.kubernetes.client.CustomResource;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
+import io.javaoperatorsdk.operator.processing.KubernetesResourceUtils;
 import io.javaoperatorsdk.operator.processing.event.AbstractEventSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -20,14 +20,14 @@ public class TimerEventSource extends AbstractEventSource {
     private final Map<String, List<EventProducerTimeTask>> timerTasks = new ConcurrentHashMap<>();
 
     public void schedule(CustomResource customResource, long delay, long period) {
-        String resourceUid = ProcessingUtils.getUID(customResource);
+        String resourceUid = KubernetesResourceUtils.getUID(customResource);
         EventProducerTimeTask task = new EventProducerTimeTask(resourceUid);
         storeTask(resourceUid, task);
         timer.schedule(task, delay, period);
     }
 
     public void scheduleOnce(CustomResource customResource, long delay) {
-        String resourceUid = ProcessingUtils.getUID(customResource);
+        String resourceUid = KubernetesResourceUtils.getUID(customResource);
         OneTimeEventProducerTimerTask task = new OneTimeEventProducerTimerTask(resourceUid);
         storeTask(resourceUid, task);
         timer.schedule(task, delay);
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/EventDispatcherTest.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/EventDispatcherTest.java
@@ -7,7 +7,6 @@
 import io.javaoperatorsdk.operator.api.UpdateControl;
 import io.javaoperatorsdk.operator.processing.EventDispatcher;
 import io.javaoperatorsdk.operator.processing.ExecutionScope;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
 import io.javaoperatorsdk.operator.processing.event.Event;
 import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEvent;
 import io.javaoperatorsdk.operator.processing.event.internal.TimerEvent;
@@ -20,6 +19,7 @@
 import java.util.Collections;
 import java.util.List;
 
+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getUID;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.Mockito.*;
 
@@ -226,7 +226,7 @@ public ExecutionScope executionScopeWithCREvent(Watcher.Action action, CustomRes
     }
 
     public Event nonCREvent(CustomResource resource) {
-        return new TimerEvent(ProcessingUtils.getUID(resource), null);
+        return new TimerEvent(getUID(resource), null);
     }
 
 }
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/processing/event/DefaultEventSourceManagerTest.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/processing/event/DefaultEventSourceManagerTest.java
@@ -7,7 +7,7 @@
 
 import java.util.Map;
 
-import static io.javaoperatorsdk.operator.processing.ProcessingUtils.getUID;
+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getUID;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.mockito.Mockito.*;
diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/processing/event/internal/TimerEventSourceTest.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/processing/event/internal/TimerEventSourceTest.java
@@ -2,7 +2,7 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.TestUtils;
-import io.javaoperatorsdk.operator.processing.ProcessingUtils;
+import io.javaoperatorsdk.operator.processing.KubernetesResourceUtils;
 import io.javaoperatorsdk.operator.processing.event.EventHandler;
 import io.javaoperatorsdk.operator.processing.event.EventSourceManager;
 import org.junit.jupiter.api.BeforeEach;
@@ -11,6 +11,7 @@
 
 import java.util.List;
 
+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.*;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.*;
 
@@ -40,7 +41,7 @@ public void producesOneTimeEvent() {
         ArgumentCaptor<TimerEvent> argumentCaptor = ArgumentCaptor.forClass(TimerEvent.class);
         verify(eventHandlerMock, timeout(100).times(1)).handleEvent(argumentCaptor.capture());
         TimerEvent event = argumentCaptor.getValue();
-        assertThat(event.getRelatedCustomResourceUid()).isEqualTo(ProcessingUtils.getUID(customResource));
+        assertThat(event.getRelatedCustomResourceUid()).isEqualTo(getUID(customResource));
         assertThat(event.getEventSource()).isEqualTo(timerEventSource);
     }
 
@@ -54,7 +55,7 @@ public void producesEventsPeriodically() {
         verify(eventHandlerMock, timeout(INITIAL_DELAY + PERIOD + TESTING_TIME_SLACK).times(2))
                 .handleEvent(argumentCaptor.capture());
         List<TimerEvent> events = argumentCaptor.getAllValues();
-        assertThat(events).allMatch(e -> e.getRelatedCustomResourceUid().equals(ProcessingUtils.getUID(customResource)));
+        assertThat(events).allMatch(e -> e.getRelatedCustomResourceUid().equals(getUID(customResource)));
         assertThat(events).allMatch(e -> e.getEventSource().equals(timerEventSource));
     }
 
@@ -64,7 +65,7 @@ public void deRegistersPeriodicalEventSources() throws InterruptedException {
 
         timerEventSource.schedule(customResource, INITIAL_DELAY, PERIOD);
         Thread.sleep(INITIAL_DELAY + PERIOD + TESTING_TIME_SLACK);
-        timerEventSource.eventSourceDeRegisteredForResource(ProcessingUtils.getUID(customResource));
+        timerEventSource.eventSourceDeRegisteredForResource(getUID(customResource));
         Thread.sleep(PERIOD + TESTING_TIME_SLACK);
 
         verify(eventHandlerMock, times(2))
@@ -77,7 +78,7 @@ public void deRegistersOneTimeEventSource() throws InterruptedException {
 
         timerEventSource.scheduleOnce(customResource, INITIAL_DELAY);
         Thread.sleep(TESTING_TIME_SLACK);
-        timerEventSource.eventSourceDeRegisteredForResource(ProcessingUtils.getUID(customResource));
+        timerEventSource.eventSourceDeRegisteredForResource(getUID(customResource));
         Thread.sleep(PERIOD + TESTING_TIME_SLACK);
 
         verify(eventHandlerMock, times(0))

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`import io.javaoperatorsdk.operator.api.UpdateControl;`
`8`	`8`	`import io.javaoperatorsdk.operator.processing.EventDispatcher;`
`9`	`9`	`import io.javaoperatorsdk.operator.processing.ExecutionScope;`
`10`		`-import io.javaoperatorsdk.operator.processing.ProcessingUtils;`
`11`	`10`	`import io.javaoperatorsdk.operator.processing.event.Event;`
`12`	`11`	`import io.javaoperatorsdk.operator.processing.event.internal.CustomResourceEvent;`
`13`	`12`	`import io.javaoperatorsdk.operator.processing.event.internal.TimerEvent;`
`@@ -20,6 +19,7 @@`
`20`	`19`	`import java.util.Collections;`
`21`	`20`	`import java.util.List;`
`22`	`21`
	`22`	`+import static io.javaoperatorsdk.operator.processing.KubernetesResourceUtils.getUID;`
`23`	`23`	`import static org.junit.jupiter.api.Assertions.assertEquals;`
`24`	`24`	`import static org.mockito.Mockito.*;`
`25`	`25`
`@@ -226,7 +226,7 @@ public ExecutionScope executionScopeWithCREvent(Watcher.Action action, CustomRes`
`226`	`226`	`}`
`227`	`227`
`228`	`228`	`public Event nonCREvent(CustomResource resource) {`
`229`		`- return new TimerEvent(ProcessingUtils.getUID(resource), null);`
	`229`	`+ return new TimerEvent(getUID(resource), null);`
`230`	`230`	`}`
`231`	`231`
`232`	`232`	`}`