fix(kube-api-test): allow injected field inheritance from base test class (7224)

Fix KubeApiTest inheritance from base test class

Signed-off-by: Attila Mészáros <[email protected]>
---
changelog

Signed-off-by: Attila Mészáros <[email protected]>
---
license
---
revert mvnw del

Signed-off-by: Attila Mészáros <[email protected]>

Author: csviri

CHANGELOG.md

@@ -10,6 +10,7 @@
 * Fix #7116: (java-generator) Use timezone format compatible with Kubernetes
 * Fix #7163: Ensure that streams are notified of errors
 * Fix #7092: (crd-generator) Add support for @Annotations and @Labels in CRD generation - CRD generator now includes annotations and labels specified via these annotations in the generated CRD metadata
+* Fix #7224: Fix KubeApiTest inheritance from base test class
 
 #### Improvements
  * Fix #7217: refinements and expanded documentation for preserve unknown handling

junit/kube-api-test/client-inject/src/main/java/io/fabric8/kubeapitest/junit/Fabric8ClientInjectionHandler.java

@@ -23,9 +23,7 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 
 import java.lang.reflect.Field;
-import java.util.Arrays;
 import java.util.Optional;
-import java.util.stream.Collectors;
 
 public class Fabric8ClientInjectionHandler implements ClientInjectionHandler {
 
@@ -67,9 +65,9 @@ public void cleanup(ExtensionContext extensionContext) {
   public static Optional<Field> getFieldForKubeClientInjection(ExtensionContext extensionContext,
       boolean staticField) {
     Class<?> clazz = extensionContext.getTestClass().orElseThrow();
-    var kubeConfigFields = Arrays.stream(clazz.getDeclaredFields())
-        .filter(f -> KubernetesClient.class.isAssignableFrom(f.getType()))
-        .collect(Collectors.toList());
+    var kubeConfigFields = KubeConfigInjectionHandler.getAllFieldsIncludingAllParents(clazz,
+        f -> KubernetesClient.class.isAssignableFrom(f.getType()));
+
     if (kubeConfigFields.isEmpty()) {
       return Optional.empty();
     }

junit/kube-api-test/client-inject/src/test/java/io/fabric8/kubeapitest/junit/sample/BaseTestClass.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubeapitest.junit.sample;
+
+import io.fabric8.kubeapitest.junit.EnableKubeAPIServer;
+import io.fabric8.kubeapitest.junit.KubeConfig;
+import io.fabric8.kubernetes.client.KubernetesClient;
+
+@EnableKubeAPIServer
+public class BaseTestClass {
+
+  static KubernetesClient client;
+
+  // config yaml injection also works
+  @KubeConfig
+  static String configYaml;
+
+}

junit/kube-api-test/client-inject/src/test/java/io/fabric8/kubeapitest/junit/sample/JUnitFabric8ClientExtendingBaseClassTest.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubeapitest.junit.sample;
+
+import io.fabric8.kubeapitest.junit.TestCaseUtils;
+import io.fabric8.kubernetes.client.Config;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import org.junit.jupiter.api.Test;
+
+public class JUnitFabric8ClientExtendingBaseClassTest extends BaseTestClass {
+
+  @Test
+  void testClientInjection() {
+    TestCaseUtils.simpleTest(client, "test1");
+  }
+
+  @Test
+  void testKubeConfigInjectionAlsoWorks() {
+    TestCaseUtils.simpleTest(new KubernetesClientBuilder().withConfig(Config.fromKubeconfig(configYaml)).build(),
+        "test2");
+  }
+
+}

junit/kube-api-test/core/src/main/java/io/fabric8/kubeapitest/junit/EnableKubeAPIServer.java

@@ -18,6 +18,7 @@
 import io.fabric8.kubeapitest.KubeAPIServerConfig;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
@@ -30,6 +31,7 @@
 @ExtendWith(KubeAPIServerExtension.class)
 @Target({ TYPE, METHOD, ANNOTATION_TYPE })
 @Retention(RUNTIME)
+@Inherited
 public @interface EnableKubeAPIServer {
 
   String NOT_SET = "NOT_SET";

junit/kube-api-test/core/src/main/java/io/fabric8/kubeapitest/junit/KubeConfigInjectionHandler.java

@@ -20,9 +20,11 @@
 import org.junit.jupiter.api.extension.ExtensionContext;
 
 import java.lang.reflect.Field;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.List;
 import java.util.Optional;
-import java.util.stream.Collectors;
+import java.util.function.Predicate;
 
 public class KubeConfigInjectionHandler implements ClientInjectionHandler {
 
@@ -53,9 +55,9 @@ private void setKubeConfigYamlToField(ExtensionContext extensionContext,
   public Optional<Field> getFieldForKubeConfigInjection(ExtensionContext extensionContext,
       boolean staticField) {
     Class<?> clazz = extensionContext.getTestClass().orElseThrow(IllegalStateException::new);
-    java.util.List<Field> kubeConfigFields = Arrays.stream(clazz.getDeclaredFields())
-        .filter(f -> f.getAnnotationsByType(KubeConfig.class).length > 0)
-        .collect(Collectors.toList());
+    java.util.List<Field> kubeConfigFields = getAllFieldsIncludingAllParents(clazz,
+        f -> f.getAnnotationsByType(KubeConfig.class).length > 0);
+
     if (kubeConfigFields.isEmpty()) {
       return Optional.empty();
     }
@@ -76,4 +78,17 @@ public Optional<Field> getFieldForKubeConfigInjection(ExtensionContext extension
     }
   }
 
+  public static java.util.List<Field> getAllFieldsIncludingAllParents(Class<?> clazz, Predicate<Field> predicate) {
+    List<Field> staticFields = new ArrayList<>();
+    Class<?> currentClass = clazz;
+
+    while (currentClass != null) {
+      Field[] declaredFields = currentClass.getDeclaredFields();
+      Arrays.stream(declaredFields).filter(predicate).forEach(staticFields::add);
+      currentClass = currentClass.getSuperclass();
+    }
+
+    return staticFields;
+  }
+
 }

junit/kube-api-test/core/src/test/java/io/fabric8/kubeapitest/sample/BaseTestClass.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubeapitest.sample;
+
+import io.fabric8.kubeapitest.junit.EnableKubeAPIServer;
+import io.fabric8.kubeapitest.junit.KubeConfig;
+
+@EnableKubeAPIServer
+public class BaseTestClass {
+
+  @KubeConfig
+  static String kubeConfigYaml;
+
+}

junit/kube-api-test/core/src/test/java/io/fabric8/kubeapitest/sample/JUnitExtensionExtendingBaseTestClassTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright (C) 2015 Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.fabric8.kubeapitest.sample;
+
+import org.junit.jupiter.api.Test;
+
+public class JUnitExtensionExtendingBaseTestClassTest extends BaseTestClass {
+
+  @Test
+  void simpleTest1() {
+    TestCaseUtils.simpleTest(kubeConfigYaml);
+  }
+
+}