自动生成testng.xml

测试积点老人

工作中接到一个任务，调研是否可以实现rpc服务自动diff功能。本篇是其中的一个子功能，测试类的testng.xml自动实现。

实现原理： 1.实例化XmlSuite类 2.扫描目录下所有的classes文件，然后遍历class的所有方法是否包含@Test注解 3.步骤2中的必要信息放到XmlSuite中 4.保存XmlSuite到指定位置

主要方法：

1. /**
   
2. * 生成testng.xml
   
3. * @return
   
4. */
   
5. public Boolean CreateTestNGXML() {
   
6.         String prefix = "Test";
   
7.     String classesDir = "D:/opt/cases";
   
8.     XmlSuite suite = new XmlSuite();
   
9.     XmlTest xmlTest = new XmlTest(suite);
   
10.     List<XmlClass> xmlClasses = new ArrayList<>();
    
11. 
    
12.     // testng.xml全名
    
13.     suite.setFileName(prefix + "_testng.xml");
    
14.     // 不设置这个suite.toXml()会报NPT
    
15.     suite.setJunit(false);
    
16.     suite.setName(prefix);
    
17.     xmlTest.setName(prefix);
    
18. 
    
19.     try {
    
20.         // 新建classloader实例
    
21.         URLClassLoader loader = URLClassLoader.newInstance(new URL[] {}, getClass().getClassLoader());
    
22.         // 测试用例class所在目录加到classloader的classpath中
    
23.         TestNGUtil.addPath(loader, new File(classesDir).toURI().toURL());
    
24. 
    
25.         // 循环遍历所有的class文件
    
26.         Collection<File> classFiles = FileUtils.listFiles(new File(classesDir), new WildcardFileFilter("*.class"),
    
27.                 TrueFileFilter.INSTANCE);
    
28.         for (File f : classFiles) {
    
29.             // 包含$说明为内部类
    
30.             if (f.getName().contains("$")) {
    
31.                 continue;
    
32.             }
    
33.             XmlClass xmlClass = new XmlClass();
    
34.             List<XmlInclude> includes = new ArrayList<>();
    
35. 
    
36.             // 只要class名称不要后缀
    
37.             String clazzName = f.getName().replace(".class", "");
    
38.             xmlClass.setName(clazzName);
    
39. 
    
40.             Class<?> clazz = Class.forName(clazzName, false, loader);
    
41.             // 遍历所有方法，找到包含@Test标注的方法
    
42.             for (Method m : clazz.getMethods()) {
    
43.                 if (hasTestAnnotation(m)) {
    
44.                     XmlInclude xmlInclude = new XmlInclude(m.getName());
    
45.                     includes.add(xmlInclude);
    
46.                 }
    
47.             }
    
48.             xmlClass.setIncludedMethods(includes);
    
49.             xmlClasses.add(xmlClass);
    
50.         }
    
51. 
    
52.         xmlTest.setXmlClasses(xmlClasses);
    
53. 
    
54.         // 保存到文件系统中
    
55.         FileUtils.write(new File(classesDir + "/" + suite.getFileName()), suite.toXml(), Charset.defaultCharset());
    
56.     } catch (MalformedURLException e) {
    
57.         e.printStackTrace();
    
58.     } catch (ClassNotFoundException e) {
    
59.         e.printStackTrace();
    
60.     } catch (Exception e) {
    
61.         e.printStackTrace();
    
62.     }
    
63. 
    
64.     return null;
    
65. }
    
66. 
    
67. /**
    
68. * 判断当前方法是否包含@Test标注
    
69. *
    
70. * @param m
    
71. * @return
    
72. */
    
73. private Boolean hasTestAnnotation(Method m) {
    
74.     List<Annotation> annotations = Arrays.asList(m.getAnnotations());
    
75.     for (Annotation annotation : annotations) {
    
76.         if (annotation.annotationType().getName().equals(Test.class.getName())) {
    
77.             return Boolean.TRUE;
    
78.         }
    
79.     }
    
80.     return Boolean.FALSE;
    
81. }

复制代码

额外的类TestNgUtil.java

1. /**
   
2.      * addURL为protected方法，需要借助于reflect包才能实现动态添加class到classpath中
   
3.      *
   
4.      * @param urlClassLoader
   
5.      * @param url
   
6.      * @throws Exception
   
7.      */
   
8.     public static void addPath(ClassLoader urlClassLoader, URL url) throws Exception {
   
9.         Class<URLClassLoader> urlClass = URLClassLoader.class;
   
10.         Method method = urlClass.getDeclaredMethod("addURL", new Class[] { URL.class });
    
11.         method.setAccessible(true);
    
12.         method.invoke(urlClassLoader, new Object[] { url });
    
13.     }

复制代码

import信息

1. import java.io.File;
   
2. import java.lang.annotation.Annotation;
   
3. import java.lang.reflect.Method;
   
4. import java.net.MalformedURLException;
   
5. import java.net.URL;
   
6. import java.net.URLClassLoader;
   
7. import java.nio.charset.Charset;
   
8. import java.util.ArrayList;
   
9. import java.util.Arrays;
   
10. import java.util.Collection;
    
11. import java.util.List;
    
12. 
    
13. import org.apache.commons.io.FileUtils;
    
14. import org.apache.commons.io.filefilter.TrueFileFilter;
    
15. import org.apache.commons.io.filefilter.WildcardFileFilter;
    
16. import org.testng.annotations.Test;
    
17. import org.testng.xml.XmlClass;
    
18. import org.testng.xml.XmlInclude;
    
19. import org.testng.xml.XmlSuite;
    
20. import org.testng.xml.XmlTest;
    
21. 
    
22. import com.aaa.qa.utils.TestNGUtil;

复制代码