EnvironmentAbstractions.TestHelpers 4.0.0

dotnet add package EnvironmentAbstractions.TestHelpers --version 4.0.0                
NuGet\Install-Package EnvironmentAbstractions.TestHelpers -Version 4.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EnvironmentAbstractions.TestHelpers" Version="4.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EnvironmentAbstractions.TestHelpers --version 4.0.0                
#r "nuget: EnvironmentAbstractions.TestHelpers, 4.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EnvironmentAbstractions.TestHelpers as a Cake Addin
#addin nuget:?package=EnvironmentAbstractions.TestHelpers&version=4.0.0

// Install EnvironmentAbstractions.TestHelpers as a Cake Tool
#tool nuget:?package=EnvironmentAbstractions.TestHelpers&version=4.0.0                

EnvironmentAbstractions.TestHelpers

Nuget (with prereleases)

Examples of MockEnvironmentProvider

The EnvironmentAbstractions.TestHelpers provides a helper implementation of IEnvironmentProvider which can be passed to classes to mock access to the environment.

By default, all existing values are set from the current environment.

[Fact]
public void MethodReturnsExpectedValue()
{
    IEnvironmentProvider environmentProvider = new MockEnvironmentProvider();
    
    MyClass instance = new MyClass(environmentProvider);

    string value = instance.Method();
}

To use an instance of the environment without any values already set, specify the useExistingEnvironmentValues parameter to the MockEnvironmentProvider constructor:

[Fact]
public void MethodReturnsExpectedValue()
{
    IEnvironmentProvider environmentProvider = new MockEnvironmentProvider(useExistingEnvironmentValues: false);

    // The only Environment property with a value will be UserName
    environmentProvider.UserName = "UserA";
}

To use an instance of the environment with existing environment variable values, specify the addExistingEnvironmentVariables parameter to the MockEnvironmentProvider constructor:

[Fact]
public void MethodReturnsExpectedValue()
{
    IEnvironmentProvider environmentProvider = new MockEnvironmentProvider(addExistingEnvironmentVariables: true);

    // All existing environment variables are set but UserName is overidden
    environmentProvider["UserName"] = "UserA";
}

Examples of MockEnvironmentVariableProvider

The EnvironmentAbstractions.TestHelpers provides a helper implementation of IEnvironmentVariableProvider which can be passed to classes to mock environment variable values.

Use a clean set of environment variables where only what is added is available

[Fact]
public void MethodReturnsExpectedValue()
{
    IEnvironmentVariableProvider environmentVariableProvider = new MockEnvironmentVariableProvider
    {
        ["Variable1"] = "Value1";
    };

    MyClass instance = new MyClass(environmentVariableProvider);

    string value = instance.Method();
}

To make all existing environment variables available, specify the addExistingEnvironmentVariables parameter to the MockEnvironmentVariableProvider constructor:

[Fact]
public void MethodReturnsExpectedValue()
{
    IEnvironmentVariableProvider environmentVariableProvider = new MockEnvironmentVariableProvider(addExistingEnvironmentVariables: true);

    environmentVariableProvider["UserName"] = @"User1";

    // Accessing environment variables returns actual values except %UserName% has been changed for just this test
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on EnvironmentAbstractions.TestHelpers:

Repository Stars
microsoft/slngen
Visual Studio solution generator
Version Downloads Last updated
4.0.0 78 5/28/2024
3.0.2 3,518 11/15/2023
2.1.0 399 9/26/2023