From fb4626dd0712c18b7f214c938f6d797d72f55222 Mon Sep 17 00:00:00 2001 From: Jast Date: Thu, 14 Nov 2024 11:24:49 +0800 Subject: [PATCH] [feature] add e2e code (#2811) Co-authored-by: aias00 Co-authored-by: tomsun28 --- .../workflows/backend-build-test-reuse.yml | 2 +- .../hertzbeat-collector-kafka-e2e/pom.xml | 61 ++++++++ .../collect/kafka/KafkaCollectE2eTest.java | 143 ++++++++++++++++++ hertzbeat-e2e/pom.xml | 69 +++++++++ material/licenses/LICENSE | 1 + material/licenses/backend/LICENSE | 1 + pom.xml | 1 + 7 files changed, 277 insertions(+), 1 deletion(-) create mode 100644 hertzbeat-e2e/hertzbeat-collector-kafka-e2e/pom.xml create mode 100644 hertzbeat-e2e/hertzbeat-collector-kafka-e2e/src/test/java/org/apache/hertzbeat/collector/collect/kafka/KafkaCollectE2eTest.java create mode 100644 hertzbeat-e2e/pom.xml diff --git a/.github/workflows/backend-build-test-reuse.yml b/.github/workflows/backend-build-test-reuse.yml index a7e796b0560..66b21e0a2d0 100644 --- a/.github/workflows/backend-build-test-reuse.yml +++ b/.github/workflows/backend-build-test-reuse.yml @@ -35,7 +35,7 @@ jobs: - uses: ./script/ci/github-actions/setup-deps - name: Build with Maven - run: mvn clean -B package -Prelease --file pom.xml + run: mvn clean -B package -Prelease -Dmaven.test.skip=false --file pom.xml - name: Upload coverage reports to Codecov uses: codecov/codecov-action@v4.0.1 diff --git a/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/pom.xml b/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/pom.xml new file mode 100644 index 00000000000..765c4ad22b5 --- /dev/null +++ b/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/pom.xml @@ -0,0 +1,61 @@ + + + + 4.0.0 + + org.apache.hertzbeat + hertzbeat-e2e + 2.0-SNAPSHOT + + + hertzbeat-collector-kafka-e2e + + + 17 + 17 + UTF-8 + + + + + org.testcontainers + kafka + ${testcontainers.version} + test + + + org.apache.kafka + kafka-clients + test + + + org.apache.hertzbeat + hertzbeat-collector-kafka + ${hertzbeat.version} + test + + + org.apache.hertzbeat + hertzbeat-collector-common + ${hertzbeat.version} + test + + + \ No newline at end of file diff --git a/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/src/test/java/org/apache/hertzbeat/collector/collect/kafka/KafkaCollectE2eTest.java b/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/src/test/java/org/apache/hertzbeat/collector/collect/kafka/KafkaCollectE2eTest.java new file mode 100644 index 00000000000..6edf0615dfe --- /dev/null +++ b/hertzbeat-e2e/hertzbeat-collector-kafka-e2e/src/test/java/org/apache/hertzbeat/collector/collect/kafka/KafkaCollectE2eTest.java @@ -0,0 +1,143 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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.apache.hertzbeat.collector.collect.kafka; + +import lombok.extern.slf4j.Slf4j; +import org.apache.hertzbeat.common.entity.job.Metrics; +import org.apache.hertzbeat.common.entity.job.protocol.KafkaProtocol; +import org.apache.hertzbeat.common.entity.message.CollectRep; +import org.apache.kafka.clients.admin.AdminClient; +import org.apache.kafka.clients.admin.KafkaAdminClient; +import org.apache.kafka.clients.admin.NewTopic; +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.testcontainers.containers.GenericContainer; +import org.testcontainers.containers.KafkaContainer; +import org.testcontainers.containers.Network; +import org.testcontainers.containers.output.Slf4jLogConsumer; +import org.testcontainers.containers.wait.strategy.Wait; +import org.testcontainers.lifecycle.Startables; +import org.testcontainers.utility.DockerImageName; +import org.testcontainers.utility.DockerLoggerFactory; + +import java.time.Duration; +import java.util.Collections; +import java.util.List; +import java.util.Properties; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.stream.Stream; + +/** + * KafkaCollectE2E + */ +@Slf4j +public class KafkaCollectE2eTest { + + private static final String ZOOKEEPER_IMAGE_NAME = "zookeeper:3.8.4"; + private static final String ZOOKEEPER_NAME = "zookeeper"; + private static final Integer ZOOKEEPER_PORT = 2181; + private static final String KAFKA_IMAGE_NAME = "confluentinc/cp-kafka:7.4.7"; + private static final String KAFKA_NAME = "kafka"; + private static GenericContainer zookeeperContainer; + private static KafkaContainer kafkaContainer; + private Metrics metrics; + private KafkaCollectImpl kafkaCollect; + private CollectRep.MetricsData.Builder builder; + + @AfterAll + public static void tearDown() { + kafkaContainer.stop(); + zookeeperContainer.stop(); + } + + @BeforeEach + public void setUp() { + kafkaCollect = new KafkaCollectImpl(); + metrics = new Metrics(); + Network.NetworkImpl network = Network.builder().build(); + zookeeperContainer = new GenericContainer<>(DockerImageName.parse(ZOOKEEPER_IMAGE_NAME)) + .withExposedPorts(ZOOKEEPER_PORT) + .withNetwork(network) + .withNetworkAliases(ZOOKEEPER_NAME) + .waitingFor(Wait.forListeningPort()) + .withStartupTimeout(Duration.ofSeconds(30)); + zookeeperContainer.setPortBindings(Collections.singletonList(ZOOKEEPER_PORT + ":" + ZOOKEEPER_PORT)); + + Startables.deepStart(Stream.of(zookeeperContainer)).join(); + + kafkaContainer = new KafkaContainer(DockerImageName.parse(KAFKA_IMAGE_NAME)) + .withExternalZookeeper(ZOOKEEPER_NAME + ":2181") + .withNetwork(network) + .withNetworkAliases(KAFKA_NAME) + .withLogConsumer( + new Slf4jLogConsumer( + DockerLoggerFactory.getLogger(KAFKA_IMAGE_NAME))); + Startables.deepStart(Stream.of(kafkaContainer)).join(); + } + + @Test + public void testKafkaCollect() throws ExecutionException, InterruptedException, TimeoutException { + + Assertions.assertTrue(zookeeperContainer.isRunning(), "Zookeeper container should be running"); + Assertions.assertTrue(kafkaContainer.isRunning(), "Kafka container should be running"); + + String topicName = "test-topic"; + + String bootstrapServers = kafkaContainer.getBootstrapServers().replace("PLAINTEXT://", ""); + KafkaProtocol kafkaProtocol = new KafkaProtocol(); + kafkaProtocol.setHost(bootstrapServers.split(":")[0]); + kafkaProtocol.setPort(bootstrapServers.split(":")[1]); + kafkaProtocol.setCommand("topic-list"); + metrics.setKclient(kafkaProtocol); + log.info("bootstrapServers: {}", bootstrapServers); + + // Create Topic + Properties properties = new Properties(); + properties.put("bootstrap.servers", bootstrapServers); + AdminClient adminClient = KafkaAdminClient.create(properties); + int numPartitions = 1; + short replicationFactor = 1; + NewTopic newTopic = new NewTopic(topicName, numPartitions, replicationFactor); + adminClient.createTopics(Collections.singletonList(newTopic)).all().get(60, TimeUnit.SECONDS); + + // Verify the information of topic list monitoring + builder = CollectRep.MetricsData.newBuilder(); + kafkaCollect.collect(builder, 0, "kafka", metrics); + Assertions.assertTrue(builder.getValuesList().stream() + .anyMatch(valueRow -> valueRow.getColumns(0).equals(topicName))); + + // Verify the information monitored by topic description + builder = CollectRep.MetricsData.newBuilder(); + kafkaProtocol.setCommand("topic-describe"); + kafkaCollect.collect(builder, 0, "kafka", metrics); + List topicDescribeList = builder.getValuesList(); + CollectRep.ValueRow firstRow = topicDescribeList.get(0); + Assertions.assertAll( + () -> Assertions.assertEquals(topicName, firstRow.getColumns(0)), + () -> Assertions.assertEquals(String.valueOf(numPartitions), firstRow.getColumns(1)), + () -> Assertions.assertEquals("0", firstRow.getColumns(2)), + () -> Assertions.assertEquals(kafkaProtocol.getHost(), firstRow.getColumns(3)), + () -> Assertions.assertEquals(kafkaProtocol.getPort(), firstRow.getColumns(4)), + () -> Assertions.assertEquals(String.valueOf(replicationFactor), firstRow.getColumns(5)) + ); + } +} diff --git a/hertzbeat-e2e/pom.xml b/hertzbeat-e2e/pom.xml new file mode 100644 index 00000000000..872171ca09e --- /dev/null +++ b/hertzbeat-e2e/pom.xml @@ -0,0 +1,69 @@ + + + + 4.0.0 + + org.apache.hertzbeat + hertzbeat + 2.0-SNAPSHOT + + + hertzbeat-e2e + pom + + hertzbeat-collector-kafka-e2e + + + + + 17 + 17 + UTF-8 + 1.20.2 + 4.13.2 + 4.2.0 + + + + + + org.testcontainers + testcontainers + ${testcontainers.version} + + + org.mockito + mockito-core + test + + + junit + junit + ${junit.version} + test + + + org.awaitility + awaitility + ${awaitility.version} + test + + + \ No newline at end of file diff --git a/material/licenses/LICENSE b/material/licenses/LICENSE index 03306d7ff66..9f9a3a4bea0 100644 --- a/material/licenses/LICENSE +++ b/material/licenses/LICENSE @@ -533,6 +533,7 @@ The text of each license is also included in licenses/LICENSE-[project].txt. https://mvnrepository.com/artifact/org.java-websocket/Java-WebSocket/1.5.2 https://mvnrepository.com/artifact/com.taosdata.jdbc/taos-jdbcdriver/3.0.0 https://mvnrepository.com/artifact/com.beetstra.jutf7/jutf7/1.0.0 + https://mvnrepository.com/artifact/org.testcontainers/kafka/1.20.2 MIT ======================================================================== MPL-1.1 licenses diff --git a/material/licenses/backend/LICENSE b/material/licenses/backend/LICENSE index 45fda44a0c4..958cd9b343f 100644 --- a/material/licenses/backend/LICENSE +++ b/material/licenses/backend/LICENSE @@ -533,6 +533,7 @@ The text of each license is also included in licenses/LICENSE-[project].txt. https://mvnrepository.com/artifact/org.java-websocket/Java-WebSocket/1.5.2 https://mvnrepository.com/artifact/com.taosdata.jdbc/taos-jdbcdriver/3.0.0 https://mvnrepository.com/artifact/com.beetstra.jutf7/jutf7/1.0.0 + https://mvnrepository.com/artifact/org.testcontainers/kafka/1.20.2 MIT ======================================================================== MPL-1.1 licenses diff --git a/pom.xml b/pom.xml index 3ceff0f4a4d..61336071683 100644 --- a/pom.xml +++ b/pom.xml @@ -88,6 +88,7 @@ hertzbeat-push hertzbeat-plugin hertzbeat-grafana + hertzbeat-e2e