This repository was archived by the owner on Dec 5, 2022. It is now read-only.
Specify Environment Variables in RunSettings RFC #202
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 |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # 0027 Specifying Environment Variables In RunSettings File | ||
|
|
||
| ## Summary | ||
| Specifying environment variables in the runsettings file. The environment variables can be set which can directly interact with the test host. | ||
|
|
||
| ## Motivation | ||
| Specifying environment variables in the runsettings file is necessary to support non-trivial projects that require settings env vars like DOTNET_ROOT. These variables are set while spawning the test host process, thus will be available in the host. | ||
|
|
||
| ## Usage | ||
| The runsettings contains a "EnvironmentVariables" node in the RunConfiguration section. | ||
| The different environment variables can be specified as element name and it's value. | ||
| Below is a sample runsettings for passing environment variables. | ||
|
|
||
| ```csharp | ||
|
|
||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <!-- File name extension must be .runsettings --> | ||
| <RunSettings> | ||
| <RunConfiguration> | ||
| <EnvironmentVariables> | ||
| <!-- List of environment variables we want to set--> | ||
| <DOTNET_ROOT>C:\ProgramFiles\dotnet</DOTNET_ROOT> | ||
| <SDK_PATH>C:\Codebase\Sdk</SDK_PATH> | ||
| </EnvironmentVariables> | ||
| </RunConfiguration> | ||
| </RunSettings> | ||
|
|
||
|
|
||
| ``` | ||
| Since these environment variables should always be set when the test host is started, the tests should always run in a separate process. | ||
| For this, the `/InIsolation` flag will be set when there are environment variables so that the test host is always invoked. | ||
|
Member
There was a problem hiding this comment. I think it makes sense to not set the InIsolation flag when env vars are set as others who aren't running in isolation want to use this feature as well, not for the testhost invocation but inside the test app.
Contributor
Author
There was a problem hiding this comment. In certain specific cases, we run the tests inside vstest.console process without starting the testhost process. Since we are planning to set the environment variables when starting the test host, these cases will not be encountered for. This flag will insure that the test host is launched with the correct variables.
Member
There was a problem hiding this comment. Can we support both cases?
|
||
|
|
||
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.
nit: do you usually use plural or singular? I.e. you have
RunSettings(plural) but alsoRunConfiguration(singular).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.
For the
EnvironmentVariables, it made sense to use plural to infer that multiple values are allowed.