Skip to content

[release/6.0] Making user secrets optional by default #62917

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 3 commits into from
Jan 6, 2022
Merged

[release/6.0] Making user secrets optional by default #62917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fb8b9c
Making user secrets optional by default
maryamariyan Dec 14, 2021
40e353c
update test
maryamariyan Dec 15, 2021
c94dd87
Update fix for 6.0.x servicing.
eerhardt Jan 4, 2022
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
2 changes: 2 additions & 0 deletions ...sions.Configuration.UserSecrets/src/Microsoft.Extensions.Configuration.UserSecrets.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<TargetFrameworks>netstandard2.0;net461</TargetFrameworks>
<EnableDefaultItems>true</EnableDefaultItems>
<PackageDescription>User secrets configuration provider implementation for Microsoft.Extensions.Configuration.</PackageDescription>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<ServicingVersion>1</ServicingVersion>
</PropertyGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions .../Microsoft.Extensions.Configuration.UserSecrets/src/UserSecretsConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public static class UserSecretsConfigurationExtensions
/// <returns>The configuration builder.</returns>
public static IConfigurationBuilder AddUserSecrets<T>(this IConfigurationBuilder configuration)
where T : class
=> configuration.AddUserSecrets(typeof(T).Assembly, optional: false, reloadOnChange: false);
=> configuration.AddUserSecrets(typeof(T).Assembly, optional: true, reloadOnChange: false);

/// <summary>
/// <para>
Expand Down Expand Up @@ -82,7 +82,7 @@ public static IConfigurationBuilder AddUserSecrets<T>(this IConfigurationBuilder
/// <exception cref="InvalidOperationException">Thrown when <paramref name="assembly"/> does not have a valid <see cref="UserSecretsIdAttribute"/></exception>
/// <returns>The configuration builder.</returns>
public static IConfigurationBuilder AddUserSecrets(this IConfigurationBuilder configuration, Assembly assembly)
=> configuration.AddUserSecrets(assembly, optional: false, reloadOnChange: false);
=> configuration.AddUserSecrets(assembly, optional: true, reloadOnChange: false);

/// <summary>
/// <para>
Expand Down
10 changes: 5 additions & 5 deletions ...raries/Microsoft.Extensions.Configuration.UserSecrets/tests/ConfigurationExtensionTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,23 @@ public void AddUserSecrets_FindsAssemblyAttributeFromType()
public void AddUserSecrets_ThrowsIfAssemblyAttributeFromType()
{
var ex = Assert.Throws<InvalidOperationException>(() =>
new ConfigurationBuilder().AddUserSecrets<string>());
new ConfigurationBuilder().AddUserSecrets<string>(optional: false));
Assert.Equal(SR.Format(SR.Error_Missing_UserSecretsIdAttribute, typeof(string).Assembly.GetName().Name),
ex.Message);

ex = Assert.Throws<InvalidOperationException>(() =>
new ConfigurationBuilder().AddUserSecrets(typeof(JObject).Assembly));
new ConfigurationBuilder().AddUserSecrets(typeof(JObject).Assembly, optional: false));
Assert.Equal(SR.Format(SR.Error_Missing_UserSecretsIdAttribute, typeof(JObject).Assembly.GetName().Name),
ex.Message);
}


[Fact]
public void AddUserSecrets_DoesNotThrowsIfOptional()
public void AddUserSecrets_DoesNotThrowsIfOptionalByDefault()
{
var config = new ConfigurationBuilder()
.AddUserSecrets<string>(optional: true)
.AddUserSecrets(typeof(List<>).Assembly, optional: true)
.AddUserSecrets<string>()
.AddUserSecrets(typeof(List<>).Assembly)
.Build();

Assert.Empty(config.AsEnumerable());
Expand Down