Account for standard environment variable prefixes when simulating launch profile #7698
Conversation
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
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
src/Aspire.Hosting.Testing/DistributedApplicationFactory.cs:164
- Removing this default environment assignment may lead to unexpected behavior if no environment variable is provided in the launch profile. Please ensure that the intended default (Development) is set when neither a plain nor a prefixed environment variable is present.
hostBuilderOptions.EnvironmentName = Environments.Development;
tests/Aspire.Hosting.Testing.Tests/TestingBuilderTests.cs:110
- Consider adding tests that explicitly verify how environment variables with the 'DOTNET_' and 'ASPNETCORE_' prefixes propagate into configuration, ensuring that the precedence order (no prefix > DOTNET_ > ASPNETCORE_) is correctly enforced.
[Fact]
ReubenBond
commented
Feb 19, 2025
| @@ -162,7 +162,6 @@ private static void PreConfigureBuilderOptions( | |||
| }; | |||
| applicationOptions.Args = hostBuilderOptions.Args; | |||
|
|
|||
| hostBuilderOptions.EnvironmentName = Environments.Development; | |||
There was a problem hiding this comment.
EnvironmentName is nullable. When not set, it defaults to Production. Our launch profiles set it to Development. If there is no launch profile, therefore, the new behavior would be to set it to Production by default. This would most likely come up in the ad-hoc testing case where the developer has no app host specified (the overloads of DistributedApplicationTestingBuilder.CreateAsync(...) which do not accept a type arg)
eerhardt
reviewed
Feb 21, 2025
eerhardt
reviewed
Feb 21, 2025
eerhardt
reviewed
Feb 21, 2025
Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>
Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>
Merged
eerhardt
added a commit
that referenced
this pull request
Feb 21, 2025
These tests assumed that the test environment was always "development" which is no longer the case after #7698.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Environment variables prefixed with
DOTNET_orASPNETCORE_should be propagated into configuration in non-prefixed form. For example, settingDOTNET_ENVIRONMENT=Testingvia an environment variable should setENVIRONMENT=Testingin configuration.In the Aspire.Hosting.Testing package, we simulate loading the app host's launch profile, including environment variables. We do not set environment variables in the process since that would leak between concurrently running tests. Instead, we read the environment variables from the launch profile into configuration. This PR changes how we propagate the environment variables into configuration so that we check for those two well-known prefixes and flow them into configuration without those prefixes with the precedence order of no prefix >
DOTNET_>ASPNETCORE_.In particular, this allows setting the environment name from launch profile to work as expected.
Checklist
<remarks />and<code />elements on your triple slash comments?breaking-changetemplate):doc-ideatemplate):