测试驱动开发

以前，我一般用TDD（测试驱动开发）来做服务器端，以确保开发质量，以及提高开发速度。

很多人的体会是写测试用例是延缓了开发进度。也许是开发场景不一样，或者是没有熟练的使用测试驱动开发的技巧。

先写测试用例，然后写实现代码，完成一点功能，就运行测试用例，多次测试的情况下（回归测试），所花时间肯定比每次都手工测试来的少。

这里的关键是，首先要写测试代码，再写正式代码，这样正式代码的每次测试都使用测试程序来测试。

我怎么看BDD

我也不知道，老实话，我也才用这个东西。我是想找一个nodejs环境下比较普及的测试框架，结果看到Mocha，它的测试可以引用BDD概念，我才决定试一试的。

也许，用一段时间，我会发现它确实比TDD好的地方。

BDD测试准备步骤

我是在写nodejs代码，编写了操作mongodb的代码模块，见在dao代码中使用异常。我需要一个对该模块的测试程序，确保这个模块在逐步发展的时候，有足够的自动回归测试来保证该模块的质量。

我找到了Mocha（它的作者也编写了express），可能是目前比较普及的这方面框架。该框架可执行TDD，也可执行BDD。Mocha本身可以使用第三方的断言库，当然，作者自己写了个基于BDD的断言库，should.js。

我的测试就是使用了Mocha和should.js。

首先要安装Mocha和should.js。Mocha安装：

npm install -g mocha

安装should.js：

npm install should

然后，在项目中建立test目录。

之后可以在项目根目录下命令行下运行一下mocha：

$ mocha

运行后，什么也没有发生，因为mocha扫描了test目录下，未找到可执行的测试脚本。

但是，我们的环境搭建好了。

编写最简单的BDD测试

编写一个最简单的测试代码。说明如何使用mocha和should.js。

首先代码中需要should模块：

require(‘should’);

然后，我们假设要测试一个对象是否和另外一个对象相等：

var book = {name:”枪炮、病毒和钢铁”};

describe(‘Book’, function () {
it(‘图书应该应该一致’, function () {
var newBook={name:”枪炮、病毒和钢铁”};
newBook.should.eql(book);
});
});

再次命令行运行mocha，会有类似这样的输出：

$ mocha

.

✔ 1 test complete (3ms)

如果故意将name写的不一致，可能会有类似这样的报错：

mocha

.

✖ 1 of 1 test failed:

1) Book 图书应该应该一致:
AssertionError: expected {} to equal { name: ‘枪炮、病毒和钢铁’ }

编写正式的测试代码

下面写真的了，要测试DocProvider.js的逻辑是否正确。

在test目录下创建DbTest.js：

require(‘should’);
var DocProvider = require(‘../lib/db/DocProvider’).DocProvider;

var bookProvider = new DocProvider(‘books’);

describe(‘DocProvider’, function () {
var book = {
name:’钱的历史’
};

describe(‘#insert’, function () {
bookProvider.insert(book, {}, function (result) {
it(‘图书应该有_id属性’, function () {
result[0].should.have.property(‘_id’);
});

describe(‘#findOne’, function () {
it(‘读取的图书应该和插入的对象一致’, function (done) {
bookProvider.findOne({_id:book._id}, {}, function (result) {
result.should.eql(book);
done();
});
});
});
});
});
});

这里需要注意的是，对于异步执行的函数，要使用：

it(‘读取的图书应该和插入的对象一致’, function (done) {

另外，在异步内容执行完毕后：

result.should.eql(book);
done();

否则，测试执行不等待异步执行完就结束了。

完整的源代码可参见这里：https://github.com/MarshalW/HelloExpress/tree/v0.2

在这里：https://github.com/MarshalW/HelloExpress/tree/v0.1 ，给出了具体的实现。

见lib/db目录下的两个代码：

• Config.js ，用于配置db模块的参数等；
• DocProvider.js，实现对mongodb的dao封装，示意性的实现，只实现了getCollection和insert

在app.js最后部分，是对该模块的调用：

var book={name:’枪炮、病毒和钢铁’};

var docProvider=new DocProvider(‘books’);

docProvider.insert(book,{},function(result){

    console.log(‘insert ok.’);

});

在nodejs中能找到assertion模块。

写法类似这样：

var assert=require(‘assert’);
assert.equal(1,2);

equal接收两个参数，如果相等，就过去，否则抛出异常，类似这样：

AssertionError: 1 == 2
at Object.<anonymous> (/Users/marshal/WebstormProjects/HelloExpress/app.js:66:8)

DataProvider.prototype.getCollection = function (callback) {
this.db.collection(this.collectionName, function (err, collection) {
if (err) callback(err);

在操作mongodb中，类似的代码很多。问题在于，callback函数负担很重，既要执行业务正常逻辑，又要处理是否有错误。这让程序员编码负担很重，往往不编写对错误的处理。这样一旦有错误，程序还继续执行业务逻辑，带来混乱。

其实，这里一旦有错误，业务逻辑也是无法继续执行的。那么，直接抛异常吧。参见在javascript中使用异常。

可写成类似这样：

DataProvider.prototype.getCollection = function (callback) {
this.db.collection(this.collectionName, function (err, collection) {
if (err) throw(err);
callback(collection);

这样，调用该方法的写法是：

DataProvider.prototype.update = function (selector, document, options, callback) {
this.getCollection(function (collection) {
collection.update(selector, document, options, function(err, result) {
if (err) throw(err);
callback(result);
});
});

这样就可不必在每个callback中写重复的劳什子错误处理了。

throw “Hello error”;

捕获异常的语法也和java差不多：

function test() {
throw “Test error”;
}

try {
test();
} catch (err) {
console.log(err);
}finally{
console.log(‘finally’);
}

下面写的语法，未依赖nodejs函数，应该是标准的javascript语法。

var Hello = function (name) {
this.name = name;
Hello.prototype.sayHello = function () {
console.log(‘hello, ‘ + this.name);
};
};

var hello = new Hello(‘zhangsan’);
hello.sayHello();

var HelloImpl = function (name, title) {
this.title = title;
Hello.call(this, name);

HelloImpl.prototype.sayHello=function(){
console.log(‘Title: ‘+this.title);
Hello.prototype.sayHello.call(this);
};
};

HelloImpl.prototype = new Hello();

var helloImpl = new HelloImpl(‘zhangsan’, ‘Mr.’);
helloImpl.sayHello();

执行的结果：

hello, zhangsan
Title: Mr.
hello, zhangsan

debug: client authorized
info: handshake authorized 949572516804683503
debug: setting request GET /socket.io/1/websocket/949572516804683503
debug: set heartbeat interval for client 949572516804683503
debug: client authorized for
debug: websocket writing 1::

可以通过设置日志级别，屏蔽掉这些debug或者info的日志。

比如这样：

var express = require(‘express’)
, routes = require(‘./routes’)
, io = require(‘socket.io’);

var app = module.exports = express.createServer(),
io = io.listen(app);

// Configuration

io.set(‘log level’, 0);

详细socket.io配置参见：https://github.com/LearnBoost/Socket.IO/wiki/Configuring-Socket.IO

另外，日志级别的设置见：https://github.com/LearnBoost/Socket.IO/blob/master/lib/logger.js

设置的log level的数字，其实就是日志数组下标。

添加

插入一个图书文档：

db.books.insert({name:’深入学习MongoDB’});

然后，可以看一下是否插入成功了：

db.books.find();

打印的结果类似这样：

{ “_id” : ObjectId(“4f8e8a8e7a919fd8a1a37e2d”), “name” : “深入学习MongoDB” }

好了，现在不想要这条记录了，删除掉：

db.books.remove();

再次使用find()，就不会打印内容了。这里要注意，remove()将删除集合中所有文档。如何删除指定条件的文档，后面再说。

修改

再次创建一个图书文档：

db.books.insert({name:’钱的历史’,items:[]});

这里我增加了一个空数组，后面有用。

现在我要将图书名称（name）改为：深入学习MongoDB。

命令：

db.books.update({_id:ObjectId(“4f8e8a8e7a919fd8a1a37e2d”)},{name:’深入学习MongoDB’},false);

上述命令的缺点是，items属性没有了。如果只想修改图书的名称，而不影响文档的其他属性，可以这样：

db.books.update({_id:ObjectId(“4f8ea9a619bc948142e0dad5″)},{$set:{name:’Deep in MongoDB’}},false);

现在，我想往空数组里添加一些东西，比如，一个条目：

{_id:ObjectId, type:’chapter’,items:[]}

那么，命令如下：

 db.books.update({_id:ObjectId(’4f8ea9a619bc948142e0dad5′)},{$push:{items:{_id:new ObjectId(),type:’chapter’,items:[]}}},false);

看一下显示的结果：

{
“_id” : ObjectId(“4f8ea9a619bc948142e0dad5″),
“items” : [
{
"_id" : ObjectId("4f8eaf227a919fd8a1a37e2e"),
"type" : "chapter",
"items" : [ ]
}
],
“name” : “野外维生食物”
}

现在我们想在4f8eaf227a919fd8a1a37e2e的条目的数组中加入内容，怎么做呢？要用到push，它可以向指定的数组追加元素：

db.books.update({_id:ObjectId(’4f8ea9a619bc948142e0dad5′)},{$push:{items:{_id:new ObjectId(),type:’chapter’,items:[]}}},false);

现在我又发现追加的元素的type值错了，想改成section：

db.books.update({_id:ObjectId(“4f8ea9a619bc948142e0dad5″),’items._id’:ObjectId(“4f8ef10b7a919fd8a1a37e32″)},{$set:{‘items.$.type’:'section’}},false);

我是否能在items的元素的items数组中再追加元素呢？答案是肯定的：

db.books.update({_id:ObjectId(“4f8ea9a619bc948142e0dad5″),’items._id’:ObjectId(“4f8ef10b7a919fd8a1a37e32″)},{$push:{‘items.$.items’:{_id:new ObjectId(),type:’section’,items:[]}}},false);

追加后的结果类似这样：

{
“_id” : ObjectId(“4f8ea9a619bc948142e0dad5″),
“items” : [
{
"_id" : ObjectId("4f8ef10b7a919fd8a1a37e32"),
"items" : [
{
"_id" : ObjectId("4f8ef4d17a919fd8a1a37e33"),
"type" : "section",
"items" : [ ]
}
],
“type” : “chapter”
}
]
}

删除

如果文档添加了不该有的属性，想删除，比如：

db.books.update({_id:ObjectId(’4f8e8a8e7a919fd8a1a37e2d’)},{$push:{hello:’test1′}},false);

为文档增加了一个没用的属性，he l lo，这是个数组。

删除它：

db.books.update({_id:ObjectId(’4f8e8a8e7a919fd8a1a37e2d’)},{$unset:{hello:1}},false);

nohup node your_app.js &

但是，forever能做更多的事情，比如分别记录输出和错误日志，比如可以在js中作为api使用。

我们只是很简单的在命令行里使用它。

安装很简单：

sudo npm install forever -g

使用forever启动守护进程：

forever start server.js

关闭守护进程：

forever stop server.js

如果需要记录输出日志和错误：

forever start -l forever.log -o out.log -e err.log server.js

通过以下方式，做了个复用的方案。

常量

如果一遍一遍的写下面这样的代码：

var bookProvider = new BookProvider(“localhost”, 27017);

这部分代码，应该用常量来解决，nodejs提供了Globals模块，里面的global可以设置常量：

global.mongodbHost=’localhost’;
global.mongodbPort=27017;

使用：

console.log(‘mongodb host:’+global.mongodbHost);

 继承

继承可以让子类复用父类的方法。在nodejs中，提供了继承机制的支持，需要引入：

var util=require(‘util’);

比如，我有一个Provider类：

var Provider=function(){

};

Provider.prototype.delete=function(id,callback){
console.log(‘delete document from Provider’);
};

exports.Provider=Provider;

现在，我有一个PersonProvider子类：

var Provider=require(‘./Provider’).Provider,
util=require(‘util’);

var PersonProvider=function(){
console.log(‘mongodb host:’+global.mongodbHost);
};

util.inherits(PersonProvider,Provider);

覆盖

子类可以覆盖超类的方法：

var Provider=require(‘./Provider’).Provider,
util=require(‘util’);

var PersonProvider=function(){
console.log(‘mongodb host:’+global.mongodbHost);
};

util.inherits(PersonProvider,Provider);

Provider.prototype.delete=function(id,callback){
console.log(‘delete document from PersonProvider’);
};

完整的源代码见：https://github.com/MarshalW/Demos/tree/v0.2