用Rest assured作API自动化集成测试

素颜马尾好姑娘i 2022-12-14 14:58 108阅读 0赞

### 文章目录 ###

*  用Rest assured作API自动化集成测试
 *   *  前言
     *  文档
     *  环境
     *  Rest assured依赖
     *  测试示例
     *   *  HTTP基础
         *  测试GET方法
         *   *  打印HTTP response
             *  测试路径参数（Path variable）
             *  测试查询参数(Query param)
             *  判断单个JSON对象
             *  判断JSON对象集合
             *  抽取HTTP response
         *  测试POST方法
         *   *  入参为JSON
             *  提交表单
     *  小结
     *  参考文档

# 用Rest assured作API自动化集成测试 #

## 前言 ##

在用Spring Boot开发时，可以用Spring Boot Test + JUnit + Maven来做API自动化单元测试。这种测试的特点：

*  深度依赖于Spring Boot Test测试框架。
 *  白盒测试，需要完全了解功能代码细节才能编写测试代码。
 *  Mock测试，只适用于小范围的单元测试。

除吃之外，还可以使用Rest assured + JUnit + Maven做API自动化集成测试。这种测试的特点：

*  不依赖于开发框架和语言。
 *  黑盒测试，不需要了解功能代码细节就可以写测试代码。
 *  真实测试，适用于API的端到端的集成测试。

## 文档 ##

Rest assured文档：

*  Rest assured官网：[https://rest-assured.io/][https_rest-assured.io]
 *  Rest assured GitHub：[https://github.com/rest-assured/rest-assured/][https_github.com_rest-assured_rest-assured]
 *  Rest assured Getstarted: [https://github.com/rest-assured/rest-assured/wiki/GettingStarted][https_github.com_rest-assured_rest-assured_wiki_GettingStarted]
 *  Rest assured Usage (<= Java 1.9.0): [https://github.com/rest-assured/rest-assured/wiki/Usage\_Legacy][https_github.com_rest-assured_rest-assured_wiki_Usage_Legacy]
 *  Rest assured Usage (> Java 1.9.0): [https://github.com/rest-assured/rest-assured/wiki/Usage][https_github.com_rest-assured_rest-assured_wiki_Usage]
 *  Rest assured Maven repository: [https://mvnrepository.com/artifact/io.rest-assured][https_mvnrepository.com_artifact_io.rest-assured]

## 环境 ##

本文的测试环境：

*  Java8
 *  JUnit4
 *  Maven
 *  Rest assured

## Rest assured依赖 ##

Rest assured的Maven依赖：

<dependency>
      <groupId>io.rest-assured</groupId>
      <artifactId>rest-assured</artifactId>
      <version>4.3.0</version>
      <scope>test</scope>
    </dependency>

静态导入相关包：

import static io.restassured.RestAssured.*;
    import static io.restassured.matcher.ResponseAwareMatcher.*;
    import static org.hamcrest.Matchers.*;

## 测试示例 ##

下面的测试示例，以在线模拟REST API测试网站作为要测试的对象:

*  [https://jsonplaceholder.typicode.com/][https_jsonplaceholder.typicode.com]
 *  [https://reqres.in/][https_reqres.in]

### HTTP基础 ###

简单回顾一下调用REST API的过程：

1.  客户端发起HTTP请求：
    
     *  指定HTTP方法，比如：GET，POST
     *  指定HTTP协议，比如：HTTP/1.1
     *  指定URL，比如：https://reqres.in/api/users/2
     *  提供HTTP request报文包括HTTP request headers和HTTP request body。
2.  服务端响应HTTP请求:
    
     *  HTTP status code，比如200，详情参见：[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status][https_developer.mozilla.org_en-US_docs_Web_HTTP_Status]
     *  HTTP status message
     *  HTTP response报文包括HTTP response headers和HTTP response body。

> 在Postman中，打开View / Show postman console，可以查看详细的HTTP日志。

关于HTTP的更多内容，参见：

*  HTTP Overview 英文版：[https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview][https_developer.mozilla.org_en-US_docs_Web_HTTP_Overview]
 *  HTTP Overview 中文版：[https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Overview][https_developer.mozilla.org_zh-CN_docs_Web_HTTP_Overview]

### 测试GET方法 ###

#### 打印HTTP response ####

打印HTTP response的全部报文或只打印response body。

@Test
    public void test_get_log_all() { 
      String url = "https://jsonplaceholder.typicode.com/posts/1";
      get(url).then().log().all();
    }
    
    @Test
    public void test_get_log_body() { 
      String url = "https://jsonplaceholder.typicode.com/posts/1";
      get(url).then().log().body();
    }

#### 测试路径参数（Path variable） ####

传入路径参数（path variable)，并判断Status code是否为200，且Content-type为JSON。

@Test
    public void test_get_with_path_variable() { 
      String url = "https://jsonplaceholder.typicode.com/posts/{id}";
      get(url, 1).then().statusCode(200).contentType(ContentType.JSON);
    }

#### 测试查询参数(Query param) ####

传入查询参数（query param），并判断Status code是否为200，且Content-type为JSON。

@Test
    public void test_get_with_query_param() { 
      String url = "https://jsonplaceholder.typicode.com/comments";
      given().param("postId", 1).get(url).then().statusCode(200).contentType(ContentType.JSON);
    }

#### 判断单个JSON对象 ####

以https://reqres.in/api/users/2为例，返回的JSON内容类似：

{ 
        "data": { 
            "id": 2,
            "email": "janet.weaver@reqres.in",
            "first_name": "Janet",
            "last_name": "Weaver",
            "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/josephstein/128.jpg"
        },
        "ad": { 
            "company": "StatusCode Weekly",
            "url": "http://statuscode.org/",
            "text": "A weekly newsletter focusing on software development, infrastructure, the server, performance, and the stack end of things."
        }
    }

验证上面JSON的data部分：

@Test
    public void test_validate_json() { 
      String url = "https://reqres.in/api/users/2";
      get(url).then().statusCode(200).contentType(ContentType.JSON).
        body("data.id", equalTo(2)).
        body("data.email", equalTo("janet.weaver@reqres.in")).
        body("data.first_name", equalTo("Janet")).
        body("data.last_name", equalTo("Weaver")).
        body("data.avatar", not(emptyOrNullString()));
    }

Rest assured支持通过JSON Path （比如`data.email` )来判断返回的JSON内容的字段的值。

#### 判断JSON对象集合 ####

以[https://reqres.in/api/users?page=2][https_reqres.in_api_users_page_2]为例，返回的JSON内容类似：

{ 
        "page": 2,
        "per_page": 6,
        "total": 12,
        "total_pages": 2,
        "data": [
            { 
                "id": 7,
                "email": "michael.lawson@reqres.in",
                "first_name": "Michael",
                "last_name": "Lawson",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/follettkyle/128.jpg"
            },
            { 
                "id": 8,
                "email": "lindsay.ferguson@reqres.in",
                "first_name": "Lindsay",
                "last_name": "Ferguson",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/araa3185/128.jpg"
            },
            { 
                "id": 9,
                "email": "tobias.funke@reqres.in",
                "first_name": "Tobias",
                "last_name": "Funke",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/vivekprvr/128.jpg"
            },
            { 
                "id": 10,
                "email": "byron.fields@reqres.in",
                "first_name": "Byron",
                "last_name": "Fields",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/russoedu/128.jpg"
            },
            { 
                "id": 11,
                "email": "george.edwards@reqres.in",
                "first_name": "George",
                "last_name": "Edwards",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/mrmoiree/128.jpg"
            },
            { 
                "id": 12,
                "email": "rachel.howell@reqres.in",
                "first_name": "Rachel",
                "last_name": "Howell",
                "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/hebertialmeida/128.jpg"
            }
        ],
        "ad": { 
            "company": "StatusCode Weekly",
            "url": "http://statuscode.org/",
            "text": "A weekly newsletter focusing on software development, infrastructure, the server, performance, and the stack end of things."
        }
    }

可以看到data部分是一个数组。

@Test
    public void test_validate_json_array() { 
      String url = "https://reqres.in/api/users?page=2";
      get(url).then().statusCode(200).contentType(ContentType.JSON).
        body("data.id", hasItems(7, 8, 9, 10, 11, 12)).
        body("data.email", hasItems(endsWith("@reqres.in"))).
        body("data.first_name", hasItems("Michael", "Lindsay", "Tobias", "Byron", "George", "Rachel")).
        body("data.last_name", hasItems("Lawson", "Ferguson", "Funke", "Fields", "Edwards", "Howell")).
        body("data.avatar", hasItems(not(emptyOrNullString())));
    }

#### 抽取HTTP response ####

可以将HTTP response抽取到一个变量、Map和List：

@Test
    public void test_extract_response() { 
      String url = "https://reqres.in/api/users/2";
      Response response = get(url).then().extract().response();
    
      System.out.println(response.getStatusCode());
      System.out.println(response.getContentType());
      System.out.println(response.asString());
      response.getBody().prettyPrint();
    
      // 抽取某个字段的值
      System.out.println((String)response.path("data.email"));
    
      // 抽取到Map中
      Map map = (HashMap) response.path("data");
      System.out.println(map);
    }
    
    @Test
    public void test_extract_response_list() { 
      String url = "https://reqres.in/api/users?page=2";
      Response response = get(url).then().extract().response();
    
      // 抽取对象数组到List中
      List list = (ArrayList) response.path("data");
      System.out.println(list);
    }

也可以抽取到类的对象中。

在测试类中，自定义类：

@Data
    static class Result { 
      private ResultData data;
      @JsonIgnore
      private Object ad;
    }
    
    @Data
    static class ResultData { 
      private Long id;
      private String email;
    
      @JsonProperty("first_name")
      private String firstName;
    
      @JsonProperty("last_name")
      private String lastName;
      private String avatar;
    }

说明：

*  `@Data`为Lombok注解，参见：[https://blog.csdn.net/nklinsirui/article/details/104501340][https_blog.csdn.net_nklinsirui_article_details_104501340]
 *  需要引入jackson-databind依赖，来完成JSON序列化和反序列化，比如：
    
        <dependency>
          <groupId>com.fasterxml.jackson.core</groupId>
          <artifactId>jackson-databind</artifactId>
          <version>2.9.9</version>
        </dependency>

测试抽取到类的对象：

@Test
    public void test_extract_response_to_class_object() { 
      String url = "https://reqres.in/api/users/2";
      Response response = get(url).then().extract().response();
    
      // 抽取到类的对象中
      Result result = response.as(Result.class);
      System.out.println(result);
    }

通过jsonpath来抽取集合：

@Test
    public void test_extract_response_to_class_object_list() { 
      String url = "https://reqres.in/api/users?page=2";
      Response response = get(url).then().extract().response();
    
      List<ResultData> resultDataList = response.jsonPath().getList("data");
      System.out.println(resultDataList);
    
      List<String> emailList = response.jsonPath().getList("data.email");
      System.out.println(emailList);
    }

### 测试POST方法 ###

#### 入参为JSON ####

URL：https://reqres.in/api/register

HTTP方法：POST

数据格式：JSON

入参：

{ 
        "email": "eve.holt@reqres.in",
        "password": "pistol"
    }

出参：

{ 
        "id": 4,
        "token": "QpwL5tke4Pnpja7X4"
    }

测试代码：

@Data
    static class User { 
      private String email;
      private String password;
    }
    
    @Test
    public void test_post_json_pojo() { 
    
      User user = new User();
      user.setEmail("eve.holt@reqres.in");
      user.setPassword("pistol");
    
      String url = "https://reqres.in/api/register";
      given().contentType(ContentType.JSON).body(user).
        when().post(url).
        then().statusCode(200).contentType(ContentType.JSON).body("id", greaterThan(0)).body("token", not(emptyOrNullString()));
    }
    
    @Test
    public void test_post_json_hash_map() { 
      Map<String, Object> userMap = new HashMap<>();
      userMap.put("email", "eve.holt@reqres.in");
      userMap.put("password", "pistol");
    
      String url = "https://reqres.in/api/register";
      given().contentType(ContentType.JSON).body(userMap).
        when().post(url).
        then().statusCode(200).contentType(ContentType.JSON).body("id", greaterThan(0)).body("token", not(emptyOrNullString()));
    }

说明：

*  可以定义一个和入参结构一样的User类，传入User类的对象作为request body。
 *  也可以传入HashMap作为request body。
 *  也可以传入JSON字符串作为request body。

对应Postman测试：

*  HTTP方法为POST。
 *  Request body中勾选“raw”，再选择“JSON"格式。

#### 提交表单 ####

@Test
    public void test_post_form() { 
      String url = "";
      given().urlEncodingEnabled(true).
        param("param1", "xxx").
        param("param2", "abc").
        header("Accept", ContentType.JSON.getAcceptHeader()).
        when().post(url).then().statusCode(0);
    }

对应Postman测试：

*  HTTP方法为POST。
 *  Request body中勾选“x-www-form-urlencoded”，再输入参数的Key和Value。（注意，这里不要勾选“form-data"，因为这里的`form-data`实际上是`multipart/form-data`，是用于文件分段上传的）

## 小结 ##

本文描述了如何用Rest assured来测试REST API的GET/PUT方法。

对测试时需要指定HTTP headers的情况，还有测试Spring Boot应用的场景，将在后续其他文章中再说明。

## 参考文档 ##

*  [https://www.guru99.com/rest-assured.html][https_www.guru99.com_rest-assured.html]
 *  [https://techbeacon.com/app-dev-testing/how-perform-api-testing-rest-assured][https_techbeacon.com_app-dev-testing_how-perform-api-testing-rest-assured]
 *  [REST-Assured，接口自动化的 “瑞士军刀”- 初识篇][REST-Assured_ _-]
 *  [Hamcrest][]
 *  [https://stackoverflow.com/questions/56642603/rest-assured-isnt-there-a-better-way-to-test-an-array-of-results][https_stackoverflow.com_questions_56642603_rest-assured-isnt-there-a-better-way-to-test-an-array-of-results]
 *  [https://devqa.io/rest-assured-post-request/][https_devqa.io_rest-assured-post-request]
 *  [https://techeplanet.com/rest-assured-post-json/][https_techeplanet.com_rest-assured-post-json]
 *  [postman中 form-data、x-www-form-urlencoded、raw、binary的区别][postman_ form-data_x-www-form-urlencoded_raw_binary]

[https_rest-assured.io]: https://rest-assured.io/
[https_github.com_rest-assured_rest-assured]: https://github.com/rest-assured/rest-assured/
[https_github.com_rest-assured_rest-assured_wiki_GettingStarted]: https://github.com/rest-assured/rest-assured/wiki/GettingStarted
[https_github.com_rest-assured_rest-assured_wiki_Usage_Legacy]: https://github.com/rest-assured/rest-assured/wiki/Usage_Legacy
[https_github.com_rest-assured_rest-assured_wiki_Usage]: https://github.com/rest-assured/rest-assured/wiki/Usage
[https_mvnrepository.com_artifact_io.rest-assured]: https://mvnrepository.com/artifact/io.rest-assured
[https_jsonplaceholder.typicode.com]: https://jsonplaceholder.typicode.com/
[https_reqres.in]: https://reqres.in/
[https_developer.mozilla.org_en-US_docs_Web_HTTP_Status]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
[https_developer.mozilla.org_en-US_docs_Web_HTTP_Overview]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Overview
[https_developer.mozilla.org_zh-CN_docs_Web_HTTP_Overview]: https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Overview
[https_reqres.in_api_users_page_2]: https://reqres.in/api/users?page=2
[https_blog.csdn.net_nklinsirui_article_details_104501340]: https://blog.csdn.net/nklinsirui/article/details/104501340
[https_www.guru99.com_rest-assured.html]: https://www.guru99.com/rest-assured.html
[https_techbeacon.com_app-dev-testing_how-perform-api-testing-rest-assured]: https://techbeacon.com/app-dev-testing/how-perform-api-testing-rest-assured
[REST-Assured_ _-]: http://testingpai.com/article/1596787886216
[Hamcrest]: https://www.jianshu.com/p/e7d4c3bdac6e
[https_stackoverflow.com_questions_56642603_rest-assured-isnt-there-a-better-way-to-test-an-array-of-results]: https://stackoverflow.com/questions/56642603/rest-assured-isnt-there-a-better-way-to-test-an-array-of-results
[https_devqa.io_rest-assured-post-request]: https://devqa.io/rest-assured-post-request/
[https_techeplanet.com_rest-assured-post-json]: https://techeplanet.com/rest-assured-post-json/
[postman_ form-data_x-www-form-urlencoded_raw_binary]: https://blog.csdn.net/ye1992/article/details/49998511