はじめに

Djangoチュートリアル⑤（汎用ビュー）に続いて、はじめての Django アプリ作成、その 5に沿ってチュートリアルを進めていく。チュートリアルだけでは理解できないので、現場で使える Django の教科書（基礎編）も読みながら進める。

自動テストの導入

ここまでアプリケーションの動作に関することのみ実行してきたが、ここでテストを作成する。自動テストを作ることで、プログラムが正しく動作していることの確認が一瞬ででき、エラーが発生していた場合にはどこでそれが起きたのかをすばやく見極めることができる。テストを作成する時間はかかるが、テストなしで実装した場合のデバッグと比べても大きく時間を節約することができるため非常に意味がある。その他にも、ソフト自体の信頼度が上がったり複数人で開発をした場合にも他者のコードを自分が破壊したり、また自分のコードを他者が破壊することを防ぐことができる。

Django ではアプリケーションのテストを tests.py というファイルに記述することで、テスト実行時に自動的にテストを見つけて実行してくれる。たとえば、polls アプリケーションのテストは polls/tests.py にテストを書く。具体的には、django.test.TestCase クラスを継承したクラスの、名前が test で始まるメソッドをテストとして実行する。チュートリアルでは、TestCase を継承した QuestionModelTests というサブクラスを作成し、未来の日付の pub_date を持つ Question のインスタンスを生成して、それに対する was_published_recently() の出力をチェックする test_was_published_recently_with_future_question() というメソッドを記述している。

polls/tests.py

import datetime

from django.test import TestCase
from django.utils import timezone

from .models import Question


class QuestionModelTests(TestCase):

    def test_was_published_recently_with_future_question(self):
        """
        was_published_recently() returns False for questions whose pub_date
        is in the future.
        """
        time = timezone.now() + datetime.timedelta(days=30)
        future_question = Question(pub_date=time)
        self.assertIs(future_question.was_published_recently(), False)

コード中の assertIs(a, b) というメソッドは、「a is b」となるかどうかのテストを実行しており、was_published_recently() の出力が False となっていれば、テストは成功となる。Python では unittest という標準ライブラリがあり、ここで使用している TestCase というクラスはこれを拡張しているらしい。assertIs 以外にも便利な assert メソッドはあるのでそれらは assert メソッド一覧を参照。

テストの実行

以下コマンドで、作成したテストを polls アプリケーションのテストを実行できる。

$ python manage.py test polls

テストの結果以降、コードの編集等ははじめての Django アプリ作成、その 5を参照することとし、説明はここまでとする。

テストにおいて多いことはいいことだ

このようにテストを作成していくと、似たようなテストがたくさんできたり、重複があったりとなっていくことが想定される。しかし、テストにおいては多いことはいいことであり、たとえ冗長であっても一度テストを作成すればあとはそれを実行するだけで多くの恩恵を得られる。テストを整理さえすれば、テストがいくら膨大になろうと問題はないため、以下のようなルールを意識してテストを作成することが推奨されている。

モデルやビューごとに TestClass を分割する
テストしたい条件の集まりのそれぞれに対して、異なるテストメソッドを作る
テストメソッドの名前は、その機能を説明するようなものにする

さらなるテスト

チュートリアルでは、モデルの内部ロジックやビューに関するテストを作成したが、それらはほんの一部で他にも多くの便利なツールが用意されている。たとえば、Web アプリケーションの UI テストや JavaScript のテストを行える Selenium のようなフレームワークを使うことができる LiveServerTestCase がある。他にもコミット時に自動的にテストを実行することや、コードカバレッジをチェックしてテストされていないコードを発見することも重要とのこと。そのあたりは今後進めていった際に、利用して再度記事にしたい。

おわりに

初心者のため、unittest ライブラリを含めこんなに便利なツールがあることを知らなかった。テストを意識したアプリ開発をできるように慣れていこう。引き続き、はじめての Django アプリ作成、その 6を進めていく。

Djangoチュートリアル⑥（自動テスト）