FakeEnvironment Class

Summary

Represents a fake environment.
Namespace
Cake.Testing
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakeEnvironment"] click Interface0 "/api/Cake.Core/ICakeEnvironment" Type["FakeEnvironment"] class Type type-node

Syntax

public sealed class FakeEnvironment : ICakeEnvironment

Constructors

Name Summary
FakeEnvironment(PlatformFamily, bool) Initializes a new instance of the FakeEnvironment class.

Properties

Name Value Summary
ApplicationRoot DirectoryPath
Gets the application root path.
Platform FakePlatform
Gets the platform Cake is running on.
Runtime FakeRuntime
Gets the runtime Cake is running in.
WorkingDirectory DirectoryPath
Gets or sets the working directory.

Methods

Name Value Summary
ChangeOperatingSystemFamily(PlatformFamily) void
Change the operating system platform family.
ChangeOperativeSystemBitness(bool) void
Changes the operative system bitness.
CreateUnixEnvironment(bool) FakeEnvironment
Creates a Unix environment.
static
CreateWindowsEnvironment(bool) FakeEnvironment
Creates a Windows environment.
static
GetEnvironmentVariable(string) string
Gets an environment variable.
GetEnvironmentVariables() IDictionary<string, string>
Gets all environment variables.
GetSpecialPath(SpecialPath) DirectoryPath
Gets a special path.
SetBuiltFramework(FrameworkName) void
Sets the built framework.
SetCommandLineArgument(string, string) void
Sets a command line argument.
SetEnvironmentVariable(string, string) void
Sets an environment variable.
SetIsCoreClr(bool) void
Sets if is .NET Core CLR.
SetSpecialPath(SpecialPath, DirectoryPath) void
Sets a special path.

Extension Methods

Name Value Summary
Dump<FakeEnvironment>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ExpandEnvironmentVariables(string) string
Expands the environment variables in the provided text.
IsIn<FakeEnvironment>(FakeEnvironment[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<FakeEnvironment>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<FakeEnvironment>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<FakeEnvironment>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<FakeEnvironment>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin