Add Webpage Sample to V2 + fix for observed generation

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ObservedGenerationAware.java

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.api;
 
-import java.util.Optional;
-
 import io.fabric8.kubernetes.client.CustomResource;
 import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;
 
@@ -24,6 +22,6 @@ public interface ObservedGenerationAware {
 
   void setObservedGeneration(Long generation);
 
-  Optional<Long> getObservedGeneration();
+  Long getObservedGeneration();
 
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/ObservedGenerationAwareStatus.java

@@ -1,7 +1,5 @@
 package io.javaoperatorsdk.operator.api;
 
-import java.util.Optional;
-
 /**
  * A helper base class for status sub-resources classes to extend to support generate awareness.
  */
@@ -15,7 +13,7 @@ public void setObservedGeneration(Long generation) {
   }
 
   @Override
-  public Optional<Long> getObservedGeneration() {
-    return Optional.ofNullable(observedGeneration);
+  public Long getObservedGeneration() {
+    return observedGeneration;
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java

@@ -23,7 +23,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateResource(T customRe
     return new UpdateControl<>(customResource, false, true);
   }
 
-  public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(
+  public static <T extends HasMetadata> UpdateControl<T> updateStatus(
       T customResource) {
     return new UpdateControl<>(customResource, true, false);
   }
@@ -35,7 +35,7 @@ public static <T extends HasMetadata> UpdateControl<T> updateStatusSubResource(
    * @param customResource - custom resource to use in both API calls
    * @return UpdateControl instance
    */
-  public static <T extends HasMetadata> UpdateControl<T> updateCustomResourceAndStatus(
+  public static <T extends HasMetadata> UpdateControl<T> updateResourceAndStatus(
       T customResource) {
     return new UpdateControl<>(customResource, true, true);
   }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/ReconciliationDispatcher.java

@@ -75,9 +75,9 @@ private PostExecutionControl<R> handleDispatch(ExecutionScope<R> executionScope)
     Context context =
         new DefaultContext(executionScope.getRetryInfo());
     if (markedForDeletion) {
-      return handleDelete(resource, context);
+      return handleCleanup(resource, context);
     } else {
-      return handleCreateOrUpdate(executionScope, resource, context);
+      return handleReconcile(executionScope, resource, context);
     }
   }
 
@@ -99,7 +99,7 @@ private boolean shouldNotDispatchToDelete(R resource) {
     return configuration().useFinalizer() && !resource.hasFinalizer(configuration().getFinalizer());
   }
 
-  private PostExecutionControl<R> handleCreateOrUpdate(
+  private PostExecutionControl<R> handleReconcile(
       ExecutionScope<R> executionScope, R resource, Context context) {
     if (configuration().useFinalizer() && !resource.hasFinalizer(configuration().getFinalizer())) {
       /*
@@ -114,7 +114,7 @@ private PostExecutionControl<R> handleCreateOrUpdate(
       try {
         var resourceForExecution =
             cloneResourceForErrorStatusHandlerIfNeeded(resource, context);
-        return createOrUpdateExecution(executionScope, resourceForExecution, context);
+        return reconcileExecution(executionScope, resourceForExecution, context);
       } catch (RuntimeException e) {
         handleLastAttemptErrorStatusHandler(resource, context, e);
         throw e;
@@ -137,7 +137,7 @@ private R cloneResourceForErrorStatusHandlerIfNeeded(R resource, Context context
     }
   }
 
-  private PostExecutionControl<R> createOrUpdateExecution(ExecutionScope<R> executionScope,
+  private PostExecutionControl<R> reconcileExecution(ExecutionScope<R> executionScope,
       R resource, Context context) {
     log.debug(
         "Executing createOrUpdate for resource {} with version: {} with execution scope: {}",
@@ -222,7 +222,7 @@ private void updatePostExecutionControlWithReschedule(
     baseControl.getScheduleDelay().ifPresent(postExecutionControl::withReSchedule);
   }
 
-  private PostExecutionControl<R> handleDelete(R resource, Context context) {
+  private PostExecutionControl<R> handleCleanup(R resource, Context context) {
     log.debug(
         "Executing delete for resource: {} with version: {}",
         getName(resource),

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/internal/ResourceEventFilters.java

@@ -34,7 +34,7 @@ public final class ResourceEventFilters {
             var actualGeneration = newResource.getMetadata().getGeneration();
             var observedGeneration = ((ObservedGenerationAware) status)
                 .getObservedGeneration();
-            return observedGeneration.map(aLong -> actualGeneration > aLong).orElse(true);
+            return observedGeneration == null || actualGeneration > observedGeneration;
           }
         }
         return oldResource == null || !generationAware ||

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/ReconciliationDispatcherTest.java

@@ -92,7 +92,7 @@ void updatesOnlyStatusSubResourceIfFinalizerSet() {
     testCustomResource.addFinalizer(DEFAULT_FINALIZER);
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
-        .thenReturn(UpdateControl.updateStatusSubResource(testCustomResource));
+        .thenReturn(UpdateControl.updateStatus(testCustomResource));
 
     reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
 
@@ -105,7 +105,7 @@ void updatesBothResourceAndStatusIfFinalizerSet() {
     testCustomResource.addFinalizer(DEFAULT_FINALIZER);
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
-        .thenReturn(UpdateControl.updateCustomResourceAndStatus(testCustomResource));
+        .thenReturn(UpdateControl.updateResourceAndStatus(testCustomResource));
     when(customResourceFacade.replaceWithLock(testCustomResource)).thenReturn(testCustomResource);
 
     reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
@@ -281,7 +281,7 @@ void setReScheduleToPostExecutionControlFromUpdateControl() {
 
     when(reconciler.reconcile(eq(testCustomResource), any()))
         .thenReturn(
-            UpdateControl.updateStatusSubResource(testCustomResource).rescheduleAfter(1000L));
+            UpdateControl.updateStatus(testCustomResource).rescheduleAfter(1000L));
 
     PostExecutionControl control =
         reconciliationDispatcher.handleExecution(executionScopeWithCREvent(testCustomResource));
@@ -315,12 +315,12 @@ void setObservedGenerationForStatusIfNeeded() {
 
     when(lConfiguration.isGenerationAware()).thenReturn(true);
     when(lController.reconcile(eq(observedGenResource), any()))
-        .thenReturn(UpdateControl.updateStatusSubResource(observedGenResource));
+        .thenReturn(UpdateControl.updateStatus(observedGenResource));
     when(lFacade.updateStatus(observedGenResource)).thenReturn(observedGenResource);
 
     PostExecutionControl<ObservedGenCustomResource> control = lDispatcher.handleExecution(
         executionScopeWithCREvent(observedGenResource));
-    assertThat(control.getUpdatedCustomResource().get().getStatus().getObservedGeneration().get())
+    assertThat(control.getUpdatedCustomResource().get().getStatus().getObservedGeneration())
         .isEqualTo(1L);
   }
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/processing/event/internal/CustomResourceSelectorTest.java

@@ -173,7 +173,7 @@ public UpdateControl<TestCustomResource> reconcile(
 
       consumer.accept(resource);
 
-      return UpdateControl.updateStatusSubResource(resource);
+      return UpdateControl.updateStatus(resource);
     }
   }
 }

operator-framework/src/test/java/io/javaoperatorsdk/operator/ObservedGenerationHandlingIT.java

@@ -0,0 +1,40 @@
+package io.javaoperatorsdk.operator;
+
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.fabric8.kubernetes.api.model.ObjectMeta;
+import io.javaoperatorsdk.operator.config.runtime.DefaultConfigurationService;
+import io.javaoperatorsdk.operator.junit.OperatorExtension;
+import io.javaoperatorsdk.operator.sample.observedgeneration.ObservedGenerationTestCustomResource;
+import io.javaoperatorsdk.operator.sample.observedgeneration.ObservedGenerationTestReconciler;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+public class ObservedGenerationHandlingIT {
+  @RegisterExtension
+  OperatorExtension operator =
+      OperatorExtension.builder()
+          .withConfigurationService(DefaultConfigurationService.instance())
+          .withReconciler(new ObservedGenerationTestReconciler())
+          .build();
+
+  @Test
+  public void testReconciliationOfNonCustomResourceAndStatusUpdate() {
+    var resource = new ObservedGenerationTestCustomResource();
+    resource.setMetadata(new ObjectMeta());
+    resource.getMetadata().setName("observed-gen1");
+
+    var createdResource = operator.create(ObservedGenerationTestCustomResource.class, resource);
+
+    await().atMost(10, TimeUnit.SECONDS).untilAsserted(() -> {
+      var d = operator.get(ObservedGenerationTestCustomResource.class,
+          createdResource.getMetadata().getName());
+      assertThat(d.getStatus().getObservedGeneration()).isNotNull();
+      assertThat(d.getStatus().getObservedGeneration()).isEqualTo(1);
+    });
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/deployment/DeploymentReconciler.java

@@ -42,7 +42,7 @@ public UpdateControl<Deployment> reconcile(
     if (condition.isEmpty()) {
       conditions.add(new DeploymentCondition(null, null, STATUS_MESSAGE, null,
           "unknown", "DeploymentReconciler"));
-      return UpdateControl.updateStatusSubResource(resource);
+      return UpdateControl.updateStatus(resource);
     } else {
       return UpdateControl.noUpdate();
     }

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/doubleupdate/DoubleUpdateTestCustomReconciler.java

@@ -34,7 +34,7 @@ public UpdateControl<DoubleUpdateTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(DoubleUpdateTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateCustomResourceAndStatus(resource);
+    return UpdateControl.updateResourceAndStatus(resource);
   }
 
   private void ensureStatusExists(DoubleUpdateTestCustomResource resource) {

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/event/EventSourceTestCustomReconciler.java

@@ -27,7 +27,7 @@ public UpdateControl<EventSourceTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(EventSourceTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource).rescheduleAfter(TIMER_PERIOD);
+    return UpdateControl.updateStatus(resource).rescheduleAfter(TIMER_PERIOD);
   }
 
   private void ensureStatusExists(EventSourceTestCustomResource resource) {

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/informereventsource/InformerEventSourceTestCustomReconciler.java

@@ -55,7 +55,7 @@ public UpdateControl<InformerEventSourceTestCustomResource> reconcile(
     LOGGER.debug("Setting target status for CR: {}", targetStatus);
     resource.setStatus(new InformerEventSourceTestCustomResourceStatus());
     resource.getStatus().setConfigMapValue(targetStatus);
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   @Override

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenerationTestCustomResource.java

@@ -0,0 +1,23 @@
+package io.javaoperatorsdk.operator.sample.observedgeneration;
+
+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.Kind;
+import io.fabric8.kubernetes.model.annotation.ShortNames;
+import io.fabric8.kubernetes.model.annotation.Version;
+
+@Group("sample.javaoperatorsdk")
+@Version("v1")
+@Kind("ObservedGenerationTestCustomResource")
+@ShortNames("og")
+public class ObservedGenerationTestCustomResource
+    extends CustomResource<Void, ObservedGenerationTestCustomResourceStatus>
+    implements Namespaced {
+
+  @Override
+  protected ObservedGenerationTestCustomResourceStatus initStatus() {
+    return new ObservedGenerationTestCustomResourceStatus();
+  }
+
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenerationTestCustomResourceStatus.java

@@ -0,0 +1,7 @@
+package io.javaoperatorsdk.operator.sample.observedgeneration;
+
+import io.javaoperatorsdk.operator.api.ObservedGenerationAwareStatus;
+
+public class ObservedGenerationTestCustomResourceStatus extends ObservedGenerationAwareStatus {
+
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/observedgeneration/ObservedGenerationTestReconciler.java

@@ -0,0 +1,23 @@
+package io.javaoperatorsdk.operator.sample.observedgeneration;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.javaoperatorsdk.operator.api.reconciler.*;
+
+import static io.javaoperatorsdk.operator.api.reconciler.ControllerConfiguration.NO_FINALIZER;
+
+@ControllerConfiguration(finalizerName = NO_FINALIZER)
+public class ObservedGenerationTestReconciler
+    implements Reconciler<ObservedGenerationTestCustomResource> {
+
+  private static final Logger log = LoggerFactory.getLogger(ObservedGenerationTestReconciler.class);
+
+  @Override
+  public UpdateControl<ObservedGenerationTestCustomResource> reconcile(
+      ObservedGenerationTestCustomResource resource, Context context) {
+    log.info("Reconcile ObservedGenerationTestCustomResource: {}",
+        resource.getMetadata().getName());
+    return UpdateControl.updateStatus(resource);
+  }
+}

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/retry/RetryTestCustomReconciler.java

@@ -46,7 +46,7 @@ public UpdateControl<RetryTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(RetryTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private void ensureStatusExists(RetryTestCustomResource resource) {

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/simple/TestReconciler.java

@@ -128,7 +128,7 @@ public UpdateControl<TestCustomResource> reconcile(
       }
       resource.getStatus().setConfigMapStatus("ConfigMap Ready");
     }
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private Map<String, String> configMapData(TestCustomResource resource) {

operator-framework/src/test/java/io/javaoperatorsdk/operator/sample/subresource/SubResourceTestCustomReconciler.java

@@ -36,7 +36,7 @@ public UpdateControl<SubResourceTestCustomResource> reconcile(
     ensureStatusExists(resource);
     resource.getStatus().setState(SubResourceTestCustomResourceStatus.State.SUCCESS);
 
-    return UpdateControl.updateStatusSubResource(resource);
+    return UpdateControl.updateStatus(resource);
   }
 
   private void ensureStatusExists(SubResourceTestCustomResource resource) {

sample-operators/pom.xml

@@ -20,59 +20,6 @@
 
     <modules>
         <module>tomcat-operator</module>
+        <module>webpage</module>
     </modules>
-
-    <dependencies>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>operator-framework</artifactId>
-            <version>1.9.2</version>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.logging.log4j</groupId>
-            <artifactId>log4j-slf4j-impl</artifactId>
-            <version>2.13.3</version>
-        </dependency>
-        <dependency>
-            <groupId>org.takes</groupId>
-            <artifactId>takes</artifactId>
-            <version>1.19</version>
-        </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.1</version>
-            <scope>test</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.awaitility</groupId>
-            <artifactId>awaitility</artifactId>
-            <version>4.1.0</version>
-            <scope>test</scope>
-        </dependency>
-    </dependencies>
-
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>com.google.cloud.tools</groupId>
-                <artifactId>jib-maven-plugin</artifactId>
-                <version>${jib-maven-plugin.version}</version>
-                <configuration>
-                    <from>
-                        <image>gcr.io/distroless/java:11</image>
-                    </from>
-                    <to>
-                        <image>tomcat-operator</image>
-                    </to>
-                </configuration>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.8.1</version>
-            </plugin>
-        </plugins>
-    </build>
-
 </project>

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/TomcatReconciler.java

@@ -75,7 +75,7 @@ public UpdateControl<Tomcat> reconcile(Tomcat tomcat, Context context) {
           tomcat.getMetadata().getName(),
           tomcat.getMetadata().getNamespace(),
           tomcat.getStatus().getReadyReplicas());
-      return UpdateControl.updateStatusSubResource(updatedTomcat);
+      return UpdateControl.updateStatus(updatedTomcat);
     }
     return UpdateControl.noUpdate();
   }

sample-operators/tomcat-operator/src/main/java/io/javaoperatorsdk/operator/sample/WebappReconciler.java

@@ -98,7 +98,7 @@ public UpdateControl<Webapp> reconcile(Webapp webapp, Context context) {
       }
       webapp.getStatus().setDeployedArtifact(webapp.getSpec().getUrl());
       webapp.getStatus().setDeploymentStatus(commandStatusInAllPods);
-      return UpdateControl.updateStatusSubResource(webapp);
+      return UpdateControl.updateStatus(webapp);
     } else {
       log.info("WebappController invoked but Tomcat not ready yet ({}/{})",
           tomcat.getStatus() != null ? tomcat.getStatus().getReadyReplicas() : 0,