Java接口自动化框架增加钉钉机器人配置，自动发送测试结果

1.utils目录下新建DingDingUtil类

package utils;


import com.alibaba.fastjson.JSONObject;
import org.apache.http.client.methods.CloseableHttpResponse;
import restclient.RestClient;

import java.text.NumberFormat;
import java.util.HashMap;

/**
 *钉钉机器人工具类
 */
public class DingDingUtil {

    //通过钉钉机器人发送消息到钉钉群中
    public static void sendVal(String url,String context)throws Exception{
        HashMap<String,String> headermap = new HashMap<>();
        headermap.put("Content-Type","application/json");
        String entityString ="{'msgtype': 'text', 'text': {'content': '"+context+"'}}";

        RestClient restClient = new RestClient();

        CloseableHttpResponse closeableHttpResponse = restClient.post(url,entityString,headermap);
        JSONObject responseJson = restClient.getResponseJson(closeableHttpResponse);
    }

    //folat数字转换为百分号格式
    public static String folatToPer(float folatNum){

        NumberFormat numberFormat = NumberFormat.getPercentInstance();
        String per=null;
        try {
            numberFormat.setMaximumFractionDigits(2); //精确到2位

            per = numberFormat.format(folatNum);

            ReportUtil.log("小数点数字转百分数字符串:" + folatNum + " 转为 " + per);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return per;
    }

    public static void main(String[] args) {
        String c=DingDingUtil.folatToPer((float) 5/7);
        System.out.println(c);

    }
}

RestClient类引用请参考下面这篇文章
https://blog.csdn.net/weixin_42884654/article/details/94634905

2.utils目录下新建ReportUtil类，增加日志记录

package utils;

import org.testng.Reporter;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;

/**
 *测试报告日志输出工具类
 */
public class ReportUtil {


    private static String splitTimeAndMsg = "---";

    public static void log(String msg) {
        long timeMillis = Calendar.getInstance().getTimeInMillis();
        //TODO 日志记录
//        LoggerUtil.infoData(msg);

        //获取当前系统时间
        long currentTime = System.currentTimeMillis();
        SimpleDateFormat formatter = new SimpleDateFormat("yyyy年-MM月dd日-HH时mm分ss秒");
        Date date = new Date(currentTime);
        System.out.println(formatter.format(date));

        Reporter.log(formatter.format(date) + splitTimeAndMsg + msg, true);

    }

}

3.钉钉上添加钉钉机器人，保存webhook

4.config目录下ExtentTestNGIReporterListener类，增加钉钉机器人配置

package config;

import com.aventstack.extentreports.reporter.configuration.Theme;
import org.testng.*;
import org.testng.xml.XmlSuite;

import java.io.File;
import java.util.*;
import com.aventstack.extentreports.ExtentReports;
import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.ResourceCDN;
import com.aventstack.extentreports.Status;
import com.aventstack.extentreports.model.TestAttribute;
import com.aventstack.extentreports.reporter.ExtentHtmlReporter;
import com.aventstack.extentreports.reporter.configuration.ChartLocation;
import utils.DingDingUtil;
import utils.ReportUtil;

/**
 * 测试报告模板.
 */
public class ExtentTestNGIReporterListener implements IReporter {
    //生成的路径以及文件名
    private static final String OUTPUT_FOLDER = "test-output/";
    private static final String FILE_NAME = "index.html";
    private ExtentReports extent;

    @Override
    public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory) {
        init();
        //统计suite下的成功、失败、跳过和总的用例数
        int suiteSize=0;
        int suiteFailSize=0;
        int suitePassSize=0;
        int suiteSkipSize=0;
        boolean createSuiteNode = false;
        if(suites.size()>1){
            createSuiteNode=true;
        }
        for (ISuite suite : suites) {
            Map<String, ISuiteResult> result = suite.getResults();
            //如果suite里面没有任何用例，直接跳过，不在报告里生成
            if(result.size()==0){
                continue;
            }

            ExtentTest suiteTest=null;
            //存在多个suite的情况下，在报告中将同一个一个suite的测试结果归为一类，创建一级节点。
            if(createSuiteNode){
                suiteTest = extent.createTest(suite.getName()).assignCategory(suite.getName());
            }
            boolean createSuiteResultNode = false;
            if(result.size()>=1){
                createSuiteResultNode=true;
            }
            for (ISuiteResult r : result.values()) {
                ExtentTest resultNode;
                ITestContext context = r.getTestContext();
                if(createSuiteResultNode){
                    //没有创建suite的情况下，将在SuiteResult的创建为一级节点，否则创建为suite的一个子节点。
                    if( null == suiteTest){
                        resultNode = extent.createTest(r.getTestContext().getName());
                    }else{
                        resultNode = suiteTest.createNode(r.getTestContext().getName());
                    }
                }else{
                    resultNode = suiteTest;
                }
                if(resultNode != null){
                    resultNode.getModel().setName(suite.getName()+" : "+r.getTestContext().getName());
                    if(resultNode.getModel().hasCategory()){
                        resultNode.assignCategory(r.getTestContext().getName());
                    }else{
                        resultNode.assignCategory(suite.getName(),r.getTestContext().getName());
                    }
                    resultNode.getModel().setStartTime(r.getTestContext().getStartDate());
                    resultNode.getModel().setEndTime(r.getTestContext().getEndDate());
                    //统计SuiteResult下的数据
                    int passSize = r.getTestContext().getPassedTests().size();
                    int failSize = r.getTestContext().getFailedTests().size();
                    int skipSize = r.getTestContext().getSkippedTests().size();
                    suitePassSize += passSize;
                    suiteFailSize += failSize;
                    suiteSkipSize += skipSize;
                    if(failSize>0){
                        resultNode.getModel().setStatus(Status.FAIL);
                    }
                    resultNode.getModel().setDescription(String.format("Pass: %s ; Fail: %s ; Skip: %s ;",passSize,failSize,skipSize));
                }
                buildTestNodes(resultNode,context.getFailedTests(), Status.FAIL);
                buildTestNodes(resultNode,context.getSkippedTests(), Status.SKIP);
                buildTestNodes(resultNode,context.getPassedTests(), Status.PASS);
            }
            if(suiteTest!= null){
                suiteTest.getModel().setDescription(String.format("Pass: %s ; Fail: %s ; Skip: %s ;",suitePassSize,suiteFailSize,suiteSkipSize));
                if(suiteFailSize>0){
                    suiteTest.getModel().setStatus(Status.FAIL);
                }
            }

        }
//        for (String s : Reporter.getOutput()) {
//            extent.setTestRunnerOutput(s);
//        }

        extent.flush();
        suiteSize = suiteFailSize + suitePassSize + suiteSkipSize;

        //新加钉钉机器人测试报告
        String pass= DingDingUtil.folatToPer((float)suitePassSize/suiteSize);
        String url ="https://oapi.dingtalk.com/robot/send?access_token=457d8eb62b4f0b1e5781f3862c0b9e77ab21f";
        String context="此次运行接口用例，总用例数为："+suiteSize+"；通过："+suitePassSize+"；失败："+suiteFailSize+"；跳过："+suiteSkipSize+"；通过率为："+pass;
        try {
            DingDingUtil.sendVal(url,context);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private void init() {
        //文件夹不存在的话进行创建
        File reportDir= new File(OUTPUT_FOLDER);
        if(!reportDir.exists()&& !reportDir .isDirectory()){
            reportDir.mkdir();
        }
        ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter(OUTPUT_FOLDER + FILE_NAME);
        htmlReporter.config().setDocumentTitle("秀场-接口自动化测试报告");
        htmlReporter.config().setReportName("秀场-接口自动化测试报告");
        htmlReporter.config().setChartVisibilityOnOpen(true);
        htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);
        //设置报告背景颜色
        htmlReporter.config().setTheme(Theme.DARK);
        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);
        htmlReporter.config().setCSS(".node.level-1  ul{ display:none;} .node.level-1.active ul{display:block;}");
        extent = new ExtentReports();
        extent.attachReporter(htmlReporter);
        extent.setReportUsesManualConfiguration(true);
        // 设置系统信息
        Properties properties = System.getProperties();
//        extent.setSystemInfo("os.name",properties.getProperty("os.name","未知"));
//        extent.setSystemInfo("os.arch",properties.getProperty("os.arch","未知"));
//        extent.setSystemInfo("os.version",properties.getProperty("os.version","未知"));
//        extent.setSystemInfo("java.version",properties.getProperty("java.version","未知"));
//        extent.setSystemInfo("java.home",properties.getProperty("java.home","未知"));
//        extent.setSystemInfo("user.name",properties.getProperty("user.name","未知"));
//        extent.setSystemInfo("user.dir",properties.getProperty("user.dir","未知"));

        // 设置自定义配置信息
        Map<String,String> systemmap = new  HashMap<>();
        MySystemInfo mySystemInfo = new MySystemInfo();
        systemmap = mySystemInfo.getSystemInfo();
        for (Map.Entry<String,String> entry:
                systemmap.entrySet()) {
            extent.setSystemInfo(entry.getKey(),entry.getValue());
        }

    }

    private void buildTestNodes(ExtentTest extenttest, IResultMap tests, Status status) {
        //存在父节点时，获取父节点的标签
        String[] categories=new String[0];
        if(extenttest != null ){
            List<TestAttribute> categoryList = extenttest.getModel().getCategoryContext().getAll();
            categories = new String[categoryList.size()];
            for(int index=0;index<categoryList.size();index++){
                categories[index] = categoryList.get(index).getName();
            }
        }

        ExtentTest test;

        if (tests.size() > 0) {
            //调整用例排序，按时间排序
            Set<ITestResult> treeSet = new TreeSet<ITestResult>(new Comparator<ITestResult>() {
                @Override
                public int compare(ITestResult o1, ITestResult o2) {
                    return o1.getStartMillis()<o2.getStartMillis()?-1:1;
                }
            });
            treeSet.addAll(tests.getAllResults());
            for (ITestResult result : treeSet) {
                Object[] parameters = result.getParameters();
                String name="";
                //如果有参数，则使用参数的toString组合代替报告中的name
                for(Object param:parameters){
                    name+=param.toString();
                }
                if(name.length()>0){
                    if(name.length()>50){
                        name= name.substring(0,49)+"...";
                    }
                }else{
                    name = result.getMethod().getMethodName();
                }
                if(extenttest==null){
                    test = extent.createTest(name);
                }else{
                    //作为子节点进行创建时，设置同父节点的标签一致，便于报告检索。
                    test = extenttest.createNode(name).assignCategory(categories);
                }
                //test.getModel().setDescription(description.toString());
                //test = extent.createTest(result.getMethod().getMethodName());
                for (String group : result.getMethod().getGroups())
                    test.assignCategory(group);

                List<String> outputList = Reporter.getOutput(result);
                for(String output:outputList){
                    //将用例的log输出报告中
//                    test.debug(output);
                    test.debug(output.replaceAll("<","&lt;").replaceAll(">","&gt;"));
                }
                if (result.getThrowable() != null) {
                    test.log(status, result.getThrowable());
                }
                else {
                    test.log(status, "Test " + status.toString().toLowerCase() + "ed");
                }

                test.getModel().setStartTime(getTime(result.getStartMillis()));
                test.getModel().setEndTime(getTime(result.getEndMillis()));
            }
        }
    }

    private Date getTime(long millis) {
        Calendar calendar = Calendar.getInstance();
        calendar.setTimeInMillis(millis);
        return calendar.getTime();
    }
}

增加部分如下图：

5.使用testng里的xml文件执行test，钉钉机器人发送测试结果