Class BaseTestMethod

java.lang.Object

org.testng.internal.BaseTestMethod

All Implemented Interfaces:

Cloneable, IInstanceIdentity, IInvocationStatus, ITestNGMethod

Direct Known Subclasses:

ConfigurationMethod, FactoryMethod, TestNGMethod

public abstract class BaseTestMethod
extends Object
implements ITestNGMethod, IInvocationStatus, IInstanceIdentity

Superclass to represent both @Test and @Configuration methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	m_afterGroups
protected final IAnnotationFinder	m_annotationFinder
protected String[]	m_beforeGroups
protected AtomicInteger	m_currentInvocationCount
protected long	m_date
protected String[]	m_groups
protected String[]	m_groupsDependedUpon
protected String	m_id
protected final ConstructorOrMethod	m_method
protected final Class<?>	m_methodClass
protected String[]	m_methodsDependedUpon
protected final ITestObjectFactory	m_objectFactory
protected ITestClass	m_testClass	The test class on which the test method was found.

Constructor Summary

Constructors

Constructor	Description
BaseTestMethod(ITestObjectFactory objectFactory, String methodName, ConstructorOrMethod com, IAnnotationFinder annotationFinder, IObject.IdentifiableObject instance)

Method Summary

Modifier and Type	Method	Description
void	addFailedInvocationNumber(int number)	The list of invocation numbers that failed, which is only applicable for methods that have a data provider.
void	addMethodDependedUpon(String method)
boolean	canRunFromClass(IClass testClass)
abstract ITestNGMethod	clone()
Set<ITestNGMethod>	downstreamDependencies()
boolean	equals(Object obj)	Compares two BaseTestMethod using the test class then the associated Java Method.
Map<String,String>	findMethodParameters(XmlTest test)
String[]	getAfterGroups()
protected IAnnotationFinder	getAnnotationFinder()
String[]	getBeforeGroups()
ConstructorOrMethod	getConstructorOrMethod()
int	getCurrentInvocationCount()
long	getDate()
String	getDescription()
boolean	getEnabled()
IParameterInfo	getFactoryMethodParamsInfo()
List<Integer>	getFailedInvocationNumbers()
String[]	getGroups()
String[]	getGroupsDependedUpon()
String	getId()
Object	getInstance()
long[]	getInstanceHashCodes()	Needed for serialization.
UUID	getInstanceId()
int	getInterceptedPriority()
int	getInvocationCount()
List<Integer>	getInvocationNumbers()	Which invocation numbers of this method should be used (only applicable if it uses a data provider).
long	getInvocationTime()
long	getInvocationTimeOut()
String	getMethodName()	Returns the method name.
String[]	getMethodsDependedUpon()
String	getMissingGroup()
int	getParameterInvocationCount()
Class<?>[]	getParameterTypes()
int	getPriority()	The scheduling priority.
String	getQualifiedName()	getRealClass().getName() + "." + getMethodName()
Class<?>	getRealClass()
IRetryAnalyzer	getRetryAnalyzer(ITestResult result)
Class<? extends IRetryAnalyzer>	getRetryAnalyzerClass()
protected String	getSignature()
String	getSimpleName()
protected String[]	getStringArray(String[] methodArray, String[] classArray)
int	getSuccessPercentage()	Default value for successPercentage.
ITestClass	getTestClass()
int	getThreadPoolSize()
long	getTimeOut()
XmlTest	getXmlTest()
int	hashCode()	This implementation returns the associated Java Method's hash code.
boolean	hasMoreInvocation()
boolean	ignoreMissingDependencies()
void	incrementCurrentInvocationCount()
protected void	initBeforeAfterGroups(Class<? extends ITestOrConfiguration> annotationClass, String[] groups)
protected void	initGroups(Class<? extends ITestOrConfiguration> annotationClass)
boolean	isAfterClassConfiguration()
boolean	isAfterGroupsConfiguration()
boolean	isAfterMethodConfiguration()
boolean	isAfterSuiteConfiguration()
boolean	isAfterTestConfiguration()
boolean	isAlwaysRun()
boolean	isBeforeClassConfiguration()
boolean	isBeforeGroupsConfiguration()
boolean	isBeforeMethodConfiguration()
boolean	isBeforeSuiteConfiguration()
boolean	isBeforeTestConfiguration()
boolean	isTest()
protected void	setAlwaysRun(boolean alwaysRun)
void	setDate(long date)
void	setDescription(String description)
void	setDownstreamDependencies(Set<ITestNGMethod> methods)
void	setEnabled(boolean enabled)
protected void	setGroups(String[] groups)
protected void	setGroupsDependedUpon(String[] groups, Collection<String> xmlGroupDependencies)
void	setId(String id)
void	setIgnoreMissingDependencies(boolean i)
void	setInterceptedPriority(int priority)
void	setInvocationCount(int counter)	No-op.
void	setInvocationNumbers(List<Integer> numbers)
void	setInvocationTimeOut(long timeOut)
void	setInvokedAt(long date)
protected void	setMethodsDependedUpon(String[] methods)
void	setMissingGroup(String group)
void	setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)
void	setParameterInvocationCount(int n)
void	setPriority(int priority)
void	setRetryAnalyzerClass(Class<? extends IRetryAnalyzer> clazz)
void	setSkipFailedInvocations(boolean s)
void	setTestClass(ITestClass tc)	Sets the test class having this method.
void	setThreadPoolSize(int threadPoolSize)	No-op.
void	setTimeOut(long timeOut)
void	setUpstreamDependencies(Set<ITestNGMethod> methods)
void	setXmlTest(XmlTest xmlTest)
boolean	skipFailedInvocations()
String	toString()
Set<ITestNGMethod>	upstreamDependencies()

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ITestNGMethod

getAttributes, getDataProviderMethod, hasAfterGroupsConfiguration, hasBeforeGroupsConfiguration, isDataDriven, isIgnoreFailure

Field Details

m_testClass

protected ITestClass m_testClass

The test class on which the test method was found. Note that this is not necessarily the declaring class.

m_methodClass

protected final Class<?> m_methodClass

m_method

protected final ConstructorOrMethod m_method

m_id

protected String m_id

m_date

protected long m_date

m_annotationFinder

protected final IAnnotationFinder m_annotationFinder

m_groups

protected String[] m_groups

m_groupsDependedUpon

protected String[] m_groupsDependedUpon

m_methodsDependedUpon

protected String[] m_methodsDependedUpon

m_beforeGroups

protected String[] m_beforeGroups

m_afterGroups

protected String[] m_afterGroups

m_currentInvocationCount

protected AtomicInteger m_currentInvocationCount

m_objectFactory

protected final ITestObjectFactory m_objectFactory

Constructor Details

BaseTestMethod

public BaseTestMethod(ITestObjectFactory objectFactory,
 String methodName,
 ConstructorOrMethod com,
 IAnnotationFinder annotationFinder,
 IObject.IdentifiableObject instance)

Method Details

isAlwaysRun

public boolean isAlwaysRun()

Specified by:

isAlwaysRun in interface ITestNGMethod

Returns:

true if this method is alwaysRun=true

setAlwaysRun

protected void setAlwaysRun(boolean alwaysRun)

getRealClass

public Class<?> getRealClass()

Specified by:

getRealClass in interface ITestNGMethod

Returns:

The real class on which this method was declared (can be different from getMethod().getDeclaringClass() if the test method was defined in a superclass).

getTestClass

public ITestClass getTestClass()

Specified by:

getTestClass in interface ITestNGMethod

setTestClass

public void setTestClass(ITestClass tc)

Sets the test class having this method. This is not necessarily the declaring class.

Specified by:

setTestClass in interface ITestNGMethod

Parameters:

tc - The test class having this method.

getMethodName

public String getMethodName()

Returns the method name. This is needed for serialization because methods are not Serializable.

Specified by:

getMethodName in interface ITestNGMethod

Returns:

the method name.

getInstance

public Object getInstance()

Specified by:

getInstance in interface ITestNGMethod

getInstanceId

public UUID getInstanceId()

Specified by:

getInstanceId in interface IInstanceIdentity

Returns:

- A UUID that represents a unique id which is associated with every test class object.

getInstanceHashCodes

public long[] getInstanceHashCodes()

Needed for serialization.

Specified by:

getInstanceHashCodes in interface ITestNGMethod

Returns:

The hashcode of instances

getGroups

public String[] getGroups()

Specified by:

getGroups in interface ITestNGMethod

Returns:

the addition of groups defined on the class and on this method.

getGroupsDependedUpon

public String[] getGroupsDependedUpon()

Specified by:

getGroupsDependedUpon in interface ITestNGMethod

Returns:

The groups this method depends on, possibly added to the groups declared on the class.

getMethodsDependedUpon

public String[] getMethodsDependedUpon()

Specified by:

getMethodsDependedUpon in interface ITestNGMethod

Returns:

The methods this method depends on, possibly added to the methods declared on the class.

downstreamDependencies

public Set<ITestNGMethod> downstreamDependencies()

Specified by:

downstreamDependencies in interface ITestNGMethod

Returns:

- The set of methods that are dependent on the current method. This information can help in deciding what other TestNG methods will be skipped if the current method fails. If the current method is a configuration method, then an empty set is returned.

upstreamDependencies

public Set<ITestNGMethod> upstreamDependencies()

Specified by:

upstreamDependencies in interface ITestNGMethod

Returns:

- The set of methods upon which the current method has a dependency. This information can help in deciding what all TestNG methods need to pass before the current method can be executed. If the current method is a configuration method, then an empty set is returned.

setDownstreamDependencies

public void setDownstreamDependencies(Set<ITestNGMethod> methods)

setUpstreamDependencies

public void setUpstreamDependencies(Set<ITestNGMethod> methods)

isTest

public boolean isTest()

Specified by:

isTest in interface ITestNGMethod

Returns:

true if this method was annotated with @Test

isBeforeSuiteConfiguration

public boolean isBeforeSuiteConfiguration()

Specified by:

isBeforeSuiteConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and beforeSuite = true

isAfterSuiteConfiguration

public boolean isAfterSuiteConfiguration()

Specified by:

isAfterSuiteConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and afterSuite = true

isBeforeTestConfiguration

public boolean isBeforeTestConfiguration()

Specified by:

isBeforeTestConfiguration in interface ITestNGMethod

Returns:

true if this method is a @BeforeTest (@Configuration beforeTest=true)

isAfterTestConfiguration

public boolean isAfterTestConfiguration()

Specified by:

isAfterTestConfiguration in interface ITestNGMethod

Returns:

true if this method is an @AfterTest (@Configuration afterTest=true)

isBeforeGroupsConfiguration

public boolean isBeforeGroupsConfiguration()

Specified by:

isBeforeGroupsConfiguration in interface ITestNGMethod

isAfterGroupsConfiguration

public boolean isAfterGroupsConfiguration()

Specified by:

isAfterGroupsConfiguration in interface ITestNGMethod

isBeforeClassConfiguration

public boolean isBeforeClassConfiguration()

Specified by:

isBeforeClassConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and beforeClassMethod = true

isAfterClassConfiguration

public boolean isAfterClassConfiguration()

Specified by:

isAfterClassConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and beforeClassMethod = false

isBeforeMethodConfiguration

public boolean isBeforeMethodConfiguration()

Specified by:

isBeforeMethodConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and beforeTestMethod = true

isAfterMethodConfiguration

public boolean isAfterMethodConfiguration()

Specified by:

isAfterMethodConfiguration in interface ITestNGMethod

Returns:

true if this method was annotated with @Configuration and beforeTestMethod = false

getTimeOut

public long getTimeOut()

Specified by:

getTimeOut in interface ITestNGMethod

Returns:

The timeout in milliseconds.

setTimeOut

public void setTimeOut(long timeOut)

Specified by:

setTimeOut in interface ITestNGMethod

getInvocationCount

public int getInvocationCount()

Specified by:

getInvocationCount in interface ITestNGMethod

Returns:

the number of times this method needs to be invoked.

setInvocationCount

public void setInvocationCount(int counter)

No-op.

Specified by:

setInvocationCount in interface ITestNGMethod

getSuccessPercentage

public int getSuccessPercentage()

Default value for successPercentage.

Specified by:

getSuccessPercentage in interface ITestNGMethod

Returns:

the success percentage for this method (between 0 and 100).

getId

public String getId()

Specified by:

getId in interface ITestNGMethod

Returns:

The id of the thread this method was run in.

setId

public void setId(String id)

Specified by:

setId in interface ITestNGMethod

getDate

public long getDate()

Specified by:

getDate in interface ITestNGMethod

Returns:

Returns the date.

setDate

public void setDate(long date)

Specified by:

setDate in interface ITestNGMethod

Parameters:

date - The date to set.

canRunFromClass

public boolean canRunFromClass(IClass testClass)

Specified by:

canRunFromClass in interface ITestNGMethod

Parameters:

testClass - The test class

Returns:

true if this ITestNGMethod can be invoked from within IClass.

equals

public boolean equals(Object obj)

Compares two BaseTestMethod using the test class then the associated Java Method.

Overrides:

equals in class Object

hashCode

public int hashCode()

This implementation returns the associated Java Method's hash code.

Overrides:

hashCode in class Object

Returns:

the associated Java Method's hash code.

initGroups

protected void initGroups(Class<? extends ITestOrConfiguration> annotationClass)

initBeforeAfterGroups

protected void initBeforeAfterGroups(Class<? extends ITestOrConfiguration> annotationClass,
 String[] groups)

getAnnotationFinder

protected IAnnotationFinder getAnnotationFinder()

getSimpleName

public String getSimpleName()

getSignature

protected String getSignature()

toString

public String toString()

Overrides:

toString in class Object

getStringArray

protected String[] getStringArray(String[] methodArray,
 String[] classArray)

setGroups

protected void setGroups(String[] groups)

setGroupsDependedUpon

protected void setGroupsDependedUpon(String[] groups,
 Collection<String> xmlGroupDependencies)

setMethodsDependedUpon

protected void setMethodsDependedUpon(String[] methods)

addMethodDependedUpon

public void addMethodDependedUpon(String method)

Specified by:

addMethodDependedUpon in interface ITestNGMethod

getMissingGroup

public String getMissingGroup()

Specified by:

getMissingGroup in interface ITestNGMethod

Returns:

If a group was not found.

setMissingGroup

public void setMissingGroup(String group)

Specified by:

setMissingGroup in interface ITestNGMethod

getThreadPoolSize

public int getThreadPoolSize()

Specified by:

getThreadPoolSize in interface ITestNGMethod

Returns:

the number of threads to be used when invoking the method on parallel

setThreadPoolSize

public void setThreadPoolSize(int threadPoolSize)

No-op.

Specified by:

setThreadPoolSize in interface ITestNGMethod

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ITestNGMethod

getDescription

public String getDescription()

Specified by:

getDescription in interface ITestNGMethod

setEnabled

public void setEnabled(boolean enabled)

getEnabled

public boolean getEnabled()

Specified by:

getEnabled in interface ITestNGMethod

getBeforeGroups

public String[] getBeforeGroups()

Specified by:

getBeforeGroups in interface ITestNGMethod

getAfterGroups

public String[] getAfterGroups()

Specified by:

getAfterGroups in interface ITestNGMethod

incrementCurrentInvocationCount

public void incrementCurrentInvocationCount()

Specified by:

incrementCurrentInvocationCount in interface ITestNGMethod

getCurrentInvocationCount

public int getCurrentInvocationCount()

Specified by:

getCurrentInvocationCount in interface ITestNGMethod

setParameterInvocationCount

public void setParameterInvocationCount(int n)

Specified by:

setParameterInvocationCount in interface ITestNGMethod

getParameterInvocationCount

public int getParameterInvocationCount()

Specified by:

getParameterInvocationCount in interface ITestNGMethod

setMoreInvocationChecker

public void setMoreInvocationChecker(Callable<Boolean> moreInvocationChecker)

Specified by:

setMoreInvocationChecker in interface ITestNGMethod

hasMoreInvocation

public boolean hasMoreInvocation()

Specified by:

hasMoreInvocation in interface ITestNGMethod

clone

public abstract ITestNGMethod clone()

Specified by:

clone in interface ITestNGMethod

Overrides:

clone in class Object

getRetryAnalyzer

public IRetryAnalyzer getRetryAnalyzer(ITestResult result)

Specified by:

getRetryAnalyzer in interface ITestNGMethod

setRetryAnalyzerClass

public void setRetryAnalyzerClass(Class<? extends IRetryAnalyzer> clazz)

Specified by:

setRetryAnalyzerClass in interface ITestNGMethod

getRetryAnalyzerClass

public Class<? extends IRetryAnalyzer> getRetryAnalyzerClass()

Specified by:

getRetryAnalyzerClass in interface ITestNGMethod

skipFailedInvocations

public boolean skipFailedInvocations()

Specified by:

skipFailedInvocations in interface ITestNGMethod

setSkipFailedInvocations

public void setSkipFailedInvocations(boolean s)

Specified by:

setSkipFailedInvocations in interface ITestNGMethod

setInvocationTimeOut

public void setInvocationTimeOut(long timeOut)

getInvocationTimeOut

public long getInvocationTimeOut()

Specified by:

getInvocationTimeOut in interface ITestNGMethod

Returns:

The time under which all invocationCount methods need to complete by.

ignoreMissingDependencies

public boolean ignoreMissingDependencies()

Specified by:

ignoreMissingDependencies in interface ITestNGMethod

setIgnoreMissingDependencies

public void setIgnoreMissingDependencies(boolean i)

Specified by:

setIgnoreMissingDependencies in interface ITestNGMethod

getInvocationNumbers

public List<Integer> getInvocationNumbers()

Description copied from interface: ITestNGMethod

Which invocation numbers of this method should be used (only applicable if it uses a data provider). If this value is an empty list, use all the values returned from the data provider. These values are read from the XML file in the <include invocationNumbers="..."> tag.

Specified by:

getInvocationNumbers in interface ITestNGMethod

Returns:

The list of invocation numbers

setInvocationNumbers

public void setInvocationNumbers(List<Integer> numbers)

Specified by:

setInvocationNumbers in interface ITestNGMethod

getFailedInvocationNumbers

public List<Integer> getFailedInvocationNumbers()

Specified by:

getFailedInvocationNumbers in interface ITestNGMethod

addFailedInvocationNumber

public void addFailedInvocationNumber(int number)

Description copied from interface: ITestNGMethod

The list of invocation numbers that failed, which is only applicable for methods that have a data provider.

Specified by:

addFailedInvocationNumber in interface ITestNGMethod

Parameters:

number - The invocation number that failed

getPriority

public int getPriority()

Description copied from interface: ITestNGMethod

The scheduling priority. Lower priorities get scheduled first.

Specified by:

getPriority in interface ITestNGMethod

Returns:

The priority value

setPriority

public void setPriority(int priority)

Specified by:

setPriority in interface ITestNGMethod

getInterceptedPriority

public int getInterceptedPriority()

Specified by:

getInterceptedPriority in interface ITestNGMethod

setInterceptedPriority

public void setInterceptedPriority(int priority)

Specified by:

setInterceptedPriority in interface ITestNGMethod

getXmlTest

public XmlTest getXmlTest()

Specified by:

getXmlTest in interface ITestNGMethod

Returns:

the XmlTest this method belongs to.

setXmlTest

public void setXmlTest(XmlTest xmlTest)

getConstructorOrMethod

public ConstructorOrMethod getConstructorOrMethod()

Specified by:

getConstructorOrMethod in interface ITestNGMethod

getParameterTypes

public Class<?>[] getParameterTypes()

Specified by:

getParameterTypes in interface ITestNGMethod

findMethodParameters

public Map<String,String> findMethodParameters(XmlTest test)

Specified by:

findMethodParameters in interface ITestNGMethod

Parameters:

test - - The XmlTest object.

Returns:

the parameters found in the include tag, if any

getQualifiedName

public String getQualifiedName()

Description copied from interface: ITestNGMethod

getRealClass().getName() + "." + getMethodName()

Specified by:

getQualifiedName in interface ITestNGMethod

Returns:

qualified name for this method

getFactoryMethodParamsInfo

public IParameterInfo getFactoryMethodParamsInfo()

Specified by:

getFactoryMethodParamsInfo in interface ITestNGMethod

Returns:

- A IParameterInfo object that represents details about the parameters associated with the factory method.

setInvokedAt

public void setInvokedAt(long date)

Specified by:

setInvokedAt in interface IInvocationStatus

Parameters:

date - - The timestamp at which a method was invoked.

getInvocationTime

public long getInvocationTime()

Specified by:

getInvocationTime in interface IInvocationStatus

Returns:

- The timestamp at which a method got invoked.