全栈搭建接口自动化之接口开发（四）

一、前言

前面我们把Jenkins环境、开发环境都搭建好了，现在是不是开始可以写代码了，of course，lets do it!

二、实战开始

看到网上的教学都喜欢拿登录、注册做demo，这次小弟就不走寻常路，来个交易接口作为这次的demo，那么问题来了，交易的前提肯账号必须登录的情况下呀对不对，哼对于咱们开发来说就是一个token/cookie的问题，如果不知道cookie/token是啥的测试人员好好的系统性的多去了解开发的东西，不然多年测试白走一回

设计思路开始了，首先呢封装一个类调用登录接口获取返回值token，token啥模样呢？咱们看一看瞧一瞧

fiddler一开，接口尽来，看到木有其实就是一串字符码，别在问我fiddler是啥咯哦，不然卸载CSDN吧，emmmm…大哥我开玩笑别打我

2.既然你知道了登录接口，知道了请求域名那么就感觉封装登录接口获取cookie吧

3.新建个类，源码拷贝过去就行，idea会自动帮你引入第三方包

/*** 【封装cookie类】** @author XXX 2019/03/05* */public class getCookie {//获取APP登录 cookie值public static String httpGetAppCookie(String account, String password) throws IOException {HttpPost post = new HttpPost("http://域名/app/uc/login");CloseableHttpClient client = HttpClients.createDefault();//设置请求头post.setHeader("Content-Type","application/x-www-form-urlencoded");//设置请求体List<NameValuePair> paramenters = new ArrayList<NameValuePair>();paramenters.add(new BasicNameValuePair("account",account));paramenters.add(new BasicNameValuePair("pwd",password));HttpEntity requestEntity = new UrlEncodedFormEntity(paramenters);post.setEntity(requestEntity);//执行post请求CloseableHttpResponse response = client.execute(post);//获取的响应内容HttpEntity entity = response.getEntity();String entityString = EntityUtils.toString(entity);//获得cookie值JSONObject json = new JSONObject(entityString);JSONObject jsonData = json.getJSONObject("data");return "token="+jsonData.getString("token");}
}

如果有问我请求体的key为啥是account跟pwd，我抓包工具截图抓出来的哦，真正的实战去看开发接口文档会更方便点，什么？没有接口文档，天杀的开发人员，怼啊老哥
另外小弟得坦白，第31行其实可以把域名，接口都写在application.properties配置文件进行管理的，我偷了个懒，如果大佬们要精益求精那就参考这个吧：https://blog.csdn.net/weixin_40686603/article/details/84751708

4.来吧开始写testng配置文件了，新建个testng.xml

<?xml version="1.0" encoding="UTF-8" ?><suite name="TestSuite"><test name="创建cdk订单"><classes><parameter name="account" value="账号"/><parameter name="password" value="123456"/><parameter name="isPreCreate" value="true"/><parameter name="gameId" value="3"/><parameter name="payApiId" value="10"/><class name="com.test.demo.TestDemo"/></classes></test><listeners><listener class-name="com.test.demo.ExtentTestNGIReporterListener"/></listeners>
</suite>

有人可能会有疑问，parameter是啥玩意儿，我想那你得要系统性的去学习testNG是啥了，懂了你就会用，在这里parameter就是用来运行代码传的参数

5.testng搞定了，那么就开始我们一个demo演示吧

public class TestDemo {@Test@Parameters({"account","password","isPreCreate","gameId","payApiId"})public void testDemo(String account,String password,boolean isPreCreate,long gameId,long payApiId) throws IOException {HttpPost post = new HttpPost("http://appservice.wogame-test.com/app/trade/buyCdkOrder");CloseableHttpClient client = HttpClients.createDefault();//设置请求头post.setHeader("Content-Type","application/x-www-form-urlencoded");post.setHeader("Cookie", GetCookie.getCooike(account,password));//设置请求体List<NameValuePair> paramenters = new ArrayList<NameValuePair>();paramenters.add(new BasicNameValuePair("isPreCreate",String.valueOf(isPreCreate)));paramenters.add(new BasicNameValuePair("gameId",String.valueOf(gameId)));paramenters.add(new BasicNameValuePair("payApiId",String.valueOf(payApiId)));HttpEntity requestEntity = new UrlEncodedFormEntity(paramenters);post.setEntity(requestEntity);//执行post请求CloseableHttpResponse response = client.execute(post);//获得响应内容HttpEntity entity = response.getEntity();String entityString = EntityUtils.toString(entity);//对响应内容断言JSONObject json = new JSONObject(entityString);System.out.println(json);Assert.assertEquals(json.getString("code"),"2000","/app/trade/buyCdkOrder接口异常"+"\n"+String.valueOf(json));}
}

看到了没，testng的参数我给引过来啦，为啥要这样做，因为参数是多变的呀，如果你通过代码写死那你还玩个P接口自动化对不对，所以哦各位老哥搭建这套全栈框架之前，考虑代码的易用性，维护性也是我第一章讲的要思考的问题

6.然后呢？是不是得要运行testng跑接口试试效果啊对不对

舒不舒服，爽不爽？但是呢还没结束哦

7.心细的老哥会发现我testng.xml文件引入了一个ExtentTestNGIReporterListener的监听脚本，那是啥是生成测试报告的玩意儿，不信你看看我跑完接口多了个test-out的文件夹，里面是不是有个测试报告
![在这里插入图片描述
8.ExtentTestNGIReporterListener源码

package com.test.demo;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 com.aventstack.extentreports.reporter.configuration.Theme;
import org.testng.*;
import org.testng.xml.XmlSuite;import java.io.File;
import java.util.*;public class ExtentTestNGIReporterListener implements IReporter {//生成的路径以及文件名private static final String OUTPUT_FOLDER = "test-output/";private static final String FILE_NAME = "AutoTest.html";private ExtentReports extent;@Overridepublic void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory) {init();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;}//统计suite下的成功、失败、跳过的总用例数int suiteFailSize=0;int suitePassSize=0;int suiteSkipSize=0;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();}private void init() {//文件夹不存在的话进行创建File reportDir= new File(OUTPUT_FOLDER);if(!reportDir.exists()&& !reportDir .isDirectory()){reportDir.mkdir();}ExtentHtmlReporter htmlReporter = new ExtentHtmlReporter(OUTPUT_FOLDER + FILE_NAME);// 设置静态文件的DNS//怎么样解决csdn无法加载的问题htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);htmlReporter.config().setDocumentTitle("自动化测试报告");htmlReporter.config().setReportName("自动化测试报告");htmlReporter.config().setChartVisibilityOnOpen(true);htmlReporter.config().setTestViewChartLocation(ChartLocation.TOP);htmlReporter.config().setTheme(Theme.STANDARD);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);}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>() {@Overridepublic 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组合代替报告中的namefor(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);}if (result.getThrowable() != null) {test.log(status, result.getThrowable());}else {test.log(status, "TestDemo " + 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();}
}

9.老哥舒服不？一站式给你搞定，那么咱就更舒服点打开报告看看

报告长这玩意儿，有人会有疑问为啥是一串字符串，而不是接口名，那是因为我testng.xml没有用group，你加上就OK

10.兄弟这时候你要睡觉，你要休息等明天再写咋整，上传到git上去吧，让Git给你管理让你无后顾之忧

git常用三步操作git add、commit、push好奇的小伙伴可能就会问，这个干嘛的呢？好奇心害死人这样你又得去了解啥是git了哈哈，但是这个一定要会，好东西开源很多公司都用，别面试问你啥都不知道

当然我这边偷懒不规范正常开发人员还得先pull一下代码看下是否有冲突在进行后面操作

11.push完了然后呢？idea没啥变化呀，你的去Git上看，这可是小白步骤我说多了懂得大佬得骂我了

OK搞定，这下接口开发就告一段落了，后面我们该干啥？干你…emmmmmm，阿弥陀佛

后面我们得通过maven编译触发testng执行，然后将Jenkins与git进行结合以及邮件发送测试报告了