用unittest测试web2py应用中的非页面部分

虽然web2py在文档中建议采用doctest对controller进行测试的方式,但是一则我对doctest不熟,二则只对controller层进行测试覆盖虽然很全面,但是测试粒度太大,对我来说测得不够细。

我 的设计习惯是controller层只进行简单的调用转换,实际的业务逻辑放在module层(注意:不是model层)处理,虽然在model里进行设 置后借助于Generic View也能干很多事情,但是一方面我不习惯这种方式,另一方面这种方式还是有一定的局限性——最主要是我不想把太多界面上的东西放到model里。

既 然业务逻辑在module中,那么我就需要在不借助页面的情况下对这些module进行单独的测试,这是文档建议的测试方式所做不到的——我又不想为了测 试而特地弄几个页面。于是研究了一下如何用unittest对module进行测试——问题在关键在于如何在unittest中创建web2py的运行环 境。而这一环境的核心就是db——如何初始化一个db供被测试的module使用。

其实要做到这一点并不难。gluon.shell包中提供了一个函数exec_environment来实现这一功能。假设有一个db.py是这样的:

db.define_table('tabletest',
    SQLField('code'),
    SQLField('name'))

那么测试用例可以写成这样:

import sys
import os
db_path = path.realpath('../models/db.py')
web2py_path = '../../..'
sys.path.append(os.path.realpath(web2py_path))
sys.path.append(os.path.realpath('..'))
os.chdir(web2py_path)

import unittest from gluon.shell import exec_environment from modules import datamodule

class TestDefaultController(unittest.TestCase): def setUp(self): self.dbm=exec_environment(db_path)

def tearDown(self):
    db=self.dbm.db
    query=(db.tabletest.code=="000111")
    db(query).delete()

def testDB(self):
    db=self.dbm.db
    x=db.tabletest.insert(code="000111", name="test name")
    query=(db.tabletest.id==x)
    y=db(query).select()[0].id
    self.assertEqual(x,y)

def testDataModule(self):
    db=self.dbm.db
    x=datamodule.foo(db, ...)
    self.assert...

if name == 'main': unittest.main()

代码很简单,最开始一段是准备程序的运行路径,因为这个测试用例的文件是放在: web2py/applications/yourapp/tests下的,所以用"../../.."来指向web2py的根目录,并定位当前位置于此。

重 点在于setUp函数中调用了exec_environment函数来执行db.py,这样就能够为测试准备好web2py的运行环境,并启用db.py 中的model定义。之后在testDB和testDataModule中就可以使用db进行数据库访问并检测执行结果。这与一般的unittest应用 没什么不同。

最后需要注意的一点是:不能用windows exe版的web2py,要用源码版的web2py才能正常使用unittest,否则会出错。