Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial setup for integration tests #57

Merged
merged 1 commit into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,13 @@
<maven.gpg.version>3.1.0</maven.gpg.version>
<sonatype.nexus.staging>1.7.0</sonatype.nexus.staging>

<kafka.version>3.7.0</kafka.version>
<kafka.version>3.8.1</kafka.version>
<prometheus.version>1.3.2</prometheus.version>
<yammer.version>2.2.0</yammer.version>
<slf4j.version>2.0.13</slf4j.version>
<junit.version>5.10.2</junit.version>
<strimzi-test-container.version>0.108.0</strimzi-test-container.version>
<testcontainers.version>1.20.1</testcontainers.version>
</properties>

<distributionManagement>
Expand Down Expand Up @@ -195,6 +197,18 @@
<version>${slf4j.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.strimzi</groupId>
<artifactId>strimzi-test-container</artifactId>
<version>${strimzi-test-container.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>testcontainers</artifactId>
<version>${testcontainers.version}</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down Expand Up @@ -225,6 +239,11 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven.surefire.version}</version>
<configuration>
<excludes>
<exclude>**/*IT.java</exclude>
</excludes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down Expand Up @@ -290,6 +309,8 @@
<ignoredUnusedDeclaredDependencies>
<!-- Needed for logging in tests -->
<ignoredUnusedDeclaredDependency>org.slf4j:slf4j-simple</ignoredUnusedDeclaredDependency>
<ignoredUnusedDeclaredDependency>io.strimzi:strimzi-test-container</ignoredUnusedDeclaredDependency>
<ignoredUnusedDeclaredDependency>org.testcontainers:testcontainers</ignoredUnusedDeclaredDependency>
</ignoredUnusedDeclaredDependencies>
</configuration>
</execution>
Expand Down
13 changes: 12 additions & 1 deletion src/test/java/io/strimzi/kafka/metrics/MetricsUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,19 @@ public class MetricsUtils {
* @throws Exception If any error occurs
*/
public static List<String> getMetrics(int port) throws Exception {
return getMetrics("localhost", port);
}

/**
* Query the HTTP endpoint and returns the output
* @param host The host to query
* @param port The port to query
* @return The lines from the output
* @throws Exception If any error occurs
*/
public static List<String> getMetrics(String host, int port) throws Exception {
List<String> metrics = new ArrayList<>();
URL url = new URL("http://localhost:" + port + "/metrics");
URL url = new URL("http://" + host + ":" + port + "/metrics");
HttpURLConnection con = (HttpURLConnection) url.openConnection();
con.setRequestMethod("GET");

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
/*
* Copyright Strimzi authors.
* License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
*/
package io.strimzi.kafka.metrics.integration;

import io.strimzi.kafka.metrics.KafkaPrometheusMetricsReporter;
import io.strimzi.kafka.metrics.MetricsUtils;
import io.strimzi.kafka.metrics.PrometheusMetricsReporterConfig;
import io.strimzi.kafka.metrics.YammerPrometheusMetricsReporter;
import io.strimzi.kafka.metrics.http.Listener;
import io.strimzi.test.container.StrimziKafkaContainer;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.testcontainers.utility.MountableFile;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class TestBrokerMetricsIT {

private static final String VERSION = "1.0.0-SNAPSHOT";
private static final String REPORTER_JARS = "target/metrics-reporter-" + VERSION + "/metrics-reporter-" + VERSION + "/libs/";
private static final String MOUNT_PATH = "/opt/strimzi/metrics-reporter/";
private static final int PORT = Listener.parseListener(PrometheusMetricsReporterConfig.LISTENER_CONFIG_DEFAULT).port;

private Map<String, String> configs;
private StrimziKafkaContainer broker;

@BeforeEach
public void setUp() {
configs = new HashMap<>();
configs.put("metric.reporters", KafkaPrometheusMetricsReporter.class.getName());
configs.put("kafka.metrics.reporters", YammerPrometheusMetricsReporter.class.getName());

broker = new StrimziKafkaContainer()
.withNodeId(0)
.withKraft()
.withCopyFileToContainer(MountableFile.forHostPath(REPORTER_JARS), MOUNT_PATH)
.withExposedPorts(9092, PORT)
.withKafkaConfigurationMap(configs)
.withEnv(Collections.singletonMap("CLASSPATH", MOUNT_PATH + "*"));
}

@AfterEach
public void tearDown() {
broker.stop();
}

@Test
public void testMetricsReporter() throws Exception {
broker.start();
List<String> metrics = MetricsUtils.getMetrics(broker.getHost(), broker.getMappedPort(PORT));
List<String> prefixes = Arrays.asList(
"jvm_",
"kafka_controller_",
"kafka_coordinator_",
"kafka_log_",
"kafka_network_",
"kafka_server_");
for (String prefix : prefixes) {
assertFalse(filterMetrics(metrics, prefix).isEmpty());
}
}

@Test
public void testMetricsReporterWithAllowlist() throws Exception {
configs.put("prometheus.metrics.reporter.allowlist", "kafka_controller.*,kafka_server.*");
broker.withKafkaConfigurationMap(configs);
broker.start();
List<String> metrics = MetricsUtils.getMetrics(broker.getHost(), broker.getMappedPort(PORT));
List<String> allowedPrefixes = Arrays.asList(
"jvm_",
"kafka_controller_",
"kafka_server_");
for (String prefix : allowedPrefixes) {
assertFalse(filterMetrics(metrics, prefix).isEmpty());
}
List<String> disallowPrefixes = Arrays.asList(
"kafka_coordinator_",
"kafka_log_",
"kafka_network_");
for (String prefix : disallowPrefixes) {
assertTrue(filterMetrics(metrics, prefix).isEmpty());
}
}

private List<String> filterMetrics(List<String> allMetrics, String prefix) {
List<String> metrics = new ArrayList<>();
for (String metric : allMetrics) {
if (metric.startsWith(prefix)) {
metrics.add(metric);
}
}
return metrics;
}
}