IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
NUnit.Common.PackageSettings Class Reference

PackageSettings is a static class containing constant values that are used as keys in setting up a TestPackage. These values are used in the engine and framework. Setting values may be a string, int or bool. More...

Public Attributes

const string DebugTests = "DebugTests"
 Flag (bool) indicating whether tests are being debugged. More...
 
const string PauseBeforeRun = "PauseBeforeRun"
 Flag (bool) indicating whether to pause execution of tests to allow the user to attache a debugger. More...
 
const string InternalTraceLevel = "InternalTraceLevel"
 The InternalTraceLevel for this run. Values are: "Default", "Off", "Error", "Warning", "Info", "Debug", "Verbose". Default is "Off". "Debug" and "Verbose" are synonyms. More...
 
const string WorkDirectory = "WorkDirectory"
 Full path of the directory to be used for work and result files. This path is provided to tests by the frameowrk TestContext. More...
 
const string ActiveConfig = "ActiveConfig"
 The name of the config to use in loading a project. If not specified, the first config found is used. More...
 
const string AutoBinPath = "AutoBinPath"
 Bool indicating whether the engine should determine the private bin path by examining the paths to all the tests. Defaults to true unless PrivateBinPath is specified. More...
 
const string BasePath = "BasePath"
 The ApplicationBase to use in loading the tests. If not specified, and each assembly has its own process, then the location of the assembly is used. For multiple assemblies in a single process, the closest common root directory is used. More...
 
const string ConfigurationFile = "ConfigurationFile"
 Path to the config file to use in running the tests. More...
 
const string DebugAgent = "DebugAgent"
 Bool flag indicating whether a debugger should be launched at agent startup. Used only for debugging NUnit itself. More...
 
const string DomainUsage = "DomainUsage"
 Indicates how to load tests across AppDomains. Values are: "Default", "None", "Single", "Multiple". Default is "Multiple" if more than one assembly is loaded in a process. Otherwise, it is "Single". More...
 
const string PrivateBinPath = "PrivateBinPath"
 The private binpath used to locate assemblies. Directory paths is separated by a semicolon. It's an error to specify this and also set AutoBinPath to true. More...
 
const string MaxAgents = "MaxAgents"
 The maximum number of test agents permitted to run simultneously. Ignored if the ProcessModel is not set or defaulted to Multiple. More...
 
const string ProcessModel = "ProcessModel"
 Indicates how to allocate assemblies to processes. Values are: "Default", "Single", "Separate", "Multiple". Default is "Multiple" for more than one assembly, "Separate" for a single assembly. More...
 
const string RuntimeFramework = "RuntimeFramework"
 Indicates the desired runtime to use for the tests. Values are strings like "net-4.5", "mono-4.0", etc. Default is to use the target framework for which an assembly was built. More...
 
const string RunAsX86 = "RunAsX86"
 Bool flag indicating that the test should be run in a 32-bit process on a 64-bit system. By default, NUNit runs in a 64-bit process on a 64-bit system. Ignored if set on a 32-bit system. More...
 
const string DisposeRunners = "DisposeRunners"
 Indicates that test runners should be disposed after the tests are executed More...
 
const string ShadowCopyFiles = "ShadowCopyFiles"
 Bool flag indicating that the test assemblies should be shadow copied. Defaults to false. More...
 
const string DefaultTimeout = "DefaultTimeout"
 Integer value in milliseconds for the default timeout value for test cases. If not specified, there is no timeout except as specified by attributes on the tests themselves. More...
 
const string InternalTraceWriter = "InternalTraceWriter"
 A TextWriter to which the internal trace will be sent. More...
 
const string LOAD = "LOAD"
 A list of tests to be loaded. More...
 
const string NumberOfTestWorkers = "NumberOfTestWorkers"
 The number of test threads to run for the assembly. If set to 1, a single queue is used. If set to 0, tests are executed directly, without queuing. More...
 
const string RandomSeed = "RandomSeed"
 The random seed to be used for this assembly. If specified as the value reported from a prior run, the framework should generate identical random values for tests as were used for that run, provided that no change has been made to the test assembly. Default is a random value itself. More...
 
const string StopOnError = "StopOnError"
 If true, execution stops after the first error or failure. More...
 
const string SynchronousEvents = "SynchronousEvents"
 If true, use of the event queue is suppressed and test events are synchronous. More...
 

Detailed Description

PackageSettings is a static class containing constant values that are used as keys in setting up a TestPackage. These values are used in the engine and framework. Setting values may be a string, int or bool.

Member Data Documentation

const string NUnit.Common.PackageSettings.DebugTests = "DebugTests"
const string NUnit.Common.PackageSettings.PauseBeforeRun = "PauseBeforeRun"

Flag (bool) indicating whether to pause execution of tests to allow the user to attache a debugger.

Referenced by NUnit.Engine.Runners.ProcessRunner.LoadPackage(), NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), and NUnit.Framework.Api.NUnitTestAssemblyRunner.StartRun().

const string NUnit.Common.PackageSettings.InternalTraceLevel = "InternalTraceLevel"

The InternalTraceLevel for this run. Values are: "Default", "Off", "Error", "Warning", "Info", "Debug", "Verbose". Default is "Off". "Debug" and "Verbose" are synonyms.

Referenced by NUnit.Framework.Api.FrameworkController.Initialize(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.WorkDirectory = "WorkDirectory"

Full path of the directory to be used for work and result files. This path is provided to tests by the frameowrk TestContext.

Referenced by NUnit.Framework.Api.NUnitTestAssemblyRunner.CreateTestExecutionContext(), NUnit.Framework.Api.FrameworkController.Initialize(), NUnitLite.TextRunner.MakeRunSettings(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.ActiveConfig = "ActiveConfig"

The name of the config to use in loading a project. If not specified, the first config found is used.

Referenced by NUnit.Engine.Services.ProjectService.ExpandProjectPackage(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.AutoBinPath = "AutoBinPath"

Bool indicating whether the engine should determine the private bin path by examining the paths to all the tests. Defaults to true unless PrivateBinPath is specified.

Referenced by NUnit.Engine.Services.DomainManager.GetPrivateBinPath().

const string NUnit.Common.PackageSettings.BasePath = "BasePath"

The ApplicationBase to use in loading the tests. If not specified, and each assembly has its own process, then the location of the assembly is used. For multiple assemblies in a single process, the closest common root directory is used.

Referenced by NUnit.Engine.Services.DomainManager.GetApplicationBase().

const string NUnit.Common.PackageSettings.ConfigurationFile = "ConfigurationFile"

Path to the config file to use in running the tests.

Referenced by NUnit.Engine.Services.ProjectService.ExpandProjectPackage(), and NUnit.Engine.Services.DomainManager.GetConfigFile().

const string NUnit.Common.PackageSettings.DebugAgent = "DebugAgent"

Bool flag indicating whether a debugger should be launched at agent startup. Used only for debugging NUnit itself.

Referenced by NUnit.Engine.Services.TestAgency.LaunchAgentProcess(), NUnit.Engine.Runners.ProcessRunner.LoadPackage(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.DomainUsage = "DomainUsage"

Indicates how to load tests across AppDomains. Values are: "Default", "None", "Single", "Multiple". Default is "Multiple" if more than one assembly is loaded in a process. Otherwise, it is "Single".

Referenced by NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), and NUnit.Engine.Services.InProcessTestRunnerFactory.MakeTestRunner().

const string NUnit.Common.PackageSettings.PrivateBinPath = "PrivateBinPath"

The private binpath used to locate assemblies. Directory paths is separated by a semicolon. It's an error to specify this and also set AutoBinPath to true.

Referenced by NUnit.Engine.Services.DomainManager.GetPrivateBinPath().

const string NUnit.Common.PackageSettings.MaxAgents = "MaxAgents"

The maximum number of test agents permitted to run simultneously. Ignored if the ProcessModel is not set or defaulted to Multiple.

Referenced by NUnit.Engine.Runners.MultipleTestProcessRunner.GetLevelOfParallelism(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.ProcessModel = "ProcessModel"

Indicates how to allocate assemblies to processes. Values are: "Default", "Single", "Separate", "Multiple". Default is "Multiple" for more than one assembly, "Separate" for a single assembly.

Referenced by NUnit.Engine.Services.DefaultTestRunnerFactory.GetTargetProcessModel(), NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), and NUnit.Engine.Runners.MasterTestRunner.ValidatePackageSettings().

const string NUnit.Common.PackageSettings.RuntimeFramework = "RuntimeFramework"

Indicates the desired runtime to use for the tests. Values are strings like "net-4.5", "mono-4.0", etc. Default is to use the target framework for which an assembly was built.

Referenced by NUnit.Engine.Services.TestAgency.LaunchAgentProcess(), NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), NUnit.Engine.Services.RuntimeFrameworkService.SelectRuntimeFramework(), and NUnit.Engine.Runners.MasterTestRunner.ValidatePackageSettings().

const string NUnit.Common.PackageSettings.RunAsX86 = "RunAsX86"

Bool flag indicating that the test should be run in a 32-bit process on a 64-bit system. By default, NUNit runs in a 64-bit process on a 64-bit system. Ignored if set on a 32-bit system.

Referenced by NUnit.Engine.Services.TestAgency.LaunchAgentProcess(), NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), and NUnit.Engine.Services.RuntimeFrameworkService.SelectRuntimeFramework().

const string NUnit.Common.PackageSettings.DisposeRunners = "DisposeRunners"

Indicates that test runners should be disposed after the tests are executed

Referenced by NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage(), and NUnit.Engine.Runners.AggregatingTestRunner.RunTests().

const string NUnit.Common.PackageSettings.ShadowCopyFiles = "ShadowCopyFiles"

Bool flag indicating that the test assemblies should be shadow copied. Defaults to false.

Referenced by NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.DefaultTimeout = "DefaultTimeout"

Integer value in milliseconds for the default timeout value for test cases. If not specified, there is no timeout except as specified by attributes on the tests themselves.

Referenced by NUnit.Framework.Api.NUnitTestAssemblyRunner.CreateTestExecutionContext(), NUnitLite.TextRunner.MakeRunSettings(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.InternalTraceWriter = "InternalTraceWriter"

A TextWriter to which the internal trace will be sent.

Referenced by NUnit.Framework.Api.FrameworkController.Initialize().

const string NUnit.Common.PackageSettings.LOAD = "LOAD"

A list of tests to be loaded.

Referenced by NUnit.Framework.Api.DefaultTestAssemblyBuilder.Build().

const string NUnit.Common.PackageSettings.NumberOfTestWorkers = "NumberOfTestWorkers"

The number of test threads to run for the assembly. If set to 1, a single queue is used. If set to 0, tests are executed directly, without queuing.

Referenced by NUnit.Framework.Api.FrameworkController.InsertSettingsElement(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.RandomSeed = "RandomSeed"

The random seed to be used for this assembly. If specified as the value reported from a prior run, the framework should generate identical random values for tests as were used for that run, provided that no change has been made to the test assembly. Default is a random value itself.

Referenced by NUnit.Framework.Api.NUnitTestAssemblyRunner.GetInitialSeed(), NUnitLite.TextRunner.MakeRunSettings(), and NUnit.ConsoleRunner.ConsoleRunner.MakeTestPackage().

const string NUnit.Common.PackageSettings.StopOnError = "StopOnError"
const string NUnit.Common.PackageSettings.SynchronousEvents = "SynchronousEvents"

If true, use of the event queue is suppressed and test events are synchronous.

Referenced by NUnit.Framework.Api.NUnitTestAssemblyRunner.StartRun().


The documentation for this class was generated from the following file: