API自动化测试与持续集成

目的

• 如何使用SuperTest测试框架，进行API测试
• 如何将API测试与构建工具结合
• 如何将API测试、构建工具与持续集成结合

SuperTest

什么是SuperTest

• To provide a high-level abstraction for testing HTTP，提供一个高级别的HTTP测试
• Github地址：SuperTest

如何安装

• 命令

npm install supertest --save-dev

• 样例

describe('Test Demo.', function() {

    it('Visit URL', function(done) {
        request.get('')
            .expect(200)
            .end(done);
    });
});

• 样例原理：通过获取请求的结果，对请求结果进行验证。样例中的验证条件为返回的状态码为200。

自动化API测试：Grunt & Gulp

Grunt篇

什么是Grunt

• The JavaScript Task Runner，JavaScript的构建工具
• 官网：Grunt

安装

• 命令

npm install -g grunt-cli

功能分析

测试目的：请求https://github.com/aimer1124/SuperTestWithGrunt是否能返回状态码200

使用Github来Clonehttps://github.com/aimer1124/SuperTestWithGrunt.git

fileTree.png

• /test/module/demo.js:测试脚本

var config = require('../config/endpoints'),

request = require('supertest')(config.host[config.env]);

describe('Test Demo.', function() {

  this.timeout(10000);

  it('Visit ' + config.env, function(done) {

    request.get('')

                .expect(200)

                .end(done);

    });

});

• /test/config/endpoints.js:环境配制

module.exports = {

host : {

master: 'https://github.com/aimer1124/SuperTestWithGrunt',

branch: 'https://github.com/aimer1124/SuperTestWithGrunt/tree/differentENV'

},

env: process.env.NODE_ENV || 'master'

};

• Gruntfile.js:Grunt运行时的命令配制
• package.json:npm 安装时所需要的包
• results.txt:执行结果存放文件

执行

• 命令:grunt
• 运行结果

➜  SuperTestWithGrunt git:(master) ✗ grunt
Running "mochaTest:test" (mochaTest) task


  Test Demo.
    ✓ Visit master (1640ms)


  1 passing (2s)


Done, without errors.

• 结果分析：✓ Visit master (1640ms)表示测试正常通过；1 passing (2s)表示整个测试所执行的时间和测试所执行的数量

Gulp篇

什么是Gulp

• Automate and enhance your workflow，自动化并且增强你的工作流
• 官网：http://gulpjs.com/
• 中文官网：http://www.gulpjs.com.cn/

安装

• 命令

npm install --global gulp-cli

功能分析

测试目的：请求http://aimer1124.github.io/是否能返回状态码200

使用Github来Clonehttps://github.com/aimer1124/SuperTestWithGulp

SuperTestWithGulp.png

• /test/config/endpoints.js:环境配制

var host = {
    master: require('./master.js'),
    branch: require('./branch.js')
};

var ENV;

module.exports = function(env) {
    if (env) {
        ENV = host[env];
        return;
    }
    return ENV;
};

• /test/config/master的具体配制

module.exports = {
    url: 'http://aimer1124.github.io/',
    name: 'master'
};

• /test/module/test-demo.js:测试脚本

var data = require('../config/endpoints'),
    request = require('supertest')(data().url);

describe('Test Demo.', function() {

    this.timeout(10000);

    it('Visit ' + data().url, function(done) {
        request.get('')
            .expect(200)
            .end(done);
    });
    console.log('You are in ' + data().name);
});

• gulpfile.js:Grunt运行时的命令配制
• package.json:npm 安装时所需要的包
• results.txt:执行结果存放文件

执行

• 命令

gulp master

• 结果

➜  SuperTestWithGulp git:(master) gulp master
[17:34:44] Using gulpfile ~/Downloads/SuperTestWithGulp/gulpfile.js
[17:34:44] Starting 'master'...
[17:34:44] Finished 'master' after 37 ms
You are in master


  Test Demo.
    ✓ Visit http://aimer1124.github.io/ (502ms)


  1 passing (506ms)

• 结果分析：✓ Visit http://aimer1124.github.io/ (502ms)表示测试正常通过；1 passing (506ms)表示整个测试所执行的时间和测试所执行的数量

自动化测试的持续集成

持续集成是什么

• Continuous Integration (CI) is a development practice that requires developers to integrate code into a shared repository several times a day. Each check-in is then verified by an automated build, allowing teams to detect problems early.

Travis CI

• 在线CI工具
• 官网：https://travis-ci.org/

Travis与Gulp集成

• 使用Git项目SuperTestWithGulp
• 在项目根目录中添加.travis.yml文件，language表示使用的语言为node_js，0.12表示使用node_js的版本，before_script表示运行脚本前执行的脚本命令，script表示启动时的执行脚本

language: node_js

node_js:

  - "0.12"

before_script:

  - npm install -g gulp

script: gulp master

• 在Travis中关联此Github项目SuperTestWithGulp

GulpInTravis.png

• Travis会在Github代码有变更时，自动拉取项目的代码并进行在线集成

gulpWithTravis.png

Jenkins

• Build great things at any scale
• 官网：https://jenkins.io/

Jenkins与Grunt集成

• 安装NodeJS、Git插件
• 配制Job的build step中execute shell

ConfigScriptInJenkins.png

• 运行Job即可执行API测试

LogInJenkins.png

总结

• API自动化测试已经说完了，完全没有太复杂的代码和编写难度。
• 使用SuperTest可实现多场景、多环境的API场景测试，且执行速度较UI自动化测试快很多。
• SuperTest与Grunt/Gulp的集成很方便，即使在本地进行调试也很快捷。
• 持续集成工具Travis/Jenkins，与API测试集成后，更高效的提高测试效率。

参考

• SuperTest
  https://github.com/visionmedia/supertest
• Grunt官网
  http://gruntjs.com/
• NPM官网
  https://www.npmjs.com/
• Gulp官网
  http://gulpjs.com/
• Continuous Integration
  https://www.thoughtworks.com/continuous-integration
• Travis CI
  https://travis-ci.org/
• Jenkins
  https://jenkins.io/
• NodeJS
  https://nodejs.org/en/
• UI自动化测试
  http://www.jianshu.com/p/cb24e7fa8f56
• Jenkins with Grunt
  http://aimer1124.github.io/2016/03/03/Tool-Jenkins-with-SuperTest-and-Grunt/

文／巴索罗米杰（简书作者）
原文链接：http://www.jianshu.com/p/a3e35928a0aa
著作权归作者所有，转载请联系作者获得授权，并标注“简书作者”。