fix: webpage e2e test (#982)

Author: csviri

.github/workflows/e2e-test.yml

@@ -16,6 +16,7 @@ jobs:
         sample_dir:
           - "sample-operators/mysql-schema"
           - "sample-operators/tomcat-operator"
+          - "sample-operators/webpage"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

operator-framework-junit5/src/main/java/io/javaoperatorsdk/operator/junit/E2EOperatorExtension.java

@@ -10,6 +10,7 @@
 import java.util.Locale;
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
+import java.util.function.Consumer;
 
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.slf4j.Logger;
@@ -70,7 +71,7 @@ protected void before(ExtensionContext context) {
       }
     }
 
-    LOGGER.debug("Deploying the operator into Kubernetes");
+    LOGGER.debug("Deploying the operator into Kubernetes. Target namespace: {}", namespace);
     operatorDeployment.forEach(hm -> {
       hm.getMetadata().setNamespace(namespace);
       if (hm.getKind().toLowerCase(Locale.ROOT).equals("clusterrolebinding")) {
@@ -88,6 +89,7 @@ protected void before(ExtensionContext context) {
     kubernetesClient
         .resourceList(operatorDeployment)
         .waitUntilReady(operatorDeploymentTimeout.toMillis(), TimeUnit.MILLISECONDS);
+    LOGGER.debug("Operator resources deployed.");
   }
 
   @Override
@@ -110,6 +112,13 @@ public Builder withDeploymentTimeout(Duration value) {
       return this;
     }
 
+    public Builder withOperatorDeployment(List<HasMetadata> hm,
+        Consumer<List<HasMetadata>> modifications) {
+      modifications.accept(hm);
+      operatorDeployment.addAll(hm);
+      return this;
+    }
+
     public Builder withOperatorDeployment(List<HasMetadata> hm) {
       operatorDeployment.addAll(hm);
       return this;

sample-operators/webpage/k8s/operator.yaml

@@ -1,35 +1,27 @@
 apiVersion: v1
-kind: Namespace
-metadata:
-  name: webserver-operator
-
----
-apiVersion: v1
 kind: ServiceAccount
 metadata:
-  name: webserver-operator
-  namespace: webserver-operator
+  name: webpage-operator
 
 ---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: webserver-operator
-  namespace: webserver-operator
+  name: webpage-operator
 spec:
   selector:
     matchLabels:
-      app: webserver-operator
+      app: webpage-operator
   replicas: 1
   template:
     metadata:
       labels:
-        app: webserver-operator
+        app: webpage-operator
     spec:
-      serviceAccountName: webserver-operator
+      serviceAccountName: webpage-operator
       containers:
       - name: operator
-        image: webserver-operator
+        image: webpage-operator
         imagePullPolicy: Never
         ports:
         - containerPort: 80
@@ -53,18 +45,17 @@ metadata:
   name: operator-admin
 subjects:
 - kind: ServiceAccount
-  name: webserver-operator
-  namespace: webserver-operator
+  name: webpage-operator
 roleRef:
   kind: ClusterRole
-  name: webserver-operator
+  name: webpage-operator
   apiGroup: ""
 
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-  name: webserver-operator
+  name: webpage-operator
 rules:
 - apiGroups:
   - ""

sample-operators/webpage/pom.xml

@@ -45,6 +45,12 @@
             <artifactId>awaitility</artifactId>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>io.javaoperatorsdk</groupId>
+            <artifactId>operator-framework-junit-5</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>
@@ -57,7 +63,7 @@
                         <image>gcr.io/distroless/java:11</image>
                     </from>
                     <to>
-                        <image>webserver-operator</image>
+                        <image>webpage-operator</image>
                     </to>
                 </configuration>
             </plugin>

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageOperator.java

@@ -1,7 +1,6 @@
 package io.javaoperatorsdk.operator.sample;
 
 import java.io.IOException;
-import java.util.Arrays;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -18,16 +17,18 @@
 import io.javaoperatorsdk.operator.config.runtime.DefaultConfigurationService;
 
 public class WebPageOperator {
-
+  public static final String WEBPAGE_RECONCILER_ENV = "WEBPAGE_RECONCILER";
+  public static final String WEBPAGE_RECONCILER_ENV_VALUE = "classic";
   private static final Logger log = LoggerFactory.getLogger(WebPageOperator.class);
 
+
   public static void main(String[] args) throws IOException {
     log.info("WebServer Operator starting!");
 
     Config config = new ConfigBuilder().withNamespace(null).build();
     KubernetesClient client = new DefaultKubernetesClient(config);
     Operator operator = new Operator(client, DefaultConfigurationService.instance());
-    if (Arrays.stream(args).anyMatch(arg -> arg.equals("--classic"))) {
+    if (WEBPAGE_RECONCILER_ENV_VALUE.equals(System.getenv(WEBPAGE_RECONCILER_ENV))) {
       operator.register(new WebPageReconciler(client));
     } else {
       operator.register(new WebPageReconcilerDependentResources(client));

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconciler.java

@@ -111,7 +111,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context context) {
   private WebPageStatus createStatus(String configMapName) {
     WebPageStatus status = new WebPageStatus();
     status.setHtmlConfigMap(configMapName);
-    status.setAreWeGood("Yes!");
+    status.setAreWeGood(true);
     status.setErrorMessage(null);
     return status;
   }
@@ -191,7 +191,7 @@ private ConfigMap makeDesiredHtmlConfigMap(String ns, String configMapName, WebP
     return configMap;
   }
 
-  private Map<String, String> lowLevelLabel() {
+  public static Map<String, String> lowLevelLabel() {
     Map<String, String> labels = new HashMap<>();
     labels.put(LOW_LEVEL_LABEL_KEY, "true");
     return labels;

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageReconcilerDependentResources.java

@@ -69,7 +69,7 @@ public UpdateControl<WebPage> reconcile(WebPage webPage, Context context) {
   private WebPageStatus createStatus(String configMapName) {
     WebPageStatus status = new WebPageStatus();
     status.setHtmlConfigMap(configMapName);
-    status.setAreWeGood("Yes!");
+    status.setAreWeGood(true);
     status.setErrorMessage(null);
     return status;
   }
@@ -148,16 +148,16 @@ protected Class<Service> resourceType() {
         .setLabelSelector(DEPENDENT_RESOURCE_LABEL_SELECTOR));
   }
 
-  private static String configMapName(WebPage nginx) {
+  public static String configMapName(WebPage nginx) {
     return nginx.getMetadata().getName() + "-html";
   }
 
-  private static String deploymentName(WebPage nginx) {
+  public static String deploymentName(WebPage nginx) {
     return nginx.getMetadata().getName();
   }
 
-  private static String serviceName(WebPage nginx) {
-    return nginx.getMetadata().getName();
+  public static String serviceName(WebPage webPage) {
+    return webPage.getMetadata().getName();
   }
 
   private class ConfigMapDependentResource

sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageStatus.java

@@ -6,7 +6,7 @@ public class WebPageStatus extends ObservedGenerationAwareStatus {
 
   private String htmlConfigMap;
 
-  private String areWeGood;
+  private Boolean areWeGood;
 
   private String errorMessage;
 
@@ -18,11 +18,11 @@ public void setHtmlConfigMap(String htmlConfigMap) {
     this.htmlConfigMap = htmlConfigMap;
   }
 
-  public String getAreWeGood() {
+  public Boolean getAreWeGood() {
     return areWeGood;
   }
 
-  public void setAreWeGood(String areWeGood) {
+  public void setAreWeGood(Boolean areWeGood) {
     this.areWeGood = areWeGood;
   }
 

sample-operators/webpage/src/main/resources/io/javaoperatorsdk/operator/sample/ingress.yaml

@@ -0,0 +1,113 @@
+package io.javaoperatorsdk.operator.sample;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.time.Duration;
+import java.util.Objects;
+
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import io.fabric8.kubernetes.api.model.ObjectMeta;
+import io.fabric8.kubernetes.api.model.apps.Deployment;
+import io.fabric8.kubernetes.client.DefaultKubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.LocalPortForward;
+import io.javaoperatorsdk.operator.junit.AbstractOperatorExtension;
+
+import static io.javaoperatorsdk.operator.sample.WebPageReconcilerDependentResources.serviceName;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.awaitility.Awaitility.await;
+
+public abstract class WebPageOperatorAbstractTest {
+
+  static final Logger log = LoggerFactory.getLogger(WebPageOperatorDependentResourcesE2E.class);
+
+  static final KubernetesClient client = new DefaultKubernetesClient();
+  public static final String TEST_PAGE = "test-page";
+
+  boolean isLocal() {
+    String deployment = System.getProperty("test.deployment");
+    boolean remote = (deployment != null && deployment.equals("remote"));
+    log.info("Running the operator " + (remote ? "remote" : "locally"));
+    return !remote;
+  }
+
+  @Test
+  void testAddingWebPage() {
+
+    var webPage = createWebPage();
+    operator().create(WebPage.class, webPage);
+
+    await()
+        .atMost(Duration.ofSeconds(20))
+        .pollInterval(Duration.ofSeconds(1))
+        .until(
+            () -> {
+              var actual = operator().get(WebPage.class, TEST_PAGE);
+              var deployment = operator().get(Deployment.class,
+                  WebPageReconcilerDependentResources.deploymentName(webPage));
+
+              return Boolean.TRUE.equals(actual.getStatus().getAreWeGood())
+                  && Objects.equals(deployment.getSpec().getReplicas(),
+                      deployment.getStatus().getReadyReplicas());
+            });
+
+    String response = httpGetForWebPage(webPage);
+    assertThat(response).contains("<title>Hello Operator World</title>");
+  }
+
+  String httpGetForWebPage(WebPage webPage) {
+    LocalPortForward portForward = null;
+    try {
+      portForward =
+          client.services().inNamespace(webPage.getMetadata().getNamespace())
+              .withName(serviceName(webPage)).portForward(80);
+      HttpClient httpClient =
+          HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(10)).build();
+      HttpRequest request =
+          HttpRequest.newBuilder().GET()
+              .uri(new URI("http://localhost:" + portForward.getLocalPort())).build();
+      return httpClient.send(request, HttpResponse.BodyHandlers.ofString()).body();
+    } catch (URISyntaxException | IOException | InterruptedException e) {
+      throw new IllegalStateException(e);
+    } finally {
+      if (portForward != null) {
+        try {
+          portForward.close();
+        } catch (IOException e) {
+          log.error("Port forward close error.", e);
+        }
+      }
+    }
+  }
+
+  WebPage createWebPage() {
+    WebPage webPage = new WebPage();
+    webPage.setMetadata(new ObjectMeta());
+    webPage.getMetadata().setName(TEST_PAGE);
+    webPage.getMetadata().setNamespace(operator().getNamespace());
+    webPage.setSpec(new WebPageSpec());
+    webPage
+        .getSpec()
+        .setHtml(
+            "<html>\n"
+                + "      <head>\n"
+                + "        <title>Hello Operator World</title>\n"
+                + "      </head>\n"
+                + "      <body>\n"
+                + "        Hello World! \n"
+                + "      </body>\n"
+                + "    </html>");
+
+    return webPage;
+  }
+
+  abstract AbstractOperatorExtension operator();
+
+}