Jenkins + Postman + Newman作自动化API测试

╰半夏微凉° 2021-10-13 23:00 414阅读 0赞

### 文章目录 ###

*  Jenkins + Postman + Newman作自动化API测试
 *   *  用Postman作API测试
     *  提交Postman Collection到版本控制
     *  在Jenkins上安装\`newman\`
     *  在Jenkins freestyle job中集成API测试
     *  API白盒测试（代码级别测试）

# Jenkins + Postman + Newman作自动化API测试 #

## 用Postman作API测试 ##

新建Postman collection，在collection下新建request。

选择HTTP Method为Get，输入URL，填写Tests断言代码（JavaScript）。

示例：

pm.test("HTTP response is ok and has expected result", function () { 
        pm.response.to.be.ok;
        pm.response.to.be.withBody;
        pm.response.to.be.json;
        pm.expect(pm.response.text()).to.include("Hello");
    });

参考文档：

*  [https://learning.getpostman.com/docs/postman/scripts/test\_scripts/][https_learning.getpostman.com_docs_postman_scripts_test_scripts]

## 提交Postman Collection到版本控制 ##

Postman提供了Personal workspace和Team workspace之间的`fork`和`merge`功能，使得团队成员可以独立测试，也可以对测试案例作集中管理。

Postman收费版Postman Pro提供了与GitLab集成的功能，可以提供更完整的测试脚本版本控制功能。

Postman免费版，可以手工将Team workspace上的Postman collection导出成`postman_collection.json`文件，再手工将该文件提交到GitLab中。

参见：

*  [https://learning.getpostman.com/docs/postman/collections/version\_control/][https_learning.getpostman.com_docs_postman_collections_version_control]
 *  [https://learning.getpostman.com/docs/postman\_pro/integrations/gitlab/][https_learning.getpostman.com_docs_postman_pro_integrations_gitlab]

## 在Jenkins上安装`newman` ##

Postman提供了一个命令行工具`newman`，可以执行`newman run <collection>`命令作自动化API测试。

通过与Jenkins集成，可以在应用部署后，对应用的REST API作自动化API测试。

先安装`npm`和设置淘宝npm registry：

# Instll nodejs and npm
    sudo yum install epel-release -y
    sudo yum install nodejs
    node -v
    sudo yum install npm -y
    npm -v
    
    # Use Taobao npm registry
    npm config set registry http://r.cnpmjs.org/
    npm config get registry

安装`newman`：

npm install -g newman

参考文档：

*  [https://npm.taobao.org/][https_npm.taobao.org]
 *  [https://learning.getpostman.com/docs/postman/collection\_runs/integration\_with\_jenkins/][https_learning.getpostman.com_docs_postman_collection_runs_integration_with_jenkins]

## 在Jenkins freestyle job中集成API测试 ##

在Build step中，新增Execute shell：

newman run test/apitest/demo.postman_collection.json

## API白盒测试（代码级别测试） ##

Postman适合用来作API黑盒测试。

如果想对API作白盒测试（代码级别控制，适用于更复杂的情况），可以使用开发框架的Mock工具（比如Spring Boot MockMVC）或RestAssured的方案。

SpringBoot MockMVC是专门针对Spring Boot REST API的测试工具，而RestAssured是跨开发框架的REST API测试工具，更容易编写BDD风格测试。如果是Spring Boot应用，使用SpringBoot MockMVC就可以了，否则建议使用RestAssured。

参考文档

*  [https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/test/web/servlet/MockMvc.html][https_docs.spring.io_spring_docs_current_javadoc-api_org_springframework_test_web_servlet_MockMvc.html]
 *  [https://howtodoinjava.com/spring-boot2/spring-boot-mockmvc-example/][https_howtodoinjava.com_spring-boot2_spring-boot-mockmvc-example]
 *  [https://github.com/rest-assured/rest-assured/wiki/Usage\#spring-support][https_github.com_rest-assured_rest-assured_wiki_Usage_spring-support]
 *  [https://www.baeldung.com/spring-mock-mvc-rest-assured][https_www.baeldung.com_spring-mock-mvc-rest-assured]
 *  [https://github.com/rest-assured/rest-assured/tree/master/examples/spring-mvc-webapp][https_github.com_rest-assured_rest-assured_tree_master_examples_spring-mvc-webapp]

[https_learning.getpostman.com_docs_postman_scripts_test_scripts]: https://learning.getpostman.com/docs/postman/scripts/test_scripts/
[https_learning.getpostman.com_docs_postman_collections_version_control]: https://learning.getpostman.com/docs/postman/collections/version_control/
[https_learning.getpostman.com_docs_postman_pro_integrations_gitlab]: https://learning.getpostman.com/docs/postman_pro/integrations/gitlab/
[https_npm.taobao.org]: https://npm.taobao.org/
[https_learning.getpostman.com_docs_postman_collection_runs_integration_with_jenkins]: https://learning.getpostman.com/docs/postman/collection_runs/integration_with_jenkins/
[https_docs.spring.io_spring_docs_current_javadoc-api_org_springframework_test_web_servlet_MockMvc.html]: https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/test/web/servlet/MockMvc.html
[https_howtodoinjava.com_spring-boot2_spring-boot-mockmvc-example]: https://howtodoinjava.com/spring-boot2/spring-boot-mockmvc-example/
[https_github.com_rest-assured_rest-assured_wiki_Usage_spring-support]: https://github.com/rest-assured/rest-assured/wiki/Usage#spring-support
[https_www.baeldung.com_spring-mock-mvc-rest-assured]: https://www.baeldung.com/spring-mock-mvc-rest-assured
[https_github.com_rest-assured_rest-assured_tree_master_examples_spring-mvc-webapp]: https://github.com/rest-assured/rest-assured/tree/master/examples/spring-mvc-webapp