improve: submodule refactors and test move (#28)

csviri · web-flow · commit 859293a81096 · 2023-03-17T13:56:50.000+01:00
diff --git a/README.md b/README.md
@@ -10,9 +10,20 @@ Project is in early phases, heading towards mvp release.
 
 ## Usage 
 
-### Unit Tests
+Include dependency:
+
+```xml
+<dependency>
+   <groupId>io.javaoperatorsdk</groupId>
+   <artifactId>jenvtest</artifactId>
+   <version>[version]</version>
+   <scope>test</scope>
+</dependency>
+```
+
+### In Unit Tests
 
-See sample unit test [here](https://github.com/csviri/jenvtest/blob/main/src/test/java/com/csviri/jenvtest/junit/JUnitExtensionTest.java)
+See sample unit test [here](https://github.com/java-operator-sdk/jenvtest/blob/main/samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionTest.java#L10-L10)
 
 ```java
  
@@ -42,6 +53,12 @@ class JUnitExtensionTest {
 }
 ```
 
+### API
+
+The underlying API can be used directly. See [KubeApiServer](https://github.com/java-operator-sdk/jenvtest/blob/main/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServer.java#L47-L47)
+
+https://github.com/java-operator-sdk/jenvtest/blob/main/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubeApiServerTest.java#L12-L35
+
 ### Testing Mutation and Validation Webhooks
 
 An additional benefits os running K8S API Server this way, is that it makes easy to test 
@@ -50,7 +67,7 @@ and/or
 [Dynamic Admission Controllers](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/)
 
 In general using additional standard frameworks to implement webhookhooks is adviced, like [kubernetes-webooks-framework](https://github.com/java-operator-sdk/kubernetes-webooks-framework)
-with Quarkus or Spring. However, we demonstrate how it works in [this test](https://github.com/csviri/jenvtest/blob/main/src/test/java/com/csviri/jenvtest/KubernetesMutationHookHandlingTest.java)
+with Quarkus or Spring. However, we demonstrate how it works in [this test](https://github.com/java-operator-sdk/jenvtest/blob/main/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubernetesMutationHookHandlingTest.java#L53-L53)
 
 ### How does it work
 
diff --git a/core/pom.xml b/core/pom.xml
@@ -83,10 +83,6 @@
             <groupId>org.bouncycastle</groupId>
             <artifactId>bcpkix-jdk18on</artifactId>
         </dependency>
-        <dependency>
-            <groupId>io.javaoperatorsdk</groupId>
-            <artifactId>kubernetes-webhooks-framework-core</artifactId>
-            <scope>test</scope>
-        </dependency>
+
     </dependencies>
 </project>
diff --git a/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfig.java b/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfig.java
@@ -10,20 +10,20 @@ public class KubeAPIServerConfig {
   private final String jenvtestDir;
 
   /**
-   * If not set the latest binary will be selected automatically Sample: 1.26.1, 1.25.0.
+   * If not set the latest binary will be selected automatically. Sample: 1.26.1, 1.25.0.
    */
   private final String apiServerVersion;
 
   /**
    * If true, tries to download binaries. If the apiServerVersion is not set and some local binaries
    * found won't try to download them again.
    */
-  private final boolean downloadBinaries;
+  private final boolean offlineMode;
 
-  KubeAPIServerConfig(String jenvtestDir, String apiServerVersion, boolean downloadBinaries) {
+  KubeAPIServerConfig(String jenvtestDir, String apiServerVersion, boolean offlineMode) {
     this.jenvtestDir = jenvtestDir;
     this.apiServerVersion = apiServerVersion;
-    this.downloadBinaries = downloadBinaries;
+    this.offlineMode = offlineMode;
   }
 
   public String getJenvtestDir() {
@@ -34,7 +34,7 @@ public Optional<String> getApiServerVersion() {
     return Optional.ofNullable(apiServerVersion);
   }
 
-  public boolean isDownloadBinaries() {
-    return downloadBinaries;
+  public boolean isOfflineMode() {
+    return offlineMode;
   }
 }
diff --git a/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfigBuilder.java b/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfigBuilder.java
@@ -12,7 +12,7 @@ public final class KubeAPIServerConfigBuilder {
 
   private String jenvtestDir;
   private String apiServerVersion;
-  private Boolean downloadBinaries;
+  private Boolean offlineMode;
 
   public KubeAPIServerConfigBuilder() {}
 
@@ -30,8 +30,8 @@ public KubeAPIServerConfigBuilder withApiServerVersion(String apiServerVersion)
     return this;
   }
 
-  public KubeAPIServerConfigBuilder withDownloadBinaries(boolean downloadBinaries) {
-    this.downloadBinaries = downloadBinaries;
+  public KubeAPIServerConfigBuilder withOfflineMode(boolean downloadBinaries) {
+    this.offlineMode = downloadBinaries;
     return this;
   }
 
@@ -44,12 +44,12 @@ public KubeAPIServerConfig build() {
         this.jenvtestDir = new File(System.getProperty("user.home"), DIRECTORY_NAME).getPath();
       }
     }
-    if (downloadBinaries == null) {
+    if (offlineMode == null) {
       var downloadBinariesEnvVal = System.getenv(JENVTEST_DOWNLOAD_BINARIES);
       if (downloadBinariesEnvVal != null) {
-        this.downloadBinaries = Boolean.parseBoolean(downloadBinariesEnvVal);
+        this.offlineMode = Boolean.parseBoolean(downloadBinariesEnvVal);
       } else {
-        this.downloadBinaries = true;
+        this.offlineMode = false;
       }
     }
     if (apiServerVersion == null) {
@@ -58,6 +58,6 @@ public KubeAPIServerConfig build() {
         this.apiServerVersion = apiServerVersionEnvVar;
       }
     }
-    return new KubeAPIServerConfig(jenvtestDir, apiServerVersion, downloadBinaries);
+    return new KubeAPIServerConfig(jenvtestDir, apiServerVersion, offlineMode);
   }
 }
diff --git a/core/src/main/java/io/javaoperatorsdk/jenvtest/binary/BinaryManager.java b/core/src/main/java/io/javaoperatorsdk/jenvtest/binary/BinaryManager.java
@@ -29,7 +29,7 @@ public void initAndDownloadIfRequired() {
     File binaryDir = maybeBinaryDir.orElse(null);
 
     if (maybeBinaryDir.isEmpty()) {
-      if (!config.isDownloadBinaries()) {
+      if (config.isOfflineMode()) {
         throw new JenvtestException("Binaries cannot be found, and download is turned off");
       }
       binaryDir = config.getApiServerVersion().isEmpty() ? downloader.downloadLatest()
diff --git a/core/src/test/java/io/javaoperatorsdk/jenvtest/binary/BinaryManagerTest.java b/core/src/test/java/io/javaoperatorsdk/jenvtest/binary/BinaryManagerTest.java
@@ -12,7 +12,7 @@ class BinaryManagerTest {
   @Test
   void throwsExceptionIfBinaryNotPresentAndInOfflineMode() {
     BinaryManager binaryManager = new BinaryManager(KubeAPIServerConfigBuilder.anAPIServerConfig()
-        .withDownloadBinaries(false)
+        .withOfflineMode(true)
         .withApiServerVersion("1.0.1")
         .build());
 
diff --git a/samples/pom.xml b/samples/pom.xml
@@ -18,6 +18,54 @@
             <groupId>io.javaoperatorsdk</groupId>
             <artifactId>jenvtest</artifactId>
             <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.fabric8</groupId>
+            <artifactId>kubernetes-client</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.eclipse.jetty</groupId>
+            <artifactId>jetty-server</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.javaoperatorsdk</groupId>
+            <artifactId>kubernetes-webhooks-framework-core</artifactId>
+            <scope>test</scope>
         </dependency>
     </dependencies>
 </project>
diff --git a/samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionTest.java b/samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionTest.java
@@ -1,22 +1,20 @@
-package io.javaoperatorsdk.jenvtest.junit;
+package io.javaoperatorsdk.jenvtest;
 
+import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
-import io.javaoperatorsdk.jenvtest.TestUtils;
-
-import static io.javaoperatorsdk.jenvtest.TestUtils.testConfigMap;
-import static org.assertj.core.api.Assertions.assertThat;
+import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
 
 @EnableKubeAPIServer
 class JUnitExtensionTest {
 
   @Test
   void testCommunication() {
     var client = new KubernetesClientBuilder().build();
-    client.resource(testConfigMap()).createOrReplace();
+    client.resource(TestUtils.testConfigMap()).createOrReplace();
     var cm = client.resource(TestUtils.testConfigMap()).get();
 
-    assertThat(cm).isNotNull();
+    Assertions.assertThat(cm).isNotNull();
   }
 }
diff --git a/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubeApiServerTest.java b/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubeApiServerTest.java
@@ -1,5 +1,6 @@
 package io.javaoperatorsdk.jenvtest;
 
+import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
@@ -23,11 +24,12 @@ void apiServerWithSpecificVersion() {
 
   void testWithAPIServer(KubeAPIServer kubeApi) {
     kubeApi.start();
+
     var client = new KubernetesClientBuilder().build();
     client.resource(TestUtils.testConfigMap()).create();
     var cm = client.resource(TestUtils.testConfigMap()).get();
 
-    assertThat(cm).isNotNull();
+    Assertions.assertThat(cm).isNotNull();
 
     kubeApi.stop();
   }
diff --git a/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubernetesMutationHookHandlingTest.java b/samples/src/test/java/io/javaoperatorsdk/jenvtest/KubernetesMutationHookHandlingTest.java
diff --git a/samples/src/test/java/io/javaoperatorsdk/jenvtest/TestUtils.java b/samples/src/test/java/io/javaoperatorsdk/jenvtest/TestUtils.java
diff --git a/samples/src/test/resources/MutatingWebhookConfig.yaml b/samples/src/test/resources/MutatingWebhookConfig.yaml
diff --git a/samples/src/test/resources/log4j2.xml b/samples/src/test/resources/log4j2.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Configuration status="WARN">
+  <Appenders>
+    <Console name="Console" target="SYSTEM_OUT">
+      <PatternLayout pattern="%d %threadId %-30c{1.} [%-5level] %msg%n%throwable"/>
+    </Console>
+  </Appenders>
+  <Loggers>
+    <Logger name="io.csviri.jenvtest" level="debug">
+    </Logger>
+    <Root level="error">
+      <AppenderRef ref="Console"/>
+    </Root>
+  </Loggers>
+</Configuration>

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public final class KubeAPIServerConfigBuilder {`
`12`	`12`
`13`	`13`	`private String jenvtestDir;`
`14`	`14`	`private String apiServerVersion;`
`15`		`- private Boolean downloadBinaries;`
	`15`	`+ private Boolean offlineMode;`
`16`	`16`
`17`	`17`	`public KubeAPIServerConfigBuilder() {}`
`18`	`18`
`@@ -30,8 +30,8 @@ public KubeAPIServerConfigBuilder withApiServerVersion(String apiServerVersion)`
`30`	`30`	`return this;`
`31`	`31`	`}`
`32`	`32`
`33`		`- public KubeAPIServerConfigBuilder withDownloadBinaries(boolean downloadBinaries) {`
`34`		`- this.downloadBinaries = downloadBinaries;`
	`33`	`+ public KubeAPIServerConfigBuilder withOfflineMode(boolean downloadBinaries) {`
	`34`	`+ this.offlineMode = downloadBinaries;`
`35`	`35`	`return this;`
`36`	`36`	`}`
`37`	`37`
`@@ -44,12 +44,12 @@ public KubeAPIServerConfig build() {`
`44`	`44`	`this.jenvtestDir = new File(System.getProperty("user.home"), DIRECTORY_NAME).getPath();`
`45`	`45`	`}`
`46`	`46`	`}`
`47`		`- if (downloadBinaries == null) {`
	`47`	`+ if (offlineMode == null) {`
`48`	`48`	`var downloadBinariesEnvVal = System.getenv(JENVTEST_DOWNLOAD_BINARIES);`
`49`	`49`	`if (downloadBinariesEnvVal != null) {`
`50`		`- this.downloadBinaries = Boolean.parseBoolean(downloadBinariesEnvVal);`
	`50`	`+ this.offlineMode = Boolean.parseBoolean(downloadBinariesEnvVal);`
`51`	`51`	`} else {`
`52`		`- this.downloadBinaries = true;`
	`52`	`+ this.offlineMode = false;`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`	`if (apiServerVersion == null) {`
`@@ -58,6 +58,6 @@ public KubeAPIServerConfig build() {`
`58`	`58`	`this.apiServerVersion = apiServerVersionEnvVar;`
`59`	`59`	`}`
`60`	`60`	`}`
`61`		`- return new KubeAPIServerConfig(jenvtestDir, apiServerVersion, downloadBinaries);`
	`61`	`+ return new KubeAPIServerConfig(jenvtestDir, apiServerVersion, offlineMode);`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public void initAndDownloadIfRequired() {`
`29`	`29`	`File binaryDir = maybeBinaryDir.orElse(null);`
`30`	`30`
`31`	`31`	`if (maybeBinaryDir.isEmpty()) {`
`32`		`- if (!config.isDownloadBinaries()) {`
	`32`	`+ if (config.isOfflineMode()) {`
`33`	`33`	`throw new JenvtestException("Binaries cannot be found, and download is turned off");`
`34`	`34`	`}`
`35`	`35`	`binaryDir = config.getApiServerVersion().isEmpty() ? downloader.downloadLatest()`