Add kafka messaging support to integration test module

- add ncmp test using kafka to integration test suite

Issue-ID: CPS-2152

Change-Id: Ia486bbcf1590ecf3ec6cbc2f513b74d55e4d6a31
Signed-off-by: halil.cakal <halil.cakal@est.tech>

1 files changed, 86 insertions, 0 deletions

diff --git a/integration-test/src/test/java/org/onap/cps/integration/KafkaTestContainer.java b/integration-test/src/test/java/org/onap/cps/integration/KafkaTestContainer.java
new file mode 100644
index 0000000000..d41f752912
--- /dev/null
+++ b/integration-test/src/test/java/org/onap/cps/integration/KafkaTestContainer.java
@@ -0,0 +1,86 @@
+/*
+ *  ============LICENSE_START=======================================================
+ *  Copyright (C) 2024 Nordix Foundation.
+ *  ================================================================================
+ *  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.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.integration;
+
+import java.util.HashMap;
+import java.util.Map;
+import org.apache.kafka.clients.consumer.ConsumerConfig;
+import org.apache.kafka.clients.consumer.KafkaConsumer;
+import org.apache.kafka.common.serialization.StringDeserializer;
+import org.testcontainers.containers.KafkaContainer;
+import org.testcontainers.utility.DockerImageName;
+
+/**
+ * The Apache Kafka test container wrapper.
+ * Allow to use specific image and version with Singleton design pattern.
+ * This ensures only one instance of Kafka container across the integration tests.
+ * Avoid unnecessary resource and time consumption.
+ */
+public class KafkaTestContainer extends KafkaContainer {
+
+    private static final String IMAGE_NAME_AND_VERSION = "registry.nordix.org/onaptest/confluentinc/cp-kafka:6.2.1";
+
+    private static KafkaTestContainer kafkaTestContainer;
+
+    private KafkaTestContainer() {
+        super(DockerImageName.parse(IMAGE_NAME_AND_VERSION).asCompatibleSubstituteFor("confluentinc/cp-kafka"));
+    }
+
+    /**
+     * Provides an instance of Kafka test container wrapper.
+     * This will allow to initialize Kafka messaging support before any integration test run.
+     *
+     * @return KafkaTestContainer the unique Kafka instance
+     */
+    public static KafkaTestContainer getInstance() {
+        if (kafkaTestContainer == null) {
+            kafkaTestContainer = new KafkaTestContainer();
+            Runtime.getRuntime().addShutdownHook(new Thread(kafkaTestContainer::close));
+        }
+        return kafkaTestContainer;
+    }
+
+    public static KafkaConsumer getConsumer(final String consumerGroupId, final Object valueDeserializer) {
+        return new KafkaConsumer<>(consumerProperties(consumerGroupId, valueDeserializer));
+    }
+
+    @Override
+    public void start() {
+        super.start();
+        System.setProperty("spring.kafka.properties.bootstrap.servers", kafkaTestContainer.getBootstrapServers());
+    }
+
+    @Override
+    public void stop() {
+        // Method intentionally left blank
+    }
+
+    private static Map<String, Object> consumerProperties(final String consumerGroupId,
+                                                          final Object valueDeserializer) {
+        final Map<String, Object> configProps = new HashMap<>();
+        configProps.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, kafkaTestContainer.getBootstrapServers());
+        configProps.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class);
+        configProps.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, valueDeserializer);
+        configProps.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
+        configProps.put(ConsumerConfig.GROUP_ID_CONFIG, consumerGroupId);
+        return configProps;
+    }
+
+}