TestNG-详解preserve-order的作用与测试case的执行顺序

野性酷女 2022-07-16 05:51 161阅读 0赞

在TestNG xml配置文件中，关于`<test>`的配置里面，有一个属性叫`preserve-order`，一开始以为这个属性可以用来控制测试case(那些被**@Test**注解标注的方法)的执行顺序，后来测试了一把，发现没有这种效果，最后上网找了一下这个属性的作用，发现它是用来控制`<test>`里面所有`<classes>`的执行顺序的。`<test>`默认下的`preserve-order`为`true`，表示`<test>`下所有`<classes>`顺序执行，eg:

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
    <suite name="Preserve order test runs">
      <test name="Regression 1" preserve-order="true">
        <classes>
          <class name="com.pack.preserve.ClassOne"/>
          <class name="com.pack.preserve.ClassTwo"/>
          <class name="com.pack.preserve.ClassThree"/>
        </classes>
      </test>
    </suite>

会依次执行`ClassOne`、`ClassTwo`、`ClassThree`的测试方法。

又如:

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
    <suite name="Preserve order test runs">
      <test name="Regression 1" preserve-order="true">
        <classes>
          <class name="com.pack.preserve.ClassTwo"/>
          <class name="com.pack.preserve.ClassThree"/>
          <class name="com.pack.preserve.ClassOne"/>
        </classes>
      </test>
    </suite>

会依次执行`ClassTwo`、`ClassThree`、`ClassOne`的测试方法。

**【注意】** 一个`<class>`类里面可能存在多个测试方法(被**@Test**注解的方法)，这些方法的执行顺序不受`preserve-order`控制。默认测试方法的执行顺序是按照方法名的字典序升序排序执行的。

**那么，对于需要按照一定顺序执行测试方法的需求，我们应该如何实现？**

有以下几种做法:

**(1) 使用`priority`指定执行顺序(默认值为0)，数值越小，越靠前执行**

eg:

@Test(priority = 0)
    public void testMethod1() {
    }
    
    @Test(priority = 1)
    public void testMethod2() {
    }
    
    @Test(priority = 2)
    public void testMethod3() {
    }

这样指定以后，将按照`testMethod1`、`testMethod2`、`testMethod3`顺序执行。

> 我们不推荐使用这种方式来指定测试方法的执行顺序。因为当你中间需要修改执行顺序的时候，会相当麻烦。而且，多个`<class>`的测试方法，如果指定了相同的`priority`，那么会产生与预期不一样的执行顺序，TestNG会先跑所有相同`priority`的测试方法，而不管你的测试方法是不是在同一个`<class>`里面。

**(2) 从方法名称做手脚**

因为默认执行顺序是按照方法名的字典序升序排序执行的。那么，有目的地去定制方法名称，就可以让方法按照我们要求的顺序执行，比如:

@Test
    public void B() {
    }
    
    @Test
    public void A() {
    }
    
    @Test
    public void C() {
    }

这样方法就会按照`A`、`B`、`C`顺序执行。

> 这种方式使得我们命名测试方法名称更加费劲，也不是最优的解决方案。

**(3) 在xml里面使用`<include>`指定需要执行的方法和顺序**

比如:

<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
    <suite name="Preserve order test runs">
      <test name="Regression 1" preserve-order="true">
        <classes>
          <class name="com.pack.preserve.ClassOne">
              <methods>
                  <include name="B" />
                  <include name="A" />
              </methods>
          </class>
        </classes>
      </test>
    </suite>

如上配置，`ClassOne`会执行两个测试方法，先执行`B`，然后执行`A`。

> 我们推荐使用这种方式来指定方法的执行顺序，因为这是最灵活并且最直观的。

参考:

[preserve-order-in-testng][]

[preserve-order-in-testng]: https://www.seleniumeasy.com/testng-tutorials/preserve-order-in-testng