Flask Web 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)最佳實(shí)踐之 Flask 實(shí)例

wuyangnju 發(fā)布于2019-07-30 18:32 / 1142人閱讀

摘要：當(dāng)功能越來(lái)越復(fù)雜的時(shí)候，你可能修改了一些東西，導(dǎo)致另外一個(gè)功能的不可用，而單元測(cè)試也能保證了原有功能被破壞后能被檢測(cè)出來(lái)。

前言

前一篇講到了 TDD 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)的相關(guān)概念和環(huán)境搭建，這篇就著手開(kāi)始用TDD方式開(kāi)發(fā)了。首先這篇需要編寫(xiě)用戶相關(guān)的API接口，如用戶注冊(cè)、用戶登錄、用戶驗(yàn)證等功能。

編寫(xiě)測(cè)試

這里使用 Python 自帶的測(cè)試框架 unittest 來(lái)編寫(xiě)簡(jiǎn)單測(cè)試，后續(xù)會(huì)使用更好用的 pytest 框架來(lái)完成整個(gè)網(wǎng)站的測(cè)試。
首先，最基本的測(cè)試是 Flask 應(yīng)用實(shí)例是否存在，新建一個(gè) test_basic.py 文件，當(dāng)前 v2ex 項(xiàng)目結(jié)構(gòu)如下：

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

編寫(xiě) 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():
        """測(cè)試 Flask 實(shí)例是否存在"""
        self.assertFalse(current_app is None)


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

這里使用 unittest 編寫(xiě)了一個(gè)測(cè)試類(lèi)，setUp() 和 tearDown() 允許執(zhí)行每個(gè)測(cè)試用例前分別初始化和清理測(cè)試環(huán)境，setUp 可用于創(chuàng)建應(yīng)用實(shí)例，然后測(cè)試完成后就通過(guò) tearDown 函數(shù)清理.

很明顯，這個(gè)測(cè)試肯定是失敗的，因?yàn)楹苊黠@

from server import create_app

這一行是什么東東啊，好像項(xiàng)目里沒(méi)有存在啊，這就是 TDD 的一個(gè)概念了，先編寫(xiě)一個(gè)預(yù)料之中的失敗，然后一步步的把失敗那部分改進(jìn)到測(cè)試成功為止。

編寫(xiě)代碼跑通測(cè)試

新建一個(gè) server 包，用于保存 v2ex 的業(yè)務(wù)邏輯代碼，下面是當(dāng)前項(xiàng)目的結(jié)構(gòu)：

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

為了組織好模塊，會(huì)將多個(gè)模塊分為包。簡(jiǎn)單來(lái)說(shuō)，包就是文件夾，但該文件夾下必須存在 __init__.py 文件, 然后可以在 __init__.py 文件中新增創(chuàng)建 Flask 實(shí)例的工廠函數(shù)，代碼如下所示：

from flask import Flask
from config import config


def create_app(config_name: str):
    """ 工廠函數(shù)，用于延遲創(chuàng)建 Flask 實(shí)例，可用于創(chuàng)建多個(gè)實(shí)例.

    :param config_name: 配置名稱(chēng)，可根據(jù)開(kāi)發(fā)環(huán)境、測(cè)試環(huán)境、生產(chǎn)環(huán)境區(qū)分
    :return: Flask 示例
    """
    app = Flask(__name__)
    app.config.from_object(config[config_name])
    config[config_name].init_app(app)

    return app

然后運(yùn)行 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

這還不能成功，因?yàn)槲覀儚淖铋_(kāi)始就說(shuō)過(guò)，要使用最佳實(shí)踐方式來(lái)一步步實(shí)現(xiàn)網(wǎng)站，因此實(shí)例化 Flask 需要多帶帶存在一個(gè)配置模塊(config.py),目的就是把配置和其它功能區(qū)分開(kāi)。
而且 TDD 的思想就是每次編寫(xiě)最少量的代碼取得一些進(jìn)展，再運(yùn)行測(cè)試，如此不斷重復(fù)，直到測(cè)試成功為止，最后可能還要重構(gòu)代碼，測(cè)試能保證不破壞任何一個(gè)功能。

進(jìn)一步完善

當(dāng)前文件結(jié)構(gòu)如下：

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

前面一節(jié)已經(jīng)知道測(cè)試失敗原因，這一節(jié)就編寫(xiě)一個(gè)config.py 模塊使單元測(cè)試通過(guò)：

class Config(object):
    """ 配置基類(lèi)，所有其它配置類(lèi)都要繼承該類(lèi).
    """

    @staticmethod
    def init_app(app):
        pass


class DevelopmentConfig(Config):
    """ 開(kāi)發(fā)環(huán)境配置 """
    DEBUG = True


class ProductionConfig(Config):
    """ 生產(chǎn)環(huán)境配置 """
    DEBUG = False


class TestingConfig(Config):
    """ 測(cè)試環(huán)境配置 """
    TESTING = True
    DEBUG = True


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

使用最少的代碼使測(cè)試成功，然后運(yùn)行 test_basic.py 看看測(cè)試是否通過(guò)

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

OK

總結(jié)

從上面步驟可以總結(jié)到，先寫(xiě)測(cè)試代碼，然后設(shè)法使測(cè)試一步步通過(guò)的 TDD 開(kāi)發(fā)方式是十分有用的，保證了開(kāi)發(fā)的功能符合預(yù)期的想法。當(dāng)功能越來(lái)越復(fù)雜的時(shí)候，你可能修改了一些東西，導(dǎo)致另外一個(gè)功能的不可用，而單元測(cè)試也能保證了原有功能被破壞后能被檢測(cè)出來(lái)。這里的代碼都可以到 v2ex
項(xiàng)目中查看，每一篇文章都對(duì)應(yīng)著一個(gè) tag, 想要查看每篇文章的修改可以切到對(duì)應(yīng)標(biāo)簽上查看。

云服務(wù)器 GPU云服務(wù)器 Flask_Web 單元測(cè)試最佳實(shí)踐 Flask flask建站

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://www.ezyhdfw.cn/yun/42631.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

wuyangnju

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

linux之realpath命令

閱讀 1998·2021-11-23 09:51
如何在SpringBoot啟動(dòng)時(shí)執(zhí)行初始化操作，兩個(gè)簡(jiǎn)單接口就可以實(shí)現(xiàn)

閱讀 1445·2021-11-18 10:02
酷銳云：雙十一活動(dòng)預(yù)熱，1核/2G/10M帶寬，月付11元，4核/8G/20M帶寬，月付111元

閱讀 1035·2021-10-25 09:44
IIFE立即執(zhí)行函數(shù)

閱讀 2169·2019-08-26 18:36
VUE 全局變量的幾種實(shí)現(xiàn)方式

閱讀 1693·2019-08-26 12:17
JavaScript 進(jìn)階從實(shí)現(xiàn)理解閉包（校對(duì)版）

閱讀 1227·2019-08-26 11:59
Vue基礎(chǔ)之計(jì)算屬性

閱讀 2803·2019-08-23 15:56
使用webpack打包多頁(yè)jquery項(xiàng)目

閱讀 3432·2019-08-23 15:05

亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專(zhuān)欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Flask Web 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)最佳實(shí)踐之 Flask 實(shí)例

相關(guān)文章

Flask Web 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)最佳實(shí)踐之開(kāi)篇

**microservices-with-docker-flask-and-react 簡(jiǎn)介**

docker-compose 運(yùn)行 Flask 應(yīng)用最佳實(shí)踐

docker-compose 運(yùn)行 Flask 應(yīng)用最佳實(shí)踐

**《Python Web開(kāi)發(fā)》作者Harry Percival：TDD就是微小而漸進(jìn)的改變**

發(fā)表評(píng)論

0條評(píng)論

wuyangnju

男|高級(jí)講師

TA的文章

linux之realpath命令

如何在SpringBoot啟動(dòng)時(shí)執(zhí)行初始化操作，兩個(gè)簡(jiǎn)單接口就可以實(shí)現(xiàn)

酷銳云：雙十一活動(dòng)預(yù)熱，1核/2G/10M帶寬，月付11元，4核/8G/20M帶寬，月付111元

IIFE立即執(zhí)行函數(shù)

VUE 全局變量的幾種實(shí)現(xiàn)方式

JavaScript 進(jìn)階從實(shí)現(xiàn)理解閉包（校對(duì)版）

Vue基礎(chǔ)之計(jì)算屬性

使用webpack打包多頁(yè)jquery項(xiàng)目

最新活動(dòng)

資訊專(zhuān)欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Flask Web 測(cè)試驅(qū)動(dòng)開(kāi)發(fā)最佳實(shí)踐之 Flask 實(shí)例

相關(guān)文章

發(fā)表評(píng)論

0條評(píng)論

男|高級(jí)講師

TA的文章

最新活動(dòng)

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！