Django筆記三十六之單元測試彙總介紹

来源:https://www.cnblogs.com/hunterxiong/archive/2023/05/06/17378703.html
-Advertisement-
Play Games

本文首發於公眾號:Hunter後端 原文鏈接:Django筆記三十六之單元測試彙總介紹 Django 的單元測試使用了 Python 的標準庫:unittest。 在我們創建的每一個 application 下麵都有一個 tests.py 文件,我們通過繼承 django.test.TestCase ...


本文首發於公眾號:Hunter後端

原文鏈接:Django筆記三十六之單元測試彙總介紹

Django 的單元測試使用了 Python 的標準庫:unittest。

在我們創建的每一個 application 下麵都有一個 tests.py 文件,我們通過繼承 django.test.TestCase 編寫我們的單元測試。

本篇筆記會包括單元測試的編寫方式,單元測試操作流程,如何復用資料庫結構,如何測試介面,如何指定 sqlite 作為我們的單元測試資料庫等

以下是本篇筆記目錄:

  1. 單元測試示例、使用和介紹
  2. 單元測試流程介紹
  3. 單元測試的執行命令
  4. 復用測試資料庫結構
  5. 判斷函數
  6. 介面的測試
  7. 標記測試
  8. 單元測試配置
  9. 使用 SQLite 作為測試資料庫

1、單元測試示例、使用和介紹

首先我們編寫 blog/tests.py 文件,創建一個簡單的單元測試:

from django.test import TestCase
from blog.models import Blog


class BlogCreateTestCase(TestCase):
    def setUp(self):
        Blog.objects.create(name="Python", tag_line="this is a tag line")

    def test_get_blog(self):
        blog = Blog.objects.get(name="Python")
        self.assertEqual(blog.name, "Python")

以上是一個很簡單的單元測試示例,接下來我們執行這個單元測試:

python3 manage.py test blog.tests.BlogCreateTestCase.test_get_blog

執行之後可以看到控制台會輸出一些信息,如果沒有報錯,說明我們的這個單元測試成功執行。

在 BlogCreateTestCase 中,這個單元測試繼承了 django.test.TestCase,我們在 setUp() 函數中執行一些操作,這個操作會在執行某個測試,比如 test_get_blog() 前先執行。

我們執行的是 test_get_blog() 函數,這裡的邏輯是先獲取一個 blog 示例,然後通過 assertEqual() 函數判斷兩個輸入的值是否相等,如果相等,則單元測試通過,否則會報失敗的錯誤。

2、單元測試流程介紹

首先我們看一下 settings.py 中的資料庫定義:

# hunter/settings.py

DATABASES = {
    'default': {
        'ENGINE': "django.db.backends.mysql",
        'NAME': "func_db",
        "USER": "root",
        "PASSWORD": "123456",
        "HOST": "192.168.1.9",
        "PORT": 3306,
    },
}

當我們執行下麵這個命令之後:

python3 manage.py test blog.tests.BlogCreateTestCase.test_get_blog

系統會去 default 這個資料庫的連接地址,創建一個新的資料庫,資料庫名稱為當前資料庫的名稱加上 test_ 首碼。

比如我們連接的正式資料庫名稱為 func_db,那麼測試資料庫名為 test_func_db

創建該資料庫之後,系統會將當前系統所有的 migration 都執行一遍到測試資料庫,然後依據我們單元測試的邏輯,比如 setUp() 中對數據的初始化,以及 test_get_blog() 中對數據的獲取和比較操作執行一遍邏輯。

這個流程結束之後,系統會自動刪除剛剛創建的測試資料庫,至此,一個單元測試執行的流程就結束了。

3、單元測試的執行命令

執行單個單元測試

上面我們執行的單元測試的命令精確到了類中的函數,我們也可以直接執行某個單元測試,比如我們的 BlogCreateTestCase 內容如下:

class BlogCreateTestCase(TestCase):
    def setUp(self):
        Blog.objects.create(name="Python", tag_line="this is a tag line")

    def test_get_blog(self):
        print("test_get_blog")
    
    def test_get_blog_2(self):
        print("test_get_blog_2")

我們直接執行命令到這個單元測試:

python3 manage.py test blog.tests.BlogCreateTestCase

那麼系統就會執行 BlogCreateTestCase 下 test_get_blog 和 test_get_blog_2 這兩個函數。

執行單元測試文件

再往上一層,我們可以執行某個單元測試的文件,比如該 tests.py 內容如下:

# blog/tests.py

class BlogCreateTestCase(TestCase):
    def setUp(self):
        Blog.objects.create(name="Python", tag_line="this is a tag line")

    def test_get_blog(self):
        print("test_get_blog")
        
class BlogCreateTestCase2(TestCase):
    
    def test_get_blog_2(self):
        print("test_get_blog_2")

當我們執行:

python3 manage.py test blog.tests

系統就會將 tests.py 中 BlogCreateTestCase 和 BlogCreateTestCase2 這兩個單元測試都執行一遍。

執行系統所有單元測試

如果我們想要統一執行系統全部單元測試,可以直接如下操作:

python3 manage.py test

單元測試查找邏輯

當我們執行上面那條命令的時候,系統是如何查找處測試文件的呢?

系統會搜索目錄下所有 test 開頭的文件夾或者文件,如果是文件夾,則繼續尋找文件夾下 test 開頭的文件,對於每個 test 開頭的文件,找到繼承了 django.test.TestCase 的類,然後執行每個開頭名為 test 的類函數。

接下來我們舉幾個示例,假設我們在 blog 的目錄下有這樣的結構:

blog/
    test_123/
        no_test.py
        test_ok.py
        tests.py
    tests/
        tests.py
        test_123.py
    no_test/
        test_123.py
    test.py
    test_123.py
    no_test.py

在上面這個目錄結構下,系統會去搜索 test_123tests 文件夾下 test 開頭的文件,以及 blog 下的 test.pytest_123.py,尋找其中繼承了 django.test.TestCase 的類作為單元測試然後執行。

在這裡,比如 test_123/no_test.py 這個文件就不會被判定為測試文件,因為它名稱不是 test 開頭的。

而在 test 開頭的測試文件中,如果一個類繼承了 django.test.TestCase,但是它的類函數並不是以 test 開頭的,這樣的函數也不會被執行,比如:

class BlogCreateTestCase(TestCase):
    def setUp(self):
        Blog.objects.create(name="如何Python", tag_line="this is a tag line")

    def test_ok(self):
        print("12344444............")
        self.assertEqual(1, 1)

    def no_test(self):
        print("no test")

比如上面這個單元測試,test_ok 這個類函數就會被作為單元測試的一部分,而 no_test 則不會被執行。

如果測試文件較多,為了統一管理,我們可以都放在 application 下的 tests 文件夾下,比如:

blog/
    tests/
        test_1.py
        test_2.py
        test_3.py

4、復用測試資料庫結構

當我們寫完一個功能,然後編寫這個功能的單元測試,緊接著去測這個單元測試,系統就會去創建一個資料庫,然後執行所有的 migration,然後執行單元測試邏輯,執行結束之後會刪掉該測試資料庫。

在我們的項目中,如果維護到了後期,擁有的 migration 較多,每次執行單元測試都要刪掉然後重建資料庫,在時間上是一個很大的消耗,那麼我們如何在執行完一個單元測試之後保存當前的測試資料庫用於下一次執行呢。

那就是使用 --keepdb 參數。

按照前面的邏輯,我們的測試資料庫會在 DATABASES 中定義的資料庫地址新建一個資料庫,我們可以使用 --keepdb 執行這樣的操作:

python3 manage.py test --keepdb blog.tests.BlogCreateTestCase

加上 --keepdb 參數之後,執行單元測試結束之後,我們可以通過 workbench 或者 navicat 等工具去該資料庫地址查看,會多出一個名為 test_fund_db 的資料庫,那就是我們執行單元測試之後沒有刪除的測試資料庫。

當我們下次再執行這個或者其他單元測試的時候,可以發現執行的時間就變得很快了,而且在控制台會輸出這樣一條信息:

Using existing test database for alias 'default'...

意思就是使用已經存在的測試資料庫。

而不加 --keepdb 的時候,輸出的是:

Creating test database for alias 'default'...

表示的是正在創建新的測試資料庫。

註意: 雖然單元測試結束之後資料庫的結構還會保留,但是在單元測試中我們創建的數據還是會被刪除。這個僅限於在單元測試中創建的數據,通過 migration 初始化的數據還是存在資料庫中。

5、判斷函數

在介紹測試介面前,我們先介紹一下幾個判定函數。

self.assertEqual

這個函數接收三個參數,前兩個參數用於比較是否相等,第三個參數為 msg,用於在前兩個參數不相等時報出的錯誤信息,但是可不傳,預設為 None。

比如我們這樣操作:

self.assertEqual(Blog.objects.count(), 20, msg="blog count error")

self.assertEqual(Blog.objects.count(), 20)

如果前兩個參數不相等則單元測試會不通過。

self.assertTrue

這個函數接收兩個參數,前一個參數是一個表達式,後一個參數是 msg,也是用於前一個參數不為 True 的時候報出的錯誤信息,可不傳,預設為 None。

我們可以這樣操作:

self.assertTrue(Blog.objects.filter(name="Python").exists(), "Pyrhon blog not exists")

self.assertTrue(Blog.objects.filter(name="Python").exists())

同樣,如果表達式參數不為 True,則單元測試不會通過。

self.assertIn

接收三個參數,如果第二個參數不包含第一個參數,則會報錯,比如:

self.assertIn(6, [1,2,3], "not in list")

self.assertIn("a", "def", "not in string")

self.assertIsNone

介面兩個參數,表示如果傳入的參數為 None 則通過單元測試:

a = None
self.assertIsNone(a)

對於 assertEqual、 assertTrue、assertIn、assertIsNone 還有對應的相反意義的函數

  • assertNotEqual 表示判定兩者不相等
  • assertFalse 表示判定表達式為 False
  • assertNotIn 表示判定後者不包含前者
  • assertIsNotNone 表示判定不為 None

這裡還有一些判定大於、小於、大於等於、小於等於的函數,這裡就不做多介紹了 assertGreater、assertLess、assertGreaterEqual、assertLessEqual

self.fail(msg="failed testcase")

如果我們希望在某些判斷條件下直接讓單元測試不通過,可以直接使用 self.fail() 函數,比如:

a = 1
b = 2
if a < b:
    self.fail(msg="a < b")

6、介面的測試

在上面我們的單元測試中,我們使用的只是簡單的對於 model 的創建查詢和驗證,但是一般來說,除了測試系統的工具類函數,我們常用到的測試用途是測試和驗證介面的邏輯。

在介紹如何對介面進行測試前,一下 model_mommy 庫。

model_mommy 庫

這是個可以模擬 model 數據的庫,它有什麼用處呢,比如我們想創建幾條 model 的數據,但是不關心一些必填欄位的值,或者只想指定某幾個欄位特定的值,或者想批量創建某個 model 的數據。

首先我們引入這個庫:

pip3 install model_mommy

使用 model_mommy 來創建模擬數據:

from model_mommy import mommy

blog_1 = mommy.make(Blog, name="Python")

這樣我們就創建了一條數據,這個時候如果我們列印出 blog_1 的內容,可以發現 Blog 的有預設值的欄位都被預設值填充,無預設值的都會被無意義數據填充

print(blog_1.__dict__)

#  'id': 4, 'name': 'Python', 'tag_line': 'sIDENcYqKVwESvEUAwZGIVtGdWHhKyNNoDzoaZCdDuqQuIKCkwazqwfcNEEtzfcoZeEnVVDiVLzAhhOuYsxiuKUOVFifUimnCLbMNHMpYLYxHCVSVfiggeBQhmRPFuIUwiKDUSDZztzQzFlKfcSxdnewsekQBzlCuMZLVPyOrfTXYWgPIkBhytzBkcMbpvCvidSETxZRjWeeEBPLELHpHYOmKgKHdNxrmjjLlewGWKTLQNFPFWOGndzncghTEcuFnEfRQvGgXcsPTfaGAHDDqPGyNeerTmOHDTUmnWmzHIXF', 'char_count': 0, 'is_published': 0, 'pub_datetime': None}

或者我們想批量創建二十條 Blog 的數據,我們可以通過 _quantity 參數這樣操作:

mommy.make(Blog, _quantity=20)

Client() 調用介面

調用介面用到的函數是 Client()

假設我們想要調用登錄介面,我們可以如下操作:

from django.test import Client

url = "/users/login"
c = Client()
response = c.post(url, data={"username": "admin", "password": "123456"}, content_type="application/json")

self.assertEqual(response.json().get("code"), 0)

使用單元測試而不是使用 postman 調用有一個好處就是我們不用把後端服務啟動起來,所以這裡的 url 相應的也不用加上 ip 地址或者功能變數名稱。

調用介面還有另一種方式,就是在繼承了 django.test.TestCase 的單元測試中直接使用 self.client,它與實例化 Client() 後的直接作用效果是一樣的,都可以用來調用介面。

那為什麼要使用 self.client 呢,是為了自動保存登錄介面的 session。

比如對於 /users/user/info 這個需要登錄後才能訪問到的用戶信息介面,我們就可以使用 self.client 在 setUp() 初始化數據的時候先進行登錄操作,接著就可以以已登錄狀態訪問用戶信息介面了。

class UserInfoTestCase(TestCase):
    def setUp(self):
        username = "admin"
        password = make_password("123456")
        User.objects.create(username=username, password=password)

        url = "/users/login"
        response = self.client.post(url, data={"username": "admin", "password": "123456"}, content_type="application/json")
        resp_data = response.json()
        print("login...")
        self.assertEqual(resp_data.get("code"), 0)
    
    def test_user_info(self):
        url = "/users/user/info"
        response = self.client.post(url)
        print(response.json())

如果系統大部分介面都需要以登錄狀態才能訪問,我們甚至可以將登錄操作寫入一個基礎類,其他的單元測試都繼承這個類,這樣就不需要重覆編寫登錄的介面了:

class BaseTestCase(TestCase):
    def setUp(self):
        username = "admin"
        password = make_password("123456")
        User.objects.create(username=username, password=password)

        url = "/users/login"
        response = self.client.post(url, data={"username": "admin", "password": "123456"}, content_type="application/json")
        resp_data = response.json()
        print("login...")
        self.assertEqual(resp_data.get("code"), 0)



class UserInfoTestCase(BaseTestCase):
    def test_user_info(self):
        url = "/users/user/info"
        response = self.client.post(url)
        print(response.json())


class TestCase2(BaseTestCase):
    def test_case(self):
        url = "/xx/xxx"
        response = self.client.post(url)
        print(response.json())

7、標記測試

一般來說,我們的單元測試是都要全部通過才能上線進入生產環境的,但是某些情況下,我們對系統只進行了少部分的修改,或者說只需要測試某些特定的重要功能就可以上線,這種情況下可以給我們的測試用例打上 tag,這樣在測試的時候就可以挑選特定的單元測試,通過即可上線。

這個 tag 可以打到一個單元測試上,也可以打到某個單元測試的函數上,比如我們有三個標記,fast,slow,core,以下是幾個單元測試:

from django.test import tag

class SingleTestCase(TestCase):
    @tag("fast", "core")
    def test_1(self):
        print("fast, core from SingleTestCase.test_1")

    @tag("slow")
    def test_2(self):
        print("slow from SingleTestCase.test_2")


@tag("core")
class CoreTestCase(TestCase):
    def test_1(self):
        print("core from CoreTestCase")

然後我們可以通過 --tag 指定標記的單元測試:

python3 manage.py test --keepdb --tag=core

python3 manage.py test --keepdb --tag=core --tag=slow

8、單元測試配置

編碼配置

在前面我們的資料庫鏈接中,並沒有指定資料庫的編碼,而我們創建生產資料庫的時候使用的 charset 是 utf-8,而測試資料庫在創建的時候沒有指定編碼的話,預設使用的是 latin1 編碼。

這樣會造成一個問題,就是我們的單元測試在往資料庫寫入數據的時候就會因為不支持中文而導致報錯。

比如在不設置編碼的時候我們使用下麵的單元測試就會報錯:

from django.test import TestCase
from blog.models import Blog


class BlogCreateTestCase(TestCase):
    def setUp(self):
        Blog.objects.create(name="測試數據", tag_line="this is a tag line")

    def test_get_blog(self):
        blog = Blog.objects.get(name="測試數據")
        self.assertEqual(blog.name, "測試數據")

所以如果要指定創建的測試資料庫的編碼,我們需要加上一個配置:

DATABASES = {
    'default': {
        ...
        "TEST": {
            "CHARSET": "utf8",
        },
    }
}

測試資料庫名稱

預設情況下,測試資料庫的名稱是 'test_' + DATABASES['default']['name'],如果我們想指定測試資料庫名稱,可以額外加一個 NAME 欄位:

DATABASES = {
    'default': {
        ...
        "TEST": {
            "CHARSET": "utf8",
            "NAME": "test_default_db",
        },
    }
}

9、使用 SQLite 作為測試資料庫

目前我們的測試資料庫是在 default 資料庫的地址新建一個資料庫,如果我們想要運行單元測試的時候直接在本地使用 SQLite 作為我們的測試資料庫,可以在 settings.py 中定義 DATABASES 的後面加上下麵的定義:

import sys

if "test" in sys.argv:
    DATABASES = {
        "default": {
            "ENGINE": "django.db.backends.sqlite3",
            "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
            "TEST": {
                "NAME": os.path.join(BASE_DIR, "test_db.sqlite3"),
            }
        }
    }

其中,sys.argv 是一個列表,列表元素是我們執行命令的各個參數。

所以當我們執行單元測試命令的時候,會包含 test,所以資料庫的鏈接內容就會走我們這個邏輯。

在這部分,我們使用 ENGINE 來確定了後端資料庫的類型為 SQLite,然後通過 DATABASES["default"]["test"]["NAME"] 來指定我們的測試資料庫地址。

當我們執行單元測試的命令時,在系統根目錄下就會多出一個 test_db.sqlite3 的資料庫。

如果想獲取更多後端相關文章,可掃碼關註閱讀:
image


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 提起分庫分表,對於大部分伺服器開發來說,其實並不是一個新鮮的名詞。隨著業務的發展,我們表中的數據量會變的越來越大,欄位也可能隨著業務複雜度的升高而逐漸增多,我們為瞭解決單表的查詢性能問題,一般會進行分表操作。 同時我們業務的用戶活躍度也會越來越高,併發量級不斷加大,那麼可能會達到單個資料庫的處理能... ...
  • 分析服務 ◆ 事件分析下新增商品訂閱分析報告,幫助開發者瞭解應用內用戶付費訂閱概況,評估訂閱付費價值; ◆ 營銷分析、用戶質量、轉化分析以及過濾器中,新增廣告系列/廣告任務通過ID進行搜索的功能,通過更便捷高效的數據分析體驗,幫助開發者合理評估廣告投放的後端轉化效果。 查看詳情>> 運動健康服務 ◆ ...
  • 在Flutter中,我們有各種插件可供使用,從而實現音頻和視頻的播放功能。 例如,可以使用“text_to_speech”插件來將文字轉換為語音,使用內置的“video_player”插件輕鬆地實現視頻播放,或者使用“audioplayers”插件實現音頻播放。 對於僅需要簡單播放器功能的情況,也可 ...
  • 前端開發中涉及表單的頁面非常多,看似功能簡單,開發快速,實則占去了很大一部分時間。當某個表單包含元素過多時還會導致html代碼過多,vue文件過大。從而不容易查找、修改和維護。為了提高開發效率及降低維護成本,下麵介紹表單配置化組件的封裝原理與封裝方法。 ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 1. provide/inject provide/inject 是 Vue.js 中用於跨組件傳遞數據的一種高級技術,它可以將數據註入到一個組件中,然後讓它的所有子孫組件都可以訪問到這個數據。通常情況下,我們在父組件中使用 provid ...
  • 前兩天我寫了一個上傳下載功能 使用<el-upload>組件 當後端將文件流格式數據發送到響應裡面前端屈接受的時候 ,我們使用 <el-upload> 組件裡面的 :on-success 方法進行捕捉,使用blob進行文件下載 文件可以正常下載下來 但是打開文件損壞 我去網上尋找答案, 但大多都是說 ...
  • 本文使用 React + Three.js + React Three Fiber 技術棧,實現一個《塞爾達傳說:王國之淚》主題風格基於滾動控制的平滑滾動圖片展示頁面。通過本文的閱讀,你將學習到的知識點包括:瞭解 R3F 中 useFrame hook 及 useThree hook 基本原理及用法... ...
  • 解決的問題 避免新開發的代碼影響提測的代碼 避免生產環境出現問題後,修複後,由於代碼混亂,無法合併到生產環境 解決多個需求並行開發,並行測試,合併上線的問題 我的設計思路 流程圖工具我使用的是:diagrams.net 具體執行步驟 開發人員按需求粒度從dev建立分支 哪個需求或者哪些需求提測,就把 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...