自動生成testng.xml

工作中接到一個任務，調研是否可以實作rpc服務自動diff功能。本篇是其中的一個子功能，測試類的testng.xml自動實作。

實作原理：

1.執行個體化XmlSuite類

2.掃描目錄下所有的classes檔案，然後周遊class的所有方法是否包含@Test注解

3.步驟2中的必要資訊放到XmlSuite中

4.儲存XmlSuite到指定位置

主要方法：

/**
 * 生成testng.xml
 * @return
 */
public Boolean createTestNGXML() {
	String prefix = "Test";
    String classesDir = "D:/opt/cases";
    XmlSuite suite = new XmlSuite();
    XmlTest xmlTest = new XmlTest(suite);
    List<XmlClass> xmlClasses = new ArrayList<>();

    // testng.xml全名
    suite.setFileName(prefix + "_testng.xml");
    // 不設定這個suite.toXml()會報NPT
    suite.setJunit(false);
    suite.setName(prefix);
    xmlTest.setName(prefix);

    try {
        // 建立classloader執行個體
        URLClassLoader loader = URLClassLoader.newInstance(new URL[] {}, getClass().getClassLoader());
        // 測試用例class所在目錄加到classloader的classpath中
        TestNGUtil.addPath(loader, new File(classesDir).toURI().toURL());

        // 循環周遊所有的class檔案
        Collection<File> classFiles = FileUtils.listFiles(new File(classesDir), new WildcardFileFilter("*.class"),
                TrueFileFilter.INSTANCE);
        for (File f : classFiles) {
            // 包含$說明為内部類
            if (f.getName().contains("$")) {
                continue;
            }
            XmlClass xmlClass = new XmlClass();
            List<XmlInclude> includes = new ArrayList<>();

            // 隻要class名稱不要字尾
            String clazzName = f.getName().replace(".class", "");
            xmlClass.setName(clazzName);

            Class<?> clazz = Class.forName(clazzName, false, loader);
            // 周遊所有方法，找到包含@Test标注的方法
            for (Method m : clazz.getMethods()) {
                if (hasTestAnnotation(m)) {
                    XmlInclude xmlInclude = new XmlInclude(m.getName());
                    includes.add(xmlInclude);
                }
            }
            xmlClass.setIncludedMethods(includes);
            xmlClasses.add(xmlClass);
        }

        xmlTest.setXmlClasses(xmlClasses);

        // 儲存到檔案系統中
        FileUtils.write(new File(classesDir + "/" + suite.getFileName()), suite.toXml(), Charset.defaultCharset());
    } catch (MalformedURLException e) {
        e.printStackTrace();
    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    } catch (Exception e) {
        e.printStackTrace();
    }

    return null;
}

/**
 * 判斷目前方法是否包含@Test标注
 * 
 * @param m
 * @return
 */
private Boolean hasTestAnnotation(Method m) {
    List<Annotation> annotations = Arrays.asList(m.getAnnotations());
    for (Annotation annotation : annotations) {
        if (annotation.annotationType().getName().equals(Test.class.getName())) {
            return Boolean.TRUE;
        }
    }
    return Boolean.FALSE;
}
           

額外的類TestNgUtil.java

/**
     * addURL為protected方法，需要借助于reflect包才能實作動态添加class到classpath中
     * 
     * @param urlClassLoader
     * @param url
     * @throws Exception
     */
    public static void addPath(ClassLoader urlClassLoader, URL url) throws Exception {
        Class<URLClassLoader> urlClass = URLClassLoader.class;
        Method method = urlClass.getDeclaredMethod("addURL", new Class[] { URL.class });
        method.setAccessible(true);
        method.invoke(urlClassLoader, new Object[] { url });
    }
           

import資訊

import java.io.File;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;

import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.apache.commons.io.filefilter.WildcardFileFilter;
import org.testng.annotations.Test;
import org.testng.xml.XmlClass;
import org.testng.xml.XmlInclude;
import org.testng.xml.XmlSuite;
import org.testng.xml.XmlTest;

import com.aaa.qa.utils.TestNGUtil;