improve: no separate samples module, facelift docs (#74)

Author: csviri

README.md

@@ -25,33 +25,28 @@ Include dependency:
 ### In Unit Tests
 
 See sample unit
-test [here](https://github.com/java-operator-sdk/jenvtest/blob/6fadd8cb07ea0a61410175abf1f6ec495bf6a20f/samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionOnClassTest.java)
+test [here](https://github.com/java-operator-sdk/jenvtest/blob/main/core/src/test/java/io/javaoperatorsdk/jenvtest/sample/JUnitExtensionSimpleCaseTest.java)
 
 ```java
 
-@EnableKubeAPIServer // Start/Stop Kube API Server in the background
-class JUnitExtensionTest {
+@EnableKubeAPIServer
+class JUnitExtensionSimpleCaseTest {
+
+    // Use @KubeConfig annotation to inject kube config yaml to init any client
+    @KubeConfig
+    static String kubeConfigYaml;
 
     @Test
-    void testCommunication() {
-        // use a Kubernetes client to communicate with the server
-        var client = new KubernetesClientBuilder().build();
-        client.resource(configMap()).createOrReplace();
-        var cm = client.resource(configMap()).get();
+    void simpleTestWithTargetVersion() {
+        var client = new KubernetesClientBuilder()
+                .withConfig(Config.fromKubeconfig(kubeConfigYaml))
+                .build();
 
-        assertThat(cm).isNotNull();
-    }
+        client.resource(TestUtils.testConfigMap()).create();
+        var cm = client.resource(TestUtils.testConfigMap()).get();
 
-    private ConfigMap configMap() {
-        return new ConfigMapBuilder()
-                .withMetadata(new ObjectMetaBuilder()
-                        .withName("test1")
-                        .withNamespace("default")
-                        .build())
-                .withData(Map.of("key", "data"))
-                .build();
+        Assertions.assertThat(cm).isNotNull();
     }
-
 }
 ```
 
@@ -94,6 +89,34 @@ class KubeApiServerTest {
 }
 ```
 
+### Fabric8 Kubernetes Client Support 
+
+There is a dedicated support for [Fabric8 Kubernetes Client](https://github.com/fabric8io/kubernetes-client).
+
+Using dependency:
+
+```xml
+<dependency>
+    <groupId>io.javaoperatorsdk</groupId>
+    <artifactId>jenvtest-fabric8-client</artifactId>
+    <version>[version]</version>
+    <scope>test</scope>
+</dependency>
+```
+
+The client can be directly injected to the test. See sample test [here](/home/csviri/Workspace/jenvtest/fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/JUnitFabric8ClientInjectionTest.java).
+
+```java
+
+@EnableKubeAPIServer
+class JUnitFabric8ClientInjectionTest {
+
+    static KubernetesClient client;
+   
+    // emitted code     
+}  
+```
+
 ### Testing Mutation and Validation Webhooks
 
 An additional benefits os running K8S API Server this way, is that it makes easy to test

core/pom.xml

@@ -83,6 +83,10 @@
             <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>

samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionKubeConfigUpdateTest.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/JUnitExtensionKubeConfigUpdateTest.java

@@ -1,10 +1,10 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import org.junit.jupiter.api.Test;
 
 import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
 
-import static io.javaoperatorsdk.jenvtest.TestUtils.simpleTest;
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 
 @EnableKubeAPIServer
 class JUnitExtensionKubeConfigUpdateTest {

samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionOnMethodTest.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/JUnitExtensionOnMethodTest.java

@@ -1,11 +1,11 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import org.junit.jupiter.api.Test;
 
 import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
 import io.javaoperatorsdk.jenvtest.junit.KubeConfig;
 
-import static io.javaoperatorsdk.jenvtest.TestUtils.simpleTest;
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 
 class JUnitExtensionOnMethodTest {
 
@@ -14,13 +14,13 @@ class JUnitExtensionOnMethodTest {
 
   @Test
   @EnableKubeAPIServer
-  void testCommunication() {
-    simpleTest(kubeConfigYaml);
+  void simpleTest1() {
+    TestUtils.simpleTest(kubeConfigYaml);
   }
 
   @Test
   @EnableKubeAPIServer
-  void testCommunication2() {
-    simpleTest(kubeConfigYaml);
+  void simpleTest2() {
+    TestUtils.simpleTest(kubeConfigYaml);
   }
 }

core/src/test/java/io/javaoperatorsdk/jenvtest/sample/JUnitExtensionSimpleCaseTest.java

@@ -0,0 +1,26 @@
+package io.javaoperatorsdk.jenvtest.sample;
+
+import org.junit.jupiter.api.Test;
+
+import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
+import io.javaoperatorsdk.jenvtest.junit.KubeConfig;
+
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
+
+@EnableKubeAPIServer
+class JUnitExtensionSimpleCaseTest {
+
+  @KubeConfig
+  static String kubeConfigYaml;
+
+  @Test
+  void simpleTestWithTargetVersion() {
+    var client = new KubernetesClientBuilder()
+        .withConfig(Config.fromKubeconfig(kubeConfigYaml))
+        .build();
+
+    simpleTest(client);
+  }
+}

samples/src/test/java/io/javaoperatorsdk/jenvtest/JUnitExtensionTargetVersionTest.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/JUnitExtensionTargetVersionTest.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import org.junit.jupiter.api.Test;
 
@@ -7,7 +7,7 @@
 import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
 import io.javaoperatorsdk.jenvtest.junit.KubeConfig;
 
-import static io.javaoperatorsdk.jenvtest.TestUtils.simpleTest;
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 import static org.assertj.core.api.Assertions.assertThat;
 
 @EnableKubeAPIServer(kubeAPIVersion = TestUtils.NON_LATEST_API_SERVER_VERSION)

samples/src/test/java/io/javaoperatorsdk/jenvtest/KubeApiServerTest.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/KubeApiServerTest.java

@@ -1,12 +1,14 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.jenvtest.KubeAPIServer;
+import io.javaoperatorsdk.jenvtest.KubeAPIServerConfigBuilder;
 
-import static io.javaoperatorsdk.jenvtest.TestUtils.NON_LATEST_API_SERVER_VERSION;
-import static io.javaoperatorsdk.jenvtest.TestUtils.simpleTest;
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.NON_LATEST_API_SERVER_VERSION;
+import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 import static org.assertj.core.api.Assertions.assertThat;
 
 class KubeApiServerTest {

samples/src/test/java/io/javaoperatorsdk/jenvtest/KubernetesMutationHookHandlingTest.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/KubernetesMutationHookHandlingTest.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import java.io.*;
 import java.nio.charset.StandardCharsets;

samples/src/test/java/io/javaoperatorsdk/jenvtest/TestUtils.java renamed to core/src/test/java/io/javaoperatorsdk/jenvtest/sample/TestUtils.java

@@ -1,4 +1,4 @@
-package io.javaoperatorsdk.jenvtest;
+package io.javaoperatorsdk.jenvtest.sample;
 
 import java.util.Map;