Skip to content

Undo breaking change in 6.0 in environment variable configuration prefix support #62819

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

Merged
merged 4 commits into from
Dec 16, 2021
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
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,9 @@ internal void Load(IDictionary envVariables)
{
prefix = CustomPrefix;
}
else if (key.StartsWith(_prefix, StringComparison.OrdinalIgnoreCase))
{
// This prevents the prefix from being normalized.
// We can also do a fast path branch, I guess? No point in reallocating if the prefix is empty.
key = NormalizeKey(key.Substring(_prefix.Length));
data[key] = entry.Value as string;

continue;
}
else
{
AddIfPrefixed(data, NormalizeKey(key), (string?)entry.Value);
continue;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ public void ReplaceDoubleUnderscoreInEnvironmentVariablesButNotPrefix()

envConfigSrc.Load(dict);

Assert.Equal("connection", envConfigSrc.Get("data:ConnectionString"));
Assert.Throws<InvalidOperationException>(() => envConfigSrc.Get("data:ConnectionString"));
}

[Fact]
Expand All @@ -176,7 +176,7 @@ public void ReplaceDoubleUnderscoreInEnvironmentVariablesButNotInAnomalousPrefix
{
{"_____EXPERIMENTAL__data__ConnectionString", "connection"}
};
var envConfigSrc = new EnvironmentVariablesConfigurationProvider("_____EXPERIMENTAL__");
var envConfigSrc = new EnvironmentVariablesConfigurationProvider("::_EXPERIMENTAL:");

envConfigSrc.Load(dict);

Expand All @@ -194,7 +194,7 @@ public void ReplaceDoubleUnderscoreInEnvironmentVariablesWithDuplicatedPrefix()

envConfigSrc.Load(dict);

Assert.Equal("connection", envConfigSrc.Get("test:ConnectionString"));
Assert.Throws<InvalidOperationException>(() => envConfigSrc.Get("test:ConnectionString"));
}

[Fact]
Expand All @@ -205,14 +205,62 @@ public void PrefixPreventsLoadingSqlConnectionStrings()
{"test__test__ConnectionString", "connection"},
{"SQLCONNSTR_db1", "connStr"}
};
var envConfigSrc = new EnvironmentVariablesConfigurationProvider("test__");
var envConfigSrc = new EnvironmentVariablesConfigurationProvider("test:");

envConfigSrc.Load(dict);

Assert.Equal("connection", envConfigSrc.Get("test:ConnectionString"));
Assert.Throws<InvalidOperationException>(() => envConfigSrc.Get("ConnectionStrings:db1_ProviderName"));
}

public const string EnvironmentVariable = "Microsoft__Extensions__Configuration__EnvironmentVariables__Test__Foo";
public class SettingsWithFoo
{
public string? Foo { get; set; }
}

[Fact]
public void AddEnvironmentVariables_Bind_PrefixShouldNormalize()
{
try
{
Environment.SetEnvironmentVariable(EnvironmentVariable, "myFooValue");
var configuration = new ConfigurationBuilder()
.AddEnvironmentVariables("Microsoft:Extensions:Configuration:EnvironmentVariables:Test:")
.Build();

var settingsWithFoo = new SettingsWithFoo();
configuration.Bind(settingsWithFoo);

Assert.Equal("myFooValue", settingsWithFoo.Foo);
}
finally
{
Environment.SetEnvironmentVariable(EnvironmentVariable, null);
}
}

[Fact]
public void AddEnvironmentVariables_UsingDoubleUnderscores_Bind_PrefixWontNormalize()
{
try
{
Environment.SetEnvironmentVariable(EnvironmentVariable, "myFooValue");
var configuration = new ConfigurationBuilder()
.AddEnvironmentVariables("Microsoft__Extensions__Configuration__EnvironmentVariables__Test__")
.Build();

var settingsWithFoo = new SettingsWithFoo();
configuration.Bind(settingsWithFoo);

Assert.Null(settingsWithFoo.Foo);
}
finally
{
Environment.SetEnvironmentVariable(EnvironmentVariable, null);
}
}

[ConditionalFact(typeof(PlatformDetection), nameof(PlatformDetection.IsThreadingSupported))]
public void BindingDoesNotThrowIfReloadedDuringBinding()
{
Expand Down