第十五章 测试（一）

编写单元测试主要有2个目的：

1. 实现新功能时能够确保新添加的代码按预期方式运行；
2. 每次修改应用后，运行单元测试能确保现有代码的功能没有回归，即新改动没有影响代码的正常运行；

       从一开始我们就为Flasky应用编写了单元测试，检查数据库模型类有没有实现功能。由于模型类很容易在运行中的应用上下文之外进行测试，故应用中我们将绝大多数业务逻辑都放在了模型类中实现，视图函数中的代码只起到粘合剂的作用。为模型类编写单元测试，可以覆盖绝大多数代码。本章我们将再介绍2中单元测试的类别：

1. 使用Flask客户端测试视图函数
2. 使用selenium进行端到端的测试

       我们使用包来组织测试，tests包中，各模块都以test_*开头。unittest支持自动发现测试，执行python -m unittest discover -v运行测试时，unittest默认会从当前目录开始寻找以test_*.py模式命名的模块，然后运行其中的测试。

       视图函数只在在请求上下文和运行的应用里运行。Flask内建了一个测试客户端用于解决（至少部分解决）这一问题。测试客户端能复现应用运行在Web服务器中的环境，让测试充当客户端来发送请求。

tests/test_client.py：使用Flask测试客户端编写的测试框架

import re
import unittest
from app import create_app, db
from app.models import User, Role


class FlaskClientTestCase(unittest.TestCase):
    def setUp(self):
        self.app = create_app('testing')
        self.app_context = self.app.app_context()
        self.app_context.push()
        # 应用上下文激活以后，才可以使用db
        db.create_all()
        Role.insert_rows()
        self.client = self.app.test_client(use_cookies=True)

    def tearDown(self):
        db.drop_all()
        self.app_context.pop()

    def test_home_page(self):
        response = self.client.get('/')
        self.assertTrue(response.status_code, 200)
        self.assertIn(b'Stranger', response.data)

       在执行测试时是没有Flask上下文存在的。但有些行为又依赖于程序上下文或请求上下文才能正确进行。比如，Flask-SQLAlchemy中用来清除数据库会话的db.session.remove()调用通过teardown_appcontext装饰器注册，而这个函数只会在程序上下文销毁时才会触发。

       另外，当时用工厂函数创建程序时，我们使用current_app来操作程序实例。事实上，除了我们程序中使用的代码，扩展的代码中也会使用current_app。比如，Flask-SQLAlchemy需要从程序实例获取配置信息。直接创建程序实例，并在实例化SQLAlchemy类时传入程序实例时，Flask-SQLAlchemy会直接从这个程序实例app对象获取配置信息。当使用工厂函数创建程序实例并使用init_app()初始化程序后，Flask-SQLAlchemy则会从current_app对象获取程序配置信息。

       使用app_context()和test_request_context()方法可以手动激活程序上下文和请求上下文。

       新增的self.client实例变量即Flask测试客户端对象，在这个对象上调用请求方法向应用发起请求。如果创建测试客户端时启用了use_cookies选项，这个客户端就能像浏览器一样接收和发送cookie。

       test_home_page()演示了测试客户端的使用，向根路径发送GET请求后，我们先检查响应的状态码，然后使用response.data获取响应体，类型为字节串，所以使用b'Stranger'。使用response.get_data(as_text=True)可以获取字符串形式。

       测试客户端还可以使用POST方法发送包含表单数据的POST请求。但需要注意，Flask-WTF生成的表单中包含一个隐藏字段，其内容是CSRF令牌。为了发送CSRF令牌，测试必须请求表单所在的页面，然后解析响应返回的HTML代码，提取CSRF令牌。简单起见，最好在测试环境中禁用CSRF保护机制。

config.py 在测试配置中禁用CSRF保护机制

class TestingConfig(Config):
    TESTING = True
    # 未指定环境变量时，测试换将将使用内存数据库sqlite
    SQLALCHEMy_DATABASE_URI = os.environ.get('TEST_DATABASE_URI') or 'sqlite://'
    WTF_CSRF_ENABLED = False

tests/test_client.py：使用Flask测试客户端模拟新用户注册的整个流程

class FlaskClientTestCase(unittest.TestCase):
    ... ...
        def test_register_and_login(self):
        # register a new account
        response = self.client.post('/auth/register', data={
            'email': 'Bob@example.com',
            'username': 'Bob',
            'password': '123',
            'password2': '123',
        })
        self.assertEqual(response.status_code, 302)

        # login with the new account
        response = self.client.post('/auth/login', data={
            'email': 'Bob@example.com',
            'password': '123'
        }, follow_redirects=True)
        self.assertEqual(response.status_code, 200)
        self.assertTrue(re.search(b'Hello,\s+Bob!', response.data))
        self.assertTrue(b'You have not confirmed your account yet.' in response.data)

        # send a confirmation token
        user = User.query.filter_by(email='Bob@example.com').first()
        token = user.generate_confirmation_token()
        response = self.client.get('/auth/confirm/{}'.format(token), follow_redirects=True)
        self.assertTrue(response.status_code, 200)
        self.assertTrue(b'You have confirmed your account. Thanks!' in response.data)

        # logout
        response = self.client.get('/auth/logout', follow_redirects=True)
        self.assertEqual(response.status_code, 200)
        self.assertTrue(b'You have been logged out.' in response.data)

       这个测试先向注册路由提交一个表单。post方法的data参数是一个字典，包含表单中的各字段，字段的名称和表单字段的name属性保持一致。由于CSRF保护机制已经在配置中禁用了，因此无需和表单数据一起发送。为了确认注册成功，测试检测响应的状态码是否为302，表示重定向。

       接下来使用刚刚注册的email登录应用，调用post方法时指定了参数follow_redirects=True，让客户端像浏览器那样，自动向重定向的URL发起GET请求。指定这个参数后，返回的不是302状态码，而是请求重定向的URL返回的响应。

       成功登录后的响应应该是一个页面，显示一个包含用户名的欢迎消息，并提醒用户去确认账户。值得注意的是在检查“Hello Bob”时，由于字符串由静态部分和动态部分组成，Jinjia2模板生成最终的HTML会在中间加上额外的空格。因此我们使用正则进行匹配。

       在进行确认账户操作时，我们忽略了注册时生成的令牌，直接调用User模型相关方法产生新令牌，构建URL进行确认。向这个包含令牌的URL发起GET请求，这个请求的响应是重定向到首页，故这里再次指定了参数follow_redirects=True。