15.1 获取代码覆盖报告

编写单元测试有两个目的：

1.   实现新功能时， 单元测试能够确保新添加的代码按预期方式运行。
2.   每次修改程序后， 运行单元测试能保证现有代码的功能没有退化。

编写测试组件很重要， 但知道测试的好坏更重要。 代码覆盖工具用来统计单元测试检查了多少程序功能， 并提供一个详细的报告， 说明程序的哪些代码没有测试到。 这个信息非常重要， 因为它能指引你为最需要测试的部分编写测试。

一. 安装代码覆盖工具coverage

二. 用编程方式启动覆盖检查引擎 manage.py

#!usr/bin/env python

import os

COV = None

if os.environ.get('FLASK_COVERAGE'):

    import coverage

    COV = coverage.coverage(branch=True, include='app/*') 

    COV.start()


#...


@manager.command

def test(coverage=False):

    """Run the unit tests."""

    if coverage and not os.environ.get('FLASK_COVERAGE'):

        import sys

        os.environ['FLASK_COVERAGE'] = '1'

        os.execvp(sys.executable, [sys.executable] + sys.argv)

    import unittest

    tests = unittest.TestLoader().discover('tests')

    unittest.TextTestRunner(verbosity=2).run(tests)

    if COV:

        COV.stop()

        COV.save()

        print('Coverage Summary:')

        COV.report()

        basedir = os.path.abspath(os.path.dirname(__file__))

        covdir = os.path.join(basedir, 'tmp/coverage')

        COV.html_report(directory=covdir)

        print('HTML version: file://%s/index.html' % covdir)

        COV.erase()


#...

若想为test命令添加一个布尔值选项， 只需在test函数中添加一个布尔值参数即可。 Flask-Script根据参数名确定选项名， 并据此向函数传入True或False。

不过把代码覆盖继承到manage.py脚本中有个小问题。 test函数收到 --coverage选项的值后再启动覆盖检测已经晚了， 那时全局作用域中的所有代码都已经执行了。 为了检测的准确性， 设定完环境变量FLASK_COVERAGE后， 脚本会重启。 再次运行时， 脚本顶端的代码发现已经设置了环境变量， 于是立即启动检测覆盖。

coverage.coverage()函数用于启动覆盖检测引擎。

  brach=True开启分支覆盖分析， 除了跟踪哪行代码已经执行外， 还要检查每个条件语句的True分支和False分支是否都执行了。

  include选项用来限制程序包中文件的分析范围。

三. 开启覆盖检测

  执行完所有测试后， text()函数会在终端生成覆盖检测的报告， 同时还会生成一个使用HTML编写的精美报告并写入硬盘， 按照源码的使用情况给代码行加上了不同的颜色。

有了这个报告， 我们就能很容易的确定应该向测试组件中添加哪些测试以提高覆盖率。 但遗憾的是， 并非程序的所有组成部分都像数据库模型那样容易测试。

在接下来， 我们将介绍更高级的测试策略， 可用于测试视图函数， 表单和模板。