Flask Web 测试驱动开发最佳实践之 Flask 实例

wuyangnju 发布于2019-07-30 18:32 / 819人阅读

摘要：当功能越来越复杂的时候，你可能修改了一些东西，导致另外一个功能的不可用，而单元测试也能保证了原有功能被破坏后能被检测出来。

前言

前一篇讲到了 TDD 测试驱动开发的相关概念和环境搭建，这篇就着手开始用TDD方式开发了。首先这篇需要编写用户相关的API接口，如用户注册、用户登录、用户验证等功能。

编写测试

这里使用 Python 自带的测试框架 unittest 来编写简单测试，后续会使用更好用的 pytest 框架来完成整个网站的测试。
首先，最基本的测试是 Flask 应用实例是否存在，新建一个 test_basic.py 文件，当前 v2ex 项目结构如下：

├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
└── tests
    ├── test_basic.py
    └── test_user.py

编写 test_user.py 代码如下：

import unittest
from flask import current_app
from server import create_app


class UserTestCase(unittest.TestCase):
    def setUp(self):
        self.app = create_app("testing")
        self.app_context = self.app.app_context()
        self.app_context.push()

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

    def test_app_is_exist():
        """测试 Flask 实例是否存在"""
        self.assertFalse(current_app is None)


if __name__ == "__main__":
    unittest.main()

这里使用 unittest 编写了一个测试类，setUp() 和 tearDown() 允许执行每个测试用例前分别初始化和清理测试环境，setUp 可用于创建应用实例，然后测试完成后就通过 tearDown 函数清理.

很明显，这个测试肯定是失败的，因为很明显

from server import create_app

这一行是什么东东啊，好像项目里没有存在啊，这就是 TDD 的一个概念了，先编写一个预料之中的失败，然后一步步的把失败那部分改进到测试成功为止。

编写代码跑通测试

新建一个 server 包，用于保存 v2ex 的业务逻辑代码，下面是当前项目的结构：

v2ex
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── server
│   └── __init__.py
└── tests
    ├── test_basic.py
    └── test_user.py

为了组织好模块，会将多个模块分为包。简单来说，包就是文件夹，但该文件夹下必须存在 __init__.py 文件, 然后可以在 __init__.py 文件中新增创建 Flask 实例的工厂函数，代码如下所示：

from flask import Flask
from config import config


def create_app(config_name: str):
    """ 工厂函数，用于延迟创建 Flask 实例，可用于创建多个实例.

    :param config_name: 配置名称，可根据开发环境、测试环境、生产环境区分
    :return: Flask 示例
    """
    app = Flask(__name__)
    app.config.from_object(config[config_name])
    config[config_name].init_app(app)

    return app

然后运行 tests 文件夹下的 test_basic.py 文件，

$ python3 tests/test_basic.py 

Ran 1 test in 0.007s

FAILED (errors=1)

Error
Traceback (most recent call last):
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/case.py", line 59, in testPartExecutor
    yield
  File "/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/unittest/case.py", line 611, in run
    self.setUp()
  File "/Users/guoweikuang/project/github/v2ex/tests/test_basic.py", line 14, in setUp
    self.app = create_app("testing")
  File "/Users/guoweikuang/project/github/v2ex/server/__init__.py", line 17, in create_app
    app.config.from_object(config[config_name])
NameError: name "config" is not defined

这还不能成功，因为我们从最开始就说过，要使用最佳实践方式来一步步实现网站，因此实例化 Flask 需要多带带存在一个配置模块(config.py),目的就是把配置和其它功能区分开。
而且 TDD 的思想就是每次编写最少量的代码取得一些进展，再运行测试，如此不断重复，直到测试成功为止，最后可能还要重构代码，测试能保证不破坏任何一个功能。

进一步完善

当前文件结构如下：

v2ex
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── config.py
├── server
│   └── __init__.py
└── tests
    ├── test_basic.py
    └── test_user.py

前面一节已经知道测试失败原因，这一节就编写一个config.py 模块使单元测试通过：

class Config(object):
    """ 配置基类，所有其它配置类都要继承该类.
    """

    @staticmethod
    def init_app(app):
        pass


class DevelopmentConfig(Config):
    """ 开发环境配置 """
    DEBUG = True


class ProductionConfig(Config):
    """ 生产环境配置 """
    DEBUG = False


class TestingConfig(Config):
    """ 测试环境配置 """
    TESTING = True
    DEBUG = True


config = {
    "development": DevelopmentConfig,
    "product": ProductionConfig,
    "testing": TestingConfig,
    "default": DevelopmentConfig,
}

使用最少的代码使测试成功，然后运行 test_basic.py 看看测试是否通过

$ python tests/test_basic.py
.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK

总结

从上面步骤可以总结到，先写测试代码，然后设法使测试一步步通过的 TDD 开发方式是十分有用的，保证了开发的功能符合预期的想法。当功能越来越复杂的时候，你可能修改了一些东西，导致另外一个功能的不可用，而单元测试也能保证了原有功能被破坏后能被检测出来。这里的代码都可以到 v2ex
项目中查看，每一篇文章都对应着一个 tag, 想要查看每篇文章的修改可以切到对应标签上查看。

混合云服务器托管 Flask_Web 单元测试最佳实践 Flask flask建站

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/42631.html

Flask Web 测试驱动开发最佳实践之开篇

摘要：测试驱动开发简称，是一种软件开发过程中的应用方法，，由极限编程中倡导，以其倡导先写测试程序，然后编码实现其功能得名。测试驱动着整个开发过程首先，驱动代码的设计和功能的实现其后，驱动代码的再设计和重构。 showImg(https://segmentfault.com/img/remote/1460000017081716); 前言一直都有听到 TDD 测试驱动开发的开发方式，之前看...

fnngj 2019-07-30 18:32 评论0 收藏0
microservices-with-docker-flask-and-react 简介

摘要：前置条件这不是一个入门课程。此课程为至少有六个月网站开发经验的高级入门者设置。主题资源目标这部分结束，具备以下能力。。。第一部分完整代码依赖第一部分依赖耗时一章需要几个小时到一整天。空余大块时间来完成一章，特别是，，这些较难的部分。在第一部分，你学到如何使用 Docker 来创建一个基于python, postgres, 和 flask web 框架的 RESTful API 可重...

lily_wang 2019-06-28 17:10 评论0 收藏0
docker-compose 运行 Flask 应用最佳实践

摘要：现在有了之后，部署方式变了更加容易，不容易出现配置错误，环境不一致问题。实际应用中，经常遇到多个容器相配合运行一套应用程序的情况。所以想要将应用运行在容器中，该容器必须将该应用所有的环境依赖安装好。 showImg(https://segmentfault.com/img/remote/1460000017081815); 背景以前部署应用，需要各种环境配置，各种shell操作...

fasss 2019-06-28 16:48 评论0 收藏0
docker-compose 运行 Flask 应用最佳实践

摘要：现在有了之后，部署方式变了更加容易，不容易出现配置错误，环境不一致问题。实际应用中，经常遇到多个容器相配合运行一套应用程序的情况。所以想要将应用运行在容器中，该容器必须将该应用所有的环境依赖安装好。 showImg(https://segmentfault.com/img/remote/1460000017081815); 背景以前部署应用，需要各种环境配置，各种shell操作...

sumory 2019-07-30 18:32 评论0 收藏0
《Python Web开发》作者Harry Percival：TDD就是微小而渐进的改变

摘要：目前就职于，他在各种演讲研讨会和开发者大会上积极推广测试驱动开发。问很多敏捷教练都表示训练新人做测试驱动开发是一件辛苦而进度缓慢的事，并且收益也不是很大。首先是开发的对话式风格。第一个问题就是测试套件的速度。 Harry J.W. Percival目前就职于PythonAnywhere，他在各种演讲、研讨会和开发者大会上积极推广测试驱动开发（TDD）。他在利物浦大学获得计算机科学硕士学...

Guakin_Huang 2019-07-24 18:26 评论0 收藏0