testng.xml 配置大全

时间:2021-10-30 06:20:40

1.TestNG的运行方式如下:

1 With a testng.xml file           直接run as test suite
2 With ant 使用ant
3 From the command line 从命令行
4 IDE 直接在IDE中执行

在IDEA中直接运行的时候,需要说明的是:可以运行一个测试类,也可以单独运行一个测试的方法。

在IDEA里执行,只需要右键,点击 Run xxx 即可。 如果是在某一个方法的代码块里右键,出现的是 Run methodName ,即只运行当前的方法; 如果是在类的代码块里右键,出现的是 Run className ,即运行当前类中的所有Test方法; 也可以创建testng.xml,右键出现的 Run path/testng.xml ,即运行该配置文件中需要运行的方法。

2.TestNG常见的注解:

注解 描述
@DataProvider 为测试方法提供数据
@BeforeMethod 在每个测试方法 前 执行
@AfterMethod 在每个测试方法 后 执行
@BeforeClass 被注释的方法将在当前类的第一个测试方法调用前运行
@AfterClass 被注释的方法将在当前类的所有测试方法调用后运行
@BeforeGroups 被配置的方法将在列表中的gourp前运行。这个方法保证在第一个属于这些组的测试方法调用前立即执行
@BeforeTest 被注释的方法将在测试运行前运行
@AfterTest 被注释的方法将在测试运行后运行
@BeforeSuite 被注释的方法将在所有测试运行前运行
@AfterSuite 被注释的方法将在所有测试运行后运行

另外还有一些属性,

alwaysRun:对于每个bufore方法(beforeSuite, beforeTest, beforeTestClass 和 beforeTestMethod, 但是不包括 beforeGroups):
                   如果设置为true,被配置的方法将总是运行而不管它属于哪个组。
                   对于after方法(afterSuite, afterClass, ...): 如果设置为true,被配置的方法甚至在一个或多个先调用的方法失败或被忽略时也将运行。

dependsOnGroups:这个方法依赖的组列表

dependsOnMethod:这个方法依赖的方法列表

enabled:这个类的方法是否激活

groups:这个类或方法所属的分组列表

inheritGroups:如果设置为true,这个方法被属于在类级别被@Test annotation指定的组例如:

例如:
1 @Test(enabled = false) //表示该测试用例不被执行
2 public Object runTest() {
3 xxxxxx
4 }

3.testNG.xml配置详解:

testng.xml的基本格式可以在官网上查看,基本格式如下:

testng.xml 配置大全

以下详细XML结构规则

suite
--tests
----parameters
----groups
------definitions
------runs

----classes
--parameters

比较详细的结构如下:

testng.xml 配置大全
testng.xml 配置大全
 1 <test name="xxxx">
2   <!-- 参数定义的方法 -->
3   <parameter name="first-name" value="Cedric"/>
4
5   <!-- groups的用法,前提是需要存在classes的组,否则所有方法不被运行 -->
6   <groups>
7   <!-- 定义组中组的方法 -->
8     <define name="groups_name">
9       <include name="group1"/>
10       <include name="group2"/>
11     </define>
12
13     <run>
14       <!-- 此处用组名来区别 -->
15       <inclue name="groups_name" />
16       <exclue name="groups_name" />
17       </run>
18   </groups>
19
20   <!-- classes的用法,classes中包含类名,类名底下可以包含方法名或排除方法名 -->
21   <classes>
22     <class name="class1">
23       <methods>
24         <!-- 此处用方法名来区别 -->
25         <inclue name="method_name" />
26         <exclue name="method_name" />
27       </methods>
28     </class>
29   </classes>
30 </test>
testng.xml 配置大全
testng.xml 配置大全

具体的元素说明:

<suite>   testng.xml文档中最上层的元素
说明:一个xml文件只能有一个<suites>,,是一个xml文件的根级
<suite>由<test>和<parameters>组成
参数说明:
 
参数 说明 使用方法 参数值
name 必选项,<suite>的名字,将出现在reports里 name="XXX" suite名字
junit 是否执行Junit模式(识别setup()等) junit="true" true和false,默认false
verbose 控制台输出的详细内容等级,0-10级(0无,10最详细) verbose="5" 0到10
parallel 是否在不同的线程并行进行测试,要与thread-count配套使用 parallel="mehods" 详见表格下内容,默认false
parent-module 和Guice框架有关,只运行一次,创建一个parent injector给所有guice injectors  
guice-stage 和Guice框架有关 guice-stage="DEVELOPMENT" DEVELOPMENT,PRODUCTION,TOOL,默认"DEVELOPMENT"
configfailurepolicy 测试失败后是再次执行还是跳过,值skip和continue configfailurepolicy="skip" skip、continue,默认skip
thread-count 与parallel配套使用,线程池的大小,决定并行线程数量 thread-count="10" 整数,默认5
annotations 获取注解,值为javadoc时,使用JavaDoc的注释;否则用JDK5注释 annotations="javadoc" javadoc
time-out 设置parallel时,终止执行单元之前的等待时间(毫秒) time-out="10000" 整数,单位毫秒
skipfailedinvocationcounts 是否跳过失败的调用 skipfailedinvocationcounts="true" true和false,默认false
data-provider-thread-count 并发时data-provider的线程池数量 data-provider-thread-count="5" 整数
object-factory 一个实现IObjectFactory接口的类,实例化测试对象 object-factory="classname" 类名
allow-return-values 是否允许返回函数值 all-return-values="true" true和false
preserve-order 是否按照排序执行 preserve-order="true" true和false,默认true
group-by-instances 按照实例分组 group-by-instances="true" true和false,默认false
 
parallel
该参数的值false,methods,tests,classes,instances。默认false
parallel必须和thread-count配套使用,否则相当于无效参数,thread-count决定了并行测试时开启的线程数量
parallel="mehods"  TestNG将并行执行所有的测试方法在不同的线程里
parallel="tests"  TestNG将并行执行在同一个<test>下的所有方法在不同线程里
parallel="classes"  TestNG将并行执行在相同<class>下的方法在不同线程里
parallel="instances"  TestNG将并行执行相同实例下的所有方法在不同的县城里
 
parent-module和guice-stage和Guice框架有关,testNG 6对Guice框架提供了支持,我没用过这个框架,所以这两个参数没看懂╮(╯▽╰)╭
 
-<suite-file>
说明:引入外部的xml文件(地址由path参数决定,path必填项),将引入的xml与当前的xml文件一起使用
声明方法:
1 <suite-files>
2 <suite-file path="/path/suitefile1"></suite-file>
3 </suite-files>
 
-<test>
说明:一个<suite>下可以有多个<test>,可以通过<suite>的parallel="tests"来进行并行测试,必须和thread-count配套使用,否则是无效参数
<test>由<parameters>、<groups>、<classes>三部分组成
参数说明:
 
参数 说明 使用方法 参数值
name test的名字,将出现在报告里 name="testname" test的名字
junit 是否按照Junit模式运行 junit="true" true和false,默认false
verbose 控制台输出的详细内容等级,0-10级(0无,10最详细),不在报告显示 verbose="5" 0到10
parallel 是否在不同的线程并行进行测试,要与thread-count配套使用 parallel="mehods" 与suite的parallel一致,默认false
thread-count 与parallel配套使用,线程池的大小,决定并行线程数量 thread-count="10" 整数,默认5
annotations 获取注解,值为javadoc时,使用JavaDoc的注释;否则用JDK5注释 annotations="javadoc" javadoc
time-out 设置parallel时,终止执行单元之前的等待时间(毫秒) time-out="10000" 整数,单位毫秒
enabled 标记是否执行这个test enabled="true" true和false,默认true
skipfailedinvocationcounts 是否跳过失败的调用 skipfailedinvocationcounts="true" true和false,默认false
preserve-order 是否按照排序执行,如果是true,将按照xml文件中的顺序去执行 preserve-order="true" true和false,默认true
allow-return-values 是否允许返回函数值 all-return-values="true" true和false,默认false
 
--<parameter>
说明:提供测试数据,有name和value两个参数
声明方法:<parameter name = "parameter_name" value = "parameter_value "/>
testng.xml文件中的<parameter>可以声明在<suite>或者<test>级别,在<test>下的<parameter>会覆盖在<suite>下声明的同名变量
 
--<method-selectors>
说明:方法选择器定义了哪些类的方法需要去执行,类必须继承自org.testng.IMethodSelector
声明方法:
1 <method-selectors>
2 <method-selector>
3 <selector-class name="classname" priority="1"></selector-class>
4 <script language="java"></script> (language还可以用beanshell等)
5 </method-selector>
6 </method-selectors>
备注:<method-selectors>这个我没用过,所以了解,如果有错的欢迎指出来~
 
--<groups>
说明:要运行的组,可以自定义一个组,可以包括要执行的,还排除要执行的方法。必须和<classes>配套使用,从下面的类中找到对应名字的方法
<groups>由<difine>和<run>、<dependencies>三部分组成。<diffine>可以将group组成一个新组,包括要执行和不执行的大组;<run>要执行的方法;<dependencies>指定了某group需要依赖的group(比如下面的例子,group1需要依赖group2和group3先执行)。
声明方法:
testng.xml 配置大全
testng.xml 配置大全
 1 <groups>
2 <define name ="all">
3 <include name ="testgroup1"/>
4 <exclude name ="testgroup2'/>
5 </define>
6 <run>
7 <include name ="all"/>
8 <include name ="testmethod1"/>
9 <exclude name="testmethod2"/>
10 </run>
11 <dependencies>
12 <group name ="group1" depends-on="goup2 group3"/>
13 </dependencies>
14 </groups>
testng.xml 配置大全
testng.xml 配置大全
--<classes>
说明:方法选择器,要执行的方法写在这里,参数有name和priority。
注释:
1.<classes>下必须写要执行的<class>,否则不会执行任何内容,如果填写了class没有写methods,会按照填写的class的下的注释@Test去执行所有的方法
2.<classes>下的<methods>如果填写了<include>,那只会执行所填写的方法,没有填写的方法不会去执行
 
声明方法:
testng.xml 配置大全
testng.xml 配置大全
1 <classes>
2 <class name="要执行的class名">
3 <methods>
4 <include name ="要执行的方法名"></include>
5 </methods>
6 </class>
7 </classes>
testng.xml 配置大全
testng.xml 配置大全
 
--<packages>
说明:<packages>指定包名代替类名。查找包下的所有包含testNG annotation的类进行测试
声明方法:
testng.xml 配置大全
testng.xml 配置大全
1 <packages>
2 <package name="packagename"/>
3 <package name="packagename">
4 <include name="methodname"/>
5 <exclude name="methodname"/>
6 </package>
7 </packages>
testng.xml 配置大全
testng.xml 配置大全
 
<listener>
说明:指定listeners,这个class必须继承自org.testng.ITestNGListener。在java中使用@Listeners({com.example.MyListener.class,com.example.MyMethodInterceptor.class})的注释也可以有同样效果
声明方法:
1 <listeners>
2 <listener class-name="com.example.MyListener"/>
3 <listener class-name="com.example.MyMehodIntercepor"/>
4 </listeners>

(3)一个简单的testng.xml文档

testng.xml 配置大全
testng.xml 配置大全
 1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
3
4 <suite name="Suite" parallel="classes" thread-count="3">
5 <test verbose="2" preserve-order="true" name="TestDebug">
6
7 <classes>
8 <class name="com.hera.util.MathTest" />
9
10 </classes>
11 </test> <!-- Test -->
12 </suite> <!-- Suite -->
testng.xml 配置大全
testng.xml 配置大全

说明:  suite定义一个测试套件,可以设置是否使用多线程,可包含多个测试用例或者测试group

parallel = classes  每个测试用例class级别多线程

thread-count =3  线程数为5,可同时执行3个case
             preserve-order = true   classes和methods按照配置中的顺序执行,false为乱序执行。(If you want the classes and methods listed in this file to be run in an unpredictible order, set the preserve-order attribute to false

parameter 标签传递参数

4.TestNG参数化测试

testng提供测试数据的两个注释:@DataProvide和@Parameter
 
一、通过testng.xml中设置参数
(实际上testng.xml只是一个名字,可以起任何一个名字,只要是.xml文件,然后文件格式按照testng的文档格式DTD来就可以了)
testng.xml中的内容:
<?xml version="1.0" encoding="UTF-8" ?>
<suite name = "testngframetest">
    <parameter name="para" value="test_para1"/>
    <test name="测试参数赋值">
        <classes>
            <parameters>
                <parameter name="para1" value="test_para1"/>
                <parameter name="para2" value="test_para2"/>
            </parameters>
            <class name = "paramer">
                <methods>
                    <include name ="showparamer"></include>
                </methods>
            </class>
        </classes>
    </test>
</suite>
 
.java文件的测试用例中通过parameters获得数据
使用方法1:
@Test(parameters="para1")
public void testcase(String para1){
     具体的测试用例,参数中的para1自动获取@Test中声明的变量,读取的是testng的xml文件中声明的参数para1的value值
}
如果有多个参数,可以使用这种方式:@Test(parameters={"para1","para2"})
 
使用方法2:
@Parameter({"para1","para2"})
@Test
     具体的测试用例(参数@Parameter写在了@Test前面)
 
具体代码如下:
import org.testng.annotations.Test;
public class paramer {
    @Test(parameters ={"para1","para2"})
    public  void showparamer(String para11,String para22){
        System.out.println("testng获得的参数para1如下:"+para11);
        System.out.println("testng获得的参数para2如下:"+para22);;
    }
}
 
说明:
1.测试用例中设置的参数名随意,但是数量一定要和@Parameter中提供的数量一致,按照testng.xml中定义的顺序来取值的
2.<parameter>可以声明在<suite>或者<test>级别,在<test>下的<parameter>会覆盖在<suite>下声明的同名变量
3..java的测试用例中,可以通过@Optional("参数")来声明变量,如果没有在testng.xml中没有找到参数,会用@Optional("")中声明的参数
例如下面的代码,testng中没有声明para1和para2时,执行用例时会直接复制test1和test2
import org.testng.annotations.Optional;
import org.testng.annotations.Test;
public class paramer {
    @Test(parameters ={"para1","para2"})
    public  void showparamer(@Optional("test1") String para11, @Optional("test2") String para22){
        System.out.println("testng获得的参数para1如下:"+para11);
        System.out.println("testng获得的参数para2如下:"+para22);;
    }
}
 
二、通过注释@Dataprovide获得参数
(testng.xml只能传递简单的参数,如果是循环遍历的使用不同的参数则不可以实现。这时可以使用@Dataprovide来提供数据)
 
提供数据的方法:
@DataProvider(name = "dataprovider1")
public Object[][] dataprovide(){
    return new Object[][]{{1,2,3},{3,2,1}};
}
说明:
1.@DataProvide只能返回Object数组结果
2.Object的行中的每一列标识一个参数(比如上面的例子是3个参数),行数决定了调用的方法要执行的次数(比如上面的例子是执行2次)
 
调用数据方法:
@Test(dataprovide="XXX")
说明:
1.XXX为@DataProvide声明的一个名字,返回的是一个Object数组
2.方法的执行次数为赋值参数的遍数。比如提供数组为1行,则只执行一次;如果是数组为3行,则执行3次。
 
其他扩展:
1.@DataProvide写在单独的class里,增强复用性。
这时调用该数据的方法为:@Test(dataprovide="XXX",dataClass=YYY.class)
说明:读取YYY.class下的@DataProvide为XXX的Object数组数据
2.@DataProvide下定义的数组,通过其他文件读取,比如读取excel,返回一个Object数组
3.@DataProvide可以通过parallel实现并行执行线程,默认10个,可以在testng.xml中进行修改(<suite name="XXX" data-provider-thread-count="YYY">)
@DataProvider(name = "dataprovider1",parallel = true)
public Object[][] dataprovide(){
    return new Object[][]{{1,2},{2,1}};
}
@Test(dataProvider = "dataprovide")
public void showDataprovide(int a,int b,Method c){
    System.out.println("DataProvider获得的参数para1如下:"+a);
    System.out.println("DataProvider获得的参数para2如下:"+b);;
    System.out.println("DataProvider获得的参数para2如下:"+c.getName());

}

4.@DataProvide和@Parameters不能同时声明,但是可以通过其他方法实现同时使用。
String testId = context.getCurrentXmlTest().getParameter("test_id"); 
更详细的内容可以参考testng教程:https://www.yiibai.com/testng/