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.

Sign up for GitHub

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

Improve parsing of allowlist #32

Merged
merged 1 commit into from
Jul 23, 2024
Merged

Improve parsing of allowlist #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion src/main/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import java.util.stream.Collectors;

/**
* Configuration for the PrometheusMetricsReporter implementation.
Expand Down Expand Up @@ -97,7 +99,14 @@ public boolean isAllowed(String name) {
}

private Pattern compileAllowlist(List<String> allowlist) {
String joined = String.join("|", allowlist);
for (String entry : allowlist) {
try {
Pattern.compile(entry);
} catch (PatternSyntaxException pse) {
throw new ConfigException("Invalid regex pattern found in " + ALLOWLIST_CONFIG + ": " + entry);
}
}
String joined = allowlist.stream().map(v -> "(" + v + ")").collect(Collectors.joining("|"));
return Pattern.compile(joined);
}

Expand Down
57 changes: 32 additions & 25 deletions src/test/java/io/strimzi/kafka/metrics/PrometheusMetricsReporterConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,15 @@
import org.apache.kafka.common.config.ConfigException;
import org.junit.jupiter.api.Test;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

import static io.strimzi.kafka.metrics.PrometheusMetricsReporterConfig.ALLOWLIST_CONFIG;
import static io.strimzi.kafka.metrics.PrometheusMetricsReporterConfig.LISTENER_CONFIG;
import static io.strimzi.kafka.metrics.PrometheusMetricsReporterConfig.LISTENER_ENABLE_CONFIG;
import static java.util.Collections.emptyMap;
import static java.util.Collections.singletonMap;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
Expand All @@ -23,16 +27,16 @@
public class PrometheusMetricsReporterConfigTest {
@Test
public void testDefaults() {
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(Collections.emptyMap(), new PrometheusRegistry());
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(emptyMap(), new PrometheusRegistry());
assertEquals(PrometheusMetricsReporterConfig.LISTENER_CONFIG_DEFAULT, config.listener());
assertTrue(config.isAllowed("random_name"));
}

@Test
public void testOverrides() {
Map<String, String> props = new HashMap<>();
props.put(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://:0");
props.put(PrometheusMetricsReporterConfig.ALLOWLIST_CONFIG, "kafka_server.*");
props.put(LISTENER_CONFIG, "http://:0");
props.put(ALLOWLIST_CONFIG, "kafka_server.*");
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(props, new PrometheusRegistry());

assertEquals("http://:0", config.listener());
Expand All @@ -42,13 +46,17 @@ public void testOverrides() {

@Test
public void testAllowList() {
Map<String, String> props = new HashMap<>();
props.put(PrometheusMetricsReporterConfig.ALLOWLIST_CONFIG, "kafka_server.*,kafka_network.*");
Map<String, String> props = singletonMap(ALLOWLIST_CONFIG, "kafka_server.*,kafka_network.*");
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(props, new PrometheusRegistry());

assertFalse(config.isAllowed("random_name"));
assertTrue(config.isAllowed("kafka_server_metric"));
assertTrue(config.isAllowed("kafka_network_metric"));

assertThrows(ConfigException.class,
() -> new PrometheusMetricsReporterConfig(singletonMap(ALLOWLIST_CONFIG, "hell[o,s]world"), null));
assertThrows(ConfigException.class,
() -> new PrometheusMetricsReporterConfig(singletonMap(ALLOWLIST_CONFIG, "hello\\,world"), null));
}

@Test
Expand All @@ -73,28 +81,28 @@ public void testListenerParseListener() {
@Test
public void testValidator() {
PrometheusMetricsReporterConfig.ListenerValidator validator = new PrometheusMetricsReporterConfig.ListenerValidator();
validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://:0");
validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://123:8080");
validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://::1:8080");
validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://[::1]:8080");
validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://random:8080");

assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://random:"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://:-8080"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://random:-8080"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://:8080random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "randomhttp://:8080random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "randomhttp://:8080"));
validator.ensureValid(LISTENER_CONFIG, "http://:0");
validator.ensureValid(LISTENER_CONFIG, "http://123:8080");
validator.ensureValid(LISTENER_CONFIG, "http://::1:8080");
validator.ensureValid(LISTENER_CONFIG, "http://[::1]:8080");
validator.ensureValid(LISTENER_CONFIG, "http://random:8080");

assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://random:"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://:-8080"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://random:-8080"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "http://:8080random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "randomhttp://:8080random"));
assertThrows(ConfigException.class, () -> validator.ensureValid(LISTENER_CONFIG, "randomhttp://:8080"));
}

@Test
public void testIsListenerEnabled() {
Map<String, String> props = new HashMap<>();
props.put(PrometheusMetricsReporterConfig.LISTENER_ENABLE_CONFIG, "true");
props.put(PrometheusMetricsReporterConfig.LISTENER_CONFIG, "http://:0");
props.put(LISTENER_ENABLE_CONFIG, "true");
props.put(LISTENER_CONFIG, "http://:0");
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(props, new PrometheusRegistry());
Optional<HTTPServer> httpServerOptional = config.startHttpServer();

Expand All @@ -105,8 +113,7 @@ public void testIsListenerEnabled() {

@Test
public void testIsListenerDisabled() {
Map<String, Boolean> props = new HashMap<>();
props.put(PrometheusMetricsReporterConfig.LISTENER_ENABLE_CONFIG, false);
Map<String, Boolean> props = singletonMap(LISTENER_ENABLE_CONFIG, false);
PrometheusMetricsReporterConfig config = new PrometheusMetricsReporterConfig(props, new PrometheusRegistry());
Optional<HTTPServer> httpServerOptional = config.startHttpServer();

Expand Down