org.testng
Interface ITestContext

All Superinterfaces:

IAttributes, Serializable

All Known Implementing Classes:

TestRunner

public interface ITestContext
extends IAttributes

This class defines a test context which contains all the information for a given test run. An instance of this context is passed to the test listeners so they can query information about their environment.

Author:

Cedric Beust, Aug 6, 2004, Alexandru Popescu

Method Summary

ITestNGMethod[]	getAllTestMethods()
XmlTest	getCurrentXmlTest()
Date	getEndDate() When this test stopped running.
String[]	getExcludedGroups()
Collection<ITestNGMethod>	getExcludedMethods()
IResultMap	getFailedButWithinSuccessPercentageTests()
IResultMap	getFailedConfigurations() Retrieves information about the failed configuration method invocations.
IResultMap	getFailedTests()
String	getHost()
String[]	getIncludedGroups()
String	getName() The name of this test.
String	getOutputDirectory()
IResultMap	getPassedConfigurations() Retrieves information about the successful configuration method invocations.
IResultMap	getPassedTests()
IResultMap	getSkippedConfigurations() Retrieves information about the skipped configuration method invocations.
IResultMap	getSkippedTests()
Date	getStartDate() When this test started running.
ISuite	getSuite()

Methods inherited from interface org.testng.IAttributes

getAttribute, getAttributeNames, removeAttribute, setAttribute

Method Detail

getName

String getName()

The name of this test.

getStartDate

Date getStartDate()

When this test started running.

getEndDate

Date getEndDate()

When this test stopped running.

getPassedTests

IResultMap getPassedTests()

Returns:

A list of all the tests that run successfully.

getSkippedTests

IResultMap getSkippedTests()

Returns:

A list of all the tests that were skipped

getFailedButWithinSuccessPercentageTests

IResultMap getFailedButWithinSuccessPercentageTests()

Returns:

A list of all the tests that failed but are being ignored because annotated with a successPercentage.

getFailedTests

IResultMap getFailedTests()

Returns:

A map of all the tests that passed, indexed by their ITextMethor.

See Also:

ITestNGMethod

getIncludedGroups

String[] getIncludedGroups()

Returns:

All the groups that are included for this test run.

getExcludedGroups

String[] getExcludedGroups()

Returns:

All the groups that are excluded for this test run.

getOutputDirectory

String getOutputDirectory()

Returns:

Where the reports will be generated.

getSuite

ISuite getSuite()

Returns:

The Suite object that was passed to the runner at start-up.

getAllTestMethods

ITestNGMethod[] getAllTestMethods()

Returns:

All the test methods that were run.

getHost

String getHost()

Returns:

The host where this test was run, or null if it was run locally. The returned string has the form: host:port

getExcludedMethods

Collection<ITestNGMethod> getExcludedMethods()

Returns:

All the methods that were not included in this test run.

getPassedConfigurations

IResultMap getPassedConfigurations()

Retrieves information about the successful configuration method invocations.

getSkippedConfigurations

IResultMap getSkippedConfigurations()

Retrieves information about the skipped configuration method invocations.

getFailedConfigurations

IResultMap getFailedConfigurations()

Retrieves information about the failed configuration method invocations.

getCurrentXmlTest

XmlTest getCurrentXmlTest()

Returns:

the current XmlTest.