教您如何使用TestNG 做测试分离！！

lsekfe

基于TestNG参数化注入的方式，我们可以很容易地做到测试代码、数据与环境的相互分离；我们可以统一用文件来管理测试数据，并能灵活地在不同测试环境切换不同的测试数据；我们甚至可以将测试数据文件和测试用例代码进一步分离，各自独立维护，只有在具体执行测试的时候才动态关联。
　　测试代码和测试数据分离实践
　　从测试代码中分离数据，将数据集中写在文件中，文件格式可以用txt、properties、yaml、json等，本文会采用properties格式来做示范，因为这个确实比较简单；但具体到真实研发环境，笔者推荐yaml，yaml格式更方便维护和解读，尤其是需要维护大量数据且有中文字符的场景。
　　先写一个工具类TestUtils：
　　定义一个静态方法initParam()，该方法会读取类路径下的一个properties文件，将文件内容以Properties格式返回，properties文件路径由输入参数proptiesFileInClassPath指定。
　　定义一个静态方法loadParam()，该方法需要三个输入参数。第一个为Properties类型的propParams，另外两个是String类型，分别是测试类名和测试类中的方法。该方法的作用是用来将propParams中匹配测试类和测试方法的测试数据以二维对象数组的类型返回。

1. 　src/test/java/com/fastjrun.example/testng/utils/TestUtils.java

复制代码

1. 　package com.fastjrun.example.testng.utils;
   
2. 　　import java.io.IOException;
   
3. 　　import java.io.InputStream;
   
4. 　　import java.util.*;
   
5. 　　public class TestUtils {
   
6. 　　    public static Properties initParam(String proptiesFileInClassPath) throws IOException {
   
7. 　　        Properties properties = new Properties();
   
8. 　　        InputStream inParam = TestUtils.class.getResourceAsStream(proptiesFileInClassPath);
   
9. 　　        properties.load(inParam);
   
10. 　　        assert inParam != null;
    
11. 　　        inParam.close();
    
12. 　　        return properties;
    
13. 　　    }
    
14. 　　    public static Object[][] loadParam(Properties propParams, String className, String methodName) {
    
15. 　　        assert propParams != null;
    
16. 　　        Set<String> keys = propParams.stringPropertyNames();
    
17. 　　        List<Object[]> valueObjects = new ArrayList<>();
    
18. 　　        for(String key: keys) {
    
19. 　　            if (key.startsWith(className.concat(".").concat(methodName).concat("."))) {
    
20. 　　                String value = propParams.getProperty(key);
    
21. 　　                String[] params = value.split(",");
    
22. 　　                Object[] valueObject = new Object[params.length];
    
23. 　　                for(int i=0;i<params.length;i++){
    
24. 　　                    if(params[i].split(":").length>1){
    
25. 　　                        String type = params[i].split(":")[1];
    
26. 　　                        switch (type){
    
27. 　　                            case "Integer":
    
28. 　　                                valueObject[i]=Integer.parseInt(params[i].split(":")[0]);
    
29. 　　                                break;
    
30. 　　                            case "Boolean":
    
31. 　　                                valueObject[i]=Boolean.parseBoolean(params[i].split(":")[0]);
    
32. 　　                                break;
    
33. 　　                            default:
    
34. 　　                                valueObject[i]=params[i].split(":")[0];
    
35. 　　                                break;
    
36. 　　                        }
    
37. 　　                    }else{
    
38. 　　                        valueObject[i]=params[i];
    
39. 　　                    }
    
40. 　　                }
    
41. 　　                valueObjects.add(valueObject);
    
42. 　　            }
    
43. 　　        }
    
44. 　　        Object[][] object = new Object[valueObjects.size()][];
    
45. 　　        for(int i = 0; i < object.length; ++i) {
    
46. 　　            object[i] = new Object[valueObjects.get(i).length];
    
47. 　　            System.arraycopy(valueObjects.get(i), 0, object[i], 0, valueObjects.get(i).length);
    
48. 　　        }
    
49. 　　        return object;
    
50. 　　    }
    
51. 　　}

复制代码

再写一个测试类PrimeNumberCheckerTest2：
　　该类和PrimeNumberCheckerTest只有方法primeNumbers不同。
　　在PrimeNumberCheckerTest2的primeNumbers方法定义中，多了类型为Method的输入参数method，方法体也换成了从classpath下的dev.properties文件获取测试参数。

1. 　　src/test/java/com/fastjrun.example/testng/PrimeNumberCheckerTest2.java
   

复制代码

1. package com.fastjrun.example.testng;
   
2. 　　import com.fastjrun.example.testng.utils.TestUtils;
   
3. 　　import org.testng.Assert;
   
4. 　　import org.testng.annotations.BeforeMethod;
   
5. 　　import org.testng.annotations.DataProvider;
   
6. 　　import org.testng.annotations.Test;
   
7. 　　import java.io.IOException;
   
8. 　　import java.lang.reflect.Method;
   
9. 　　import java.util.Properties;
   
10. 　　public class PrimeNumberCheckerTest2 {
    
11. 　　    private PrimeNumberChecker primeNumberChecker;
    
12. 　　    @BeforeMethod
    
13. 　　    public void initialize() {
    
14. 　　        primeNumberChecker = new PrimeNumberChecker();
    
15. 　　    }
    
16. 　　    @DataProvider(name = "test1")
    
17. 　　    public Object[][] primeNumbers(Method method) {
    
18. 　　        Properties properties;
    
19. 　　        try {
    
20. 　　            properties = TestUtils.initParam("/dev.properties");
    
21. 　　        } catch (IOException e) {
    
22. 　　            throw new RuntimeException(e);
    
23. 　　        }
    
24. 　　        return TestUtils.loadParam(properties, this.getClass().getSimpleName(), method.getName());
    
25. 　　    }
    
26. 　　    @Test(dataProvider = "test1")
    
27. 　　    public void testPrimeNumberChecker(Integer inputNumber, Boolean expectedResult) {
    
28. 　　        System.out.println(inputNumber + " " + expectedResult);
    
29. 　　        Assert.assertEquals(expectedResult, primeNumberChecker.validate(inputNumber));
    
30. 　　    }
    
31. 　　}

复制代码

准备测试数据文件内容

1. 　src/test/resources/dev.properties

复制代码

1. PrimeNumberCheckerTest2.testPrimeNumberChecker.1=2:Integer,true:Boolean
   
2. 　　PrimeNumberCheckerTest2.testPrimeNumberChecker.2=6:Integer,false:Boolean
   
3. 　　PrimeNumberCheckerTest2.testPrimeNumberChecker.3=19:Integer,true:Boolean
   
4. 　　PrimeNumberCheckerTest2.testPrimeNumberChecker.4=22:Integer,false:Boolean
   
5. 　　PrimeNumberCheckerTest2.testPrimeNumberChecker.5=23:Integer,true:Boolean

复制代码

在PrimeNumberCheckerTest2类编辑窗口选中需要测试的方法名testPrimeNumberChecker，点击鼠标右键弹出下拉菜单后，从中选择“Run testPrimeNumberChecker()”即可执行该单元测试用例。

执行结果如下：

1. 　23 true
   
2. 　　22 false
   
3. 　　19 true
   
4. 　　6 false
   
5. 　　2 true
   
6. 　　===============================================
   
7. 　　Default Suite
   
8. 　　Total tests run: 5, Passes: 5, Failures: 0, Skips: 0
   
9. 　　===============================================

复制代码

从结果可以看出，该测试用例也可以一次性执行5组测试数据。如果需要调整测试数据，只需要直接修改dev.properties就可以了。
　　测试数据和测试环境分离实践
　　写一个测试类PrimeNumberCheckerTest3，该类在PrimeNumberCheckerTest2的基础上做了重构，重构要点如下：
　　新增了类型为Properties的成员变量properties，用来装载从测试数据文件读入的测试数据。
　　读取测试数据文件的逻辑从primeNumbers方法移入了initialize方法，同时使用了注解BeforeClass，确保该方法在JVM加载PrimeNumberCheckerTest3后第一时间执行，并将测试数据装载到成员变量properties。
　　initialize方法使用注解Parameters来初始化测试数据文件名，以便后续执行测试用例的时候可以通过-D命令参数来调整具体的测试数据文件。
　　primeNumbers方法修改为从成员变量properties匹配测试类和测试方法的测试数据以二维对象数组的类型返回。

1. src/test/java/com/fastjrun.example/testng/PrimeNumberCheckerTest3.java

复制代码

1. 　package com.fastjrun.example.testng;
   
2. 　　import com.fastjrun.example.testng.utils.TestUtils;
   
3. 　　import org.testng.Assert;
   
4. 　　import org.testng.annotations.*;
   
5. 　　import java.io.IOException;
   
6. 　　import java.lang.reflect.Method;
   
7. 　　import java.util.Properties;
   
8. 　　public class PrimeNumberCheckerTest3 {
   
9. 　　    private PrimeNumberChecker primeNumberChecker;
   
10. 　　    private Properties properties= new Properties();
    
11. 　　    @BeforeClass
    
12. 　　    @Parameters({"envName"})
    
13. 　　    public void initialize( @Optional("dev") String envName) {
    
14. 　　        primeNumberChecker = new PrimeNumberChecker();
    
15. 　　        try {
    
16. 　　            properties = TestUtils.initParam("/" + envName + ".properties");
    
17. 　　        } catch (IOException e) {
    
18. 　　            throw new RuntimeException(e);
    
19. 　　        }
    
20. 　　    }
    
21. 　　    @DataProvider(name = "test1")
    
22. 　　    public Object[][] primeNumbers(Method method) {
    
23. 　　        return TestUtils.loadParam(properties, this.getClass().getSimpleName(), method.getName());
    
24. 　　    }
    
25. 　　    @Test(dataProvider = "test1")
    
26. 　　    public void testPrimeNumberChecker(Integer inputNumber, Boolean expectedResult) {
    
27. 　　        System.out.println(inputNumber + " " + expectedResult);
    
28. 　　        Assert.assertEquals(expectedResult, primeNumberChecker.validate(inputNumber));
    
29. 　　    }
    
30. 　　}

复制代码

准备测试数据文件内容，在dev.properties文件里新增一行。

1. 　PrimeNumberCheckerTest3.testPrimeNumberChecker.1=2:Integer,true:Boolean

复制代码

执行PrimeNumberCheckerTest3的testPrimeNumberChecker方法，执行结果如下：

1. 　2 true
   
2. 　　===============================================
   
3. 　　Default Suite
   
4. 　　Total tests run: 1, Passes: 1, Failures: 0, Skips: 0
   
5. 　　===============================================

复制代码

显然，我们可以通过-D命令行参数的方式，调整PrimeNumberCheckerTest3的initialize方法的输入参数envName的值，来达到读取类路径下不同properties文件的目的。这一特性对自动化测试非常友好。
　　测试代码和测试数据维护分离实践
　　在上一个实践中，我们已经做到将测试数据放在了文件中，甚至做到了用同一套测试用例代码基于不同的测试数据文件执行测试，但这些测试数据文件其实还是和代码在一起维护。虽然我们的开发工程师和测试工程师已经能够基于同一个代码库各自维护测试用例代码和测试数据，但如果有必要，我们还是希望开发工程师和测试工程师能够进一步分离，使得测试代码的维护和测试数据的维护工作也相互可以独立。
　　比如开发工程师写单元测试代码并用自己准备的测试数据进行测试以达到一个准入标准（这个标准因研发团队可异）；测试工程师维护测试数据文件，后续测试工程师通过-D命令行切换成自己准备的测试数据文件来执行，生成测试报告和代码覆盖率报告。
　　将测试代码和测试数据文件维护分离的方式可以有很多种，本文只介绍一种和Nacos结合使用的方式。Nacos是一个微服务注册和发现平台，同时也能作为配置管理中心使用。Nacos支持直接在控制台维护如properties、json、xml、yaml、html和html格式的配置信息，这里我们就把这些配置信息当做测试数据文件即可。
　　TestUtils里新增initParamFromNacos方法如下：

1. public static Properties initParamFromNacos(String path) throws IOException {
   
2. 　　    Properties properties = new Properties();
   
3. 　　    HttpURLConnection connection = (HttpURLConnection) new URL(path).openConnection();
   
4. 　　    int code = connection.getResponseCode();
   
5. 　　    if (code >= 400) throw new IOException("Server returned error code #" + code);
   
6. 　　    InputStream inParam = connection.getInputStream();
   
7. 　　    properties.load(inParam);
   
8. 　　    assert inParam != null;
   
9. 　　    inParam.close();
   
10. 　　    return properties;
    
11. 　　}

复制代码

写一个测试类PrimeNumberCheckerTest4，该类与PrimeNumberCheckerTest3的不同之处只在于：
　　initialize方法中读取测试数据文件的逻辑由从类路径下文件路径变更为从Nacos配置中心指定dataId读取。

1. 　　src/test/java/com/fastjrun.example/testng/PrimeNumberCheckerTest4.java
   

复制代码

1. package com.fastjrun.example.testng;
   
2. 　　import com.fastjrun.example.testng.utils.TestUtils;
   
3. 　　import org.testng.Assert;
   
4. 　　import org.testng.annotations.*;
   
5. 　　import java.io.IOException;
   
6. 　　import java.lang.reflect.Method;
   
7. 　　import java.util.Properties;
   
8. 　　public class PrimeNumberCheckerTest4 {
   
9. 　　    private PrimeNumberChecker primeNumberChecker;
   
10. 　　    private Properties properties = new Properties();
    
11. 　　    @BeforeClass
    
12. 　　    @Parameters({"envName"})
    
13. 　　    public void initialize(@Optional("dev") String envName) {
    
14. 　　        primeNumberChecker = new PrimeNumberChecker();
    
15. 　　        try {
    
16. 　　            properties = TestUtils.initParamFromNacos("http://192.168.5.10:8848/nacos/v1/cs/configs?dataId=" + envName + ".properties&group=DEFAULT_GROUP");
    
17. 　　        } catch (IOException e) {
    
18. 　　            throw new RuntimeException(e);
    
19. 　　        }
    
20. 　　    }
    
21. 　　    @DataProvider(name = "test1")
    
22. 　　    public Object[][] primeNumbers(Method method) {
    
23. 　　        return TestUtils.loadParam(properties, this.getClass().getSimpleName(), method.getName());
    
24. 　　    }
    
25. 　　    @Test(dataProvider = "test1")
    
26. 　　    public void testPrimeNumberChecker(Integer inputNumber, Boolean expectedResult) {
    
27. 　　        System.out.println(inputNumber + " " + expectedResult);
    
28. 　　        Assert.assertEquals(expectedResult, primeNumberChecker.validate(inputNumber));
    
29. 　　    }
    
30. 　　}

复制代码

在Nacos控制台维护测试数据：

Nacos控制台输入如下配置信息，也是测试数据。

1. PrimeNumberCheckerTest4.testPrimeNumberChecker.1=23:Integer,true:Boolean

复制代码

执行PrimeNumberCheckerTest4的testPrimeNumberChecker方法，执行结果如下：

1. 　23 true
   
2. 　　===============================================
   
3. 　　Default Suite
   
4. 　　Total tests run: 1, Passes: 1, Failures: 0, Skips: 0
   
5. 　　===============================================

复制代码

如果需要调整测试数据，只需要在Nacos控制台直接操作dataId，操作完毕后点发布就可以了。
　　总结
　　本实践主要介绍了TestNG 参数化注入的三种方式，并在此基础上，介绍了测试代码和测试数据、测试数据和测试环境的分离实践以及一种利用Nacos将测试代码和测试数据维护分离的有效实践。TestNG 的参数化特性有助于研发过程实践TDD（测试驱动开发）和自动化测试，对提高代码和工程质量有积极意义。