refactor: move test sample / duplicate some to fix integration tests

The issue is that since the sample code was living under the
operator-framework-core module, which doesn't include the annotation
processor, the controller implementations were not processed and thus
not found by the runtime when needed. This should, hopefully, address
the issue.

Author: metacosm

operator-framework-core/pom.xml

@@ -28,7 +28,7 @@
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>${surefire.version}</version>
             </plugin>
-            <plugin>
+            <!--<plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
                 <version>3.2.0</version>
@@ -39,7 +39,7 @@
                         </goals>
                     </execution>
                 </executions>
-            </plugin>
+            </plugin>-->
         </plugins>
     </build>
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/Operator.java

@@ -42,7 +42,7 @@ public <R extends CustomResource> void register(ResourceController<R> controller
       throws OperatorException {
     final var configuration = configurationService.getConfigurationFor(controller);
     final var retry = GenericRetry.fromConfiguration(configuration.getRetryConfiguration());
-    final var targetNamespaces = configuration.getNamespaces().toArray(new String[]{});
+    final var targetNamespaces = configuration.getNamespaces().toArray(new String[] {});
     registerController(controller, configuration.watchAllNamespaces(), retry, targetNamespaces);
   }
 
@@ -129,7 +129,7 @@ private CustomResourceEventSource createCustomResourceEventSource(
     CustomResourceEventSource customResourceEventSource =
         watchAllNamespaces
             ? CustomResourceEventSource.customResourceEventSourceForAllNamespaces(
-            customResourceCache, client, generationAware, finalizer)
+                customResourceCache, client, generationAware, finalizer)
             : CustomResourceEventSource.customResourceEventSourceForTargetNamespaces(
                 customResourceCache, client, targetNamespaces, generationAware, finalizer);
 
@@ -152,15 +152,15 @@ private CustomResourceDefinitionContext getCustomResourceDefinitionForController
   }
 
   public Map<Class<? extends CustomResource>, CustomResourceOperationsImpl>
-  getCustomResourceClients() {
+      getCustomResourceClients() {
     return customResourceClients;
   }
 
   public <
-      T extends CustomResource,
-      L extends CustomResourceList<T>,
-      D extends CustomResourceDoneable<T>>
-  CustomResourceOperationsImpl<T, L, D> getCustomResourceClients(Class<T> customResourceClass) {
+          T extends CustomResource,
+          L extends CustomResourceList<T>,
+          D extends CustomResourceDoneable<T>>
+      CustomResourceOperationsImpl<T, L, D> getCustomResourceClients(Class<T> customResourceClass) {
     return customResourceClients.get(customResourceClass);
   }
 }

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/OperatorException.java

@@ -2,8 +2,7 @@
 
 public class OperatorException extends RuntimeException {
 
-  public OperatorException() {
-  }
+  public OperatorException() {}
 
   public OperatorException(String message) {
     super(message);

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

@@ -37,8 +37,7 @@ public interface ResourceController<R extends CustomResource> {
    *
    * @param eventSourceManager
    */
-  default void init(EventSourceManager eventSourceManager) {
-  }
+  default void init(EventSourceManager eventSourceManager) {}
 
   default String getName() {
     final var clazz = getClass();

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

@@ -1,5 +1,3 @@
 package io.javaoperatorsdk.operator.api.config;
 
-public class DefaultRetryConfiguration implements RetryConfiguration {
-
-}
+public class DefaultRetryConfiguration implements RetryConfiguration {}

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

@@ -10,6 +10,5 @@ public void setEventHandler(EventHandler eventHandler) {
   }
 
   @Override
-  public void eventSourceDeRegisteredForResource(String customResourceUid) {
-  }
+  public void eventSourceDeRegisteredForResource(String customResourceUid) {}
 }

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

@@ -42,7 +42,7 @@ public String toString() {
         + getCustomResource().getMetadata().getResourceVersion()
         + ", markedForDeletion: "
         + (getCustomResource().getMetadata().getDeletionTimestamp() != null
-        && !getCustomResource().getMetadata().getDeletionTimestamp().isEmpty())
+            && !getCustomResource().getMetadata().getDeletionTimestamp().isEmpty())
         + " ]}";
   }
 

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

@@ -19,9 +19,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-/**
- * This is a special case since is not bound to a single custom resource
- */
+/** This is a special case since is not bound to a single custom resource */
 public class CustomResourceEventSource extends AbstractEventSource
     implements Watcher<CustomResource> {
 

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/EventDispatcherTest.java

@@ -120,9 +120,7 @@ void callsDeleteIfObjectHasFinalizerAndMarkedForDelete() {
     verify(controller, times(1)).deleteResource(eq(testCustomResource), any());
   }
 
-  /**
-   * Note that there could be more finalizers. Out of our control.
-   */
+  /** Note that there could be more finalizers. Out of our control. */
   @Test
   void callDeleteOnControllerIfMarkedForDeletionButThereIsNoDefaultFinalizer() {
     markForDeletion(testCustomResource);

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

@@ -4,21 +4,18 @@
 import io.fabric8.kubernetes.api.model.ConfigMapBuilder;
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
 import io.fabric8.kubernetes.client.KubernetesClient;
-import io.javaoperatorsdk.operator.TestExecutionInfoProvider;
 import io.javaoperatorsdk.operator.api.Context;
 import io.javaoperatorsdk.operator.api.Controller;
 import io.javaoperatorsdk.operator.api.DeleteControl;
 import io.javaoperatorsdk.operator.api.ResourceController;
 import io.javaoperatorsdk.operator.api.UpdateControl;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.concurrent.atomic.AtomicInteger;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 @Controller(generationAwareEventProcessing = false, crdName = TestCustomResourceController.CRD_NAME)
-public class TestCustomResourceController
-    implements ResourceController<TestCustomResource>, TestExecutionInfoProvider {
+public class TestCustomResourceController implements ResourceController<TestCustomResource> {
 
   private static final Logger log = LoggerFactory.getLogger(TestCustomResourceController.class);
 
@@ -27,7 +24,6 @@ public class TestCustomResourceController
 
   private final KubernetesClient kubernetesClient;
   private final boolean updateStatus;
-  private final AtomicInteger numberOfExecutions = new AtomicInteger(0);
 
   public TestCustomResourceController(KubernetesClient kubernetesClient) {
     this(kubernetesClient, true);
@@ -64,7 +60,6 @@ public DeleteControl deleteResource(
   @Override
   public UpdateControl<TestCustomResource> createOrUpdateResource(
       TestCustomResource resource, Context<TestCustomResource> context) {
-    numberOfExecutions.addAndGet(1);
     if (!resource.getMetadata().getFinalizers().contains(FINALIZER_NAME)) {
       throw new IllegalStateException("Finalizer is not present.");
     }
@@ -116,8 +111,4 @@ private Map<String, String> configMapData(TestCustomResource resource) {
     data.put(resource.getSpec().getKey(), resource.getSpec().getValue());
     return data;
   }
-
-  public int getNumberOfExecutions() {
-    return numberOfExecutions.get();
-  }
 }

operator-framework/pom.xml

@@ -73,13 +73,6 @@
       <version>0.19</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>io.javaoperatorsdk</groupId>
-      <artifactId>operator-framework-core</artifactId>
-      <version>${project.version}</version>
-      <classifier>tests</classifier>
-      <type>test-jar</type>
-    </dependency>
   </dependencies>
 
 </project>

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/AccumulativeMappingWriter.java

@@ -47,9 +47,7 @@ public AccumulativeMappingWriter loadExistingMappings() {
     return this;
   }
 
-  /**
-   * Add a new mapping
-   */
+  /** Add a new mapping */
   public AccumulativeMappingWriter add(String key, String value) {
     this.mappings.put(key, value);
     return this;

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/RuntimeControllerMetadata.java

@@ -7,12 +7,11 @@
 
 public class RuntimeControllerMetadata {
 
-  private static final String FINALIZER_NAME_SUFFIX = "/finalizer";
   public static final String CONTROLLERS_RESOURCE_PATH = "javaoperatorsdk/controllers";
   public static final String DONEABLES_RESOURCE_PATH = "javaoperatorsdk/doneables";
-  private static Map<Class<? extends ResourceController>, Class<? extends CustomResource>>
+  private static final Map<Class<? extends ResourceController>, Class<? extends CustomResource>>
       controllerToCustomResourceMappings;
-  private static Map<Class<? extends CustomResource>, Class<? extends CustomResourceDoneable>>
+  private static final Map<Class<? extends CustomResource>, Class<? extends CustomResourceDoneable>>
       resourceToDoneableMappings;
 
   static {
@@ -38,8 +37,8 @@ static <R extends CustomResource> Class<R> getCustomResourceClass(
   }
 
   public static <T extends CustomResource>
-  Class<? extends CustomResourceDoneable<T>> getCustomResourceDoneableClass(
-      ResourceController<T> controller) {
+      Class<? extends CustomResourceDoneable<T>> getCustomResourceDoneableClass(
+          ResourceController<T> controller) {
     final Class<T> customResourceClass = getCustomResourceClass(controller);
     final Class<? extends CustomResourceDoneable<T>> doneableClass =
         (Class<? extends CustomResourceDoneable<T>>)

operator-framework/src/main/java/io/javaoperatorsdk/operator/config/runtime/TypeParameterResolver.java

@@ -15,9 +15,7 @@
 import javax.lang.model.type.TypeVariable;
 import javax.lang.model.util.Types;
 
-/**
- * This class can resolve a type parameter in the given index to the actual type defined.
- */
+/** This class can resolve a type parameter in the given index to the actual type defined. */
 class TypeParameterResolver {
 
   private final DeclaredType interestedClass;
@@ -139,18 +137,18 @@ private List<DeclaredType> findChainOfInterfaces(Types typeUtils, DeclaredType p
     var matchingInterfaces =
         ((TypeElement) parentInterface.asElement())
             .getInterfaces().stream()
-            .filter(i -> typeUtils.isAssignable(i, interestedClass))
-            .map(i -> (DeclaredType) i)
-            .collect(Collectors.toList());
+                .filter(i -> typeUtils.isAssignable(i, interestedClass))
+                .map(i -> (DeclaredType) i)
+                .collect(Collectors.toList());
     while (matchingInterfaces.size() > 0) {
       result.addAll(matchingInterfaces);
       final var lastFoundInterface = matchingInterfaces.get(matchingInterfaces.size() - 1);
       matchingInterfaces =
           ((TypeElement) lastFoundInterface.asElement())
               .getInterfaces().stream()
-              .filter(i -> typeUtils.isAssignable(i, interestedClass))
-              .map(i -> (DeclaredType) i)
-              .collect(Collectors.toList());
+                  .filter(i -> typeUtils.isAssignable(i, interestedClass))
+                  .map(i -> (DeclaredType) i)
+                  .collect(Collectors.toList());
     }
     return result;
   }

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

@@ -42,7 +42,7 @@ public void receivingPeriodicEvents() {
           Thread.sleep(
               EventSourceTestCustomResourceController.TIMER_DELAY
                   + EXPECTED_TIMER_EVENT_COUNT
-                  * EventSourceTestCustomResourceController.TIMER_PERIOD);
+                      * EventSourceTestCustomResourceController.TIMER_PERIOD);
 
           Assertions.assertThat(integrationTestSupport.numberOfControllerExecutions())
               .isGreaterThanOrEqualTo(EXPECTED_TIMER_EVENT_COUNT + 1);

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

@@ -27,15 +27,15 @@
 
 public class IntegrationTestSupport {
 
-  public static final String TEST_NAMESPACE = io.javaoperatorsdk.operator.TestUtils.TEST_NAMESPACE;
+  public static final String TEST_NAMESPACE = "java-operator-sdk-int-test";
   public static final String TEST_CUSTOM_RESOURCE_PREFIX = "test-custom-resource-";
   private static final Logger log = LoggerFactory.getLogger(IntegrationTestSupport.class);
   private KubernetesClient k8sClient;
   private MixedOperation<
-      CustomResource,
-      CustomResourceList,
-      CustomResourceDoneable,
-      Resource<CustomResource, CustomResourceDoneable>>
+          CustomResource,
+          CustomResourceList,
+          CustomResourceDoneable,
+          Resource<CustomResource, CustomResourceDoneable>>
       crOperations;
   private Operator operator;
   private ResourceController controller;
@@ -179,11 +179,11 @@ public KubernetesClient getK8sClient() {
   }
 
   public MixedOperation<
-      CustomResource,
-      CustomResourceList,
-      CustomResourceDoneable,
-      Resource<CustomResource, CustomResourceDoneable>>
-  getCrOperations() {
+          CustomResource,
+          CustomResourceList,
+          CustomResourceDoneable,
+          Resource<CustomResource, CustomResourceDoneable>>
+      getCrOperations() {
     return crOperations;
   }
 

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

@@ -62,9 +62,7 @@ public void updatesSubResourceStatusNoFinalizer() {
         });
   }
 
-  /**
-   * Note that we check on controller impl if there is finalizer on execution.
-   */
+  /** Note that we check on controller impl if there is finalizer on execution. */
   @Test
   public void ifNoFinalizerPresentFirstAddsTheFinalizerThenExecutesControllerAgain() {
     integrationTestSupport.teardownIfSuccess(

operator-framework-core/src/test/java/io/javaoperatorsdk/operator/TestExecutionInfoProvider.java renamed to operator-framework/src/test/java/io/javaoperatorsdk/operator/TestExecutionInfoProvider.java

@@ -0,0 +1,35 @@
+package io.javaoperatorsdk.operator;
+
+import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.javaoperatorsdk.operator.sample.simple.TestCustomResource;
+import io.javaoperatorsdk.operator.sample.simple.TestCustomResourceSpec;
+import java.util.HashMap;
+import java.util.UUID;
+
+public class TestUtils {
+
+  public static final String TEST_CUSTOM_RESOURCE_NAME = "test-custom-resource";
+  public static final String TEST_NAMESPACE = "java-operator-sdk-int-test";
+
+  public static TestCustomResource testCustomResource() {
+    return testCustomResource(UUID.randomUUID().toString());
+  }
+
+  public static TestCustomResource testCustomResource(String uid) {
+    TestCustomResource resource = new TestCustomResource();
+    resource.setMetadata(
+        new ObjectMetaBuilder()
+            .withName(TEST_CUSTOM_RESOURCE_NAME)
+            .withUid(uid)
+            .withGeneration(1L)
+            .withNamespace(TEST_NAMESPACE)
+            .build());
+    resource.getMetadata().setAnnotations(new HashMap<>());
+    resource.setKind("CustomService");
+    resource.setSpec(new TestCustomResourceSpec());
+    resource.getSpec().setConfigMapName("test-config-map");
+    resource.getSpec().setKey("test-key");
+    resource.getSpec().setValue("test-value");
+    return resource;
+  }
+}

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

@@ -54,9 +54,7 @@ public void supportsInnerClassCustomResources() {
   static class TestCustomFinalizerController
       implements ResourceController<TestCustomFinalizerController.InnerCustomResource> {
 
-    public class InnerCustomResource extends CustomResource {
-
-    }
+    public class InnerCustomResource extends CustomResource {}
 
     @Override
     public DeleteControl deleteResource(

operator-framework/src/test/java/io/javaoperatorsdk/operator/config/runtime/DefaultConfigurationServiceTest.java

@@ -2,6 +2,4 @@
 
 import io.fabric8.kubernetes.client.CustomResource;
 
-class TestCustomResource extends CustomResource {
-
-}
+class TestCustomResource extends CustomResource {}