TestNG框架源码走读三：测试用例执行
TestNG框架源码走读一：入口
TestNG框架源码走读二：测试套执行
上一篇测试套执行主要介绍了SuiteRunner类的实例化，以及SuiteRunner#run()->SuiteRunner#runSequentially()实现测试套执行，但是SuiteRunner.testRunners是如何赋值的？
一、TestRunner实例化
1.想了解SuiteRunner.testRunners的初始化过程，可以通过IDE看下SuiteRunner.testRunners的调用情况，然后跳转过去看看：
2.SuiteRunner#init()中调用了testRunners.add(tr)，查看SuiteRunner#init()的调用情况，是SuiteRunner的构造器方法调用了SuiteRunner#init()进行SuiteRunner的初始化：
3.SuiteRunner在初始化的时候，调用了SuiteRunner#init实现了测试套下TestRunner的实例化，这是在上一篇：SuiteRunner实例化中略过的地方：
查看SuiteRunner#init源码中关于TestRunner初始化的部分：
for (XmlTest test : xmlTests) {
// 1.通过工厂方法实例化TestRunner
TestRunner tr = iTestRunnerFactory.newTestRunner(this, test, invokedMethodListeners.values(),
Lists.newArrayList(this.classListeners.values()), this.dataProviderListeners);
// 2.方法拦截器安装
for (IMethodInterceptor methodInterceptor : localMethodInterceptors) {
tr.addMethodInterceptor(methodInterceptor);
}
// 3.textReporter用于收集聚合用例执行情况（和newTestRunner里面的TestHTMLReporter/JUnitXMLReporter区别是？可以看下代码）
tr.addListener(textReporter);
testRunners.add(tr);
// 4.添加找到的测试方法（@Test注解标注的方法）
allTestMethods.addAll(Arrays.asList(tr.getAllTestMethods()));
}
iTestRunnerFactory.newTestRunner()有2个实现，分别是DefaultTestRunnerFactory#newTestRunner()和ProxyTestRunnerFactory#newTestRunner()，我们举例看下DefaultTestRunnerFactory#newTestRunner()的代码：
@Override
public TestRunner newTestRunner(ISuite suite, XmlTest test,
Collection<IInvokedMethodListener> listeners, List<IClassListener> classListeners,
Map<Class<? extends IDataProviderListener>, IDataProviderListener> dataProviderListeners) {
TestRunner testRunner = new TestRunner(configuration, suite, test,
suite.getOutputDirectory(), suite.getAnnotationFinder(), skip,
listeners, classListeners, comparator, dataProviderListeners);
// 加载默认监听器（用于监听用例执行相关事件，生成测试报告），这里useDefaultListeners来自命令行参数-usedefaultlisteners，默认是true，具体可以看CommandLineArgs定义）
if (useDefaultListeners) {
testRunner.addListener(new TestHTMLReporter());
testRunner.addListener(new JUnitXMLReporter());
testRunner.addListener(new TextReporter(testRunner.getName(), TestRunner.getVerbose()));
}
// 可以通过查看定义看下failureGenerators是如何赋值的
for (ITestListener itl : failureGenerators) {
testRunner.addTestListener(itl);
}
// 配置类方法的监听器
for (IConfigurationListener cl : configuration.getConfigurationListeners()) {
testRunner.addConfigurationListener(cl);
}
return testRunner;
}
}
这里的监听器都是在SuiteRunner代码中对DefaultTestRunnerFactory初始化的时候透传进来的：
1.useDefaultListeners的值来自TestNG#configure()方法中的命令行参数解析，解析后的内容通过SuiteRunner实例化传入。
2.failureGenerators是在TestNG#addListener中赋值，在SuiteRunner实例化时传入
3.configuration来自TestNG#initializeConfiguration()方法初始化，在SuiteRunner实例化时传入。
DefaultTestRunnerFactory#newTestRunner()中调用了TestRunner的实例化方法
TestRunner testRunner = new TestRunner(configuration, suite, test,
suite.getOutputDirectory(), suite.getAnnotationFinder(), skip,
listeners, classListeners, comparator, dataProviderListeners);
和SuiteRunner实例化代码走读一样，我们暂时先略过TestRunner构造器方法中的内部实现，只要知道TestRunner在哪里进行实例化的即可
接下来回到第二节中的SuiteRunner#runSequentially()看下SuiteRunner如何实现测试用例的执行
二、SuiteRunner#runSequentially()执行测试用例
1.SuiteRunner#runSequentially()源码如下：
遍历SuiteRunner.testRunners，调用runTest执行每个用例
private void runSequentially() {
for (TestRunner tr : testRunners) {
runTest(tr);
}
}
2.SuiteRunner#runTest()源码如下：
private void runTest(TestRunner tr) {
// 调用TestRunner#run()方法实现用例的执行
tr.run();
// 拼装测试用例执行结果返回
ISuiteResult sr = new SuiteResult(xmlSuite, tr);
suiteResults.put(tr.getName(), sr);
}
3.TestRunner#run()源码如下：
/**
* The main entry method for TestRunner.
*
* This is where all the hard work is done:
* - Invoke configuration methods
* - Invoke test methods
* - Catch exceptions
* - Collect results
* - Invoke listeners
* - etc...
*/
public void run() {
// 用例执行前置处理
beforeRun();
try {
XmlTest test= getTest();
if(test.isJUnit()) {
// TestNG兼容Junit用例执行
privateRunJUnit();
}
else {
// TestNG用例执行
privateRun(test);
}
}
finally {
// 用例执行后置处理
afterRun();
}
}
TestRunner#beforeRun()主要做了2件事：
1.触发用例执行监听器ITestListener的onStart事件。 2.调用@BeforeTest方法。
TestRunner#afterRun()也做了2件事：
1.调用@AfterTest方法。 2.触发用例执行监听器ITestListener的onFinish事件。
TestRunner#privateRun()的源码如下：
/**
* Main method that create a graph of methods and then pass it to the
* graph executor to run them.
*/
private void privateRun(XmlTest xmlTest) {
boolean parallel = xmlTest.getParallel().isParallel();
{
int threadCount = parallel ? xmlTest.getThreadCount() : 1;
// 1.创建测试方法集合
DynamicGraph<ITestNGMethod> graph = DynamicGraphHelper.createDynamicGraph(intercept(m_allTestMethods),
getCurrentXmlTest());
if (parallel) {
// 并发执行用例
if (graph.getNodeCount() > 0) {
GraphThreadPoolExecutor<ITestNGMethod> executor =
new GraphThreadPoolExecutor<>("test=" + xmlTest.getName(), graph, this,
threadCount, threadCount, 0, TimeUnit.MILLISECONDS,
new LinkedBlockingQueue<Runnable>());
executor.run();
try {
long timeOut = m_xmlTest.getTimeOut(XmlTest.DEFAULT_TIMEOUT_MS);
executor.awaitTermination(timeOut, TimeUnit.MILLISECONDS);
executor.shutdownNow();
} catch (InterruptedException handled) {
handled.printStackTrace();
Thread.currentThread().interrupt();
}
}
} else {
// 串行执行用例
List<ITestNGMethod> freeNodes = graph.getFreeNodes();
if (graph.getNodeCount() > 0 && freeNodes.isEmpty()) {
throw new TestNGException("No free nodes found in:" + graph);
}
while (! freeNodes.isEmpty()) {
List<IWorker<ITestNGMethod>> runnables = createWorkers(freeNodes);
for (IWorker<ITestNGMethod> r : runnables) {
// 执行单个用例方法
r.run();
}
graph.setStatus(freeNodes, Status.FINISHED);
freeNodes = graph.getFreeNodes();
}
}
}
}
看DynamicGraph<ITestNGMethod> graph = DynamicGraphHelper.createDynamicGraph(intercept(m_allTestMethods), getCurrentXmlTest());
DynamicGraphHelper.createDynamicGraph是主要是用于用例执行调度，可以暂时不关注。
TestRunner#privateRun()的核心代码是:
List<IWorker<ITestNGMethod>> runnables = createWorkers(freeNodes);
for (IWorker<ITestNGMethod> r : runnables) {
r.run();
}
graph.setStatus(freeNodes, Status.FINISHED);
找一个TestNG用例单步调试看下：
步进后知道，调用的是TestMethodWorker#run()，源码如下：
/**
* Run all the ITestNGMethods passed in through the constructor.
*
* @see java.lang.Runnable#run()
*/
@Override
public void run() {
for (IMethodInstance testMthdInst : m_methodInstances) {
ITestNGMethod testMethod = testMthdInst.getMethod();
ITestClass testClass = testMethod.getTestClass();
invokeBeforeClassMethods(testClass, testMthdInst);
// Invoke test method
try {
invokeTestMethods(testMethod, testMthdInst.getInstance(), m_testContext);
} finally {
invokeAfterClassMethods(testClass, testMthdInst);
}
}
}
TestMethodWorker#run()主要干了3件事：
1. TestMethodWorker#invokeBeforeClassMethods()执行用例的@BeforeClass方法
2. TestMethodWorker#invokeTestMethods()执行用例方法本身
3. TestMethodWorker#invokeAfterClassMethods()执行用例的@AfterClass方法
TestMethodWorker#invokeTestMethods()源码如下：
protected void invokeTestMethods(ITestNGMethod tm, Object instance,
ITestContext testContext)
{
// 执行测试用例方法
List<ITestResult> testResults =
m_invoker.invokeTestMethods(tm,
m_suite,
m_parameters,
m_groupMethods,
instance,
testContext);
// 记录测试用例执行结果
if (testResults != null) {
m_testResults.addAll(testResults);
}
}
可以看到，通过调用m_invoker.invokeTestMethods()方法实现了测试用例方法的执行，并返回测试用例的执行结果。
TestNG关于测试用例的执行基本到此结束，但是还有疑问？
1.m_invoker.invokeTestMethods()如何实现用例方法的执行？
2.测试用例执行结果存储到m_testResults后下一步如何处理？
后续的代码走读中继续研究。
