testNG 中文文档.docx

1、testNG 中文文档TestNG官方文档中文版1. 介绍 TestNG是一个设计用来简化广泛的测试需求的测试框架，从单元测试（隔离测试一个类）到集成测试（测试由有多个类多个包甚至多个外部框架组成的整个系统，例如运用服务器）。 编写一个测试的过程有三个典型步骤： * 编写测试的 业务逻辑并在代码中插入TestNG annotation * 将测试信息添加到testng.xml文件或者build.xml中 * 运行TestNG在欢迎页面上可以找到快速入门示例。下面是这篇文档使用的概念： * suite由xml文件描述。它包含一个或多个测试并被定义为标签 * test由描述并包含一个或者多个Tes

2、tNG类 * TestNG类是包含至少一个TestNG annotation的java类，由标签描述并包含一个或多个测试方法 * 测试方法是源文件中带有Testd注释的java方法 TestNG测试可以被BeforeXXX 和 AfterXXX annotations配置，容许在特定点的前后执行一些java逻辑，这些点上面已经列出。这份手册的剩余部分将讲述以下内容： * 所有的annotation列表并带有简短说明，为TestNG的多种功能性提供参考, 你可能需要参考为每个annotation提供的代码片段来学习细节。 * testng.xml文件描述，它的语法和如果指定它。 * 多个特性的详

3、细列表和怎样结合annotation和testng.xml来使用它们*注：上面的内容很简短，但是请注意其中的一些细节。1. TestNG是一个设计用来简化广泛的测试需求的测试框架，从单元测试到集成测试 这个是TestNG设计的出发点，不仅仅是单元测试，而且可以用于集成测试。设计目标的不同，对比junit的只适合用于单元测试，TestNG无疑走的更远。 可以用于集成测试，这个特性是我选择TestNG的最重要的原因。2. 测试的过程的三个典型步骤，注意和junit(4.0)相比，多了一个将测试信息添加到testng.xml文件或者build.xml 测试信息尤其是测试数据不再写死在测试代码中，好处

4、就是修改测试数据时不需要修改代码/编译了，从而有助于将测试人员引入单元测试/集成测试。3. 基本概念，相比junit的TestCase/TestSuite，TestNG有suite/test/test method三个级别，即将test/test method明确区分开了。 junit中的TestCase将test/test method混合，比较容易让人概念不清晰，尤其是新手。2 - Annotation这里是TestNG中用到的annotation的快速预览，还有它们的属性。BeforeSuite: 被注释的方法将在所有测试运行前运行AfterSuite: 被注释的方法将在所有测试运行后运

5、行BeforeTest: 被注释的方法将在测试运行前运行AfterTest: 被注释的方法将在测试运行后运行BeforeGroups: 被配置的方法将在列表中的gourp前运行。这个方法保证在第一个属于这些组的测试方法调用前立即执行。AfterGroups: 被配置的方法将在列表中的gourp后运行。这个方法保证在最后一个属于这些组的测试方法调用后立即执行。BeforeClass: 被注释的方法将在当前类的第一个测试方法调用前运行。AfterClass: 被注释的方法将在当前类的所有测试方法调用后运行。BeforeMethod: 被注释的方法将在每一个测试方法调用前运行。AfterMethod

6、: 被注释的方法将在每一个测试方法调用后运行。属性： alwaysRun 对于每个bufore方法(beforeSuite, beforeTest, beforeTestClass 和 beforeTestMethod, 但是不包括 beforeGroups): 如果设置为true，被配置的方法将总是运行而不管它属于哪个组。 对于after方法(afterSuite, afterClass, .): 如果设置为true，被配置的方法甚至在一个或多个先调用的方法失败或被忽略时也将运行。 dependsOnGroups 这个方法依赖的组列表 dependsOnMethods 这个方法依赖的方法列表

7、 enabled 这个类的方法是否激活 groups 这个类或方法所属的分组列表 inheritGroups 如果设置为true，这个方法被属于在类级别被Test annotation指定的组DataProvider 标记一个方法用于为测试方法提供数据。 被注释的方法必须返回Object, 其中每个Object可以指派为这个测试方法的参数列表。 从这个DataProvider接收数据Test方法需要使用一个和当前注释相同名称的dataProvider名称 name 这个DataProvider的名称Factory 标记方法作为一个返回对象的工厂，这些对象将被TestNG用于作为测试类。这个方法

8、必须返回ObjectParameters 描述如何传递参数给Test方法 value 用于填充这个方法的参数的变量列表Test 标记一个类或方法作为测试的一部分 alwaysRun 如果设置为true，这个测试方法将总是运行，甚至当它依赖的方法失败时。 dataProvider 这个测试方法的data provider的名称 dataProviderClass 用于查找data provider的类。 如果不指定，将在当前测试方法所在的类或者它的基类上查找data provider。 如果这个属性被指定, 则data provider方法需要是指定类的static方法。 dependsOnGr

9、oups 当前方法依赖的组列表 dependsOnMethods 当前方法依赖的方法列表 description 当前方法的描述 enabled 当前类的方法/方法是否被激活 expectedExceptions 测试方法期望抛出的异常列表。如果没有异常或者抛出的不是列表中的任何一个，当前方法都将标记为失败. groups 当前类/方法所属的组列表 invocationCount 当前方法被调用的次数 successPercentage 当前方法期望的成功率 sequential 如果设置为true，当前测试类上的所有方法保证按照顺序运行。甚至测试们在parallel=true的情况下. 这个

10、属性只能用于类级别，如果用于方法级别将被忽略。 timeOut 当前方法容许花费的最大时间，单位毫秒。 threadPoolSize 当前方法的线程池大小。方法将被多线程调用，次数由invocationCount参数指定 注意：如果invocationCount没有指定则这个属性将被忽略注： 上面是TestNG中用到的annotation列表，从中我们可以看到TestNG提供的一些特性1. before方法和after方法 带来了足够丰富的测试生命周期控制2. dependsOnGroups/dependsOnMethods 提供了依赖检查机制，并可以严格控制执行顺序3. DataProvid

11、er 使得对同一个方法的测试覆盖变的非常轻松，非常适合进行边界测试，只要给出多种测试数据就可以针对一个测试方法进行覆盖4. expectedExceptions 使得异常测试变的非常轻松5. invocationCount/threadPoolSize 终于可以简单的直接进行多线程测试了，这个绝对是junit的超级弱项，回想junit中那个万恶的System.exist(0).6. timeOut 终于不用死等然后手工强行关闭测试，TestNG想的太周到了TestNG官方文档中文版(3)-testng.xml TestNG的官方文档的中文翻译版第3章，原文请见 http:/testng.org

12、/doc/documentation-main.html 3 - testng.xml 调用TestNG由几种不同方法： * 使用testng.xml文件 * 使用ant * 从命令行 这节描述testng.xml的格式（文档的后面会讲到ant和命令行）。 当前testng.xml的DTD文件可以从官方找到：http:/testng.org/testng-1.0.dtd。（为了方便使用，你可能更喜欢浏览HTML版本）。 下面是testng.xml文件的一个例子： 你可以指定包名替代类名： 在这个例子中，TestNG将在包test.sample中查找所有的类，并只保留带有TestNG annot

13、ation的类。 你同样可以指定包含或不包含的组和方法: 你同样可以在testng.xml中定义新的组，指定属性的额外详细情况，比如是否并行运行测试，使用多少线程，是否运行junit测试，等等. 请查看DTD文件了解完整的特性列表。4 - 运行TestNGTestNG可以以不同的方式调用： * Command line * ant * Eclipse * IntelliJs IDEA1) 命令行假设你已经将TestNG加入到class path，调用TestNG最简单的方法事下面的：java org.testng.TestNG testng1.xml testng2.xml testng3.x

14、ml .必须指定最少一个描述你试图测试的TestNG suite的xml文件。另外，下面的命令行参数可以使用：命令行参数列表选项 参数 文档说明-d 一个目录 生成报告的目录（ test-output）-sourcedir 分号隔开的目录列表 带有javadoc注释的测试源文件目录. 这个选项只在使用javadoc类型的annotation时才有效. (例如 src/test or src/test/org/testng/eclipse-plugin;src/test/org/testng/testng).-testclass 可以在classpath路径中找到的逗号分隔的类列表。逗号分隔的类

15、文件列表(例如 org.foo.Test1,org.foo.test2).-groups 逗号分隔的组列表 要运行的组列表(例如 windows,linux,regression).-excludegroups 逗号分隔的组列表 不想包含在这次运行中的组列表-testrunfactory 可以在classpath中找到的java类 指定测试的runner.这个类需要实现接口org.testng.ITestRunnerFactory .-listener 可以在classpath路径中找到的逗号分隔的类列表。 指定测试的listener. 这个类需要实现接口org.testng.ITestLis

16、tener-parallel methods|tests 如果指定, 设置运行测试时如何使用并发线程的默认机制.如果不设置，默认机制是完全不使用并发线程。这个设置可以被suite定义覆盖.-threadcount 并发测试运行时默认使用的线程数 用于设置并发测试时默认的线程数. 只在并发模式被选择时才生效 (例如, 打开 -parallel 选项). 这个设置可以被suite定义覆盖.-suitename 测试套件使用的默认名称. 指定在命令行上定义的测试套件的名称。如果suite.xml文件或源代码指定了另外一个不同的套件名称，这个选项将被忽略。可以创建带空格的套件名称，如果在名称前后加双引

17、号如like this.-testname 测试使用的默认名称. 指定在命令行上定义的测试的名称。如果suite.xml文件或源代码指定了另外一个不同的测试名称，这个选项将被忽略。可以创建带空格的测试名称，如果在名称前后加双引号如like this.-reporter 扩展配置用于自定义报告listenner. 类似 -listener 选项, 除了容许reporter示例上由javabean形式的配置. 例如: -reporter com.test.MyReporter:methodFilter=*insert*,enableFiltering=true可以通过不带任何参数直接调用TestN

18、FG来获得这个文档。可以将命令行开关写到txt文件中，例如c:command.txt, 然后告诉TestNG使用这个文件类找到参数: C: more c:command.txt -d test-output testng.xml C: java org.testng.TestNG c:command.txt另外，可以通过jvm的命令行来传递参数给TestNG，例如java -Dtestng.test.classpath=c:/build;c:/java/classes; org.testng.TestNG testng.xmlTestNG能够理解的参数属性 类型 文档testng.test.c

19、lasspath 分号分隔的包含测试类的一系列目录 如果这个属性被设置，TestNG将使用它替代从class path来查找测试类. 如果你正在使用在xml文件里面的包标签并且在classpath路径中由很多类而大部分都不是测试类的时候比较方便举例:java org.testng.TestNG -groups windows,linux -testclass org.test.MyTest注意 ant 任务和testng.xml容许用更多的参数来启动TestNG（包含的方法，指定的参数，等等），因此可以认为命令行适用于学习TestNG并且想快速入门。2) Ant 可以这样定义TestNG的an

20、t任务：这个任务运行TestNG测试，并且通常是在单独的jvm中。接受下面的属性：属性名 描述 是否必须annotations 字符串JDK或者Javadoc. 定义测试适用的注释类型.如果使用Javadoc, 则需要同时指定sourcedir. 不是必须. 如果适用jkd5则默认为JDK，如果适用jdk1.4则默认为Javadocclassfilesetref 要运行的测试类的FileSet结构的引用. classpath 要运行的测试的PATH-like 结构. classpathref 要运行的测试的PATH-like 结构的引用. dumpCommand 打印TestNG启动命令. 不

21、是必须,默认falseenableAssert 开启JDK 1.4的断言. 不是必须,默认truefailureProperty 失败发生时要设置的属性的名称. 只有haltonfailure没有设置时才有效. 不是必须.haltonfailure 如果测试运行期间发生失败，停止构造过程. 不是必须,默认falsehaltonskipped 如果发生至少一次测试跳过，停止构造过程. 不是必须,默认falsegroups 要运行的组列表，空格或逗号分隔 excludedgroups 排除在外的组列表，空格或逗号分隔jvm 使用的jvm，将被Runtime.exec()运行 javalistene

22、rs 逗号或空格分隔的全路径类列表，需要实现org.testng.ITestListener或org.testng.IReporter 不是必须outputdir 报告输出目录 不是必须,默认输出到test-output.skippedProperty 当发生测试被跳过时设置的property的名称.只有当haltonskipped没有设置时才使用 不是必须sourcedir 用于jdk1.4测试的PATH-like结构(使用JavaDoc形式的annotations) sourcedirref 用于jdk1.4测试的PATH-like结构的引用(使用JavaDoc形式的annotations

23、) suiteRunnerClass TestNG启动器的全路径名称 不是必须. 默认使用org.testng.TestNGparallel 运行测试时使用的并行模式 - methods或者tests 不是必须 - 如果没有指定，并行模式不被选择threadCount 运行时使用的线程数量。如果并行模式被同时指定否则忽略。 默认1testJar 包含测试和套件定义的jar包路径timeOut 所有测试必须运行完成的最大超时时间，单位毫秒 useDefaultListeners 是否使用默认监听器和报告器. 默认true.workingDir 运行TestNG前ant任务应该转移到的目录。xml

24、filesetref 用于要测试的套件定义的FileSet结构的引用 suitename 设置测试套件的默认名称如果在suite的xml文件或者源代码中都没有被定义。 不是必须，默认设置为Ant suitetestname 设置测试的默认名称如果在suite的xml文件或者源代码中都没有被定义。 不是必须，默认设置为Ant test属性classpath, classpathref或者内嵌的必须设置一个，用于提供测试的classpath属性xmlfilesetref, classfilesetref 或者内嵌的 , 分别的必须使用用来提供测试注意：如果使用jdk1.4，属性attributes sourcedir, sourcedirref 或者内嵌的 必须提供.注意：使用 并不自动按添加测试类到classpath: 需要报告这些在classpath中的任务要工作的类内嵌元素classpath 任务支持一个内嵌的 元素来