【TestNG】xml套件的两种写法对比

如题，本文讲述TestNG中使用xml进行启动测试的两种方式

本文使用的TestNG版本为6.9.9

现在的后端绝大多数都是分布式架构，因此为了接口自动化框架分类看起来更加舒适，也更加的方便管理，一般接口自动化项目也会按照服务进行分包。

上边是两个服务，TestCase1和TestCase2是server1服务下的两条用例。
这时我们需要写xml套件有两种写法

• 总套件中直接写入包名，以packages形式加入
• 总套件中不写包名，将两个子套件嵌套写入总套件

写法一：直接写入包名

文件名称：tng-suite.xml

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd" >
<suite name="all-suite" parallel="classes" thread-count="2">
    <test name="all-suite">
        <packages>
            <package name="com.base.test.tng.testcase.server1"/>
            <package name="com.base.test.tng.testcase.server2"/>
        </packages>
    </test>
    <listeners>
        <listener class-name="com.base.test.tng.common.BaseSuitesListener"/>
    </listeners>
</suite>

写法二：写入套件文件信息

文件名称：tng-suite2.xml

<?xml version="1.0" encoding="utf-8"?>
<suite name="all-suite2" parallel="classes" thread-count="2">

    <suite-files>
        <suite-file path="suites/server1-suite.xml"/>
        <suite-file path="suites/server2-suite.xml"/>
    </suite-files>

    <listeners>
        <listener class-name="com.base.test.tng.common.BaseSuitesListener"/>
    </listeners>
</suite>

文件名：server1-suite.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd" >
<!-- parallel=classes 以类为最小单元进行多线程执行 -->
<!-- thread-count=2  2个线程来同时执行 -->
<suite name="server1" parallel="classes" thread-count="1">
    <test name="server1">
        <packages>
            <package name="com.base.test.tng.testcase.server1.*"/>
        </packages>
    </test>

    <listeners>
        <listener class-name="com.base.test.tng.common.SingleListener"/>
    </listeners>
</suite>

文件名：server2-suite.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd" >
<!-- parallel=classes 以类为最小单元进行多线程执行 -->
<!-- thread-count=2  2个线程来同时执行 -->
<suite name="server2" parallel="classes" thread-count="1">
    <test name="server2">
        <packages>
            <package name="com.base.test.tng.testcase.server2.*"/>
        </packages>
    </test>

    <listeners>
        <listener class-name="com.base.test.tng.common.SingleListener"/>
    </listeners>
</suite>

一、两种写法执行的结果

二、运行时的差异

两种写法从控制台结果来看并没有什么差异。但是我们可以发现

• 在子套件中设置了class级别的多线程执行时，套件嵌套的方式再次进行设置是不起作用的，是以子套件的设置为准。
• 写法一，直接写入包名的方式，是会影响到执行顺序的

三、监听器内执行次数和顺序差异

也是我写这个文章重点要讲的差异。
监听器代码很简单

public class AllSuitesListener implements IReporter, ISuiteListener {

    @Override
    public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory) {
        System.out.println("im generateReport");
    }

    @Override
    public void onStart(ISuite iSuite) {
        System.out.println("im start" + iSuite.getName());
    }

    @Override
    public void onFinish(ISuite iSuite) {
        System.out.println("im finish" + iSuite.getName());
    }
}

• 当我们直接写包名的时候，也就是第一种写法
  执行结果是：

im start all-suite
im finish all-suite
im generateReport

三个函数均会执行一次

• 如果我们使用第二种方式
  执行结果是：

im start server1
im finish server1
im start server2
im finish server2
im start all-suite2
im finish all-suite2
im generateReport

执行了三次start和finish！
也就是说，三个套件，执行了三次。

结论

• 总套件嵌套了两个子套件的写法，会先执行两个子套件的start和finish，然后再执行一个总套件的start和finish，最后执行一次generateReport
• 套件嵌套的写法，在总套件中写入多线程执行的信息是不生效的，取决于子套件的配置信息
• 套件嵌套的写法，虽然执行了三次，但是最后一次里边不会包含任何case信息，是空的（如果总套件中没有写入package配置）

因此，我们如果使用套件嵌套的方式去写xml，那最终收集测试结果的时候，一定要注意start和finish的执行次数。