JAVA+TestNG接口自动化

又开始更新博客了~带来改良后的接口自动化框架

1.准备工作

1.1技术栈

    java+testng+extentreports 

1.2 推荐学习资料

   java自定义注解@Annotation https://www.runoob.com/w3cnote/java-annotation.html
   testng源码 https://testng.org/doc/documentation-main.html#methodinterceptors

1.3创建一个springboot项目

 

2.核心代码演示

/**
 * 接口信息自定义注解
 */
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiInfo {
    //请求路径
    String path();

    //请求方式
    RequestEnum method();

    //是否需要登录
    boolean isNeedLogin() default false;

    //登录账号
    String mobile() default "12345678901";
    
    //登录密码
    String password() default "Passw0rd";

    //需要保存的返回参数
    String[] results() default "";
}

public enum RequestEnum {
    GET, POST, FORM;
}


/**
* 网易音乐查询接口
* 这样接口类就很清爽，不需要维护过多信息，只需要在注解上维护，避免重复的代码
*/
@ApiInfo(path = "/weapi/search/suggest/web", method = RequestEnum.POST, isNeedLogin = true)
public class SearchSuggestWebApi {
}

/**
* 基础测试类
* resultMap 接口之间参数传递
*/
public class BaseTest {
    public static String testEnv;
    public static Map<String, String> resultMap = new HashMap<>();

    @BeforeSuite
    @Parameters({"env"})
    public void before(String env) {
        testEnv = env;
    }

}

/**
* 解析api的通用类，把接口类以及请求参数传递进来
* 继承BaseTest，BaseTest中定义env，通过maven向下传递环境信息
*/
public class AnalyzeApiAndDoRequest<T> extends BaseTest{
    public SimpleHttpResponse doRequest(Class<T> tClass, String req){

        //获取api上的自定义注解信息
        String channel = tClass.getAnnotation(ApiInfo.class).channel();
        RequestEnum method = tClass.getAnnotation(ApiInfo.class).method();
        boolean isNeedLogin = tClass.getAnnotation(ApiInfo.class).isNeedLogin();
        String mobile = tClass.getAnnotation(ApiInfo.class).mobile();
        String password = tClass.getAnnotation(ApiInfo.class).password();
        String[] results = tClass.getAnnotation(ApiInfo.class).saveResult();

        //获取BaseTest中的环境后，通过工具类获取对应host
        String url = HostUtil.getHost(this.env) + path;
        
        //通用header信息
        Map<String, String> headers = new HashMap<String, String>(){
            put("platform", "web");
        };
        if(isNeedLogin){
            //获取token信息
            headers.put("token","???")
        }

        
        //直接掉用封装好的httputil，获取返回参数
        HttpResponse response;
        switch (method) {
            case POST:
                response = HttpUtil.httpPostJson(url, headers, req);
                break;
            case FORM:
                response = HttpUtil.httpPostForm(url, headers, req);
                break;
            case GET:
                response = HttpUtil.httpGet(url, headers, req);
                break;
            default:
                return null;
        }

        // 遍历需要保存的返回参数，以类名+JSONPath最后一个节点为key保存，可以在Bas
        for (String str : results) {
            if (StringUtils.isNotBlank(str)) {
                resultMap.put(splitStr(tClass.getName()) + "." + splitStr(str), String.valueOf(JSONPath.eval(response.getResponseAsString(), str)));
            }
        }

    }
}


//同一功能的增删改查接口可以定义一个service类来管理
public class DemoService{

    public SimpleHttpResponse searchApi(String req) throws IOException {
        return new AnalyzeApiAndDoRequest<SearchApi>().doRequest(SearchApi.class, req);
    }

    public SimpleHttpResponse insertApi(String req) throws IOException {
        return new AnalyzeApiAndDoRequest<InsertApi>().doRequest(InsertApi.class, req);
    }

}


/**
* 测试类只需要new 一个Service，就可以在一个测试类中把增删改查都测试完成
*/
public class TestDemotionStrategy extends BaseTest {

    DemoService demoService = new DemoService();

    @Test(groups = {"P0"}, testName = "测试查询")
    public void testSearch(){
       HttpResponse response = demoService.searchApi("哈哈哈");
       Assert.assertEquals(response.getCode,200);
    }

    @Test(groups = {"P0"}, testName = "测试插入")
    public void testInsert(){
       HttpResponse response = demoService.insert("哈哈哈");
       Assert.assertEquals(response.getCode,200);
    }

}

 

3.进阶

3.1报告

使用extentreports来生成美观的报告

 

3.2 testng相关监听/日志

3.2.1 统计数据

写一个类实现ISuiteResult, ITestListener这两个类（定制化比较高，不上代码了）

3.2.2 重试机制

修改MAX_RETRY_COUNT可以更改重试次数，xml里添加RetryListener监听

public class RetryAnalyzer implements IRetryAnalyzer {

    private static final int MAX_RETRY_COUNT = 3;
    private int count = 0;

    @Override
    public boolean retry(ITestResult iTestResult) {
        if (count < MAX_RETRY_COUNT) {
            count++;
            return true;
        }
        return false;
    }
}


public class RetryListener implements IAnnotationTransformer {
    @Override
    public void transform(ITestAnnotation iTestAnnotation, Class aClass, Constructor constructor, Method method) {
        IRetryAnalyzer retryAnalyzer = iTestAnnotation.getRetryAnalyzer();
        if (retryAnalyzer == null) {
            iTestAnnotation.setRetryAnalyzer(RetryAnalyzer.class);
        }
    }
}

3.2.3 定制化日志（定位问题行数）

public class ReporterLogger {

    private Class<?> zClass;

    public ReporterLogger(Class<?> clazz) {
        this.zClass = clazz;
    }

    public void info(String message) {
        Reporter.log(getLogTag() + message, true);
    }

    private String getLogTag() {
        String logTag = "";
        //通过堆获取类、方法、行数信息打印到日志上
        StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
        for (StackTraceElement s : stackTraceElements) {
            //判断是否当前类
            if (s.getClassName().equals(zClass.getName())) {
                logTag = "[" + classNameDeal(s.getClassName()) + "]" + "[" + s.getMethodName() + "方法]" + "[第" + s.getLineNumber() + "行]";
            }
        }
        return logTag;
    }


    /**
     * 分割类路径，取类名
     *
     * @param allName 类路径
     * @return
     */
    private static String classNameDeal(String allName) {
        String[] className = allName.split("\\.");
        return className[className.length - 1] + ".class";
    }

}