docs link

Author: csviri

README.md

@@ -9,6 +9,10 @@ Linux, Windows, Mac is supported.
 See also [this blog](https://csviri.medium.com/introducing-jenvtest-kubernetes-api-server-tests-made-easy-for-java-4d02a9bb26d4)
 post regarding the motivation and more.
 
+## Docs 
+
+See more documentation in [docs](https://github.com/java-operator-sdk/jenvtest/tree/main/docs) directory.
+
 ## Usage
 
 Include dependency:

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

@@ -7,8 +7,12 @@
 
 import static io.javaoperatorsdk.jenvtest.sample.TestUtils.simpleTest;
 
+/**
+ * Shows usage for the case when fresh Kube API is started for each use test method.
+ */
 class JUnitExtensionOnMethodTest {
 
+  // not static in case if API server is restarted for each test
   @KubeConfig
   String kubeConfigYaml;
 

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

@@ -12,6 +12,7 @@
 @EnableKubeAPIServer
 class JUnitExtensionSimpleCaseTest {
 
+  // static is required in case the config is shared between test cases
   @KubeConfig
   static String kubeConfigYaml;
 

docs/README.md

@@ -4,6 +4,13 @@ jenvtest is a relatively simple test that support integration testing with Kuber
 The whole concept and implementation is relatively simple, this doc describes some high level concepts
 and provides some more detailed information.
 
+## Samples
+
+Samples are provided in form of unit tests in the [sample package](https://github.com/java-operator-sdk/jenvtest/tree/main/core/src/test/java/io/javaoperatorsdk/jenvtest/sample)
+in core.
+
+For fabric8 client in [this package](https://github.com/java-operator-sdk/jenvtest/tree/main/fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/sample)
+
 ## Configuration Options
 
 See available configuration options documented in [KubeAPIServerConfig](https://github.com/java-operator-sdk/jenvtest/blob/main/core/src/main/java/io/javaoperatorsdk/jenvtest/KubeAPIServerConfig.java#L6-L6)

fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/JUnitFabric8ClientInjectPerMethodTest.java renamed to fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/sample/JUnitFabric8ClientInjectPerMethodTest.java

@@ -1,8 +1,10 @@
-package io.javaoperatorsdk.jenvtest.junit;
+package io.javaoperatorsdk.jenvtest.junit.sample;
 
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.client.KubernetesClient;
+import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
+import io.javaoperatorsdk.jenvtest.junit.TestUtils;
 
 class JUnitFabric8ClientInjectPerMethodTest {
 

fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/JUnitFabric8ClientInjectionTest.java renamed to fabric8/src/test/java/io/javaoperatorsdk/jenvtest/junit/sample/JUnitFabric8ClientInjectionTest.java

@@ -1,10 +1,12 @@
-package io.javaoperatorsdk.jenvtest.junit;
+package io.javaoperatorsdk.jenvtest.junit.sample;
 
 import org.junit.jupiter.api.Test;
 
 import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.jenvtest.junit.EnableKubeAPIServer;
+import io.javaoperatorsdk.jenvtest.junit.KubeConfig;
 
 import static io.javaoperatorsdk.jenvtest.junit.TestUtils.simpleTest;