java接口自動化接口測試

功能介紹

實現接口自動化測試代碼。
注：這裏測試的接口是spring boot開發接口中開發好的接口，只需運行application.java中的main方法，即可啓動接口。

使用框架

• httpclient
• mybatis
• testng

pom文件

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.course</groupId>
    <artifactId>requestTest</artifactId>
    <version>1.0-SNAPSHOT</version>


    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.1.2</version>
        </dependency>
        <dependency>
            <groupId>org.json</groupId>
            <artifactId>json</artifactId>
            <version>20170516</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.17</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.14</version>
        </dependency>
        <dependency>
            <groupId>com.relevantcodes</groupId>
            <artifactId>extentreports</artifactId>
            <version>2.41.1</version>
        </dependency>
        <dependency>
            <groupId>com.vimalselvam</groupId>
            <artifactId>testng-extentsreport</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency>
            <groupId>com.aventstack</groupId>
            <artifactId>extentreports</artifactId>
            <version>3.0.6</version>
        </dependency>
        <dependency>
            <groupId>org.testng</groupId>
            <artifactId>testng</artifactId>
            <version>6.10</version>
        </dependency>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.1.1</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
            <version>1.2.1.RELEASE</version>
        </dependency>
    </dependencies>


	<!-- 打包需要的配置 -->
    <!--
		maven-surefire-plugin：執行mvn命令時，執行應用程序的單元測試
	-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.19.1</version>
                <configuration>
                    <suiteXmlFiles>
                        <suiteXmlFile>
                            src/main/resources/testng.xml
                        </suiteXmlFile>
                    </suiteXmlFiles>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

測試用例

測試用例使用mysql數據庫管理

測試用例	測試的接口	接口描述
logincase	/v1/login	登陸接口
getuserinfocase	/v1/getUserInfo	獲取用戶信息接口
getuserlistcase	/v1/getUserInfo	獲取用戶列表接口
addusercase	/v1/addUser	添加用戶接口
updateuserinfocase	/v1/updateUserInfo	更新用戶信息接口

配置

mybatis配置文件

databaseConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <settings>
        <!--mybatis一級緩存只對STATEMENT有效-->
        <setting name="localCacheScope" value="STATEMENT"/>
        <!--mybatis關閉二級緩存-->
        <setting name="cacheEnabled" value="false"/>
        <!--mybatis在控制檯打印sql-->
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>

    <!-- 註冊對象的空間命名 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!-- 1.加載數據庫驅動 -->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <!-- 2.數據庫連接地址 -->
                <property name="url" value="jdbc:mysql://localhost:3306/course?serverTimezone=UTC"/>
                <!-- 數據庫用戶... -->
                <property name="username" value="root"/>
                <!-- 數據庫密碼... -->
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 註冊映射文件：java對象與數據庫之間的xml文件路徑！ -->
    <mappers>
        <mapper resource="mapper/SQLMapper.xml"/>
    </mappers>

</configuration>

testng基礎配置

testng.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >

<suite name="用戶管理系統測試套件">
    <test name="用戶管理系統測試用例">

	</test>
</suite>    

配置應用程序屬性文件

application.properties

test.url=http://localhost:8888

#登陸接口uri
login.uri=/v1/login

#更新用戶信息接口uri
updateUserInfo.uri=/v1/updateUserInfo

#獲取用戶列表接口uri
getUserList.uri=/v1/getUserInfo

#獲取用戶信息接口uri
getUserInfo.uri=/v1/getUserInfo

#添加用戶接口uri
addUser.uri=/v1/addUser

# 設置生成日誌
logging.path=logs
logging.file=caseTest.log

model層

將數據表中各個表的字段轉換爲Java bean對象

AddUserCase.java

package com.course.model;

import lombok.Data;

/**
 * 添加用戶接口的測試用例
 */
@Data
public class AddUserCase {
    private String userName;
    private String password;
    private String sex;
    private String age;
    private String permission;
    private String isDelete;
    private String expected;
}

GetUserInfoCase.java

package com.course.model;

import lombok.Data;

/**
 * 獲取用戶信息的測試用例
 */
@Data
public class GetUserInfoCase {
    private int userId;
    private String expected;
}

GetUserListCase.java

package com.course.model;

import lombok.Data;

/**
 * 獲取用戶列表
 */
@Data
public class GetUserListCase {
    private String userName;
    private String age;
    private String sex;
    private String expected;
}

InterfaceName.java
創建一個枚舉類，對應接口的名稱

package com.course.model;

/**
 * 將需要測試的接口進行枚舉，防止使用 測試範圍外的非法接口
 */
public enum InterfaceName {

    GETUSERLIST,LOGIN,UPDATEUSERINFO,GETUSERINFO,ADDUSERINFO

}

LoginCase.java

package com.course.model;

import lombok.Data;

/**
 * 登錄接口的測試用例
 */
@Data
public class LoginCase {
    private int id;
    private String userName;
    private String password;
    private String expected;
}

UpdateUserInfoCase.java

package com.course.model;


import lombok.Data;

/**
 * 更新用戶信息接口的測試用例
 */
@Data
public class UpdateUserInfoCase {

    private int id;
    private int userId;
    private String userName;
    private String sex;
    private String age;
    private String permission;
    private String isDelete;
    private String expected;

}

User.java

package com.course.model;

import lombok.Data;

/**
 * 用戶 Java Bean
 */
@Data
public class User {
    private int id;
    private String userName;
    private String password;
    private int age;
    private String sex;
    private int permission;
    private int isDelete;

    ///複寫toString方法，用來處理json
    @Override
    public String toString(){
        return (
                "id:"+id+","+
                "userName:"+userName+","+
                "password:"+password+","+
                "age:"+age+","+
                "sex:"+sex+","+
                "permission:"+permission+","+
                "isDelete:"+isDelete+"}"
        );
    }
}

config層

創建測試報告類

ExtentTestNGIReporterListener.java
然後將報告加入監聽

package com.course.config;

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 = "index.html";

    private ExtentReports extent;

    @Override
    public 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);
        //怎麼樣解決cdn.rawgit.com訪問不了的情況？設置靜態文件的DNS
        htmlReporter.config().setResourceCDN(ResourceCDN.EXTENTREPORTS);

        htmlReporter.config().setDocumentTitle("api自動化測試報告");
        htmlReporter.config().setReportName("api自動化測試報告");
        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>() {
                @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);
                }
                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();
    }
}

testng.xml

    <!--添加測試報告監聽器-->
    <listeners>
        <listener class-name="com.course.config.ExtentTestNGIReporterListener"></listener>
    </listeners>

獲取用戶配置基礎信息

創建TestConfig對象，對應application.properties中的接口名稱

TestConfig.java

package com.course.config;

import lombok.Data;
import org.apache.http.client.CookieStore;
import org.apache.http.impl.client.DefaultHttpClient;


@Data
public class TestConfig {

    //登陸接口uri
    public static String loginUrl;
    //更新用戶信息接口uri
    public static String updateUserInfoUrl;
    //獲取用戶列表接口uri
    public static String getUserListUrl;
    //獲取用戶信息接口uri
    public static String getUserInfoUrl;
    //添加用戶信息接口
    public static String addUserUrl;

    //聲明http客戶端
    public static DefaultHttpClient defaultHttpClient;
    //用來存儲cookies信息的變量
    public static CookieStore store;

}

utils層

拼接url工具類

注意：工具類裏的對象、方法，我們一般聲明爲靜態方法static，不用new，直接用。

ConfigFile.java

package com.course.utils;

import com.course.model.InterfaceName;

import java.util.Locale;
import java.util.ResourceBundle;

/**
 * 讀取application.properties文件，拼接測試接口URL
 */
public class ConfigFile {

    private static ResourceBundle bundle= ResourceBundle.getBundle("application", Locale.CHINA);;

    //傳進來的name，必須是我們設計的InterfaceName類中枚舉的接口名，不能瞎傳
    public static String getUrl(InterfaceName name){
        String address = bundle.getString("test.url");
        String uri = ""; //獲取application.perperties中的uri
        String testUrl;  //最終的測試地址，address+uri
        if(name == InterfaceName.GETUSERLIST){
            uri = bundle.getString("getUserList.uri");

        }

        if(name == InterfaceName.LOGIN){
            uri = bundle.getString("login.uri");
        }

        if(name == InterfaceName.UPDATEUSERINFO){
            uri = bundle.getString("updateUserInfo.uri");
        }

        if(name == InterfaceName.GETUSERINFO){
            uri = bundle.getString("getUserInfo.uri");
        }

        if(name == InterfaceName.ADDUSERINFO){
            uri = bundle.getString("addUser.uri");
        }
        testUrl = address + uri;
        return testUrl;
    }
}

數據庫工具類

創建連接數據庫的session

DatabaseUtil.java

package com.course.utils;


import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.Reader;

/**
 * 數據庫工具類
 */
public class DatabaseUtil {

    public static SqlSession getSqlSession() throws IOException {
        //獲取配置的資源文件
        Reader reader = Resources.getResourceAsReader("databaseConfig.xml");
        //得到SqlSessionFactory，使用類加載器加載xml文件
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
        //得到sqlsession對象，這個對象就能執行配置文件中的sql語句啦
        SqlSession session = factory.openSession();
        return session;
    }
}

開發測試用例代碼

編寫測試代碼

AddUserTest.java

package com.course.cases;

import com.course.config.TestConfig;
import com.course.model.AddUserCase;
import com.course.model.User;
import com.course.utils.DatabaseUtil;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.util.EntityUtils;
import org.apache.ibatis.session.SqlSession;
import org.json.JSONObject;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Transactional;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.io.IOException;

public class AddUserTest {

    //執行這個用例，前提需要登錄成功！
    //所以需要依賴登錄成功那個組
    @Test(dependsOnGroups = "loginTrue",description = "添加用戶接口測試")
    @Transactional(isolation = Isolation.READ_UNCOMMITTED)
    public void addUser() throws IOException, InterruptedException {
        SqlSession session = DatabaseUtil.getSqlSession();
        System.out.println(session);
        AddUserCase addUserCase = session.selectOne("addUserCase", 1);
        System.out.println("測試數據爲："+ addUserCase.toString());
        System.out.println( "addUser的uri爲：" + TestConfig.addUserUrl);
        //發請求，獲取結果
        String result = getResult(addUserCase);
        //驗證返回結果
        //session.commit();
        /*
        getResult調用接口，實際上是又開了一個進程，跟測試用例addUser()代碼是並行運行的，
        這個時候就需要讓測試代碼休息一下，等待接口調用完畢後，再去查數據庫的結果，否則可能查出來user爲null
         */
        Thread.sleep(2000);

        User user = session.selectOne("addUser", addUserCase); //sql：查看新增加的user
        System.out.println("請求接口後，user表中新增的user爲：" + user.toString());

        //處理結果，判斷返回結果是否符合預期
        Assert.assertEquals(addUserCase.getExpected(), result);
    }

    private String getResult(AddUserCase addUserCase) throws IOException {
        HttpPost post = new HttpPost(TestConfig.addUserUrl);
        JSONObject param = new JSONObject();
        param.put("userName", addUserCase.getUserName());
        param.put("password", addUserCase.getPassword());
        param.put("sex", addUserCase.getSex());
        param.put("age", addUserCase.getAge());
        param.put("permission", addUserCase.getPermission());
        param.put("isDelete", addUserCase.getIsDelete());
        //設置頭信息
        post.setHeader("content-type", "application/json");
        StringEntity entity = new StringEntity(param.toString(), "utf-8");
        post.setEntity(entity);

        //設置cookies
        TestConfig.defaultHttpClient.setCookieStore(TestConfig.store);
        String result; //存放返回結果
        HttpResponse response = TestConfig.defaultHttpClient.execute(post);
        result = EntityUtils.toString(response.getEntity(), "utf-8");
        System.out.println("請求響應結果爲：" + result);
        return result;
    }
}

GetUserInfoListTest.java

package com.course.cases;

import com.course.config.TestConfig;
import com.course.model.GetUserListCase;
import com.course.model.User;
import com.course.utils.DatabaseUtil;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.util.EntityUtils;
import org.apache.ibatis.session.SqlSession;
import org.json.JSONArray;
import org.json.JSONObject;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.io.IOException;
import java.util.List;

public class GetUserInfoListTest {

    @Test(dependsOnGroups = "loginTrue", description = "獲取性別爲男的用戶信息")
    public void getUserListInfo() throws IOException {
        SqlSession session = DatabaseUtil.getSqlSession();
        GetUserListCase getUserListCase = session.selectOne("getUserListCase", 1);
        System.out.println(getUserListCase.toString());
        System.out.println(TestConfig.getUserListUrl);

        //第1步：發送請求，獲取結果
        //實際結果
        JSONArray resultJSON = getJsonResult(getUserListCase);

        //第2步：驗證
        List<User> userList = session.selectList(getUserListCase.getExpected(), getUserListCase);
        for (User u: userList){
            System.out.println("獲取的user是" + u.toString());
        }

        //預期結果
        JSONArray userListJson = new JSONArray(userList);

        //判斷獲取用戶的個數與預期是否相同
        Assert.assertEquals(userListJson.length(), resultJSON.length());

        //判斷請求獲取的每個用戶信息與預期是否相同
        for (int i = 0; i < resultJSON.length(); i++){
            JSONObject expect = (JSONObject) resultJSON.get(i);
            JSONObject actual = (JSONObject) userListJson.get(i);
            Assert.assertEquals(expect.toString(), actual.toString());

        }
    }

    private JSONArray getJsonResult(GetUserListCase getUserListCase) throws IOException {
        HttpPost post = new HttpPost(TestConfig.getUserListUrl);
        JSONObject param = new JSONObject(); //設置json數據
        param.put("userName", getUserListCase.getUserName());
        param.put("sex", getUserListCase.getSex());
        param.put("age", getUserListCase.getAge());

        post.setHeader("content-type", "application/json"); //設置header

        StringEntity entity = new StringEntity(param.toString(), "utf-8");
        post.setEntity(entity); //設置entity

        TestConfig.defaultHttpClient.setCookieStore(TestConfig.store); //設置cookie

        HttpResponse response = TestConfig.defaultHttpClient.execute(post);
        String result = EntityUtils.toString(response.getEntity(), "utf-8");
        JSONArray jsonArray = new JSONArray(result);

        return jsonArray;
    }
}

GetUserInfoTest.java

package com.course.cases;

import com.course.config.TestConfig;
import com.course.model.GetUserInfoCase;
import com.course.model.User;
import com.course.utils.DatabaseUtil;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.util.EntityUtils;
import org.apache.ibatis.session.SqlSession;
import org.json.JSONArray;
import org.json.JSONObject;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class GetUserInfoTest {


    @Test(dependsOnGroups = "loginTrue", description = "獲取userId爲1的用戶信息")
    public void getUerInfoTest() throws IOException {
        SqlSession session = DatabaseUtil.getSqlSession();
        GetUserInfoCase getUserInfoCase = session.selectOne("getUserInfoCase", 1);
        System.out.println(getUserInfoCase.toString());
        System.out.println(TestConfig.getUserInfoUrl);

        //發送請求
        //實際結果
        JSONArray resultJSON = getJsonResult(getUserInfoCase);

        //mapper id取getUserInfoCase中的expected字段，即獲取預期的用戶信息
        User user = session.selectOne(getUserInfoCase.getExpected(), getUserInfoCase);

        List userList = new ArrayList();
        userList.add(user);
        //預期結果
        JSONArray jsonArray = new JSONArray(userList);

        JSONArray jsonArray_res = new JSONArray(resultJSON.getString(0));

        //jsonArray與jsonArray_res內元素順序可能不同，不能這樣斷言；可以將裏面每個元素取出，逐個斷言
        Assert.assertEquals(jsonArray.toString(), jsonArray_res.toString());


    }

    private JSONArray getJsonResult(GetUserInfoCase getUserInfoCase) throws IOException {
        HttpPost post = new HttpPost(TestConfig.getUserInfoUrl);
        JSONObject param = new JSONObject();
        param.put("id", getUserInfoCase.getUserId());

        post.setHeader("content-type", "application/json");
        StringEntity entity = new StringEntity(param.toString(), "utf-8");
        post.setEntity(entity);

        TestConfig.defaultHttpClient.setCookieStore(TestConfig.store);
        HttpResponse response = TestConfig.defaultHttpClient.execute(post);

        String result = EntityUtils.toString(response.getEntity(), "utf-8");
        List resultList = Arrays.asList(result);
        JSONArray array = new JSONArray(resultList);
        return array;
    }
}

LoginTest.java

package com.course.cases;

import com.course.config.TestConfig;
import com.course.model.InterfaceName;
import com.course.model.LoginCase;
import com.course.utils.ConfigFile;
import com.course.utils.DatabaseUtil;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
import org.apache.ibatis.session.SqlSession;
import org.json.JSONObject;
import org.testng.Assert;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

import java.io.IOException;

public class LoginTest {

    @BeforeTest(groups = "loginTrue", description = "測試準備工作，獲取httpclient對象")
    public void beforeTest(){
        TestConfig.getUserInfoUrl = ConfigFile.getUrl(InterfaceName.GETUSERINFO);
        TestConfig.getUserListUrl = ConfigFile.getUrl(InterfaceName.GETUSERLIST);
        TestConfig.addUserUrl = ConfigFile.getUrl(InterfaceName.ADDUSERINFO);
        TestConfig.loginUrl = ConfigFile.getUrl(InterfaceName.LOGIN);
        TestConfig.updateUserInfoUrl = ConfigFile.getUrl(InterfaceName.UPDATEUSERINFO);
        TestConfig.defaultHttpClient = new DefaultHttpClient();

    }

    @Test(groups = "loginTrue", description = "用戶登錄成功接口測試")
    public void loginTrue() throws IOException {
        SqlSession session = DatabaseUtil.getSqlSession();
        LoginCase loginCase = session.selectOne("loginCase", 1);//取xml文件中sql語句id爲loginCase的，取數據庫中id爲1的數據
        System.out.println(loginCase.toString());
        System.out.println(TestConfig.loginUrl);

        //第1步：發送請求
        String result = getResult(loginCase);
        System.out.println(result);
        //驗證結果
        Assert.assertEquals(loginCase.getExpected(), result);
    }


    @Test(groups = "loginFalse", description = "用戶登錄失敗接口測試")
    public void loginFalse() throws IOException {
        SqlSession session = DatabaseUtil.getSqlSession();
        LoginCase loginCase = session.selectOne("loginCase", 2);//取xml文件中sql語句id爲loginCase的，取數據庫中id爲2的數據
        System.out.println(loginCase.toString());
        System.out.println(TestConfig.loginUrl);

        //第1步：發送請求
        String result = getResult(loginCase);
        System.out.println(result);
        //驗證結果
        Assert.assertEquals(loginCase.getExpected(), result);
    }


    private String getResult(LoginCase loginCase) throws IOException {
        HttpPost post = new HttpPost(TestConfig.loginUrl);
        JSONObject param = new JSONObject();
        param.put("userName", loginCase.getUserName());
        param.put("password", loginCase.getPassword());

        post.setHeader("content-type", "application/json");
        StringEntity entity = new StringEntity(param.toString(), "utf-8");
        post.setEntity(entity);
        String result;
        HttpResponse response = TestConfig.defaultHttpClient.execute(post);
        result = EntityUtils.toString(response.getEntity(), "utf-8");
        TestConfig.store = TestConfig.defaultHttpClient.getCookieStore();
        return result;
    }
}

UpdateUserInfoTest.java

package com.course.cases;

import com.course.config.TestConfig;
import com.course.model.UpdateUserInfoCase;
import com.course.model.User;
import com.course.utils.DatabaseUtil;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.util.EntityUtils;
import org.apache.ibatis.session.SqlSession;
import org.json.JSONObject;
import org.testng.Assert;
import org.testng.annotations.Test;

import java.io.IOException;

public class UpdateUserInfoTest {

    @Test(dependsOnGroups = "loginTrue", description = "更改用戶信息接口測試用例")
    public void updateUserInfo() throws IOException, InterruptedException {
        SqlSession session = DatabaseUtil.getSqlSession();
        UpdateUserInfoCase updateUserInfoCase = session.selectOne("updateUserInfoCase", 1);
        System.out.println(updateUserInfoCase.toString());
        System.out.println(TestConfig.updateUserInfoUrl);

        int result = getResult(updateUserInfoCase);

        Thread.sleep(3000);
        session.commit();
        User user = session.selectOne(updateUserInfoCase.getExpected(), updateUserInfoCase);

        //判斷user不爲空
        Assert.assertNotNull(user);
        //判斷result不爲空
        Assert.assertNotNull(result);
    }


    @Test(dependsOnGroups = "loginTrue", description = "刪除用戶信息")
    public void deleteUser() throws IOException, InterruptedException {
        SqlSession session = DatabaseUtil.getSqlSession();
        UpdateUserInfoCase updateUserInfoCase = session.selectOne("updateUserInfoCase", 2);
        System.out.println(updateUserInfoCase.toString());
        System.out.println(TestConfig.updateUserInfoUrl);

        int result = getResult(updateUserInfoCase);

        Thread.sleep(3000);
        session.commit();
        User user = session.selectOne(updateUserInfoCase.getExpected(), updateUserInfoCase);

        //判斷user不爲空
        Assert.assertNotNull(user);
        Assert.assertNotNull(result);
    }


    private int getResult(UpdateUserInfoCase updateUserInfoCase) throws IOException {
        HttpPost post = new HttpPost(TestConfig.updateUserInfoUrl);
        //設置請求json
        JSONObject param = new JSONObject();
        param.put("id", updateUserInfoCase.getUserId());
        param.put("userName", updateUserInfoCase.getUserName());
        param.put("sex", updateUserInfoCase.getSex());
        param.put("age", updateUserInfoCase.getAge());
        param.put("permission", updateUserInfoCase.getPermission());
        param.put("isDelete", updateUserInfoCase.getIsDelete());
        //設置請求頭信息
        post.setHeader("content-type", "application/json");

        //設置請求實體
        StringEntity entity = new StringEntity(param.toString(), "utf-8");
        post.setEntity(entity);

        //設置cookie
        TestConfig.defaultHttpClient.setCookieStore(TestConfig.store);

        String result;
        HttpResponse response = TestConfig.defaultHttpClient.execute(post);
        result = EntityUtils.toString(response.getEntity(), "utf-8");

        return Integer.parseInt(result);
    }

}

編寫對應的sql

SQLMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 命名空間mapper,如果有多個mapper文件，這個必須唯一 -->
<mapper namespace="com.course.model">

    <!--獲取登陸接口case-->
    <select id="loginCase" parameterType="Integer"  resultType="com.course.model.LoginCase">

        select * from loginCase
        where id = #{id};
    </select>
    <!--添加用戶接口case-->
    <select id="addUserCase" parameterType="Integer" resultType="com.course.model.AddUserCase">
        select * from addUserCase where id=#{id};
    </select>

    <!--獲取用戶信息case-->
    <select id="getUserInfoCase" parameterType="Integer" resultType="com.course.model.GetUserInfoCase">
        <!-- SQL語句 -->
        select * from getUserInfoCase where id=#{id};
    </select>

    <!--獲取用戶列表case-->
    <select id="getUserListCase" parameterType="Integer" resultType="com.course.model.GetUserListCase">
        <!-- SQL語句 -->
        select * from getUserListCase where id=#{id};
    </select>

    <!--更新/刪除用戶信息case-->
    <select id="updateUserInfoCase" parameterType="Integer" resultType="com.course.model.UpdateUserInfoCase">
        select * from updateUserInfoCase where id = #{id};
    </select>

    <!--添加用戶接口-->

    <select id="addUser" parameterType="com.course.model.AddUserCase" resultType="com.course.model.User" flushCache="false" useCache="false">
        select * from user where
        userName=#{userName}
        and password=#{password}
        and sex=#{sex}
        and age=#{age}
        and permission=#{permission}
        and isDelete=#{isDelete};
    </select>

    <!--獲取用戶信息-->
    <select id="getUserInfo" parameterType="com.course.model.GetUserInfoCase" resultType="com.course.model.User">
        <!-- SQL語句 -->
        select * from user where
        id=#{userId};
    </select>

    <!--獲取用戶列表-->
    <select id="getUserList" parameterType="com.course.model.GetUserListCase" resultType="com.course.model.User">
        <!-- SQL語句 -->
        select * from user
        <trim prefix="WHERE" prefixOverrides="and">
            <if test="null != userName and '' !=userName">
                AND userName=#{userName}
            </if>
            <if test="null != sex and '' !=sex">
                AND sex=#{sex}
            </if>
            <if test="null != age and '' !=age">
                AND age=#{age}
            </if>

        </trim>
        ;
    </select>

    <!--獲取更新後的數據-->
    <select id="getUpdateUserInfo" parameterType="com.course.model.UpdateUserInfoCase" resultType="com.course.model.User">
        select * from user
        <trim prefix="WHERE" prefixOverrides="and">
            <if test="null != userName and '' !=userName">
                AND userName=#{userName}
            </if>
            <if test="null != sex and '' !=sex">
                AND sex=#{sex}
            </if>
            <if test="null != age and '' !=age">
                AND age=#{age}
            </if>
            <if test="null != permission and '' !=permission">
                AND permission=#{permission}
            </if>
            <if test="null != isDelete and '' !=isDelete">
                AND isDelete=#{isDelete}
            </if>
        </trim>
        And id = #{userId};
    </select>


</mapper>

把測試用例加入testng.xml

testng.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd" >

<suite name="用戶管理系統測試套件">
    <test name="用戶管理系統測試用例">
        <classes>
            <class name="com.course.cases.LoginTest">
                <methods>
                    <include name="loginTrue"/>
                    <!--<include name="loginFalse"/>-->
                </methods>
            </class>
            <class name="com.course.cases.AddUserTest">
                <methods>
                    <include name="addUser"/>
                </methods>
            </class>
            <class name="com.course.cases.GetUserInfoTest">
                <methods>
                    <include name="getUserInfo"/>
                </methods>
            </class>
            <class name="com.course.cases.GetUserInfoListTest">
                <methods>
                    <include name="getUserListInfo"/>
                </methods>
            </class>
            <class name="com.course.cases.UpdateUserInfoTest">
                <methods>
                    <include name="updateUserInfo"/>
                    <include name="deleteUser"/>
                </methods>
            </class>
            <class name="com.course.cases.wangTest">
                <methods>
                    <include name="wangGetUser"/>
                </methods>
            </class>
        </classes>
    </test>

    <!--添加測試報告監聽器-->
    <listeners>
        <listener class-name="com.course.config.ExtentTestNGIReporterListener"></listener>
    </listeners>
</suite>

執行testng.xml

查看測試用例執行情況

打jar包

在terminal中，進入項目目錄下，執行mvn clean package，所有測試用例執行成功的情況下，會在target目錄下生成jar包
注：我這裏項目名稱由requestTest改爲interfaceTest了，大家進入自己的項目路徑就可以。