Rename GlobalLogCollector to MustGather and use only one callback (#133)

## Description

GlobalLogCollector name is weird so we decided to rename it to
MustGather


## Type of Change

Please delete options that are not relevant.

* Breaking change (fix or feature that would cause existing
functionality to not work as expected)

## Checklist

- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] New and existing unit/integration tests pass locally with my
changes

---------

Signed-off-by: David Kornel <kornys@outlook.com>

test-frame-log-collector/README.md

@@ -169,33 +169,33 @@ the logs path will then look like this:
 ```
 The tree path will look similarly to above examples, there will be folders for Namespaces matching the specified labels.
 
-### Global log collector
-`CollectLogs` is an annotation which can handle collecting logs which user want automatically in case of test failure or before/after failure.
-It gets configuration passed into `GlobalLogCollector` and call collecting in proper callbacks.
+### MustGather
+`MustGather` is an annotation which can handle collecting logs which user want automatically in case of test failure or before/after failure.
+It gets configuration passed into `MustGatherController` and call collecting in proper callbacks.
 
-Register `GlobalLogCollector` handlers and configure
+Register `MustGatherController` handlers and configure
 
 ```java
 import io.skodjob.testframe.LogCollectorBuilder;
-import io.skodjob.testframe.annotations.CollectLogs;
-import io.skodjob.testframe.listeners.GlobalLogCollector;
+import io.skodjob.testframe.annotations.MustGather;
+import io.skodjob.testframe.listeners.MustGatherController;
 import io.skodjob.testframe.resources.KubeResourceManager;
 import org.junit.jupiter.api.Test;
 
-@CollectLogs
+@MustGather
 class TestClass() {
     static {
         // Setup global log collector and handlers
-        GlobalLogCollector.setupGlobalLogCollector(new LogCollectorBuilder()
+        MustGatherController.setupMustGatherController(new LogCollectorBuilder()
             .withNamespacedResources("sa", "deployment", "configmaps", "secret")
             .withClusterWideResources("nodes")
             .withKubeClient(KubeResourceManager.getKubeClient())
             .withKubeCmdClient(KubeResourceManager.getKubeCmdClient())
             .withRootFolderPath("/some-path/path/")
             .build());
-        GlobalLogCollector.addLogCallback(() -> {
-            GlobalLogCollector.getGlobalLogCollector().collectFromNamespaces("test-namespace", "test-namespace-2");
-            GlobalLogCollector.getGlobalLogCollector().collectClusterWideResources();
+        MustGatherController.setMustGatherCallback(() -> {
+            MustGatherController.getMustGatherController().collectFromNamespaces("test-namespace", "test-namespace-2");
+            MustGatherController.getMustGatherController().collectClusterWideResources();
         });
     }
 

test-frame-log-collector/src/main/java/io/skodjob/testframe/annotations/CollectLogs.java → test-frame-log-collector/src/main/java/io/skodjob/testframe/annotations/MustGather.java

@@ -4,7 +4,7 @@
  */
 package io.skodjob.testframe.annotations;
 
-import io.skodjob.testframe.listeners.GlobalLogCollector;
+import io.skodjob.testframe.listeners.MustGatherController;
 import org.junit.jupiter.api.extension.ExtendWith;
 
 import java.lang.annotation.ElementType;
@@ -19,11 +19,11 @@
  * when test of prepare and post phase fails in JUnit tests.
  * It is applied at the class level.
  * <p>
- * It uses the {@link GlobalLogCollector}
+ * It uses the {@link MustGatherController}
  */
 @Target(ElementType.TYPE)
 @Retention(RUNTIME)
 @Inherited
-@ExtendWith(GlobalLogCollector.class)
-public @interface CollectLogs {
+@ExtendWith(MustGatherController.class)
+public @interface MustGather {
 }

test-frame-log-collector/src/main/java/io/skodjob/testframe/listeners/GlobalLogCollector.java → test-frame-log-collector/src/main/java/io/skodjob/testframe/listeners/MustGatherController.java

@@ -5,29 +5,26 @@
 package io.skodjob.testframe.listeners;
 
 import io.skodjob.testframe.LogCollector;
-import io.skodjob.testframe.annotations.CollectLogs;
+import io.skodjob.testframe.annotations.MustGather;
 import io.skodjob.testframe.interfaces.ThrowableRunner;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.LifecycleMethodExecutionExceptionHandler;
 import org.junit.jupiter.api.extension.TestExecutionExceptionHandler;
 
-import java.util.LinkedList;
-import java.util.List;
-
 /**
  * Represents global log collector which is automatically called on text fail or error even in setup or post methods
  */
-public class GlobalLogCollector implements TestExecutionExceptionHandler, LifecycleMethodExecutionExceptionHandler {
-    private static final Logger LOGGER = LogManager.getLogger(GlobalLogCollector.class);
-    private static LogCollector globalInstance;
-    private static final List<ThrowableRunner> COLLECT_CALLBACKS = new LinkedList<>();
+public class MustGatherController implements TestExecutionExceptionHandler, LifecycleMethodExecutionExceptionHandler {
+    private static final Logger LOGGER = LogManager.getLogger(MustGatherController.class);
+    private static LogCollector mustGatherInstance;
+    private static ThrowableRunner collectCallback;
 
     /**
      * Private constructor
      */
-    private GlobalLogCollector() {
+    private MustGatherController() {
         // empty constructor
     }
 
@@ -40,7 +37,7 @@ private GlobalLogCollector() {
      */
     @Override
     public void handleTestExecutionException(ExtensionContext extensionContext, Throwable throwable) throws Throwable {
-        saveKubeState();
+        saveKubeState(extensionContext);
         throw throwable;
     }
 
@@ -53,7 +50,7 @@ public void handleTestExecutionException(ExtensionContext extensionContext, Thro
      */
     @Override
     public void handleBeforeAllMethodExecutionException(ExtensionContext context, Throwable throwable)throws Throwable {
-        saveKubeState();
+        saveKubeState(context);
         LifecycleMethodExecutionExceptionHandler.super.handleBeforeAllMethodExecutionException(context, throwable);
     }
 
@@ -67,7 +64,7 @@ public void handleBeforeAllMethodExecutionException(ExtensionContext context, Th
     @Override
     public void handleBeforeEachMethodExecutionException(ExtensionContext context,
                                                          Throwable throwable) throws Throwable {
-        saveKubeState();
+        saveKubeState(context);
         LifecycleMethodExecutionExceptionHandler.super.handleBeforeEachMethodExecutionException(context, throwable);
     }
 
@@ -81,7 +78,7 @@ public void handleBeforeEachMethodExecutionException(ExtensionContext context,
     @Override
     public void handleAfterEachMethodExecutionException(ExtensionContext context,
                                                         Throwable throwable) throws Throwable {
-        saveKubeState();
+        saveKubeState(context);
         LifecycleMethodExecutionExceptionHandler.super.handleAfterEachMethodExecutionException(context, throwable);
     }
 
@@ -94,44 +91,46 @@ public void handleAfterEachMethodExecutionException(ExtensionContext context,
      */
     @Override
     public void handleAfterAllMethodExecutionException(ExtensionContext context, Throwable throwable) throws Throwable {
-        saveKubeState();
+        saveKubeState(context);
         LifecycleMethodExecutionExceptionHandler.super.handleAfterAllMethodExecutionException(context, throwable);
     }
 
     /**
-     * Setup globalLogCollector which is automatically used within {@link CollectLogs} annotation
+     * Setup globalLogCollector which is automatically used within {@link MustGather} annotation
      *
      * @param globalLogCollector log collector instance
      */
-    public static void setupGlobalLogCollector(LogCollector globalLogCollector) {
-        globalInstance = globalLogCollector;
+    public static void setupMustGatherController(LogCollector globalLogCollector) {
+        mustGatherInstance = globalLogCollector;
     }
 
     /**
      * Returns globalLogCollector instance
      *
      * @return global log collector instance
      */
-    public static LogCollector getGlobalLogCollector() {
-        if (globalInstance == null) {
+    public static LogCollector getMustGatherController() {
+        if (mustGatherInstance == null) {
             throw new NullPointerException("Global log collector is not initialized");
         }
-        return globalInstance;
+        return mustGatherInstance;
     }
 
     /**
      * Adds callback for running log collecting
      *
      * @param callback callback method with log collecting
      */
-    public static void addLogCallback(ThrowableRunner callback) {
-        COLLECT_CALLBACKS.add(callback);
+    public static void setMustGatherCallback(ThrowableRunner callback) {
+        collectCallback = callback;
     }
 
-    private void saveKubeState() {
+    private void saveKubeState(ExtensionContext context) {
         try {
-            for (ThrowableRunner runner : COLLECT_CALLBACKS) {
-                runner.run();
+            if (collectCallback != null) {
+                collectCallback.run();
+            } else {
+                LOGGER.warn("No logCallback defined");
             }
         } catch (Exception ex) {
             LOGGER.error("Cannot collect all data", ex);

test-frame-test-examples/src/test/java/io/skodjob/testframe/test/integration/AbstractIT.java

@@ -5,8 +5,8 @@
 package io.skodjob.testframe.test.integration;
 
 import io.skodjob.testframe.LogCollectorBuilder;
-import io.skodjob.testframe.annotations.CollectLogs;
-import io.skodjob.testframe.listeners.GlobalLogCollector;
+import io.skodjob.testframe.annotations.MustGather;
+import io.skodjob.testframe.listeners.MustGatherController;
 import io.skodjob.testframe.test.integration.helpers.GlobalLogCollectorTestHandler;
 import io.skodjob.testframe.utils.LoggerUtils;
 import io.skodjob.testframe.annotations.ResourceManager;
@@ -26,7 +26,7 @@
 
 @ExtendWith(GlobalLogCollectorTestHandler.class) // For testing purpose
 @ResourceManager
-@CollectLogs
+@MustGather
 @TestVisualSeparator
 public abstract class AbstractIT {
     static AtomicBoolean isCreateHandlerCalled = new AtomicBoolean(false);
@@ -60,16 +60,16 @@ public abstract class AbstractIT {
         });
 
         // Setup global log collector and handlers
-        GlobalLogCollector.setupGlobalLogCollector(new LogCollectorBuilder()
+        MustGatherController.setupMustGatherController(new LogCollectorBuilder()
             .withNamespacedResources("sa", "deployment", "configmaps", "secret")
             .withClusterWideResources("nodes")
             .withKubeClient(KubeResourceManager.getKubeClient())
             .withKubeCmdClient(KubeResourceManager.getKubeCmdClient())
             .withRootFolderPath(LOG_DIR.toString())
             .build());
-        GlobalLogCollector.addLogCallback(() -> {
-            GlobalLogCollector.getGlobalLogCollector().collectFromNamespaces("default");
-            GlobalLogCollector.getGlobalLogCollector().collectClusterWideResources();
+        MustGatherController.setMustGatherCallback(() -> {
+            MustGatherController.getMustGatherController().collectFromNamespaces("default");
+            MustGatherController.getMustGatherController().collectClusterWideResources();
         });
     }
 

test-frame-test-examples/src/test/java/io/skodjob/testframe/test/integration/GlobalLogCollectorIT.java → test-frame-test-examples/src/test/java/io/skodjob/testframe/test/integration/MustGatherControllerIT.java

@@ -14,7 +14,7 @@
 import static org.junit.jupiter.api.Assertions.fail;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
-public class GlobalLogCollectorIT extends AbstractIT {
+public class MustGatherControllerIT extends AbstractIT {
     @Test
     void testGlobalLogCollector() {
         fail("Expected issue");