Cucumber+Rest Assured快速搭建api自动化测试平台

2022-11-30 09:13:00

转载：http://www.jianshu.com/p/6249f9a9e9c4

　　什么是Cucumber？什么是BDD？这里不细讲，不懂的直接查看官方：https://cucumber.io/
　　什么是Rest Assured？传送门：https://github.com/rest-assured/rest-assured

　　以下以java为开发语言，快速搭建一个cucumber+Rest Assured的api自动化测试平台。
　　1. 用IDEA 新建一个Maven工程，并pom文件添加如下配置：

        <!--ccucumber 相关依赖-->

        <dependency>

            <groupId>info.cukes</groupId>

            <artifactId>cucumber-java8</artifactId>

            <version>1.2.4</version>

            <scope>test</scope>

        </dependency>

        <dependency>

            <groupId>info.cukes</groupId>

            <artifactId>cucumber-java</artifactId>

            <version>1.2.4</version>

        </dependency>

        <!-- https://mvnrepository.com/artifact/info.cukes/cucumber-html -->

        <dependency>

            <groupId>info.cukes</groupId>

            <artifactId>cucumber-html</artifactId>

            <version>0.2.3</version>

        </dependency>

        <!--rest-assured 接口测试框架-->

        <!-- https://mvnrepository.com/artifact/com.jayway.restassured/rest-assured -->

        <dependency>

            <groupId>com.jayway.restassured</groupId>

            <artifactId>rest-assured</artifactId>

            <version>2.9.0</version>

        </dependency>

        <!-- https://mvnrepository.com/artifact/org.testng/testng -->

        <dependency>

            <groupId>org.testng</groupId>

            <artifactId>testng</artifactId>

            <version>6.9.10</version>

        </dependency>

        <!--log 引入-->

        <dependency>

            <groupId>log4j</groupId>

            <artifactId>log4j</artifactId>

            <version>1.2.17</version>

        </dependency>

        <dependency>

            <groupId>org.slf4j</groupId>

            <artifactId>slf4j-log4j12</artifactId>

            <version>1.7.5</version>

            <scope>provided</scope>

        </dependency>

        <!--compare jsoon-->

        <dependency>

            <groupId>net.javacrumbs.json-unit</groupId>

            <artifactId>json-unit</artifactId>

            <version>1.13.0</version>

        </dependency>

        <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->

        <dependency>

            <groupId>com.fasterxml.jackson.core</groupId>

            <artifactId>jackson-databind</artifactId>

            <version>2.8.1</version>

        </dependency>

新建个ApiTools类，并对Rest Assured进程二次封装，主要是Post 和 Get请求的基础封装和对返回json解析的封装，具体代码如下：

/**

  * 带json的post请求

  *

  * @param apiPath api地址

  * @param json    请求json

  * @return api返回的Response

  */

 public static Response post(String apiPath, String json) {

//        开始发起post 请求

     String path = Parameters.BOSEHOST + apiPath;

     Response response = given().

             contentType("application/json;charset=UTF-8").

             headers("header1", "value1").

             cookies("cookies1", "value1").

             body(json).

             when().log().all().post(path.trim());

     log.info(response.statusCode());

     log.info("reponse:");

     response.getBody().prettyPrint();

     return response;

 }

 /**

  * get 请求

  *

  * @param apiPath api路径

  * @return api的response

  */

 public static Response get(String apiPath) {

//        开始发起GET 请求

     String path = Parameters.BOSEHOST + apiPath;

     Response response = given().

             contentType("application/json;charset=UTF-8").

             headers("headers1", "value1").

             cookie("cookie1", "value1").

             when().log().all().get(path.trim());

     log.info(response.statusCode());

     log.info("reponse:");

     response.getBody().prettyPrint();

     return response;

 }

 /**

  * 获取json中某个key值

  * @param response  接口返回

  * @param jsonPath  jsonpath, 例如 a.b.c   a.b[1].c  a

  * @return

  */

 public static String getJsonPathValue(Response response, String jsonPath) {

     String reponseJson = String.valueOf(response.jsonPath().get(jsonPath));

//        String jsonValue = String.valueOf(from(reponseJson).get(jsonPath));

     return reponseJson;

 }

3.新建个Steps 类，完成常用step的封装，具体代码如下：

import com.jayway.restassured.response.Response;

import com.tools.apitools.ApiTools;

import com.tools.apitools.MyAssert;

import com.tools.filetools.ReadTxtFile;

import cucumber.api.java.en.Then;

import cucumber.api.java.en.When;

import static net.javacrumbs.jsonunit.JsonAssert.assertJsonEquals;

/**

* Created by MeYoung on 8/1/2016.

* <p>

* Steps 集合

*/

public class Steps {

 Response response = null;

 @When("^I send a GET request to \"(.*?)\"$")

 public void getRequest(String path) {

     response = ApiTools.get(path);

 }

 @When("^I send a POST request to \"(.*?)\"$")

 public void postRequest(String apiPath) throws Throwable {

     response = ApiTools.post(apiPath);

 }

 @When("^I send a POST request to \"(.*?)\" and request json:$")

 public void postRequestWithJson(String apiPath, String json) {

     response = ApiTools.post(apiPath, json);

 }

 @When("^I use a \"(.*?)\" file to send a POST request to \"(.*?)\"$")

 public void postRequestWihtFile(String fileName, String path) {

     String json = ReadTxtFile.readTxtFile(fileName);

     response = ApiTools.post(path, json);

 }

 @Then("^the JSON response equals$")

 public void assertResponseJson(String expected) {

     String responseJson = response.body().asString();

     assertJsonEquals(responseJson, expected);

 }

 @Then("^the JSON response equals json file \"(.*?)\"$")

 public void theJSONResponseEqualsJsonFile(String fileName) {

     String responseJson = response.body().asString();

     String fileJson = ReadTxtFile.readTxtFile(fileName);

     assertJsonEquals(responseJson, fileJson);

 }

 @Then("^the response status should be \"(\\d{3})\"$")

 public void assertStatusCode(int statusCode) {

     Object jsonResponse = response.getStatusCode();

     MyAssert.assertEquals(jsonResponse, statusCode);

 }

 @Then("^the JSON response \"(.*?)\" equals \"(.*?)\"$")

 public void assertEquals(String str, String expected) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertEquals(jsonValue, expected);

 }

 @Then("^the JSON response \"(.*?)\" type should be \"(.*?)\"$")

 public void assertMatch(String str, String match) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertMatch(jsonValue, match);

 }

 @Then("^the JSON response \"(.*?)\" should be not null$")

 public void assertNotNull(String str) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertNotNull(jsonValue);

 }

 @Then("^the JSON response \"(.*?)\" start with \"(.*?)\"$")

 public void assertStartWith(String str, String start) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertStartWith(jsonValue, start);

 }

 @Then("^the JSON response \"(.*?)\" end with \"(.*?)\"$")

 public void assertEndWith(String str, String end) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertEndWith(jsonValue, end);

 }

 @Then("^the JSON response \"(.*?)\" include \"(.*?)\"$")

 public void assertInclude(String str, String include) {

     String jsonValue = ApiTools.getJsonPathValue(response, str);

     MyAssert.assertInclude(jsonValue, include);

 }

}

　　当然上面代码还涉及到一些Asssert的封装，这里就不列出来，个人喜好不同，更具自己熟悉的情况去引入自己熟悉的jar包。

　　ok，最后我们愉快的写两个case，看看效果：

  @get

  Scenario Outline: use examples

    When I send a GET request to "apiurl"

    Then the response status should be "200"

    Then the JSON response "<jsonPath>" equals "<value>"

    Examples:

      | jsonPath     | value             |

      | genericPlan  | false             |

      | ehiCarrierId | 90121100          |

      | carrierName  | Anthem Blue Cross |

  @post

  Scenario: test post request

    When I send a POST request to "apiurl"

    Then the response status should be "200"

    And the JSON response "message" equals "success"

    #    校验放回值是否是某种类型

    And the JSON response "sessionId" type should be "^\d{6}$"

    #    校验返回值不为空

    And the JSON response "url" should be not null

    #    校验是否以XX开头

    Then the JSON response "message" start with "su"

    #    校验是否以XX开头

    Then the JSON response "message" end with "ss"

    #    校验是否以XX开头

    Then the JSON response "message" include "ss"

    #    校验返回json是否为XXX，对整个返回json的校验

    Then the JSON response equals

    """

      {

          "result":"success"

      }

    """

通过Junit 运行feature.

在Pom.xml 文件添加junit相关包：

     <dependency>

         <groupId>info.cukes</groupId>

         <artifactId>cucumber-junit</artifactId>

         <version>1.2.4</version>

         <scope>test</scope>

     </dependency>

     <dependency>

         <groupId>junit</groupId>

         <artifactId>junit</artifactId>

         <version>4.12</version>

         <scope>test</scope>

     </dependency>

在feature 同级目录下新建个运行类，代码例子如下：

import cucumber.api.CucumberOptions;

import cucumber.api.junit.Cucumber;

import org.junit.runner.RunWith;

@RunWith(Cucumber.class)

@CucumberOptions(

        strict = true,

        monochrome = true,

        plugin = {"pretty", "html:target/cucumber", "json:target/cucumber.json"},

        features = {"src/test/java/bosev2"},

        glue = {"com.bose.step"},

        tags = {"~@unimplemented"})

public class RunnerBoseTest {

}

@RunWith(Cucumber.class) ：注解表示通过Cucumber的Junit 方式运行脚本
@CucumberOptions () ：注解用于配置运行信息，其中代码中的plugin 表示测试报告输出的路径和格式， feature 表示被运行的feature文件的包路径， glue中配置steps的包路径地址，tags中配置要运行的用例的tags名，其实~符号表示除了这个tags的所有tags.

通过Jenkins 执行

在Pom.xml 文件里面添加运行插件，如下：

<build>

     <plugins>

         <plugin>

             <groupId>org.apache.maven.plugins</groupId>

             <artifactId>maven-compiler-plugin</artifactId>

             <version>3.3</version>

             <inherited>true</inherited>

             <configuration>

                 <source>1.7</source>

                 <target>1.7</target>

                 <encoding>UTF-8</encoding>

             </configuration>

         </plugin>

         <plugin>

             <groupId>org.apache.maven.plugins</groupId>

             <artifactId>maven-surefire-plugin</artifactId>

             <version>2.18.1</version>

             <configuration>

                 <reuseForks>false</reuseForks>

             </configuration>

         </plugin>

     </plugins>

 </build>

在Jenkins 中添加Cucumber-JVM reports插件。
新建Maven job，配置maven构建方式和构建后的测试报告展示。

Paste_Image.png

Cucumber-JVM reports 提供了非常漂亮的report，如下：

Paste_Image.png

最后附上项目地址：https://github.com/MeYoung/cucumber_restassured

作者：米阳MeYoung
链接：http://www.jianshu.com/p/6249f9a9e9c4
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

参考：https://github.com/jenkinsci/cucumber-reports-plugin

码农公寓

通过Junit 运行feature.

通过Jenkins 执行

相关文章