ci: fix cleanup-after-class code

- CloudFoundryCleaner was not properly triggered on every test. In fact,
  it was only triggered when the integration test's TestContext would
  change, which was very infrequent (unsure it was ever triggered). It's
  possible the cleanup only ever happened when the test suite started.
- This is because the "clean" method was linked to lifecycle methods of
  the CloudFoundryCleaner bean, which was only created once.
- The solution is to add `@DirtiesContext`, to trigger a re-creation of
  this bean. We don't want to do it on every test, because it could add
  more that 1h to the whole test suite. To ensure that it is well
  understood why this annotation is there in the first place, we
  introduce the meta-annotation @CleanupCloudFoundryAfterClass.
- Note that calling CloudFoundryCleaner#clean() directly in tests would
  not work, because that annotation deletes EVERYTHING, and then
  subsequent tests would not have an org, a space, etc to operate in. By
  using @DirtiesContext we ensure those other beans are recreated as
  well.
- Lastly, I have a doubt that the CloudFoundryCleaner is even required.
  I believe deleting an org in current versions of CF deletes EVERYTHING
  within this org, so it should be enough. However, this would be a much
  bigger change to the tests, which we don't have the bandwidth to
  tackle at the moment.

Author: Kehrlann

integration-test/src/test/java/org/cloudfoundry/CleanupCloudFoundryAfterClass.java

@@ -0,0 +1,27 @@
+package org.cloudfoundry;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.annotation.DirtiesContext;
+
+/**
+ * Meta-annotation to show that a test class will add too much to the CF instance, and that a full universe
+ * cleanup should occur. This is important because otherwise the integration tests create too many apps and
+ * blow up the memory quota. We do not want to recreate the full environment for EVERY test class because
+ * the process takes 30~60s, so in total it could add more than an hour to the integration tests.
+ * <p>
+ * Technically, this is achieved by recreating a Spring ApplicationContext with {@link DirtiesContext}. The
+ * {@link CloudFoundryCleaner} bean will be destroyed, which triggers {@link CloudFoundryCleaner#clean()}.
+ * After that, every {@link Bean} in {@link IntegrationTestConfiguration} is recreated, including users,
+ * clients, organizations, etc: everything required to run a test.
+ * <p>
+ * We use a meta-annotation instead of a raw {@link DirtiesContext} to make it clear what it does, rather
+ * than having to understand complicated lifecycle issues.
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@DirtiesContext
+public @interface CleanupCloudFoundryAfterClass {}

integration-test/src/test/java/org/cloudfoundry/CloudFoundryCleaner.java

@@ -116,12 +116,16 @@
 import org.cloudfoundry.util.ResourceUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.beans.factory.InitializingBean;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 import reactor.util.function.Tuples;
 import reactor.util.retry.Retry;
 
-final class CloudFoundryCleaner {
+final class CloudFoundryCleaner implements InitializingBean, DisposableBean {
+
+    private static boolean cleanSlateEnvironment = false;
 
     private static final Logger LOGGER = LoggerFactory.getLogger("cloudfoundry-client.test");
 
@@ -162,6 +166,25 @@ final class CloudFoundryCleaner {
         this.uaaClient = uaaClient;
     }
 
+    /**
+     * Once at the beginning of the whole test suite, clean up the environment. It should only ever happen
+     * once, hence the static init variable.
+     */
+    @Override
+    public void afterPropertiesSet() {
+        if (!cleanSlateEnvironment) {
+            LOGGER.info(
+                    "Performing clean slate cleanup. Should happen once per integration test run.");
+            this.clean();
+            cleanSlateEnvironment = true;
+        }
+    }
+
+    @Override
+    public void destroy() {
+        this.clean();
+    }
+
     void clean() {
         Flux.empty()
                 .thenMany(

integration-test/src/test/java/org/cloudfoundry/IntegrationTestConfiguration.java

@@ -37,7 +37,6 @@
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Random;
 import org.cloudfoundry.client.CloudFoundryClient;
 import org.cloudfoundry.client.v2.info.GetInfoRequest;
 import org.cloudfoundry.client.v2.organizationquotadefinitions.CreateOrganizationQuotaDefinitionRequest;
@@ -243,14 +242,13 @@ String clientSecret(NameFactory nameFactory) {
         return nameFactory.getClientSecret();
     }
 
-    @Bean(initMethod = "clean", destroyMethod = "clean")
+    @Bean
     CloudFoundryCleaner cloudFoundryCleaner(
             @Qualifier("admin") CloudFoundryClient cloudFoundryClient,
             NameFactory nameFactory,
             @Qualifier("admin") NetworkingClient networkingClient,
             Version serverVersion,
             @Qualifier("admin") UaaClient uaaClient) {
-
         return new CloudFoundryCleaner(
                 cloudFoundryClient, nameFactory, networkingClient, serverVersion, uaaClient);
     }

integration-test/src/test/java/org/cloudfoundry/client/v2/ApplicationsTest.java

@@ -36,6 +36,7 @@
 import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
 import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
 import org.cloudfoundry.AbstractIntegrationTest;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.CloudFoundryVersion;
 import org.cloudfoundry.IfCloudFoundryVersion;
 import org.cloudfoundry.client.CloudFoundryClient;
@@ -96,6 +97,7 @@
 import reactor.test.StepVerifier;
 import reactor.util.function.Tuple2;
 
+@CleanupCloudFoundryAfterClass
 public final class ApplicationsTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;

integration-test/src/test/java/org/cloudfoundry/client/v2/ServiceBrokersTest.java

@@ -25,6 +25,7 @@
 import java.time.Duration;
 import org.cloudfoundry.AbstractIntegrationTest;
 import org.cloudfoundry.ApplicationUtils;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.ServiceBrokerUtils;
 import org.cloudfoundry.client.CloudFoundryClient;
 import org.cloudfoundry.client.v2.servicebrokers.CreateServiceBrokerRequest;
@@ -43,6 +44,7 @@
 import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
 
+@CleanupCloudFoundryAfterClass
 public final class ServiceBrokersTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;

integration-test/src/test/java/org/cloudfoundry/client/v3/AdminTest.java

@@ -26,7 +26,6 @@
 import org.cloudfoundry.util.JobUtils;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
-
 import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
 

integration-test/src/test/java/org/cloudfoundry/client/v3/ApplicationsTest.java

@@ -28,6 +28,7 @@
 import java.util.Collections;
 import java.util.Map;
 import org.cloudfoundry.AbstractIntegrationTest;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.CloudFoundryVersion;
 import org.cloudfoundry.IfCloudFoundryVersion;
 import org.cloudfoundry.client.CloudFoundryClient;
@@ -106,6 +107,7 @@
 import reactor.test.StepVerifier;
 import reactor.util.function.Tuples;
 
+@CleanupCloudFoundryAfterClass
 public final class ApplicationsTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;

integration-test/src/test/java/org/cloudfoundry/client/v3/DeploymentsTest.java

@@ -22,6 +22,7 @@
 import java.nio.file.Path;
 import java.time.Duration;
 import org.cloudfoundry.AbstractIntegrationTest;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.CloudFoundryVersion;
 import org.cloudfoundry.IfCloudFoundryVersion;
 import org.cloudfoundry.client.CloudFoundryClient;
@@ -51,6 +52,7 @@
 import reactor.test.StepVerifier;
 
 @IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_4)
+@CleanupCloudFoundryAfterClass
 public final class DeploymentsTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;

integration-test/src/test/java/org/cloudfoundry/client/v3/ProcessesTest.java

@@ -22,6 +22,7 @@
 import java.nio.file.Path;
 import java.time.Duration;
 import org.cloudfoundry.AbstractIntegrationTest;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.CloudFoundryVersion;
 import org.cloudfoundry.IfCloudFoundryVersion;
 import org.cloudfoundry.client.CloudFoundryClient;
@@ -42,6 +43,7 @@
 import reactor.test.StepVerifier;
 
 @IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_0)
+@CleanupCloudFoundryAfterClass
 public final class ProcessesTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;

integration-test/src/test/java/org/cloudfoundry/client/v3/ServiceBrokersTest.java

@@ -25,6 +25,7 @@
 import java.time.Duration;
 import org.cloudfoundry.AbstractIntegrationTest;
 import org.cloudfoundry.ApplicationUtils;
+import org.cloudfoundry.CleanupCloudFoundryAfterClass;
 import org.cloudfoundry.CloudFoundryVersion;
 import org.cloudfoundry.IfCloudFoundryVersion;
 import org.cloudfoundry.ServiceBrokerUtils;
@@ -49,6 +50,7 @@
 import reactor.test.StepVerifier;
 
 @IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_10)
+@CleanupCloudFoundryAfterClass
 public final class ServiceBrokersTest extends AbstractIntegrationTest {
 
     @Autowired private CloudFoundryClient cloudFoundryClient;