Djangoチュートリアル（ブログアプリ作成）④ - ユニットテスト編
前回、Djangoチュートリアル（ブログアプリ作成）③ - 記事一覧表示編では管理サイトから作成した記事を一覧表示させるために、クラスベース汎用ビューを使いました。
このままアプリ内での記事作成、詳細、編集、削除といった CRUD 処理を追加したいところではありますが、グッとこらえてユニットテストを盛り込みましょう。
Django のテストについて
どんどん機能を追加していくのは楽しいですが、普段はテストを書いているでしょうか？
各種チュートリアルなどでDjangoの簡単なアプリを作れるようになった方でも、
少し自分なりにいじった時にエラーを引き起こしてしまう場合があるかと思います。
また、Djangoをrunserver等で起動した際には特にエラーが出力されなくても
実際に画面をブラウザ経由で動かした時にエラーに気づく場合もあるかと思います。
いくつかの操作を手動でテストするという方法はもちろんありますが、毎回そういったことを行うのは無駄という他ありません。
そこで、Djangoの機能を用いてユニットテストを行うことを推奨します。
DjangoではUnitTestクラスを用いてテストを自動化することができるので、
最初にテスト用のコードだけ書いてしまえば後は何度も同じことをする必要はありません。
テストの考えることは開発コードを考えるのと同じぐらい重要であり、
テストを作ってからアプリ動作のためのコードを書くという開発手法もあるぐらいです。
これを機にテストを行えるようになり、あなたのテスト時間を節約してアプリ本体をより改善することに労力を費やしましょう。
フォルダ構成について
この時点では下記のようなフォルダ構成になっているはずです。
.
├── blog
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests.py # 注目
│ ├── urls.py
│ └── views.py
├── db.sqlite3
├── manage.py
├── mysite
│ ├── __init__.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
└── templates
└── blog
├── index.html
└── post_list.html
お気づきになられた方はいるかもしれませんが、blog ディレクトリ配下に tests.py というファイルが自動的に作成されています。
この tests.py の中に直接テストケースを作成していってもよいのですが、
model のテスト、view のテストとテストごとにファイルが分かれていた方が何かと管理しやすいので
下記のように tests ディレクトリを作成し、中にそれぞれ空ファイルを作成しておきましょう。
tests ディレクトリ内のファイルも実行されるように、中身はからの init.py ファイルも作成しておくのがポイントです。
.
├── blog
│ ├── __init__.py
│ ├── admin.py
│ ├── apps.py
│ ├── migrations
│ │ ├── 0001_initial.py
│ │ └── __init__.py
│ ├── models.py
│ ├── tests # 追加
│ │ ├── __init__.py
│ │ ├── test_models.py
│ │ ├── test_urls.py
│ │ └── test_views.py
......
なお、モジュールの名前は「test」で始めないと Django が認識してくれないので注意してください。
テストの書き方
Django では Python標準のTestCaseクラス(unittest.TestCase)を拡張した、
Django独自のTestCaseクラス(django.test.TestCase)を使います。
このクラスではアサーションというメソッドを使うことができ、返り値が期待する値であるかどうかをチェックする機能があります。
また、前述の通りテストモジュールは「test」という文字列で始まっている必要があるのと、
テストメソッドも「test」という文字列で始める必要があります（詳細は後述します）。
このルールを守ることで Django がテストメソッドをプロジェクト内から探し出し、自動で実行してくれるようになります。
test_models.py
それではまずは model のテストから作成していきましょう。
おさらいですが、blog/models.py に記述されている Post model はこのようになっています。
models.py
...
class Post(models.Model):
title = models.CharField('タイトル', max_length=200)
text = models.TextField('本文')
date = models.DateTimeField('日付', default=timezone.now)
def __str__(self): # Post モデルが直接呼び出された時に返す値を定義
return self.title # 記事タイトルを返す
この model に対して、今回は次の3ケースでテストしましょう。
1.初期状態では何も登録されていないこと
2.1つレコードを適当に作成すると、レコードが1つだけカウントされること
3.内容を指定してデータを保存し、すぐに取り出した時に保存した時と同じ値が返されること
ではまずひとつめからです。
test_models.py を開き、必要なモジュールを宣言します。
test_models.py
from django.test import TestCase
from blog.models import Post
そしてテストクラスを作っていくのですが、必ず TestCase を継承したクラスにします。
test_models.py
from django.test import TestCase
from blog.models import Post
class PostModelTests(TestCase):
さて、この PostModelTest クラスの中にテストメソッドを書いていきます。
TestCase を継承したクラスの中で「test」で始めることで、
Django がそれはテストメソッドであることを自動で認識してくれます。
そのため、def の後は必ず test で始まるメソッド名を名付けましょう。
test_models.py
from django.test import TestCase
from blog.models import Post
class PostModelTests(TestCase):
def test_is_empty(self):
"""初期状態では何も登録されていないことをチェック"""
saved_posts = Post.objects.all()
self.assertEqual(saved_posts.count(), 0)
saved_posts に現時点の Post model を格納し、
assertEqual でカウント数（記事数）が「0」となっていることを確認しています。
さて、これで一つテストを行う準備が整いました。
早速これで一回実行していきましょう。
テストの実行は、manage.py が置いてあるディレクトリ (mysite内) で下記のコマンドを実行します。
実行すると、命名規則に従ったテストメソッドを Django が探し出し、実行してくれます。
(blog) bash-3.2$ python3 manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
.....
----------------------------------------------------------------------
Ran 1 tests in 0.009s
OK
一つのテストを実行し、エラーなく完了したことを意味しています。
ちなみに、先ほどは Post 内にデータが空 (=0) であることを確認しましたが、データが1つ存在していることを期待するようにしてみます。
test_models.py(一時的)
from django.test import TestCase
from blog.models import Post
class PostModelTests(TestCase):
def test_is_empty(self):
"""初期状態だけど1つはデータが存在しているかどうかをチェック (error が期待される)"""
saved_posts = Post.objects.all()
self.assertEqual(saved_posts.count(), 1)
この時の test 実行結果は下記のようになっています。
(blog) bash-3.2$ python3 manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
F
======================================================================
FAIL: test_is_empty (blog.tests.test_models.PostModelTests)
初期状態だけど1つはデータが存在しているかどうかをチェック (error が期待される)
----------------------------------------------------------------------
Traceback (most recent call last):
File "/Users/masuyama/workspace/MyPython/MyDjango/blog/mysite/blog/tests/test_models.py", line 9, in test_is_empty
self.assertEqual(saved_posts.count(), 1)
AssertionError: 0 != 1
----------------------------------------------------------------------
Ran 1 test in 0.002s
FAILED (failures=1)
AssertionError が出ており、期待される結果ではないためにテストは失敗していますね（実験としては成功です）。
Django のテストではデータベースへ一時的なデータの登録も create メソッドから実行できるので、
データを登録しないと確認できないような残りのテストも実行することができます。
下記に model のテストの書き方を載せておくので、参考にしてみてください。
test_models.py(全文)
from django.test import TestCase
from blog.models import Post
class PostModelTests(TestCase):
def test_is_empty(self):
"""初期状態では何も登録されていないことをチェック"""
saved_posts = Post.objects.all()
self.assertEqual(saved_posts.count(), 0)
def test_is_count_one(self):
"""1つレコードを適当に作成すると、レコードが1つだけカウントされることをテスト"""
post = Post(title='test_title', text='test_text')
post.save()
saved_posts = Post.objects.all()
self.assertEqual(saved_posts.count(), 1)
def test_saving_and_retrieving_post(self):
"""内容を指定してデータを保存し、すぐに取り出した時に保存した時と同じ値が返されることをテスト"""
post = Post()
title = 'test_title_to_retrieve'
text = 'test_text_to_retrieve'
post.title = title
post.text = text
post.save()
saved_posts = Post.objects.all()
actual_post = saved_posts[0]
self.assertEqual(actual_post.title, title)
self.assertEqual(actual_post.text, text)
test_urls.py
model 以外にも、urls.py に書いたルーティングがうまくいっているのかどうかを確認することもできます。
おさらいすると blog/urls.py はこのようになっていました。
blog/urls.py
from django.urls import path
from . import views
app_name = 'blog'
urlpatterns = [
path('', views.IndexView.as_view(), name='index'),
path('post_list', views.PostListView.as_view(), name='post_list'),
]
上記のルーティングでは /blog/ 以下に入力されるアドレスに従ったルーティングを設定しているので、
/blog/ 以下が ''(空欄) と 'post_list' であった時のテストをします。
それぞれのページへ view 経由でリダイレクトされた結果が期待されるものであるかどうかを、assertEqual を用いて比較してチェックします。
test_urls.py
from django.test import TestCase
from django.urls import reverse, resolve
from ..views import IndexView, PostListView
class TestUrls(TestCase):
"""index ページへのURLでアクセスする時のリダイレクトをテスト"""
def test_post_index_url(self):
view = resolve('/blog/')
self.assertEqual(view.func.view_class, IndexView)
"""Post 一覧ページへのリダイレクトをテスト"""
def test_post_list_url(self):
view = resolve('/blog/post_list')
self.assertEqual(view.func.view_class, PostListView)
ここまでで一旦テストを実行しておきましょう。
※先ほど、データベースが空である状態のテストをしたときと比べると
データを登録するテストケースが増えているため
テスト用のデータベース作成、消去の処理がメッセージに出力されていることが分かります
(blog) bash-3.2$ python3 manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
.....
----------------------------------------------------------------------
Ran 5 tests in 0.007s
OK
Destroying test database for alias 'default'...
test_views.py
最後に view のテストも行いましょう。
views.py はこのようになっていました。
views.py
from django.views import generic
from .models import Post # Postモデルをimport
class IndexView(generic.TemplateView):
template_name = 'blog/index.html'
class PostListView(generic.ListView): # generic の ListViewクラスを継承
model = Post # 一覧表示させたいモデルを呼び出し
IndexView のテストでは、GET メソッドでアクセスした時にステータスコード 200(=成功) が返されることを確認します。
test_views.py
from django.test import TestCase
from django.urls import reverse
from ..models import Post
class IndexTests(TestCase):
"""IndexViewのテストクラス"""
def test_get(self):
"""GET メソッドでアクセスしてステータスコード200を返されることを確認"""
response = self.client.get(reverse('blog:index'))
self.assertEqual(response.status_code, 200)
何か view でメソッドを追加したときは、
どんなにテストを書く時間がなくてもこれだけは最低限テストケースとして作成する癖をつけましょう。
ListView の方もテストをしていきます。
同じく 200 のステータスコードが返ってくることの確認はもちろん、
ここではデータ(記事)を2つ追加した後に記事一覧を表示させ、
登録した記事のタイトルがそれぞれが一覧に含まれていることを確認するテストを作成します。
なお、ここで少し特殊なメソッドを使います。
テストメソッドは「test」で始めるように前述しましたがsetUpとtearDownというメソッドが存在します。
setUpメソッドではテストケース内で使うデータの登録をし、
tearDownメソッドでは setUp メソッド内で登録したデータの削除を行えます。
(どちらも、どんなデータを登録するかは明示的に記述する必要があることには注意しましょう）
同じテストケースの中で何回もデータの登録をするような処理を書くのは手間＆テストに時間がかかる要因になるので、
共通する処理は一箇所にまとめてしまおうというものです。
これらのメソッドを使い、test_views.py を作成するとこのようになります。
test_views.py
from django.test import TestCase
from django.urls import reverse
from ..models import Post
class IndexTests(TestCase):
"""IndexViewのテストクラス"""
def test_get(self):
"""GET メソッドでアクセスしてステータスコード200を返されることを確認"""
response = self.client.get(reverse('blog:index'))
self.assertEqual(response.status_code, 200)
class PostListTests(TestCase):
def setUp(self):
"""
テスト環境の準備用メソッド。名前は必ず「setUp」とすること。
同じテストクラス内で共通で使いたいデータがある場合にここで作成する。
"""
post1 = Post.objects.create(title='title1', text='text1')
post2 = Post.objects.create(title='title2', text='text2')
def test_get(self):
"""GET メソッドでアクセスしてステータスコード200を返されることを確認"""
response = self.client.get(reverse('blog:post_list'))
self.assertEqual(response.status_code, 200)
def test_get_2posts_by_list(self):
"""GET でアクセス時に、setUp メソッドで追加した 2件追加が返されることを確認"""
response = self.client.get(reverse('blog:post_list'))
self.assertEqual(response.status_code, 200)
self.assertQuerysetEqual(
# Postモデルでは __str__ の結果としてタイトルを返す設定なので、返されるタイトルが投稿通りになっているかを確認
response.context['post_list'],
['<Post: title1>', '<Post: title2>'],
ordered = False # 順序は無視するよう指定
)
self.assertContains(response, 'title1') # html 内に post1 の title が含まれていることを確認
self.assertContains(response, 'title2') # html 内に post2 の title が含まれていることを確認
def tearDown(self):
"""
setUp で追加したデータを消す、掃除用メソッド。
create とはなっているがメソッド名を「tearDown」とすることで setUp と逆の処理を行ってくれる＝消してくれる。
"""
post1 = Post.objects.create(title='title1', text='text1')
post2 = Post.objects.create(title='title2', text='text2')
この状態でテストを実行すると model, url, view で合計 8 つのテストが実行されます。
(blog) bash-3.2$ python3 manage.py test
Creating test database for alias 'default'...
System check identified no issues (0 silenced).
........
----------------------------------------------------------------------
Ran 8 tests in 0.183s
OK
Destroying test database for alias 'default'...
これで、これまで書いたコードについてユニットテストを作成することができました。
他にも期待される template が呼び出されているかどうか等、
Django 独自のテスト方法を用いたテストで冗長的にチェックする方法もありますが
いまは使いまわしでもよいので処理を増やす時にテストを作成する癖をつけ、後々のチェックの手間を省くようにしていきましょう。
次回はアプリ内で記事を作成できるようにします。
Discussion