Skip to content

Add support for escaping declarative config env var substitution #7033

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

Merged
merged 5 commits into from
Apr 11, 2025
Merged

Add support for escaping declarative config env var substitution #7033

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7bcc24
Add support for escaping declarative config env var substitution
jack-berg Jan 17, 2025
940dc1a
Add additional test case for $$${API_KEY} => $${API_KEY}
jack-berg Jan 22, 2025
37d6bbb
Adjust algorithm to match marcalff's proposal
jack-berg Jan 23, 2025
9e09cd9
Add additional examples
jack-berg Jan 30, 2025
a17bd3e
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
jack-berg Apr 11, 2025
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
59 changes: 49 additions & 10 deletions .../src/main/java/io/opentelemetry/sdk/extension/incubator/fileconfig/FileConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.regex.MatchResult;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import org.snakeyaml.engine.v2.api.Load;
import org.snakeyaml.engine.v2.api.LoadSettings;
import org.snakeyaml.engine.v2.common.ScalarStyle;
Expand Down Expand Up @@ -297,6 +298,10 @@ protected Map<Object, Object> constructMapping(MappingNode node) {
return mapping;
}

private static final String ESCAPE_SEQUENCE = "$$";
private static final int ESCAPE_SEQUENCE_LENGTH = ESCAPE_SEQUENCE.length();
private static final char ESCAPE_SEQUENCE_REPLACEMENT = '$';

private Object constructValueObject(Node node) {
Object value = constructObject(node);
if (!(node instanceof ScalarNode)) {
Expand All @@ -307,14 +312,53 @@ private Object constructValueObject(Node node) {
}

String val = (String) value;
ScalarStyle scalarStyle = ((ScalarNode) node).getScalarStyle();

// Iterate through val left to right, search for escape sequence "$$"
// For the substring of val between the last escape sequence and the next found, perform
// environment variable substitution
// Add the escape replacement character '$' in place of each escape sequence found

int lastEscapeIndexEnd = 0;
StringBuilder newVal = null;
while (true) {
int escapeIndex = val.indexOf(ESCAPE_SEQUENCE, lastEscapeIndexEnd);
int substitutionEndIndex = escapeIndex == -1 ? val.length() : escapeIndex;
newVal = envVarSubstitution(newVal, val, lastEscapeIndexEnd, substitutionEndIndex);
if (escapeIndex == -1) {
break;
} else {
newVal.append(ESCAPE_SEQUENCE_REPLACEMENT);
}
lastEscapeIndexEnd = escapeIndex + ESCAPE_SEQUENCE_LENGTH;
if (lastEscapeIndexEnd >= val.length()) {
break;
}
}

// If the value was double quoted, retain the double quotes so we don't change a value
// intended to be a string to a different type after environment variable substitution
if (scalarStyle == ScalarStyle.DOUBLE_QUOTED) {
newVal.insert(0, "\"");
newVal.append("\"");
}
return load.loadFromString(newVal.toString());
}

private StringBuilder envVarSubstitution(
@Nullable StringBuilder newVal, String source, int startIndex, int endIndex) {
String val = source.substring(startIndex, endIndex);
Matcher matcher = ENV_VARIABLE_REFERENCE.matcher(val);

if (!matcher.find()) {
return value;
return newVal == null ? new StringBuilder(val) : newVal.append(val);
}

if (newVal == null) {
newVal = new StringBuilder();
}

int offset = 0;
StringBuilder newVal = new StringBuilder();
ScalarStyle scalarStyle = ((ScalarNode) node).getScalarStyle();
do {
MatchResult matchResult = matcher.toMatchResult();
String envVarKey = matcher.group(1);
Expand All @@ -329,13 +373,8 @@ private Object constructValueObject(Node node) {
if (offset != val.length()) {
newVal.append(val, offset, val.length());
}
// If the value was double quoted, retain the double quotes so we don't change a value
// intended to be a string to a different type after environment variable substitution
if (scalarStyle == ScalarStyle.DOUBLE_QUOTED) {
newVal.insert(0, "\"");
newVal.append("\"");
}
return load.loadFromString(newVal.toString());

return newVal;
}
}
}
27 changes: 26 additions & 1 deletion .../java/io/opentelemetry/sdk/extension/incubator/fileconfig/FileConfigurationParseTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,8 +592,10 @@ private static java.util.stream.Stream<Arguments> coreSchemaValuesArgs() {
@MethodSource("envVarSubstitutionArgs")
void envSubstituteAndLoadYaml(String rawYaml, Object expectedYamlResult) {
Map<String, String> environmentVariables = new HashMap<>();
environmentVariables.put("FOO", "BAR");
environmentVariables.put("STR_1", "value1");
environmentVariables.put("STR_2", "value2");
environmentVariables.put("VALUE_WITH_ESCAPE", "value$$");
environmentVariables.put("EMPTY_STR", "");
environmentVariables.put("BOOL", "true");
environmentVariables.put("INT", "1");
Expand Down Expand Up @@ -656,7 +658,30 @@ private static java.util.stream.Stream<Arguments> envVarSubstitutionArgs() {
Arguments.of("key1: \"${EMPTY_STR}\"\n", mapOf(entry("key1", ""))),
Arguments.of("key1: \"${BOOL}\"\n", mapOf(entry("key1", "true"))),
Arguments.of("key1: \"${INT}\"\n", mapOf(entry("key1", "1"))),
Arguments.of("key1: \"${FLOAT}\"\n", mapOf(entry("key1", "1.1"))));
Arguments.of("key1: \"${FLOAT}\"\n", mapOf(entry("key1", "1.1"))),
// Escaped
Arguments.of("key1: ${FOO}\n", mapOf(entry("key1", "BAR"))),
Arguments.of("key1: $${FOO}\n", mapOf(entry("key1", "${FOO}"))),
Arguments.of("key1: $$${FOO}\n", mapOf(entry("key1", "$BAR"))),
Arguments.of("key1: $$$${FOO}\n", mapOf(entry("key1", "$${FOO}"))),
Arguments.of("key1: a $$ b\n", mapOf(entry("key1", "a $ b"))),
Arguments.of("key1: $$ b\n", mapOf(entry("key1", "$ b"))),
Arguments.of("key1: a $$\n", mapOf(entry("key1", "a $"))),
Arguments.of("key1: a $ b\n", mapOf(entry("key1", "a $ b"))),
Arguments.of("key1: $${STR_1}\n", mapOf(entry("key1", "${STR_1}"))),
Arguments.of("key1: $${STR_1}$${STR_1}\n", mapOf(entry("key1", "${STR_1}${STR_1}"))),
Arguments.of("key1: $${STR_1}$$\n", mapOf(entry("key1", "${STR_1}$"))),
Arguments.of("key1: $$${STR_1}\n", mapOf(entry("key1", "$value1"))),
Arguments.of("key1: \"$${STR_1}\"\n", mapOf(entry("key1", "${STR_1}"))),
Arguments.of("key1: $${STR_1} ${STR_2}\n", mapOf(entry("key1", "${STR_1} value2"))),
Arguments.of("key1: $${STR_1} $${STR_2}\n", mapOf(entry("key1", "${STR_1} ${STR_2}"))),
Arguments.of("key1: $${NOT_SET:-value1}\n", mapOf(entry("key1", "${NOT_SET:-value1}"))),
Arguments.of("key1: $${STR_1:-fallback}\n", mapOf(entry("key1", "${STR_1:-fallback}"))),
Arguments.of("key1: $${STR_1:-${STR_1}}\n", mapOf(entry("key1", "${STR_1:-value1}"))),
Arguments.of("key1: ${NOT_SET:-${FALLBACK}}\n", mapOf(entry("key1", "${FALLBACK}"))),
Arguments.of(
"key1: ${NOT_SET:-$${FALLBACK}}\n", mapOf(entry("key1", "${NOT_SET:-${FALLBACK}}"))),
Arguments.of("key1: ${VALUE_WITH_ESCAPE}\n", mapOf(entry("key1", "value$$"))));
}

private static <K, V> Map.Entry<K, V> entry(K key, @Nullable V value) {
Expand Down
Loading