TestNG框架源碼走讀二：測試套執(zhí)行

TestNG框架源碼走讀一：入口

上一篇主要走讀TestNG類的main函數入口伏钠，其中TestNG#runSuitesLocally()執(zhí)行測試套的方法有3個核心邏輯需要詳細走讀下代碼：
1.createSuiteRunners實現SuiteRunner的實例化北秽。
2.runSuiteSequentially實現測試套的串行執(zhí)行送漠。
3.populateSuiteGraph/GraphThreadPoolExecutor實現測試套批量并行執(zhí)行斩芭。

一、SuiteRunner實例化

在上一篇TestNG#runSuitesLocally()的源碼中：

TestNG#createSuiteRunners()的源碼如下：
核心邏輯是遞歸調用TestNG#createSuiteRunner()為每個測試套創(chuàng)建SuiteRunner實例：

  private void createSuiteRunners(SuiteRunnerMap suiteRunnerMap /* OUT */, XmlSuite xmlSuite) {
    // 根據命令行參數設置測試套的參數
    ......
    
    // 測試套下test的method-selector設置
    ......
    
    // createSuiteRunner(xmlSuite)為測試套創(chuàng)建執(zhí)行器
    suiteRunnerMap.put(xmlSuite, createSuiteRunner(xmlSuite));
    
    // 遞歸為測試套下的子測試套創(chuàng)建執(zhí)行器
    for (XmlSuite childSuite : xmlSuite.getChildSuites()) {
      createSuiteRunners(suiteRunnerMap, childSuite);
    }
  }

TestNG#createSuiteRunner()的源碼如下：
1.調用SuiteRunner的構造器方法獲得實例化對象result蹦玫。
2.向result賦值測試套的一些監(jiān)聽器實例烟馅。
3.最終返回result對象，完成SuiteRunner對象的創(chuàng)建康辑。

  private SuiteRunner createSuiteRunner(XmlSuite xmlSuite) {
    // SuiteRunner的實例化
    SuiteRunner result = new SuiteRunner(getConfiguration(), xmlSuite,
        m_outputDir,
        m_testRunnerFactory,
        m_useDefaultListeners,
        m_methodInterceptors,
        m_invokedMethodListeners.values(),
        m_testListeners.values(),
        m_classListeners.values());
    
    // 添加測試套的開始/結束事件監(jiān)聽器
    for (ISuiteListener isl : m_suiteListeners.values()) {
      result.addListener(isl);
    }

    // 添加報告生成的監(jiān)聽器摄欲，所有測試套執(zhí)行結束時調用（Listener的調用代碼在TestNG#run()中）
    for (IReporter r : result.getReporters()) {
      maybeAddListener(m_reporters, r.getClass(), r, true);
    }

    // 
    for (IConfigurationListener cl : m_configuration.getConfigurationListeners()) {
      result.addConfigurationListener(cl);
    }

    return result;
  }

上面就是SuiteRunner的實例化過程，具體SuiteRunner構造器方法中干了什么先略過疮薇，繼續(xù)看看為測試套創(chuàng)建SuiteRunner實例后調用TestNG#runSuitesSequentially()如何實現測試套的執(zhí)行胸墙。

二、調用SuiteRunner.run()執(zhí)行測試套

1.走讀TestNG#runSuitesSequentially()的源碼按咒，發(fā)現調用鏈如下：TestNG#runSuitesSequentially()->SuiteRunnerWorker#runSuite()->SuiteRunner#run()迟隅，橫跨3個類后最終調用了SuiteRunner#run()

  // SuiteRunnerWorker#runSuite()源碼
  private void runSuite(SuiteRunnerMap suiteRunnerMap, XmlSuite xmlSuite)
  {
    SuiteRunner suiteRunner = (SuiteRunner) suiteRunnerMap.get(xmlSuite);
    suiteRunner.run();
  }

2.SuiteRunner.run()如何實現執(zhí)行測試套？
SuiteRunner#run()的源碼如下，主要就是調用SuiteRunner#privateRun()以及前后監(jiān)聽器方法智袭。

  @Override
  public void run() {
    invokeListeners(true /* start */);
    try {
      privateRun();
    }
    finally {
      invokeListeners(false /* stop */);
    }
  }

對照走讀的代碼注釋奔缠，SuiteRunner#privateRun()的源碼核心邏輯如下：

1.從SuiteRunner.testRunners中獲取測試套前置/后置方法
2.調用測試套前置方法
3.調用SuiteRunner#runSequentially()和SuiteRunner#runInParallelTestMode()執(zhí)行所有testRunner（用例執(zhí)行器）
4.調用測試套后置方法。

    private void privateRun() {

    // Map for unicity, Linked for guaranteed order
    Map<Method, ITestNGMethod> beforeSuiteMethods= new LinkedHashMap<>();
    Map<Method, ITestNGMethod> afterSuiteMethods = new LinkedHashMap<>();

    IInvoker invoker = null;

    // 1.從testRunner集合中獲取beforeSuite/afterSuite方法
    for (TestRunner tr: testRunners) {
      invoker = tr.getInvoker();
      
      for (ITestNGMethod m : tr.getBeforeSuiteMethods()) {
        beforeSuiteMethods.put(m.getConstructorOrMethod().getMethod(), m);
      }

      for (ITestNGMethod m : tr.getAfterSuiteMethods()) {
        afterSuiteMethods.put(m.getConstructorOrMethod().getMethod(), m);
      }
    }

    // 2.調用beforeSuite方法
    if (invoker != null) {
      if(! beforeSuiteMethods.values().isEmpty()) {
        invoker.invokeConfigurations(null,
            beforeSuiteMethods.values().toArray(new ITestNGMethod[beforeSuiteMethods.size()]),
            xmlSuite, xmlSuite.getParameters(), null, /* no parameter values */
            null /* instance */
        );
      }

      Utils.log("SuiteRunner", 3, "Created " + testRunners.size() + " TestRunners");

      // 3.執(zhí)行所有的test runners
      boolean testsInParallel = XmlSuite.ParallelMode.TESTS.equals(xmlSuite.getParallel());
      if (!testsInParallel) {
        runSequentially();
      }
      else {
        runInParallelTestMode();
      }

      // 4.調用afterSuite方法
      if (! afterSuiteMethods.values().isEmpty()) {
        invoker.invokeConfigurations(null,
              afterSuiteMethods.values().toArray(new ITestNGMethod[afterSuiteMethods.size()]),
            xmlSuite, xmlSuite.getAllParameters(), null, /* no parameter values */

              null /* instance */);
      }
    }

如果進一步深入吼野，需要了解：

SuiteRunner.testRunners是如何初始化的校哎？
beforeSuite/afterSuite方法取自testRunner的屬性，那么testRunner的m_beforeSuiteMethods/m_afterSuiteMethods是如何賦值的瞳步？
SuiteRunner#runSequentially()和SuiteRunner#runInParallelTestMode()內部實現如何闷哆？

這些是接下來需要了解的TestRunner如何實現測試套下用例的執(zhí)行。