chore: Add Knative connector module

- Provide test actions to interact with Knative - Add test actions to manage Knative resources such as broker, channel, trigger - Add test actions to produce/consume events for/from the Knative broker - Add Http server binding when creating a Kubernetes service - Add XML DSL support - Add YAML DSL support
citrusframework · Oct 9, 2024 · 681bbc3 · 681bbc3
1 parent 08281b2
commit 681bbc3
Show file tree

Hide file tree

Showing 132 changed files with 9,220 additions and 26 deletions.
diff --git a/connectors/citrus-knative/pom.xml b/connectors/citrus-knative/pom.xml
@@ -0,0 +1,96 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.citrusframework</groupId>
+    <artifactId>citrus-connectors</artifactId>
+    <version>4.4.0-SNAPSHOT</version>
+    <relativePath>../pom.xml</relativePath>
+  </parent>
+
+  <artifactId>citrus-knative</artifactId>
+  <name>Citrus :: Connectors :: Knative</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-base</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-http</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-kubernetes</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>jakarta.xml.bind</groupId>
+      <artifactId>jakarta.xml.bind-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>kubernetes-client</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>knative-client</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>okhttp</artifactId>
+    </dependency>
+
+    <!-- Test scoped dependencies -->
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-test-support</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-testng</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-spring</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-xml</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.citrusframework</groupId>
+      <artifactId>citrus-yaml</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.fabric8</groupId>
+      <artifactId>kubernetes-server-mock</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.squareup.okhttp3</groupId>
+      <artifactId>mockwebserver</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+</project>
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
@@ -0,0 +1,253 @@
+/*
+ * Copyright the original author or authors.
+ *
+ * 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 org.citrusframework.knative;
+
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import org.citrusframework.kubernetes.KubernetesSettings;
+import org.citrusframework.util.StringUtils;
+
+public class KnativeSettings {
+
+    private static final String KNATIVE_PROPERTY_PREFIX = "citrus.knative.";
+    private static final String KNATIVE_ENV_PREFIX = "CITRUS_KNATIVE_";
+
+    private static final String EVENT_PRODUCER_TIMEOUT_PROPERTY = KNATIVE_PROPERTY_PREFIX + "event.producer.timeout";
+    private static final String EVENT_PRODUCER_TIMEOUT_ENV = KNATIVE_ENV_PREFIX + "EVENT_PRODUCER_TIMEOUT";
+    private static final String EVENT_PRODUCER_TIMEOUT_DEFAULT = "2000";
+
+    private static final String EVENT_CONSUMER_TIMEOUT_PROPERTY = KNATIVE_PROPERTY_PREFIX + "event.consumer.timeout";
+    private static final String EVENT_CONSUMER_TIMEOUT_ENV = KNATIVE_ENV_PREFIX + "EVENT_CONSUMER_TIMEOUT";
+    private static final String EVENT_CONSUMER_TIMEOUT_DEFAULT = "2000";
+
+    private static final String NAMESPACE_PROPERTY = KNATIVE_PROPERTY_PREFIX + "namespace";
+    private static final String NAMESPACE_ENV = KNATIVE_ENV_PREFIX + "NAMESPACE";
+
+    private static final String API_VERSION_PROPERTY = KNATIVE_PROPERTY_PREFIX + "api.version";
+    private static final String API_VERSION_ENV = KNATIVE_ENV_PREFIX + "API_VERSION";
+    private static final String API_VERSION_DEFAULT = "v1";
+
+    private static final String BROKER_HOST_PROPERTY = KNATIVE_PROPERTY_PREFIX + "broker.host";
+    private static final String BROKER_HOST_ENV = KNATIVE_ENV_PREFIX + "BROKER_HOST";
+    private static final String BROKER_HOST_DEFAULT = String.format("broker-ingress.knative-eventing.%s", KubernetesSettings.DEFAULT_DOMAIN_SUFFIX);
+
+    private static final String BROKER_NAME_PROPERTY = KNATIVE_PROPERTY_PREFIX + "broker.name";
+    private static final String BROKER_NAME_ENV = KNATIVE_ENV_PREFIX + "BROKER_NAME";
+    private static final String BROKER_NAME_DEFAULT = "default";
+
+    private static final String BROKER_PORT_PROPERTY = KNATIVE_PROPERTY_PREFIX + "broker.port";
+    private static final String BROKER_PORT_ENV = KNATIVE_ENV_PREFIX + "BROKER_PORT";
+    private static final String BROKER_PORT_DEFAULT = "8080";
+
+    private static final String BROKER_URL_PROPERTY = KNATIVE_PROPERTY_PREFIX + "broker.url";
+    private static final String BROKER_URL_ENV = KNATIVE_ENV_PREFIX + "BROKER_URL";
+
+    private static final String SERVICE_NAME_PROPERTY = KNATIVE_PROPERTY_PREFIX + "service.name";
+    private static final String SERVICE_NAME_ENV = KNATIVE_ENV_PREFIX + "SERVICE_NAME";
+    private static final String SERVICE_NAME_DEFAULT = "citrus-knative-service";
+
+    private static final String SERVICE_PORT_PROPERTY = KNATIVE_PROPERTY_PREFIX + "service.port";
+    private static final String SERVICE_PORT_ENV = KNATIVE_ENV_PREFIX + "SERVICE_PORT";
+
+    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 VERIFY_BROKER_RESPONSE_PROPERTY = KNATIVE_PROPERTY_PREFIX + "verify.broker.resources";
+    private static final String VERIFY_BROKER_RESPONSE_ENV = KNATIVE_ENV_PREFIX + "VERIFY_BROKER_RESPONSE";
+    private static final String VERIFY_BROKER_RESPONSE_DEFAULT = "true";
+
+    private static final String BROKER_RESPONSE_STATUS_PROPERTY = KNATIVE_PROPERTY_PREFIX + "broker.response";
+    private static final String BROKER_RESPONSE_STATUS_ENV = KNATIVE_ENV_PREFIX + "BROKER_RESPONSE_STATUS";
+
+    private static final String DEFAULT_LABELS_PROPERTY = KNATIVE_PROPERTY_PREFIX + "default.labels";
+    private static final String DEFAULT_LABELS_ENV = KNATIVE_ENV_PREFIX + "DEFAULT_LABELS";
+    private static final String DEFAULT_LABELS_DEFAULT = "app=citrus";
+
+    private KnativeSettings() {
+        // prevent instantiation of utility class
+    }
+
+    /**
+     * Request timeout when sending cloud events.
+     * @return
+     */
+    public static long getEventProducerTimeout() {
+        return Long.parseLong(System.getProperty(EVENT_PRODUCER_TIMEOUT_PROPERTY,
+                System.getenv(EVENT_PRODUCER_TIMEOUT_ENV) != null ? System.getenv(EVENT_PRODUCER_TIMEOUT_ENV) : EVENT_PRODUCER_TIMEOUT_DEFAULT));
+    }
+
+    /**
+     * Request timeout when receiving cloud events.
+     * @return
+     */
+    public static long getEventConsumerTimeout() {
+        return Long.parseLong(System.getProperty(EVENT_CONSUMER_TIMEOUT_PROPERTY,
+                System.getenv(EVENT_CONSUMER_TIMEOUT_ENV) != null ? System.getenv(EVENT_CONSUMER_TIMEOUT_ENV) : EVENT_CONSUMER_TIMEOUT_DEFAULT));
+    }
+
+    /**
+     * Namespace to work on when performing Knative client operations such as creating triggers, services and so on.
+     * @return
+     */
+    public static String getNamespace() {
+        String systemNamespace = System.getProperty(NAMESPACE_PROPERTY, System.getenv(NAMESPACE_ENV));
+
+        if (systemNamespace != null) {
+            return systemNamespace;
+        }
+
+        return KubernetesSettings.getNamespace();
+    }
+
+    /**
+     * Api version for current Knative installation.
+     * @return
+     */
+    public static String getApiVersion() {
+        return System.getProperty(API_VERSION_PROPERTY,
+                System.getenv(API_VERSION_ENV) != null ? System.getenv(API_VERSION_ENV) : API_VERSION_DEFAULT);
+    }
+
+    /**
+     * Broker host used as Http header when creating cloud events.
+     * @return
+     */
+    public static String getBrokerHost() {
+        String brokerHostDefault;
+
+        if (KubernetesSettings.isKubernetesCluster() || KubernetesSettings.isOpenshiftCluster()) {
+            brokerHostDefault = BROKER_HOST_DEFAULT;
+        } else {
+            brokerHostDefault = "localhost";
+        }
+
+        return System.getProperty(BROKER_HOST_PROPERTY,
+                System.getenv(BROKER_HOST_ENV) != null ? System.getenv(BROKER_HOST_ENV) : brokerHostDefault);
+    }
+
+    /**
+     * Broker to use when producing/consuming cloud events.
+     * @return
+     */
+    public static String getBrokerName() {
+        return System.getProperty(BROKER_NAME_PROPERTY,
+                System.getenv(BROKER_NAME_ENV) != null ? System.getenv(BROKER_NAME_ENV) : BROKER_NAME_DEFAULT);
+    }
+
+    /**
+     * Broker port to use when producing/consuming cloud events in local environment.
+     * @return
+     */
+    public static String getBrokerPort() {
+        return System.getProperty(BROKER_PORT_PROPERTY,
+                System.getenv(BROKER_PORT_ENV) != null ? System.getenv(BROKER_PORT_ENV) : BROKER_PORT_DEFAULT);
+    }
+
+    /**
+     * Broker URL to use when producing/consuming cloud events.
+     * @return
+     */
+    public static String getBrokerUrl() {
+        String brokerUrlDefault;
+        if (KubernetesSettings.isKubernetesCluster() || KubernetesSettings.isOpenshiftCluster()) {
+            brokerUrlDefault = String.format("http://%s/%s/${%s}", getBrokerHost(), getNamespace(), KnativeVariableNames.BROKER_NAME.value());
+        } else if (KubernetesSettings.isLocal()) {
+            brokerUrlDefault = String.format("http://%s%s", getBrokerHost(), StringUtils.hasText(getBrokerPort()) ? ":" + getBrokerPort() : "");
+        } else {
+            brokerUrlDefault = String.format("http://%s", getBrokerHost());
+        }
+
+        return System.getProperty(BROKER_URL_PROPERTY,
+                System.getenv(BROKER_URL_ENV) != null ? System.getenv(BROKER_URL_ENV) : brokerUrlDefault);
+    }
+
+    /**
+     * Service name to use when creating a new service for cloud event subscriptions.
+     * @return
+     */
+    public static String getServiceName() {
+        return System.getProperty(SERVICE_NAME_PROPERTY,
+                System.getenv(SERVICE_NAME_ENV) != null ? System.getenv(SERVICE_NAME_ENV) : SERVICE_NAME_DEFAULT);
+    }
+
+    /**
+     * Service port used when consuming cloud events via Http.
+     * @return
+     */
+    public static int getServicePort() {
+        return Optional.ofNullable(System.getProperty(SERVICE_PORT_PROPERTY, System.getenv(SERVICE_PORT_ENV)))
+                .map(Integer::parseInt)
+                .orElseGet(KubernetesSettings::getServicePort);
+    }
+
+    /**
+     * Read labels for K8s resources created by the test. The environment setting should be a
+     * comma delimited list of key-value pairs.
+     * @return
+     */
+    public static Map<String, String> getDefaultLabels() {
+        String labelsConfig = System.getProperty(DEFAULT_LABELS_PROPERTY, System.getenv(DEFAULT_LABELS_ENV));
+
+        if (labelsConfig == null) {
+            return KubernetesSettings.getDefaultLabels();
+        }
+
+        return Stream.of(labelsConfig.split(","))
+                    .map(item -> item.split("=", 2))
+                    .filter(keyValue -> keyValue.length == 2)
+                    .collect(Collectors.toMap(item -> item[0], item -> item[1]));
+    }
+
+    /**
+     * When set to true Knative resources (triggers, subscriptions, brokers, etc.) created during the test are
+     * automatically removed after the test.
+     * @return
+     */
+    public static boolean isAutoRemoveResources() {
+        return Boolean.parseBoolean(System.getProperty(AUTO_REMOVE_RESOURCES_PROPERTY,
+                System.getenv(AUTO_REMOVE_RESOURCES_ENV) != null ? System.getenv(AUTO_REMOVE_RESOURCES_ENV) : AUTO_REMOVE_RESOURCES_DEFAULT));
+    }
+
+    public static boolean isVerifyBrokerResponse() {
+        return Boolean.parseBoolean(System.getProperty(VERIFY_BROKER_RESPONSE_PROPERTY,
+                System.getenv(VERIFY_BROKER_RESPONSE_ENV) != null ? System.getenv(VERIFY_BROKER_RESPONSE_ENV) : VERIFY_BROKER_RESPONSE_DEFAULT));
+    }
+
+    public static int getBrokerResponseStatus() {
+        String defaultResponseStatus;
+        if (KubernetesSettings.isLocal()) {
+            defaultResponseStatus = "204"; // NO_CONTENT
+        } else {
+            defaultResponseStatus = "202"; // ACCEPTED
+        }
+
+        return Integer.parseInt(System.getProperty(BROKER_RESPONSE_STATUS_PROPERTY,
+                System.getenv(BROKER_RESPONSE_STATUS_ENV) != null ? System.getenv(BROKER_RESPONSE_STATUS_ENV) : defaultResponseStatus));
+    }
+
+    public static String getKnativeMessagingGroup() {
+        return "messaging.knative.dev";
+    }
+
+    public static String getKnativeEventingGroup() {
+        return "eventing.knative.dev";
+    }
+}