Add tomcat operator sample

.github/workflows/end-to-end-tests.yml

@@ -0,0 +1,77 @@
+# End to end integration test which deploys the Tomcat operator to a Kubernetes
+# (Kind) cluster and creates custom resources to verify the operator's functionality
+name: TomcatOperator End to End test
+on:
+   push:
+      branches:
+      - "*"
+jobs: 
+    tomcat_e2e_test:
+       runs-on: ubuntu-latest
+       env:
+        KIND_CL_NAME: e2e-test
+       steps:
+        - name: Checkout
+          uses: actions/checkout@v2
+
+        - name: clean resident local docker
+          if: ${{ env.ACT }}
+          continue-on-error: true
+          run: |
+            for DIMG in "$KIND_CL_NAME-control-plane "; do
+              docker stop $DIMG ; docker rm $DIMG ;
+            done ;
+            sleep 1
+
+        - name: Create Kubernetes KinD Cluster
+          uses: container-tools/[email protected]
+          with:
+            cluster_name: e2e-test
+            registry: false
+
+        - name: Set up Java and Maven
+          uses: actions/setup-java@v2
+          with:
+            java-version: 11
+            distribution: adopt-hotspot
+            cache: 'maven'
+
+        - name: Build SDK
+          run: mvn install -DskipTests
+
+        - name: build jib
+          working-directory: sample-operators/tomcat-operator
+          run: |
+            mvn --version
+            mvn -B package jib:dockerBuild jib:buildTar -Djib-maven-image=tomcat-operator -DskipTests
+            kind load image-archive target/jib-image.tar --name=${{ env.KIND_CL_NAME }}
+
+        - name: Apply CRDs
+          working-directory: sample-operators/tomcat-operator
+          run: |
+            kubectl apply -f target/classes/META-INF/fabric8/tomcats.tomcatoperator.io-v1.yml
+            kubectl apply -f target/classes/META-INF/fabric8/webapps.tomcatoperator.io-v1.yml
+
+        - name: Deploy Tomcat Operator
+          working-directory: sample-operators/tomcat-operator
+          run: |
+            kubectl apply -f k8s/operator.yaml
+
+        - name: Run E2E Tests
+          working-directory: sample-operators/tomcat-operator
+          run: mvn -B test -P end-to-end-tests
+
+        - name: Dump state
+          if: ${{ failure() }}
+          run: |
+            set +e
+            echo "All namespaces"
+            kubectl get ns
+            echo "All objects in tomcat-operator"
+            kubectl get all -n tomcat-operator -o yaml
+            echo "Output of tomcat-operator pod"
+            kubectl logs -l app=tomcat-operator -n tomcat-operator
+            echo "All objects in tomcat-test"
+            kubectl get deployment,pod,tomcat,webapp -n tomcat-test -o yaml
+            echo "Output of curl command"
+            kubectl logs curl -n tomcat-test

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

@@ -76,7 +76,7 @@ public Optional<T> getLatestResource(String uuid) {
     return Optional.ofNullable(resources.get(uuid)).map(this::clone);
   }
 
-  public List<T> getLatestResources(Predicate<CustomResource> selector) {
+  public List<T> getLatestResources(Predicate<T> selector) {
     try {
       lock.lock();
       return resources.values().stream()
@@ -88,7 +88,7 @@ public List<T> getLatestResources(Predicate<CustomResource> selector) {
     }
   }
 
-  public Set<String> getLatestResourcesUids(Predicate<CustomResource> selector) {
+  public Set<String> getLatestResourcesUids(Predicate<T> selector) {
     try {
       lock.lock();
       return resources.values().stream()
@@ -113,4 +113,5 @@ private T clone(CustomResource customResource) {
   public T cleanup(String customResourceUid) {
     return resources.remove(customResourceUid);
   }
+
 }

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

@@ -26,8 +26,8 @@
 public class DefaultEventSourceManager<R extends CustomResource<?, ?>>
     implements EventSourceManager {
 
+  public static final String CUSTOM_RESOURCE_EVENT_SOURCE_NAME = "custom-resource-event-source";
   public static final String RETRY_TIMER_EVENT_SOURCE_NAME = "retry-timer-event-source";
-  private static final String CUSTOM_RESOURCE_EVENT_SOURCE_NAME = "custom-resource-event-source";
   private static final Logger log = LoggerFactory.getLogger(DefaultEventSourceManager.class);
 
   private final ReentrantLock lock = new ReentrantLock();

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

@@ -159,7 +159,6 @@ public void onClose(WatcherException e) {
     }
   }
 
-  // todo: remove
   public CustomResourceCache<T> getCache() {
     return customResourceCache;
   }

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

@@ -5,6 +5,9 @@
 import java.util.Set;
 import java.util.function.Function;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.informers.ResourceEventHandler;
@@ -15,6 +18,8 @@
 
 public class InformerEventSource<T extends HasMetadata> extends AbstractEventSource {
 
+  private static final Logger log = LoggerFactory.getLogger(InformerEventSource.class);
+
   private final SharedInformer<T> sharedInformer;
   private final Function<T, Set<String>> resourceToUIDs;
   private final Function<HasMetadata, T> associatedWith;
@@ -41,6 +46,11 @@ public InformerEventSource(SharedInformer<T> sharedInformer,
       Function<T, Set<String>> resourceToUIDs,
       Function<HasMetadata, T> associatedWith,
       boolean skipUpdateEventPropagationIfNoChange) {
+    if (sharedInformer.isRunning()) {
+      log.warn(
+          "Informer is already running on event source creation, this is not desirable and may " +
+              "lead to non deterministic behavior.");
+    }
     this.sharedInformer = sharedInformer;
     this.resourceToUIDs = resourceToUIDs;
     this.skipUpdateEventPropagationIfNoChange = skipUpdateEventPropagationIfNoChange;
@@ -81,7 +91,10 @@ private void propagateEvent(InformerEvent.Action action, T object, T oldObject)
     }
     uids.forEach(uid -> {
       InformerEvent event = new InformerEvent(uid, this, action, object, oldObject);
-      this.eventHandler.handleEvent(event);
+      // In case user passes an already running informer this would fail.
+      if (this.eventHandler != null) {
+        this.eventHandler.handleEvent(event);
+      }
     });
   }
 

pom.xml

@@ -76,8 +76,9 @@
         <module>operator-framework-core</module>
         <module>operator-framework-junit5</module>
         <module>operator-framework</module>
-        <module>samples</module>
-      <module>micrometer-support</module>
+        <module>smoke-test-samples</module>
+        <module>micrometer-support</module>
+        <module>sample-operators</module>
     </modules>
 
 
@@ -272,6 +273,7 @@
                     </includes>
                     <excludes>
                         <exclude>**/*IT.java</exclude>
+                        <exclude>**/*E2E.java</exclude>
                     </excludes>
                 </configuration>
             </plugin>
@@ -316,6 +318,7 @@
                             <includes>
                                 <include>**/*Test.java</include>
                                 <include>**/*IT.java</include>
+                                <include>**/*E2E.java</include>
                             </includes>
                         </configuration>
                     </plugin>
@@ -335,6 +338,27 @@
                             </includes>
                             <excludes>
                                 <exclude>**/*Test.java</exclude>
+                                <exclude>**/*E2E.java</exclude>
+                            </excludes>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+            <id>end-to-end-tests</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-surefire-plugin</artifactId>
+                        <configuration>
+                            <includes>
+                                <include>**/*E2E.java</include>
+                            </includes>
+                            <excludes>
+                                <exclude>**/*Test.java</exclude>
+                                <exclude>**/*IT.java</exclude>
                             </excludes>
                         </configuration>
                     </plugin>
@@ -351,6 +375,7 @@
                         <configuration>
                             <excludes>
                                 <exclude>**/*IT.java</exclude>
+                                <exclude>**/*E2E.java</exclude>
                             </excludes>
                         </configuration>
                     </plugin>

sample-operators/pom.xml

@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.javaoperatorsdk</groupId>
+        <artifactId>java-operator-sdk</artifactId>
+        <version>1.9.12-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>sample-operators</artifactId>
+    <name>Operator SDK - Samples</name>
+    <packaging>pom</packaging>
+
+    <properties>
+        <jib-maven-plugin.version>3.1.4</jib-maven-plugin.version>
+    </properties>
+
+    <modules>
+        <module>tomcat-operator</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/README.md

@@ -0,0 +1,76 @@
+# Tomcat Operator
+
+Creates a Tomcat deployment from a Custom Resource, while keeping the WAR separated with another Custom Resource.
+
+This sample demonstrates the following capabilities of the Java Operator SDK:
+* Multiple Controllers in a single Operator. The Tomcat resource is managed by the TomcatController while the Webapp
+resource is managed by the WebappController.
+* Reacting to events about resources created by the controller. The TomcatController will receive events about the
+Deployment resources it created. See EventSource section below for more detail. 
+
+## Example input for creating a Tomcat instance
+```
+apiVersion: "tomcatoperator.io/v1"
+kind: Tomcat
+metadata:
+  name: test-tomcat1
+spec:
+  version: 9.0
+  replicas: 2
+```
+
+## Example input for the Webapp
+```
+apiVersion: "tomcatoperator.io/v1"
+kind: Webapp
+metadata:
+  name: sample-webapp1
+spec:
+  tomcat: test-tomcat1
+  url: http://tomcat.apache.org/tomcat-7.0-doc/appdev/sample/sample.war
+  contextPath: mysample
+```
+
+## Getting started / Testing
+
+The quickest way to try the operator is to run it on your local machine, while it connects to a
+local or remote Kubernetes cluster. When you start it, it will use the current kubectl context on
+your machine to connect to the cluster.
+
+Before you run it you have to install the CRDs on your cluster by running:
+- `kubectl apply -f target/classes/META-INF/fabric8/tomcats.tomcatoperator.io-v1.yml`
+- `kubectl apply -f target/classes/META-INF/fabric8/webapps.tomcatoperator.io-v1.yml`
+
+The CRDs are generated automatically from your code by simply adding the `crd-generator-apt`
+dependency to your `pom.xml` file.
+
+When the Operator is running you can create some Tomcat Custom Resources. You can find a sample
+custom resources in the k8s folder.
+
+If you want the Operator to be running as a deployment in your cluster, follow the below steps.
+
+## Build
+
+You can build the sample using `mvn install jib:dockerBuild` this will produce a Docker image you
+can push to the registry of your choice. The JAR file is built using your local Maven and JDK and
+then copied into the Docker image.
+
+## Install Operator into cluster
+
+Install the CRDs as shown above if you haven't already, then
+run `kubectl apply -f k8s/operator.yaml`. Now you can create Tomcat instances with CRs (see examples
+above).
+
+## EventSources
+The TomcatController is listening to events about Deployments created by the TomcatOperator by registering a
+InformerEventSource with the EventSourceManager. The InformerEventSource will in turn register a watch on
+all Deployments managed by the Controller (identified by the `app.kubernetes.io/managed-by` label). 
+When an event from a Deployment is received we have to identify which Tomcat object does the Deployment
+belong to. This is done when the InformerEventSource creates the event.
+
+The TomcatController has to take care of setting the `app.kubernetes.io/managed-by` label on the Deployment so the
+InformerEventSource can watch the right Deployments.
+The TomcatController also has to set `ownerReference` on the Deployment so later the InformerEventSource can 
+identify which Tomcat does the Deployment belong to. This is necessary so the frameowork can call the Controller
+`createOrUpdate` method correctly.
+