使用 Django 進行測試驅動開發

Posted on by

所謂測試驅動開發(TDD)，就是先編寫測試用例，然後編寫代碼來滿足測試用例，具體包含以下步驟：

  • 編寫測試用例。
  • 編寫代碼滿足測試用例中的需求。
  • 運行測試用例。
  • 如果通過，說明代碼滿足瞭測試用例所定義的需求。
  • 如果未通過，則需要重構代碼，直到通過。
  • 重復以上步驟，直到通過全部的測試用例。

通常情況下，我們都是先寫代碼，然後編寫測試用例，因此測試驅動開發是反直覺的，那為什麼還要這麼做呢？基於以下幾點原因：

  1. TDD 可以被認為是根據測試用例來說明需求。此後編寫源代碼，重點是滿足這些要求。當測試最終通過時，你可以確信已滿足要求。這種專註可以幫助開發人員避免范圍蔓延。
  2. TDD 可以通過較短的開發周期提高開發效率。一次解決測試用例中的個別需求可以最大限度地減少幹擾因素。重大更改將更容易跟蹤和解決，減少瞭調試工作，提高瞭效率，並且將更多時間花在開發上。
  3. 編寫測試時考慮到瞭需求。正因為如此，它們更有可能被寫成明確的，可以理解的。這樣的測試可以作為代碼庫的優質文檔。
  4. 先編寫測試用例可確保您的源代碼始終具有可測試性，它還保證隨著代碼庫的增長，測試覆蓋率始終保持在合理的百分比。

然而，測試驅動開發也不是銀彈，以下情形並不適合測試驅動開發：

  • 當需求不明確時，有時續期會隨著開發的進行而逐漸明確，在這種情況下最初編寫的任何測試可能會過時。
  • 開發的目的是為瞭證明某一概念時——例如在黑客馬拉松期間，測試通常不是優先事項。

瞭解瞭測試驅動開發之後，我們用 Django 來演示一下測試驅動開發的過程。（Python 3.7 以上，Django 2.0 以上）

首先描述需求，我們要實現這樣一個單位換算功能的 Web 應用，可以在厘米、米、英裡直接互相轉換，Web 界面如圖所示：

創建項目

首先，我們創建一個名字叫 convert 的項目：

pip install django
django-admin startproject converter

此時 Django 已經為我們生成瞭 converter 目錄及基本的項目文件：

converter/
    converter/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    manage.py

然後，進入 converter 目錄，創建一個名字叫 length 的 app：

cd converter
python manage.py startapp length

然後你會看到這樣的目錄結構：

converter/
    converter/
        __init__.py
        settings.py
        urls.py
        wsgi.py
    length/
        __init__.py
        admin.py
        apps.py
        migrations/
            __init__.py
        models.py
        tests.py
        views.py
    manage.py

配置 app

修改 converter/settings.py，在 INSTALLED_APPS 裡加入 lengh ：

INSTALLED_APPS = [
    .
    .
    .
    'length',
]

然後在 length 目錄下新建 urls.py，寫入以下內容：

from django.urls import path

from length import views

app_name = 'length'
urlpatterns = [
    path('convert/', views.convert, name='convert'),
]

最後在 converter/urls.py 中指向 length/urls.py:

from django.contrib import admin
from django.urls import path, include
urlpatterns = [
    path('admin/', admin.site.urls),
    path('length/', include('length.urls')),
]

這樣一個沒有任何業務邏輯的項目就創建成功瞭，接下來編寫測試用例：

編寫測試用例

在 lengh 目錄下新建 tests.py，寫入以下內容：

from django.test import TestCase, Client
from django.urls import reverse


class TestLengthConversion(TestCase):
    """
    This class contains tests that convert measurements from one
    unit of measurement to another.
    """

    def setUp(self):
        """
        This method runs before the execution of each test case.
        """
        self.client = Client()
        self.url = reverse("length:convert")

    def test_centimetre_to_metre_conversion(self):
        """
        Tests conversion of centimetre measurements to metre.
        """
        data = {
            "input_unit": "centimetre",
            "output_unit": "metre",
            "input_value": 8096.894
        }
        response = self.client.get(self.url, data)
        self.assertContains(response, 80.96894)

    def test_centimetre_to_mile_conversion(self):
        data = {
            "input_unit": "centimetre",
            "output_unit": "mile",
            "input_value": round(985805791.3527409, 3)
        }
        response = self.client.get(self.url, data)
        self.assertContains(response, 6125.5113)

上述代碼有兩個測試用例，分別代表兩個需求。test_centimetre_to_metre_conversion 代表厘米轉米的需求，而 test_centimetre_to_mile_conversion 代表厘米轉英裡的需求。

編寫代碼

這和 Django 開發沒什麼兩樣，先編寫一個 forms.py，內容如下：

from django import forms

class LengthConverterForm(forms.Form):
    MEASUREMENTS = (
        ('centimetre', '厘米'),
        ('metre', '米'),
        ('mile', '英裡')
    )
    input_unit = forms.ChoiceField(choices=MEASUREMENTS)
    input_value = forms.DecimalField(decimal_places=3)
    output_unit = forms.ChoiceField(choices=MEASUREMENTS)
    output_value = forms.DecimalField(decimal_places=3, required=False)

然後編寫 html，在 length 目錄下新建 templates/length.html，內容如下：

<html lang="en">
  <head>
    <title>Length Conversion</title>
  </head>
  <body>
    <form action={% url "length:convert" %} method="get">
      <div>
        {{ form.input_unit }}
        {{ form.input_value }}
      </div>
      <input type="submit" value="轉換為："/>
      <div>
        {{ form.output_unit }}
        {{ form.output_value }}
      </div>
   </form>
  </body>
</html>

然後編寫最重要的視圖函數 views.py，內容如下：

from django.shortcuts import render

from length.forms import LengthConverterForm

convert_to_metre = {
    "centimetre": 0.01,
    "metre": 1.0,
    "mile": 1609.34
}
convert_from_metre = {
    "centimetre": 100,
    "metre": 1.0,
    "mile": 0.000621371
}

# Create your views here.
def convert(request):
    form = LengthConverterForm()
    if request.GET:
        input_unit = request.GET['input_unit']
        input_value = request.GET['input_value']
        output_unit = request.GET['output_unit']
        metres = convert_to_metre[input_unit] * float(input_value)
        print(f"{metres = }, {input_value = }")
        output_value = metres * convert_from_metre[output_unit]
        data = {
            "input_unit": input_unit,
            "input_value": input_value,
            "output_unit": output_unit,
            "output_value": round(output_value,5)
        }
        form = LengthConverterForm(initial=data)
        return render(
            request, "length.html", context={"form": form})
    return render(
        request, "length.html", context={"form": form})

執行測試

執行策四並不需要啟動 django 的 runserver：

出現 OK 說明測試通過，啟動 django：

python manage.py runserver

打開瀏覽器，訪問 http://localhost:8000/length/convert/ 即可看到界面：

最後的話

本文分享瞭什麼是測試驅動開發，並用測試驅動開發的方式 創建瞭一個簡單的 Django 應用程序，用於長度轉換。和一般開發的區別就是先寫好測試用例，編碼是為瞭讓測試用例通過，這樣的方式可以使得需求更明確，開發周期更短，增量可控，提高開發效率，保證測試覆蓋率。

到此這篇關於使用 Django 進行測試驅動開發的文章就介紹到這瞭,更多相關Django測試驅動開發內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：