Allow to switch ResoruceManager between async and sequential deletion…

… mode (#194)

## Description

Some test scenarios require deletion and wait for deletion one by one
resource.


## Type of Change

Please delete options that are not relevant.

* New feature (non-breaking change which adds functionality)

## 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 <[email protected]>

test-frame-common/src/main/java/io/skodjob/testframe/annotations/ResourceManager.java

@@ -34,4 +34,11 @@
      * @return enable/disable cleaner
      */
     boolean cleanResources() default true;
+
+    /**
+     * Enables async deletion of resources
+     *
+     * @return enable/disable async cleaning
+     */
+    boolean asyncDeletion() default true;
 }

test-frame-common/src/main/java/io/skodjob/testframe/listeners/ResourceManagerCleanerExtension.java

@@ -51,7 +51,7 @@ public void afterEach(ExtensionContext extensionContext) {
 
         if (annotation.isPresent() && annotation.get().cleanResources()) {
             KubeResourceManager.setTestContext(extensionContext);
-            KubeResourceManager.getInstance().deleteResources();
+            KubeResourceManager.getInstance().deleteResources(annotation.get().asyncDeletion());
         }
     }
 }

test-frame-common/src/main/java/io/skodjob/testframe/resources/KubeResourceManager.java

@@ -400,23 +400,29 @@ private <T extends HasMetadata> void createOrUpdateResource(boolean async,
      */
     @SafeVarargs
     public final <T extends HasMetadata> void deleteResource(T... resources) {
+        deleteResource(true, resources);
+    }
+
+    /**
+     * Deletes resources.
+     *
+     * @param async     Enables async deletion
+     * @param resources The resources to delete.
+     * @param <T>       The type of the resources.
+     */
+    @SafeVarargs
+    public final <T extends HasMetadata> void deleteResource(boolean async, T... resources) {
         List<CompletableFuture<Void>> waitExecutors = new LinkedList<>();
         for (T resource : resources) {
             ResourceType<T> type = findResourceType(resource);
             LoggerUtils.logResource("Deleting", resource);
             try {
                 if (type == null) {
                     client.getClient().resource(resource).delete();
-                    waitExecutors.add(CompletableFuture.runAsync(() ->
-                        assertTrue(waitResourceCondition(resource, ResourceCondition.deletion()),
-                            String.format("Timed out deleting %s/%s in %s", resource.getKind(),
-                                resource.getMetadata().getName(), resource.getMetadata().getNamespace()))));
+                    decideDeleteWaitAsync(waitExecutors, async, resource);
                 } else {
                     type.delete(resource);
-                    waitExecutors.add(CompletableFuture.runAsync(() ->
-                        assertTrue(waitResourceCondition(resource, ResourceCondition.deletion()),
-                            String.format("Timed out deleting %s/%s in %s", resource.getKind(),
-                                resource.getMetadata().getName(), resource.getMetadata().getNamespace()))));
+                    decideDeleteWaitAsync(waitExecutors, async, resource);
                 }
             } catch (Exception e) {
                 if (resource.getMetadata().getNamespace() == null) {
@@ -485,6 +491,15 @@ public final <T extends HasMetadata> boolean waitResourceCondition(T resource, R
      * Deletes all stored resources.
      */
     public void deleteResources() {
+        deleteResources(true);
+    }
+
+    /**
+     * Deletes all stored resources.
+     *
+     * @param async sets async or sequential deletion
+     */
+    public void deleteResources(boolean async) {
         LoggerUtils.logSeparator();
         if (!STORED_RESOURCES.containsKey(getTestContext().getDisplayName())
             || STORED_RESOURCES.get(getTestContext().getDisplayName()).isEmpty()) {
@@ -505,13 +520,18 @@ public void deleteResources() {
                 ResourceItem<?> resourceItem = s.pop();
 
                 try {
-                    waitExecutors.add(CompletableFuture.runAsync(() -> {
+                    CompletableFuture<Void> c = CompletableFuture.runAsync(() -> {
                         try {
                             resourceItem.throwableRunner().run();
                         } catch (Exception e) {
                             throw new RuntimeException(e);
                         }
-                    }));
+                    });
+                    if (async) {
+                        waitExecutors.add(c);
+                    } else {
+                        CompletableFuture.allOf(c).join();
+                    }
                 } catch (Exception e) {
                     LOGGER.error(e.getMessage(), e);
                 }
@@ -585,4 +605,17 @@ private void writeResourceAsYaml(HasMetadata resource) {
             throw new RuntimeException(e);
         }
     }
+
+    private <T extends HasMetadata> void decideDeleteWaitAsync(List<CompletableFuture<Void>> waitExecutors,
+                                                               boolean async, T resource) {
+        CompletableFuture<Void> c = CompletableFuture.runAsync(() ->
+            assertTrue(waitResourceCondition(resource, ResourceCondition.deletion()),
+                String.format("Timed out deleting %s/%s in %s", resource.getKind(),
+                    resource.getMetadata().getName(), resource.getMetadata().getNamespace())));
+        if (async) {
+            waitExecutors.add(c);
+        } else {
+            CompletableFuture.allOf(c).join();
+        }
+    }
 }

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

@@ -7,6 +7,7 @@
 import io.fabric8.kubernetes.api.model.HasMetadata;
 import io.fabric8.kubernetes.api.model.Namespace;
 import io.fabric8.kubernetes.api.model.NamespaceBuilder;
+import io.skodjob.testframe.annotations.ResourceManager;
 import io.skodjob.testframe.clients.KubeClusterException;
 import io.skodjob.testframe.resources.KubeResourceManager;
 import org.junit.jupiter.api.AfterAll;
@@ -25,6 +26,7 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+@ResourceManager(asyncDeletion = false)
 public final class KubeResourceManagerCleanerIT extends AbstractIT {
 
     @BeforeAll

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

@@ -38,7 +38,7 @@ void createResource() {
             new NamespaceBuilder().withNewMetadata().withName("test2").endMetadata().build());
         assertNotNull(KubeResourceManager.getKubeClient().getClient().namespaces().withName(nsName1).get());
         assertNotNull(KubeResourceManager.getKubeClient().getClient().namespaces().withName(nsName2).get());
-        KubeResourceManager.getInstance().deleteResource(ns1);
+        KubeResourceManager.getInstance().deleteResource(false, ns1);
         assertTrue(isDeleteHandlerCalled.get());
     }
 }