-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Update integration-tests with info about test configuration overrides #37291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Youssef1313
wants to merge
1
commit into
main
Choose a base branch
from
dev/ygerges/test-config
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+64
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -181,6 +181,70 @@ The [EF-Core in-memory database provider](/ef/core/testing/choosing-a-testing-st | |||||
|
|
||||||
| See [Extend Startup with startup filters](xref:fundamentals/startup#IStartupFilter) which shows how to configure middleware using <xref:Microsoft.AspNetCore.Hosting.IStartupFilter>, which is useful when a test requires a custom service or middleware. | ||||||
|
|
||||||
| ## Customize the `WebApplicationFactory` with test configurations | ||||||
|
|
||||||
| There are various ways to supply test-specific configurations to the running web application via `WebApplicationFactory`. | ||||||
|
|
||||||
| 1. Using `ConfigureHostConfiguration`: override the `CreateHost` method and call `builder.ConfigureHostConfiguration` as follows: | ||||||
|
|
||||||
| ```csharp | ||||||
| private static readonly KeyValuePair<string, string?>[] s_inMemorySettings = new KeyValuePair<string, string?>[] | ||||||
| { | ||||||
| new("TestConfigKey", "TestConfigValue"), | ||||||
| }; | ||||||
|
|
||||||
| protected override IHost CreateHost(IHostBuilder builder) | ||||||
| { | ||||||
| builder.ConfigureHostConfiguration(builder => | ||||||
| { | ||||||
| builder.AddInMemoryCollection(s_inMemorySettings); | ||||||
| }); | ||||||
| return base.CreateHost(builder); | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Using this approach, the configuration source added via `ConfigureHostConfiguration` will be enumerated before the entrypoint is called, and the configurations will be passed to the entrypoint via `args`. The actual configuration source isn't preserved. | ||||||
|
|
||||||
| > [!IMPORTANT] | ||||||
| > Make sure you pass `args` to `WebApplication.CreateBuilder` call. Otherwise, the configurations will not take effect. | ||||||
|
|
||||||
| 2. Using `ConfigureAppConfiguration`: override the `ConfigureWebHost` method and call `builder.`ConfigureAppConfiguration` as follows: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Removed extra backtick. |
||||||
|
|
||||||
| ```csharp | ||||||
| private static readonly KeyValuePair<string, string?>[] s_inMemorySettings = new KeyValuePair<string, string?>[] | ||||||
| { | ||||||
| new("TestConfigKey", "TestConfigValue"), | ||||||
| }; | ||||||
|
|
||||||
| protected override void ConfigureWebHost(IWebHostBuilder builder) | ||||||
| { | ||||||
| base.ConfigureWebHost(builder); | ||||||
| builder.ConfigureAppConfiguration(builder => | ||||||
| { | ||||||
| builder.AddInMemoryCollection(s_inMemorySettings); | ||||||
| }); | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Using this approach, the configuration source added via `ConfigureAppConfiguration` is preserved, but it's only available after the web application is built. If you try to access the configuration before `WebApplicationBuilder.Build` is called, the configurations will not be available. | ||||||
|
|
||||||
| 3. Starting in .NET 11 Preview 6, you can override a new `ConfigureHostApplicationBuilder` method as follows: | ||||||
|
|
||||||
| ```csharp | ||||||
| private static readonly KeyValuePair<string, string?>[] s_inMemorySettings = new KeyValuePair<string, string?>[] | ||||||
| { | ||||||
| new("TestConfigKey", "TestConfigValue"), | ||||||
| }; | ||||||
|
|
||||||
| protected override void ConfigureHostApplicationBuilder(IHostApplicationBuilder hostApplicationBuilder) | ||||||
| { | ||||||
| hostApplicationBuilder.Configuration.AddInMemoryCollection(s_inMemorySettings); | ||||||
| base.ConfigureHostApplicationBuilder(hostApplicationBuilder); | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Using this approach, the configuration source added via `ConfigureHostApplicationBuilder` is preserved, and is also available immediately after `WebApplication.CreateBuilder` returns. | ||||||
|
|
||||||
| ## Customize the client with WithWebHostBuilder | ||||||
|
|
||||||
| When additional configuration is required within a test method, <xref:Microsoft.AspNetCore.Mvc.Testing.WebApplicationFactory%601.WithWebHostBuilder%2A> creates a new `WebApplicationFactory` with an <xref:Microsoft.AspNetCore.Hosting.IWebHostBuilder> that is further customized by configuration. | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we could either say "
TEntryPointinstance" or "entry point". Elsewhere we use "entry point" so I will make this consistant.