nunit.engine.api TypeExtensionPointAttribute is used to bind an extension point to a class or interface. Construct a TypeExtensionPointAttribute, specifying the path. A unique string identifying the extension point. Construct an TypeExtensionPointAttribute, without specifying the path. The extension point will use a path constructed based on the interface or class to which the attribute is applied. The unique string identifying this ExtensionPoint. This identifier is typically formatted as a path using '/' and the set of extension points is sometimes viewed as forming a tree. An optional description of the purpose of the ExtensionPoint The ExtensionPropertyAttribute is used to specify named properties for an extension. Construct an ExtensionPropertyAttribute The name of the property The property value The name of the property. The property value The ExtensionAttribute is used to identify a class that is intended to serve as an extension. Initializes a new instance of the class. A unique string identifying the ExtensionPoint for which this Extension is intended. This is an optional field provided NUnit is able to deduce the ExtensionPoint from the Type of the extension class. An optional description of what the extension does. Flag indicating whether the extension is enabled. true if enabled; otherwise, false. The minimum Engine version for which this extension is designed ExtensionPointAttribute is used at the assembly level to identify and document any ExtensionPoints supported by the assembly. Construct an ExtensionPointAttribute A unique string identifying the extension point. The required Type of any extension that is installed at this extension point. The unique string identifying this ExtensionPoint. This identifier is typically formatted as a path using '/' and the set of extension points is sometimes viewed as forming a tree. The required Type (usually an interface) of any extension that is installed at this ExtensionPoint. An optional description of the purpose of the ExtensionPoint Interface implemented by a Type that knows how to create a driver for a test assembly. Gets a flag indicating whether a given AssemblyName represents a test framework supported by this factory. An AssemblyName referring to the possible test framework. Gets a driver for a given test assembly and a framework which the assembly is already known to reference. The domain in which the assembly will be loaded An AssemblyName referring to the test framework. Interface for the various project types that the engine can load. Gets the path to the file storing this project, if any. If the project has not been saved, this is null. Gets the active configuration, as defined by the particular project. Gets a list of the configs for this project Gets a test package for the primary or active configuration within the project. The package includes all the assemblies and any settings specified in the project format. A TestPackage Gets a TestPackage for a specific configuration within the project. The package includes all the assemblies and any settings specified in the project format. The name of the config to use A TestPackage for the named configuration. The IProjectLoader interface is implemented by any class that knows how to load projects in a specific format. Returns true if the file indicated is one that this loader knows how to load. The path of the project file True if the loader knows how to load this file, otherwise false Loads a project of a known format. The path of the project file An IProject interface to the loaded project or null if the project cannot be loaded Common interface for objects that process and write out test results Checks if the output path is writable. If the output is not writable, this method should throw an exception. Writes result to the specified output path. XmlNode for the result Path to which it should be written Writes result to a TextWriter. XmlNode for the result TextWriter to which it should be written The IFrameworkDriver interface is implemented by a class that is able to use an external framework to explore or run tests under the engine. Gets and sets the unique identifier for this driver, used to ensure that test ids are unique across drivers. Loads the tests in an assembly. An Xml string representing the loaded test Count the test cases that would be executed. An XML string representing the TestFilter to use in counting the tests The number of test cases counted Executes the tests in an assembly. An ITestEventHandler that receives progress notices A XML string representing the filter that controls which tests are executed An Xml string representing the result Returns information about the tests in an assembly. An XML string representing the filter that controls which tests are included An Xml string representing the tests Cancel the ongoing test run. If no test is running, the call is ignored. If true, cancel any ongoing test threads, otherwise wait for them to complete. An ExtensionPoint represents a single point in the TestEngine that may be extended by user addins and extensions. Gets the unique path identifying this extension point. Gets the description of this extension point. May be null. Gets the FullName of the Type required for any extension to be installed at this extension point. Gets an enumeration of IExtensionNodes for extensions installed on this extension point. The IExtensionNode interface is implemented by a class that represents a single extension being installed on a particular extension point. Gets the full name of the Type of the extension object. Gets a value indicating whether this is enabled. true if enabled; otherwise, false. Gets the unique string identifying the ExtensionPoint for which this Extension is intended. This identifier may be supplied by the attribute marking the extension or deduced by NUnit from the Type of the extension class. Gets an optional description of what the extension does. Gets a collection of the names of all this extension's properties Gets a collection of the values of a particular named property If none are present, returns an empty enumerator. The property name A collection of values Interface for logging within the engine Logs the specified message at the error level. The message. Logs the specified message at the error level. The message. The arguments. Logs the specified message at the warning level. The message. Logs the specified message at the warning level. The message. The arguments. Logs the specified message at the info level. The message. Logs the specified message at the info level. The message. The arguments. Logs the specified message at the debug level. The message. Logs the specified message at the debug level. The message. The arguments. InternalTraceLevel is an enumeration controlling the level of detailed presented in the internal log. Use the default settings as specified by the user. Do not display any trace messages Display Error messages only Display Warning level and higher messages Display informational and higher messages Display debug messages and higher - i.e. all messages Display debug messages and higher - i.e. all messages Interface implemented by objects representing a runtime framework. Gets the inique Id for this runtime, such as "net-4.5" Gets the display name of the framework, such as ".NET 4.5" Gets the framework version: usually contains two components, Major and Minor, which match the corresponding CLR components, but not always. Gets the Version of the CLR for this framework Gets a string representing the particular profile installed, or null if there is no profile. Currently. the only defined values are Full and Client. Interface that returns a list of available runtime frameworks. Gets a list of available runtime frameworks. IResultWriterService provides result writers for a specified well-known format. Gets an array of the available formats Gets a ResultWriter for a given format and set of arguments. The name of the format to be used A set of arguments to be used in constructing the writer or null if non arguments are needed An IResultWriter Implemented by a type that provides information about the current and other available runtimes. Returns true if the runtime framework represented by the string passed as an argument is available. A string representing a framework, like 'net-4.0' True if the framework is available, false if unavailable or nonexistent Selects a target runtime framework for a TestPackage based on the settings in the package and the assemblies themselves. The package RuntimeFramework setting may be updated as a result and the selected runtime is returned. A TestPackage The selected RuntimeFramework Enumeration representing the status of a service Service was never started or has been stopped Started successfully Service failed to start and is unavailable The IService interface is implemented by all Services. Although it is extensible, it does not reside in the Extensibility namespace because it is so widely used by the engine. The ServiceContext Gets the ServiceStatus of this service Initialize the Service Do any cleanup needed before terminating the service Interface to a TestFilterBuilder, which is used to create TestFilters Add a test to be selected The full name of the test, as created by NUnit Specify what is to be included by the filter using a where clause. A where clause that will be parsed by NUnit to create the filter. Get a TestFilter constructed according to the criteria specified by the other calls. A TestFilter. The TestFilterService provides builders that can create TestFilters Get an uninitialized TestFilterBuilder The exception that is thrown if a valid test engine is not found Initializes a new instance of the class. Initializes a new instance of the class. The minimum version. Interface to abstract getting loggers Gets the logger. The name of the logger to get. IServiceLocator allows clients to locate any NUnit services for which the interface is referenced. In normal use, this linits it to those services using interfaces defined in the nunit.engine.api assembly. Return a specified type of service Return a specified type of service Event handler for settings changes The sender. The instance containing the event data. Event argument for settings changes Initializes a new instance of the class. Name of the setting that has changed. Gets the name of the setting that has changed The ISettings interface is used to access all user settings and options. Occurs when the settings are changed. Load a setting from the storage. Name of the setting to load Value of the setting or null Load a setting from the storage or return a default value Name of the setting to load Value to return if the setting is missing Value of the setting or the default value Remove a setting from the storage Name of the setting to remove Remove an entire group of settings from the storage Name of the group to remove Save a setting in the storage Name of the setting to save Value to be saved ITestEngine represents an instance of the test engine. Clients wanting to discover, explore or run tests start require an instance of the engine, which is generally acquired from the TestEngineActivator class. Gets the IServiceLocator interface, which gives access to certain services provided by the engine. Gets and sets the directory path used by the engine for saving files. Some services may ignore changes to this path made after initialization. The default value is the current directory. Gets and sets the InternalTraceLevel used by the engine. Changing this setting after initialization will have no effect. The default value is the value saved in the NUnit settings. Initialize the engine. This includes initializing mono addins, setting the trace level and creating the standard set of services used in the Engine. This interface is not normally called by user code. Programs linking only to the nunit.engine.api assembly are given a pre-initialized instance of TestEngine. Programs that link directly to nunit.engine usually do so in order to perform custom initialization. Returns a test runner instance for use by clients in discovering, exploring and executing tests. The TestPackage for which the runner is intended. An ITestRunner. The ITestListener interface is used to receive notices of significant events while a test is running. It's single method accepts an Xml string, which may represent any event generated by the test framework, the driver or any of the runners internal to the engine. Use of Xml means that any driver and framework may add additional events and the engine will simply pass them on through this interface. Handle a progress report or other event. An XML progress report. Interface implemented by all test runners. Get a flag indicating whether a test is running Load a TestPackage for possible execution An XmlNode representing the loaded package. This method is normally optional, since Explore and Run call it automatically when necessary. The method is kept in order to make it easier to convert older programs that use it. Unload any loaded TestPackage. If none is loaded, the call is ignored. Reload the current TestPackage An XmlNode representing the loaded package. Count the test cases that would be run under the specified filter. A TestFilter The count of test cases Run the tests in the loaded TestPackage and return a test result. The tests are run synchronously and the listener interface is notified as it progresses. The listener that is notified as the run progresses A TestFilter used to select tests An XmlNode giving the result of the test execution Start a run of the tests in the loaded TestPackage. The tests are run asynchronously and the listener interface is notified as it progresses. The listener that is notified as the run progresses A TestFilter used to select tests Cancel the ongoing test run. If no test is running, the call is ignored. If true, cancel any ongoing test threads, otherwise wait for them to complete. Explore a loaded TestPackage and return information about the tests found. The TestFilter to be used in selecting tests to explore. An XmlNode representing the tests found. NUnitEngineException is thrown when the engine has been called with improper values or when a particular facility is not available. Construct with a message Construct with a message and inner exception Serialization constructor The IRecentFiles interface is used to isolate the app from various implementations of recent files. The max number of files saved Get a list of all the file entries The most recent file list Set the most recent file name, reordering the saved names as needed and removing the oldest if the max number of files would be exceeded. The current CLR version is used to create the entry. Remove a file from the list The name of the file to remove TestEngineActivator creates an instance of the test engine and returns an ITestEngine interface. Create an instance of the test engine. If private copy is false, the search order is the NUnit install directory for the current user, then the install directory for the local machine and finally the current AppDomain's ApplicationBase. if set to true loads the engine found in the application base directory, otherwise searches for the test engine with the highest version installed. Defaults to true. Thrown when a test engine of the required minimum version is not found An Create an instance of the test engine with a minimum version. If private copy is false, the search order is the NUnit install directory for the current user, then the install directory for the local machine and finally the current AppDomain's ApplicationBase. The minimum version of the engine to return inclusive. if set to true loads the engine found in the application base directory, otherwise searches for the test engine with the highest version installed. Defaults to true. Thrown when a test engine of the given minimum version is not found An Abstract base for all test filters. A filter is represented by an XmlNode with <filter> as it's topmost element. In the console runner, filters serve only to carry this XML representation, as all filtering is done by the engine. Initializes a new instance of the class. The XML text that specifies the filter. The empty filter - one that always passes. Gets the XML representation of this filter as a string. TestPackage holds information about a set of test files to be loaded by a TestRunner. Each TestPackage represents tests for one or more test files. TestPackages may be named or anonymous, depending on how they are constructed. Construct a named TestPackage, specifying a file path for the assembly or project to be used. The file path. Construct an anonymous TestPackage that wraps test files. Every test package gets a unique ID used to prefix test IDs within that package. The generated ID is only unique for packages created within the same AppDomain. For that reason, NUnit pre-creates all test packages that will be needed. Gets the name of the package Gets the path to the file containing tests. It may be an assembly or a recognized project type. Gets the list of SubPackages contained in this package Gets the settings dictionary for this package. Add a subproject to the package. The subpackage to be added Add a setting to a package and all of its subpackages. The name of the setting The value of the setting Once a package is created, subpackages may have been created as well. If you add a setting directly to the Settings dictionary of the package, the subpackages are not updated. This method is used when the settings are intended to be reflected to all the subpackages under the package. Return the value of a setting or a default. The name of the setting The default value The ITestRun class represents an ongoing test run. Get the result of the test. An XmlNode representing the test run result Blocks the current thread until the current test run completes or the timeout is reached A that represents the number of milliseconds to wait or -1 milliseconds to wait indefinitely. True if the run completed The IExtensionService interface allows a runner to manage extensions. Gets an enumeration of all ExtensionPoints in the engine. Gets an enumeration of all installed Extensions. Get an ExtensionPoint based on it's unique identifying path. Get an enumeration of ExtensionNodes based on their identifying path. Enable or disable an extension TestSelectionParserException is thrown when an error is found while parsing the selection expression. Construct with a message Construct with a message and inner exception Serialization constructor