[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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
carlossanlop merged 6 commits into from
Sep 19, 2023
Merged

[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order #92257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d36ebdd
Fix Named parameters bug
buyaa-n Sep 12, 2023
f0760c8
Test the generator only, don't compare generated file row by row
buyaa-n Sep 14, 2023
ab9294c
Add other named parameter combinatios for other overloads in the test…
buyaa-n Sep 15, 2023
fe91e49
Adjust line numbers with source generator updates
buyaa-n Sep 15, 2023
a5654db
Move similar code section into helper method, don't exact exact line …
buyaa-n Sep 15, 2023
d656432
Apply feedbacks
buyaa-n Sep 18, 2023
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
19 changes: 16 additions & 3 deletions src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
_ => throw new InvalidOperationException()
};

IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
{
return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
};
}

private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
{
foreach (var argument in arguments)
{
if (argument.Parameter?.Ordinal == parameterIndex)
{
return argument;
}
}

throw new InvalidOperationException();
}

private void ParseGetInvocation(BinderInvocation invocation)
{
IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
}
else
{
ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
type = typeOfOperation?.TypeOperand;

if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
return;
}

ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
type = typeOfOperation?.TypeOperand;

if (paramCount is 3)
Expand Down
2 changes: 1 addition & 1 deletion ...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
/// <summary>
/// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
/// Ensure that we don't emit root interceptors to handle types/members that
/// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
/// are inaccessible to the generated helpers. Tests for inaccessible transitive members
/// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
/// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
/// </summary>
Expand Down
75 changes: 75 additions & 0 deletions ...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
public async Task Configure_T_name_BinderOptions() =>
await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

[Theory]
[InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
[InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
[InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
[InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
[InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
public async Task Configure_T_NamedParameters_OutOfOrder(string row)
{
string source = $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

public class Program
{
public static void Main()
{
ConfigurationBuilder configurationBuilder = new();
IConfiguration config = configurationBuilder.Build();
IConfigurationSection section = config.GetSection("MySection");
ServiceCollection services = new();

{{row}}
}

public class MyClass
{
public string MyString { get; set; }
public int MyInt { get; set; }
public List<int> MyList { get; set; }
public Dictionary<string, string> MyDictionary { get; set; }
}
}
""";

await VerifyThatSourceIsGenerated(source);
}

[Theory]
[InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
[InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
[InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
public async Task Bind_T_NamedParameters_OutOfOrder(string row)
{
string source = $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

public class Program
{
public static void Main()
{
ConfigurationBuilder configurationBuilder = new();
IConfiguration config = configurationBuilder.Build();
var services = new ServiceCollection();
OptionsBuilder<MyClass> optionsBuilder = new(services, "");

{{row}}
}

public class MyClass
{
public string MyString { get; set; }
public int MyInt { get; set; }
public List<int> MyList { get; set; }
public Dictionary<string, string> MyDictionary { get; set; }
}
}
""";

await VerifyThatSourceIsGenerated(source);
}

private string GetBindSource(string? configureActions = null) => $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;
Expand Down
106 changes: 106 additions & 0 deletions ...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
public async Task Bind() =>
await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

[Theory]
[InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
[InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
[InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
[InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
[InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
public async Task Bind_NamedParameters_OutOfOrder(string row)
{
string source = $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;

public class Program
{
public static void Main()
{
ConfigurationBuilder configurationBuilder = new();
IConfigurationRoot config = configurationBuilder.Build();

MyClass configObj = new();
{{row}}
}

public class MyClass
{
public string MyString { get; set; }
public int MyInt { get; set; }
public List<int> MyList { get; set; }
public Dictionary<string, string> MyDictionary { get; set; }
}
}
""";

await VerifyThatSourceIsGenerated(source);
}

[Theory]
[InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
[InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
[InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
[InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
{
string source = $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;

public class Program
{
public static void Main()
{
ConfigurationBuilder configurationBuilder = new();
IConfigurationRoot config = configurationBuilder.Build();

MyClass configObj = new();
{{row}}
}

public class MyClass
{
public string MyString { get; set; }
public int MyInt { get; set; }
public List<int> MyList { get; set; }
public Dictionary<string, string> MyDictionary { get; set; }
}
}
""";

await VerifyThatSourceIsGenerated(source);
}

[Theory]
[InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
[InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
[InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
[InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
[InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
[InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
public async Task GetValue_NamedParametersOutOfOrder(string row)
{
string source = $$"""
using System.Collections.Generic;
using Microsoft.Extensions.Configuration;

public class Program
{
public static void Main()
{
ConfigurationBuilder configurationBuilder = new();
IConfigurationRoot config = configurationBuilder.Build();
{{row}}
}

public class MyClass
{
public string MyString { get; set; }
public int MyInt { get; set; }
public List<int> MyList { get; set; }
public Dictionary<string, string> MyDictionary { get; set; }
}
}
""";

await VerifyThatSourceIsGenerated(source);
}

[Fact]
public async Task Bind_Instance()
{
Expand Down
8 changes: 8 additions & 0 deletions ...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
ServiceCollection,
}

private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
{
var (d, r) = await RunGenerator(testSourceCode);
Assert.Equal(1, r.Length);
Assert.Empty(d);
Assert.True(r[0].SourceText.Lines.Count > 10);
}

private static async Task VerifyAgainstBaselineUsingFile(
string filename,
string testSourceCode,
Expand Down
17 changes: 17 additions & 0 deletions ...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
)
;
}

[Fact]
public void TestBindAndConfigureWithNamedParameters()
{
OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
IServiceCollection services = new ServiceCollection();

OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
}
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order#92257

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

carlossanlop
merged 6 commits into

from

Sep 19, 2023
 Merged


[release/8.0] Fix: Config binder generator doesn't generate code when named arguments are out of order
#92257
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
d36ebdd

Fix Named parameters bug


buyaa-n Sep 12, 2023
f0760c8

Test the generator only, don't compare generated file row by row


buyaa-n Sep 14, 2023
ab9294c

Add other named parameter combinatios for other overloads in the test…


buyaa-n Sep 15, 2023
fe91e49

Adjust line numbers with source generator updates


buyaa-n Sep 15, 2023
a5654db

Move similar code section into helper method, don't exact exact line …


buyaa-n Sep 15, 2023
d656432

Apply feedbacks


buyaa-n Sep 18, 2023

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


19 changes: 16 additions & 3 deletions
src/libraries/Microsoft.Extensions.Configuration.Binder/gen/Parser/ConfigurationBinder.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -77,7 +77,7 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 _ => throw new InvalidOperationException()
 };

 IArgumentOperation instanceArg = operation.Arguments[instanceIndex];
 IArgumentOperation instanceArg = GetArgumentForParameterAtIndex(operation.Arguments, instanceIndex);
 if (instanceArg.Parameter.Type.SpecialType != SpecialType.System_Object)
 {
 return;
Expand DownExpand Up@@ -119,6 +119,19 @@ private void ParseBindInvocation_ConfigurationBinder(BinderInvocation invocation
 };
 }

 private static IArgumentOperation GetArgumentForParameterAtIndex(ImmutableArray<IArgumentOperation> arguments, int parameterIndex)
 {
 foreach (var argument in arguments)
 {
 if (argument.Parameter?.Ordinal == parameterIndex)
 {
 return argument;
 }
 }

 throw new InvalidOperationException();
 }

 private void ParseGetInvocation(BinderInvocation invocation)
 {
 IInvocationOperation operation = invocation.Operation!;
Expand DownExpand Up@@ -158,7 +171,7 @@ private void ParseGetInvocation(BinderInvocation invocation)
 }
 else
 {
 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 2)
Expand DownExpand Up@@ -218,7 +231,7 @@ private void ParseGetValueInvocation(BinderInvocation invocation)
 return;
 }

 ITypeOfOperation? typeOfOperation = operation.Arguments[1].ChildOperations.FirstOrDefault() as ITypeOfOperation;
 ITypeOfOperation? typeOfOperation = GetArgumentForParameterAtIndex(operation.Arguments, 1).ChildOperations.FirstOrDefault() as ITypeOfOperation;
 type = typeOfOperation?.TypeOperand;

 if (paramCount is 3)
Expand Down

2 changes: 1 addition & 1 deletion
...ns.Configuration.Binder/tests/SourceGenerationTests/ConfigurationBinderTests.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -317,7 +317,7 @@ internal class ClassWithThisIdentifier
 /// <summary>
 /// These are regression tests for https://github.com/dotnet/runtime/issues/90909.
 /// Ensure that we don't emit root interceptors to handle types/members that
 /// are inaccessible to the generated helpers. Tests for inaccessbile transitive members
 /// are inaccessible to the generated helpers. Tests for inaccessible transitive members
 /// are covered in the shared (reflection/src-gen) <see cref="ConfigurationBinderTests"/>,
 /// e.g. <see cref="NonPublicModeGetStillIgnoresReadonly"/>.
 /// </summary>
Expand Down

75 changes: 75 additions & 0 deletions
...ions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.Options.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,81 @@ public async Task Configure_T_BinderOptions() =>
 public async Task Configure_T_name_BinderOptions() =>
 await VerifyAgainstBaselineUsingFile("Configure_T_name_BinderOptions.generated.txt", GetConfigureSource(@""""", section, _ => { }"), extType: ExtensionClassType.ServiceCollection);

 [Theory]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", config: section, services: services);""")]
 [InlineData("OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, services: services);")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(configureBinder: _ => { }, config: section, name: "", services: services);""")]
 [InlineData("""OptionsConfigurationServiceCollectionExtensions.Configure<MyClass>(name: "", services: services, configureBinder: _ => { }, config: section);""")]
 public async Task Configure_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 IConfigurationSection section = config.GetSection("MySection");
 ServiceCollection services = new();

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: config, optionsBuilder: optionsBuilder);")]
 [InlineData("OptionsBuilderConfigurationExtensions.Bind(config: config, configureBinder: _ => { }, optionsBuilder: optionsBuilder);")]
 public async Task Bind_T_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfiguration config = configurationBuilder.Build();
 var services = new ServiceCollection();
 OptionsBuilder<MyClass> optionsBuilder = new(services, "");

 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 private string GetBindSource(string? configureActions = null) => $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;
Expand Down

106 changes: 106 additions & 0 deletions
...t.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Baselines.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,112 @@ public partial class ConfigurationBindingGeneratorTests
 public async Task Bind() =>
 await VerifyAgainstBaselineUsingFile("Bind.generated.txt", BindCallSampleCode, extType: ExtensionClassType.ConfigurationBinder);

 [Theory]
 [InlineData("ConfigurationBinder.Bind(instance: configObj, configuration: config);")]
 [InlineData("""ConfigurationBinder.Bind(key: "", instance: configObj, configuration: config);""")]
 [InlineData("""ConfigurationBinder.Bind(instance: configObj, key: "", configuration: config);""")]
 [InlineData("ConfigurationBinder.Bind(configureOptions: _ => { }, configuration: config, instance: configObj);")]
 [InlineData("ConfigurationBinder.Bind(configuration: config, configureOptions: _ => { }, instance: configObj);")]
 public async Task Bind_NamedParameters_OutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get<MyClass>(configureOptions: _ => { }, configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(configureOptions: _ => { }, type: typeof(MyClass), configuration: config);")]
 [InlineData("var obj = ConfigurationBinder.Get(type: typeof(MyClass), configureOptions: _ => { }, configuration: config);")]
 public async Task Get_TypeOf_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();

 MyClass configObj = new();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Theory]
 [InlineData("""var str = ConfigurationBinder.GetValue(key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(key: "key", defaultValue: "default", configuration: config);""")]
 [InlineData("""var str = ConfigurationBinder.GetValue<string>(configuration: config, key: "key", defaultValue: "default");""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", key: "key", configuration: config, type: typeof(string));""")]
 [InlineData("""var str = ConfigurationBinder.GetValue(defaultValue: "default", type: typeof(string), key: "key", configuration: config);""")]
 public async Task GetValue_NamedParametersOutOfOrder(string row)
 {
 string source = $$"""
 using System.Collections.Generic;
 using Microsoft.Extensions.Configuration;

 public class Program
 {
 public static void Main()
 {
 ConfigurationBuilder configurationBuilder = new();
 IConfigurationRoot config = configurationBuilder.Build();
 {{row}}
 }

 public class MyClass
 {
 public string MyString { get; set; }
 public int MyInt { get; set; }
 public List<int> MyList { get; set; }
 public Dictionary<string, string> MyDictionary { get; set; }
 }
 }
 """;

 await VerifyThatSourceIsGenerated(source);
 }

 [Fact]
 public async Task Bind_Instance()
 {
Expand Down

8 changes: 8 additions & 0 deletions
...oft.Extensions.Configuration.Binder/tests/SourceGenerationTests/GeneratorTests.Helpers.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,14 @@ private enum ExtensionClassType
 ServiceCollection,
 }

 private static async Task VerifyThatSourceIsGenerated(string testSourceCode)
 {
 var (d, r) = await RunGenerator(testSourceCode);
 Assert.Equal(1, r.Length);
 Assert.Empty(d);
 Assert.True(r[0].SourceText.Lines.Count > 10);
 }

 private static async Task VerifyAgainstBaselineUsingFile(
 string filename,
 string testSourceCode,
Expand Down

17 changes: 17 additions & 0 deletions
...figurationExtensions/tests/SourceGenerationTests/ConfigurationExtensionsTest.Generator.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,5 +156,22 @@ public void TestBindingInvocationsWithNewlines_StaticCalls()
 )
 ;
 }

 [Fact]
 public void TestBindAndConfigureWithNamedParameters()
 {
 OptionsBuilder<FakeOptions>? optionsBuilder = CreateOptionsBuilder();
 IServiceCollection services = new ServiceCollection();

 OptionsBuilderConfigurationExtensions.Bind(config: s_emptyConfig, optionsBuilder: optionsBuilder);
 OptionsBuilderConfigurationExtensions.Bind(configureBinder: _ => { }, config: s_emptyConfig, optionsBuilder: optionsBuilder);

 OptionsBuilderConfigurationExtensions.BindConfiguration(configureBinder: _ => { }, configSectionPath: "path", optionsBuilder: optionsBuilder);

 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(configureBinder: _ => { }, config: s_emptyConfig, services: services);
 OptionsConfigurationServiceCollectionExtensions.Configure<FakeOptions>(name: "", configureBinder: _ => { }, config: s_emptyConfig, services: services);
 }
 }
}