chore: Add final actions in test context

- Provide the opportunity to add actions in test context that get run at the end of the test - Enables test actions to dynamically add cleanup actions for instance when auto removing created resources after a test - Used in Knative and Kubernetes test actions to auto remove created resources after the test
citrusframework · Oct 9, 2024 · b739602 · b739602
1 parent 680b264
commit b739602
Show file tree

Hide file tree

Showing 71 changed files with 514 additions and 29 deletions.
diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/KnativeSettings.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/KnativeSettings.java
@@ -68,7 +68,7 @@ public class KnativeSettings {
 
     private static final String AUTO_REMOVE_RESOURCES_PROPERTY = KNATIVE_PROPERTY_PREFIX + "auto.remove.resources";
     private static final String AUTO_REMOVE_RESOURCES_ENV = KNATIVE_ENV_PREFIX + "AUTO_REMOVE_RESOURCES";
-    private static final String AUTO_REMOVE_RESOURCES_DEFAULT = "true";
+    private static final String AUTO_REMOVE_RESOURCES_DEFAULT = "false";
 
     private static final String VERIFY_BROKER_RESPONSE_PROPERTY = KNATIVE_PROPERTY_PREFIX + "verify.broker.resources";
     private static final String VERIFY_BROKER_RESPONSE_ENV = KNATIVE_ENV_PREFIX + "VERIFY_BROKER_RESPONSE";

diff --git a/...trus-knative/src/main/java/org/citrusframework/knative/actions/AbstractKnativeAction.java b/...trus-knative/src/main/java/org/citrusframework/knative/actions/AbstractKnativeAction.java
@@ -21,6 +21,7 @@
 import org.citrusframework.AbstractTestActionBuilder;
 import org.citrusframework.actions.AbstractTestAction;
 import org.citrusframework.context.TestContext;
+import org.citrusframework.knative.KnativeSettings;
 import org.citrusframework.kubernetes.ClusterType;
 import org.citrusframework.spi.ReferenceResolver;
 import org.citrusframework.spi.ReferenceResolverAware;
@@ -38,13 +39,16 @@ public abstract class AbstractKnativeAction extends AbstractTestAction implement
     private final ClusterType clusterType;
     private final String namespace;
 
+    private final boolean autoRemoveResources;
+
     public AbstractKnativeAction(String name, Builder<?, ?> builder) {
         super("knative:" + name, builder);
 
         this.knativeClient = builder.knativeClient;
         this.kubernetesClient = builder.kubernetesClient;
         this.namespace = builder.namespace;
         this.clusterType = builder.clusterType;
+        this.autoRemoveResources = builder.autoRemoveResources;
     }
 
     @Override
@@ -66,6 +70,11 @@ public ClusterType clusterType(TestContext context) {
         return KnativeAction.super.clusterType(context);
     }
 
+    @Override
+    public boolean isAutoRemoveResources() {
+        return autoRemoveResources;
+    }
+
     @Override
     public String getNamespace() {
         return namespace;
@@ -84,6 +93,8 @@ public static abstract class Builder<T extends KnativeAction, B extends Builder<
 
         protected ReferenceResolver referenceResolver;
 
+        private boolean autoRemoveResources = KnativeSettings.isAutoRemoveResources();
+
         /**
          * Use a custom Kubernetes client.
          */
@@ -116,6 +127,11 @@ public B clusterType(ClusterType clusterType) {
             return self;
         }
 
+        public B autoRemoveResources(boolean enabled) {
+            this.autoRemoveResources = enabled;
+            return self;
+        }
+
         public B withReferenceResolver(ReferenceResolver referenceResolver) {
             this.referenceResolver = referenceResolver;
             return self;

diff --git a/...ctors/citrus-knative/src/main/java/org/citrusframework/knative/actions/KnativeAction.java b/...ctors/citrus-knative/src/main/java/org/citrusframework/knative/actions/KnativeAction.java
@@ -50,6 +50,12 @@ public interface KnativeAction extends TestAction {
      */
     String getNamespace();
 
+    /**
+     * Should remove Knative resources automatically after test.
+     * @return
+     */
+    boolean isAutoRemoveResources();
+
     /**
      * Resolves namespace name from given test context using the stored test variable.
      * Fallback to the namespace given in Knative environment settings when no test variable is present.

diff --git a/...native/src/main/java/org/citrusframework/knative/actions/eventing/CreateBrokerAction.java b/...native/src/main/java/org/citrusframework/knative/actions/eventing/CreateBrokerAction.java
@@ -28,6 +28,8 @@
 import org.citrusframework.knative.actions.AbstractKnativeAction;
 import org.citrusframework.kubernetes.KubernetesSettings;
 
+import static org.citrusframework.knative.actions.KnativeActionBuilder.knative;
+
 public class CreateBrokerAction extends AbstractKnativeAction {
 
     private final String brokerName;
@@ -100,6 +102,13 @@ private void createBroker(TestContext context) {
                 .resource(broker)
                 .createOr(Updatable::update);
 
+        if (isAutoRemoveResources()) {
+            context.doFinally(knative().client(getKubernetesClient()).client(getKnativeClient())
+                    .brokers()
+                    .delete(resolvedBrokerName)
+                    .inNamespace(getNamespace()));
+        }
+
         logger.info(String.format("Successfully created Knative broker '%s' in namespace %s", resolvedBrokerName, brokerNamespace));
     }
 

diff --git a/...ative/src/main/java/org/citrusframework/knative/actions/eventing/CreateTriggerAction.java b/...ative/src/main/java/org/citrusframework/knative/actions/eventing/CreateTriggerAction.java
@@ -29,6 +29,8 @@
 import org.citrusframework.knative.actions.AbstractKnativeAction;
 import org.citrusframework.kubernetes.KubernetesSettings;
 
+import static org.citrusframework.knative.actions.KnativeActionBuilder.knative;
+
 public class CreateTriggerAction extends AbstractKnativeAction {
 
     private final String triggerName;
@@ -50,6 +52,7 @@ public CreateTriggerAction(Builder builder) {
 
     @Override
     public void doExecute(TestContext context) {
+        String resolvedTriggerName = context.replaceDynamicContentInString(triggerName);
         TriggerSpecBuilder triggerSpec = new TriggerSpecBuilder()
                 .withBroker(brokerName(brokerName, context));
 
@@ -61,7 +64,7 @@ public void doExecute(TestContext context) {
                 .withApiVersion(String.format("%s/%s", KnativeSupport.knativeEventingGroup(), KnativeSupport.knativeApiVersion()))
                 .withNewMetadata()
                     .withNamespace(namespace(context))
-                    .withName(context.replaceDynamicContentInString(triggerName))
+                    .withName(context.replaceDynamicContentInString(resolvedTriggerName))
                     .withLabels(KnativeSettings.getDefaultLabels())
                 .endMetadata()
                 .withSpec(triggerSpec.build())
@@ -71,6 +74,13 @@ public void doExecute(TestContext context) {
                 .inNamespace(namespace(context))
                 .resource(trigger)
                 .createOr(Updatable::update);
+
+        if (isAutoRemoveResources()) {
+            context.doFinally(knative().client(getKubernetesClient()).client(getKnativeClient())
+                    .trigger()
+                    .delete(resolvedTriggerName)
+                    .inNamespace(getNamespace()));
+        }
     }
 
     private void addFilterOnAttributes(TriggerSpecBuilder triggerSpec, TestContext context) {

diff --git a/...tive/src/main/java/org/citrusframework/knative/actions/messaging/CreateChannelAction.java b/...tive/src/main/java/org/citrusframework/knative/actions/messaging/CreateChannelAction.java
@@ -25,6 +25,8 @@
 import org.citrusframework.knative.actions.AbstractKnativeAction;
 import org.citrusframework.kubernetes.KubernetesSettings;
 
+import static org.citrusframework.knative.actions.KnativeActionBuilder.knative;
+
 public class CreateChannelAction extends AbstractKnativeAction {
 
     private final String channelName;
@@ -37,11 +39,12 @@ public CreateChannelAction(Builder builder) {
 
     @Override
     public void doExecute(TestContext context) {
+        String resolvedChannelName = context.replaceDynamicContentInString(channelName);
         Channel channel = new ChannelBuilder()
             .withApiVersion(String.format("%s/%s", KnativeSupport.knativeMessagingGroup(), KnativeSupport.knativeApiVersion()))
             .withNewMetadata()
                 .withNamespace(namespace(context))
-                .withName(context.replaceDynamicContentInString(channelName))
+                .withName(context.replaceDynamicContentInString(resolvedChannelName))
                 .withLabels(KnativeSettings.getDefaultLabels())
             .endMetadata()
             .build();
@@ -50,6 +53,13 @@ public void doExecute(TestContext context) {
                 .inNamespace(namespace(context))
                 .resource(channel)
                 .createOr(Updatable::update);
+
+        if (isAutoRemoveResources()) {
+            context.doFinally(knative().client(getKubernetesClient()).client(getKnativeClient())
+                    .channels()
+                    .delete(resolvedChannelName)
+                    .inNamespace(getNamespace()));
+        }
     }
 
     @Override

diff --git a/...src/main/java/org/citrusframework/knative/actions/messaging/CreateSubscriptionAction.java b/...src/main/java/org/citrusframework/knative/actions/messaging/CreateSubscriptionAction.java
@@ -26,6 +26,8 @@
 import org.citrusframework.knative.actions.AbstractKnativeAction;
 import org.citrusframework.kubernetes.KubernetesSettings;
 
+import static org.citrusframework.knative.actions.KnativeActionBuilder.knative;
+
 public class CreateSubscriptionAction extends AbstractKnativeAction {
 
     private final String subscriptionName;
@@ -69,6 +71,13 @@ public void doExecute(TestContext context) {
                 .inNamespace(namespace(context))
                 .resource(subscription)
                 .createOr(Updatable::update);
+
+        if (isAutoRemoveResources()) {
+            context.doFinally(knative().client(getKubernetesClient()).client(getKnativeClient())
+                    .subscriptions()
+                    .delete(subscriptionName)
+                    .inNamespace(getNamespace()));
+        }
     }
 
     @Override

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateBroker.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateBroker.java
@@ -65,6 +65,12 @@ public CreateBroker inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateBroker autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateChannel.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateChannel.java
@@ -65,6 +65,12 @@ public CreateChannel inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateChannel autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/...tors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateSubscription.java b/...tors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateSubscription.java
@@ -75,6 +75,12 @@ public CreateSubscription inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateSubscription autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateTrigger.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/CreateTrigger.java
@@ -92,6 +92,12 @@ public CreateTrigger inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateTrigger autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteBroker.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteBroker.java
@@ -65,6 +65,12 @@ public DeleteBroker inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public DeleteBroker autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteChannel.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteChannel.java
@@ -59,6 +59,12 @@ public DeleteChannel client(KnativeClient client) {
         return this;
     }
 
+    @Override
+    public DeleteChannel autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public DeleteChannel inNamespace(String namespace) {
         this.delegate.inNamespace(namespace);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteResource.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteResource.java
@@ -75,6 +75,12 @@ public DeleteResource inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public DeleteResource autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/...tors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteSubscription.java b/...tors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteSubscription.java
@@ -65,6 +65,12 @@ public DeleteSubscription inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public DeleteSubscription autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteTrigger.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/DeleteTrigger.java
@@ -65,6 +65,12 @@ public DeleteTrigger inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public DeleteTrigger autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/ReceiveEvent.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/ReceiveEvent.java
@@ -91,6 +91,12 @@ public ReceiveEvent inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public ReceiveEvent autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public ReceiveEventAction build() {
         return delegate.build();

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/SendEvent.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/SendEvent.java
@@ -95,6 +95,12 @@ public SendEvent inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public SendEvent autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public SendEventAction build() {
         return delegate.build();

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/VerifyBroker.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/xml/VerifyBroker.java
@@ -65,6 +65,12 @@ public VerifyBroker inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public VerifyBroker autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateBroker.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateBroker.java
@@ -61,6 +61,12 @@ public CreateBroker inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateBroker autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/connectors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateChannel.java b/connectors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateChannel.java
@@ -61,6 +61,12 @@ public CreateChannel inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateChannel autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);

diff --git a/...ors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateSubscription.java b/...ors/citrus-knative/src/main/java/org/citrusframework/knative/yaml/CreateSubscription.java
@@ -69,6 +69,12 @@ public CreateSubscription inNamespace(String namespace) {
         return this;
     }
 
+    @Override
+    public CreateSubscription autoRemoveResources(boolean enabled) {
+        this.delegate.autoRemoveResources(enabled);
+        return this;
+    }
+
     @Override
     public void setReferenceResolver(ReferenceResolver referenceResolver) {
         this.delegate.setReferenceResolver(referenceResolver);