【Django】mail送信のunit test（ユニットテスト）コードの紹介

Djangoでmail送信のコードを書けたはいいものの、unit testはどうやって作成すればいいのかわからない人のために紹介します。

本記事で紹介するコードでは、実際にメールが送信されるということはありませんのでご安心ください。

また以下は以前、説明したDjangoでメール送信機能を実装する紹介をしています。

コンテンツ

mailのユニットテスト

まずmailのユニットテストの場合、実際にメールが送信されるということはありませんのでご安心ください。

そして以下がユニットテストになります。

from django.core import mail
from django.test import TestCase

class EmailTests(TestCase):

    def test_send_email(self):
        """きちんとメールが送信されるかテスト
        """
        mail.send_mail(subject='Example Subject',
                        message='This is example message.',
                        from_email='from@example.com',
                        recipient_list=['to@example.com')

        self.assertEqual(len(mail.outbox), 1)
        self.assertEqual(mail.outbox[0].subject, 'Example Subject')
        self.assertEqual(mail.outbox[0].body, 'This is example message.')
        self.assertEqual(mail.outbox[0].from_email, 'tom@example.com')
        self.assertEqual(mail.outbox[0].to[0], 'to@example.com')

from django.core import mail

from django.test import TestCase

class EmailTests(TestCase):

def test_send_email(self):

"""きちんとメールが送信されるかテスト

"""

mail.send_mail(subject='Example Subject',

message='This is example message.',

from_email='from@example.com',

recipient_list=['to@example.com')

self.assertEqual(len(mail.outbox), 1)

self.assertEqual(mail.outbox[0].subject, 'Example Subject')

self.assertEqual(mail.outbox[0].body, 'This is example message.')

self.assertEqual(mail.outbox[0].from_email, 'tom@example.com')

self.assertEqual(mail.outbox[0].to[0], 'to@example.com')

一番気になるのは、self.assertEqual(len(mail.outbox), 1)のmail.outboxではないでしょうか。

mail.outboxは送信済みのメールのリストになります。

つまり送信済みのメールはリストとしてmail.outboxに格納され、今回のようなテストの場合はoutbox[インデックス番号=0]としてassertEqualで照合を実行しています。

あとは、mail.outbox[0]のsubject,body,from_email等を指定して照合をしていきます。

またテストケースごとに、mail.outboxはリセットされますのでご安心を。

今回は単体のユニットテストなので、インデックス番号を0とおいていますが、これが全方位的にレギュラーテストを実行する場合はemailを送信する箇所に遭遇するたびに、リストに格納されていきますので、その都度インデックス番号を気にしてテストを照合していくことが必要になりますので、その点だけ留意してください。