|
| 1 | +package datadog.trace.test.util; |
| 2 | + |
| 3 | +import static org.junit.jupiter.api.AssertionFailureBuilder.assertionFailure; |
| 4 | + |
| 5 | +import datadog.environment.EnvironmentVariables; |
| 6 | +import de.thetaphi.forbiddenapis.SuppressForbidden; |
| 7 | +import java.util.Arrays; |
| 8 | +import java.util.List; |
| 9 | +import java.util.Map; |
| 10 | +import java.util.Map.Entry; |
| 11 | +import java.util.TreeMap; |
| 12 | +import java.util.function.Predicate; |
| 13 | +import java.util.stream.Collectors; |
| 14 | +import org.junit.jupiter.api.extension.AfterAllCallback; |
| 15 | +import org.junit.jupiter.api.extension.BeforeAllCallback; |
| 16 | +import org.junit.jupiter.api.extension.ExtensionContext; |
| 17 | + |
| 18 | +/** |
| 19 | + * Asserts that no {@code DD_*} environment variable and no {@code dd.*} system property (minus a |
| 20 | + * small allowlist) is set around a test class. |
| 21 | + */ |
| 22 | +@SuppressForbidden |
| 23 | +public class CleanConfigStateExtension implements BeforeAllCallback, AfterAllCallback { |
| 24 | + |
| 25 | + private static final List<String> ALLOWED_SYS_PROPS = |
| 26 | + Arrays.asList( |
| 27 | + "dd.appsec.enabled", "dd.iast.enabled", "dd.integration.grizzly-filterchain.enabled"); |
| 28 | + |
| 29 | + private static final Predicate<String> DATADOG_ENV_VAR_FILTER = k -> k.startsWith("DD_"); |
| 30 | + private static final Predicate<Object> DATADOG_SYS_PROPERTIES_FILTER = |
| 31 | + o -> { |
| 32 | + String key = (String) o; |
| 33 | + return key.startsWith("DD_") && !ALLOWED_SYS_PROPS.contains(key); |
| 34 | + }; |
| 35 | + |
| 36 | + @Override |
| 37 | + public void beforeAll(ExtensionContext context) { |
| 38 | + assertClean("before"); |
| 39 | + } |
| 40 | + |
| 41 | + @Override |
| 42 | + public void afterAll(ExtensionContext context) { |
| 43 | + assertClean("after"); |
| 44 | + } |
| 45 | + |
| 46 | + private static void assertClean(String phase) { |
| 47 | + Map<String, String> leakedEnv = |
| 48 | + filterMap(EnvironmentVariables.getAll(), DATADOG_ENV_VAR_FILTER); |
| 49 | + Map<Object, Object> leakedSys = |
| 50 | + filterMap(System.getProperties(), DATADOG_SYS_PROPERTIES_FILTER); |
| 51 | + if (!leakedEnv.isEmpty() || !leakedSys.isEmpty()) { |
| 52 | + assertionFailure() |
| 53 | + .message("Leaked Datadog configuration detected " + phase + " test class") |
| 54 | + .reason(formatLeaks(leakedEnv, leakedSys)) |
| 55 | + .buildAndThrow(); |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + private static <T> Map<T, T> filterMap(Map<T, T> map, Predicate<T> keyFilter) { |
| 60 | + return map.entrySet().stream() |
| 61 | + .filter(e -> keyFilter.test(e.getKey())) |
| 62 | + .collect(Collectors.toMap(Entry::getKey, Entry::getValue, (a, b) -> a, TreeMap::new)); |
| 63 | + } |
| 64 | + |
| 65 | + private static String formatLeaks(Map<String, String> env, Map<Object, Object> sys) { |
| 66 | + StringBuilder sb = new StringBuilder(); |
| 67 | + if (!env.isEmpty()) { |
| 68 | + sb.append("environment variables:"); |
| 69 | + env.forEach((k, v) -> sb.append("\n ").append(k).append('=').append(v)); |
| 70 | + } |
| 71 | + if (!sys.isEmpty()) { |
| 72 | + if (sb.length() > 0) { |
| 73 | + sb.append('\n'); |
| 74 | + } |
| 75 | + sb.append("system properties:"); |
| 76 | + sys.forEach((k, v) -> sb.append("\n ").append(k).append('=').append(v)); |
| 77 | + } |
| 78 | + return sb.toString(); |
| 79 | + } |
| 80 | +} |
0 commit comments