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.Engine.Extensibility.IFrameworkDriver Interface Reference

The IFrameworkDriver interface is implemented by a class that is able to use an external framework to explore or run tests under the engine. More...

+ Inheritance diagram for NUnit.Engine.Extensibility.IFrameworkDriver:

Public Member Functions

string Load (string testAssemblyPath, IDictionary< string, object > settings)
 Loads the tests in an assembly. More...
 
int CountTestCases (string filter)
 Count the test cases that would be executed. More...
 
string Run (ITestEventListener listener, string filter)
 Executes the tests in an assembly. More...
 
string Explore (string filter)
 Returns information about the tests in an assembly. More...
 
void StopRun (bool force)
 Cancel the ongoing test run. If no test is running, the call is ignored. More...
 

Properties

string ID [get, set]
 Gets and sets the unique identifier for this driver, used to ensure that test ids are unique across drivers. More...
 

Detailed Description

The IFrameworkDriver interface is implemented by a class that is able to use an external framework to explore or run tests under the engine.

Member Function Documentation

string NUnit.Engine.Extensibility.IFrameworkDriver.Load ( string  testAssemblyPath,
IDictionary< string, object >  settings 
)
int NUnit.Engine.Extensibility.IFrameworkDriver.CountTestCases ( string  filter)

Count the test cases that would be executed.

Parameters
filterAn XML string representing the TestFilter to use in counting the tests
Returns
The number of test cases counted

Implemented in NUnit.Engine.Drivers.NUnit2FrameworkDriver, NUnit.Engine.Drivers.NUnit3FrameworkDriver, and NUnit.Engine.Drivers.NotRunnableFrameworkDriver.

Referenced by NUnit.Engine.Drivers.Tests.NotRunnableFrameworkDriverTests.CountTestCases_ReturnsZero(), and NUnit.Engine.Runners.DirectTestRunner.CountTests().

string NUnit.Engine.Extensibility.IFrameworkDriver.Run ( ITestEventListener  listener,
string  filter 
)

Executes the tests in an assembly.

Parameters
listenerAn ITestEventHandler that receives progress notices
filterA XML string representing the filter that controls which tests are executed
Returns
An Xml string representing the result

Implemented in NUnit.Engine.Drivers.NUnit3FrameworkDriver, NUnit.Engine.Drivers.NUnit2FrameworkDriver, and NUnit.Engine.Drivers.NotRunnableFrameworkDriver.

Referenced by NUnit.Engine.Drivers.Tests.NotRunnableFrameworkDriverTests.Run_ReturnsNonRunnableSuite(), and NUnit.Engine.Runners.DirectTestRunner.RunTests().

string NUnit.Engine.Extensibility.IFrameworkDriver.Explore ( string  filter)

Returns information about the tests in an assembly.

Parameters
filterAn XML string representing the filter that controls which tests are included
Returns
An Xml string representing the tests

Implemented in NUnit.Engine.Drivers.NUnit3FrameworkDriver, NUnit.Engine.Drivers.NUnit2FrameworkDriver, and NUnit.Engine.Drivers.NotRunnableFrameworkDriver.

Referenced by NUnit.Engine.Drivers.Tests.NotRunnableFrameworkDriverTests.Explore_ReturnsNonRunnableSuite(), and NUnit.Engine.Runners.DirectTestRunner.ExploreTests().

void NUnit.Engine.Extensibility.IFrameworkDriver.StopRun ( bool  force)

Cancel the ongoing test run. If no test is running, the call is ignored.

Parameters
forceIf true, cancel any ongoing test threads, otherwise wait for them to complete.

Implemented in NUnit.Engine.Drivers.NUnit3FrameworkDriver, NUnit.Engine.Drivers.NUnit2FrameworkDriver, and NUnit.Engine.Drivers.NotRunnableFrameworkDriver.

Property Documentation

string NUnit.Engine.Extensibility.IFrameworkDriver.ID
getset

Gets and sets the unique identifier for this driver, used to ensure that test ids are unique across drivers.

Referenced by NUnit.Engine.Drivers.Tests.NotRunnableFrameworkDriverTests.CreateDriver(), and NUnit.Engine.Runners.DirectTestRunner.LoadPackage().


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