[Django] tutorial #5-test

작성한 코드들에 대해 테스트를 할 수 있는 테스트 코드를 작성해보려고 한다.

하나의 기능을 제공하는 코드를 작성하면,
결과가 원하는 값으로 나오는지에 대해 테스트 코드를 작성하는 것이다.

테스트 코드를 작성해야되는 이유는 다음과 같다.

• 수십개의 컴포넌트가 엮이게 되면 하나하나 테스트를 해볼 수 없기 때문에 테스트 코드를 통해 시간을 절약할 수 있다.
• 테스트 작성을 통해 기능을 명확히 해서 앞으로 생길 문제들에 대해 예방할 수 있다.
• 많은 사람들과 협업하기 때문에 다른사람이 수정했을 때 테스트 코드를 통해 확인할 수 있다.

기능개발에 대한 코드를 테스트 코드를 먼저 작성하고 난뒤, 기능개발을 작성하는 것을 테스트 주도 개발(TDD)이라 한다.

첫번째 테스트 작성하기

---

버그 식별하기

지금까지 작성한 코드에는 버그가 있는데,

모델 코드 중 데이터가 최근이냐 아니냐 반환하는 함수(was_published_recently(self))에서 문제가 하나 있다.

생성날짜가 미래에 생성된 데이터는 최근으로 간주하지 않는다. 미래의 날짜는 거짓으로 나와야하는 것이다.

하지만 지금 코드를 보면 미래에 대한 코드처리가 없다.
따라서 shell에서 결과값이 참인지 거짓인지 테스트를 해보려고 한다.

py manage.py shell

>>> import datetime
>>> from django.utils import timezone
>>> from polls.models import Question
>>> future_question = Question(pub_date=timezone.now() + datetime.timedelta(days=30))
>>> future_question.was_published_recently()
True

테스트를 위해 관련 패키지들을 import하고
현재날짜에 30일을 더한 미래의 생성날짜를 가진 질문(question)을 하나 만들어준다.

다음 이것이 최근 생성날짜인지 묻는 식별함수를 호출하였을 때, 결과 값이 True가 나오는 것을 확인 할 수 있다.

미래는 최근이 아니기 때문에 이것은 잘못된 것이다.

버그를 노출하는 테스트 코드 만들기

이러한 테스트를 shell에서 수동적으로 하는 것이 아닌 명령어 하나로 테스트를 해볼 수 있는 테스트 코드를 작성해볼 것이다.

테스트 코드는 일반적으로 앱 내부의 polls/tests.py에 작성한다.
코드 작성시 함수 이름의 앞글자도 test로 시작해주면,
명령어 실행시 작성한 test 코드들을 찾아서 수행해준다.

- 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)

코드를 살펴보면,
위 shell에서 해준 것과 비슷하다. 30일 미래의 질문을 생성한뒤, 이 질문에 대해 생성일이 최근이냐고 물었을때 결과값이 False가 나오는 것을 확인하는 것이다.

테스트 실행

그럼 명령어를 실행하여 테스트 코드의 결과를 확인해 보겠다.

터미널에서 테스트를 실행한다.

py manage.py test polls

명령어를 실행하면 다음과같이 테스트를 실패했다는 결과가 나온다.

Creating test database for alias 'default'...
System check identified no issues (0 silenced).
F
======================================================================
FAIL: test_was_published_recently_with_future_question (polls.tests.QuestionModelTests)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/path/to/mysite/polls/tests.py", line 16, in test_was_published_recently_with_future_question
    self.assertIs(future_question.was_published_recently(), False)
AssertionError: True is not False

----------------------------------------------------------------------
Ran 1 test in 0.001s

FAILED (failures=1)
Destroying test database for alias 'default'...

테스트 상에서 결과값이 False가 나와야 하는데 True가 나와 테스트에 실패했다는 것이다.

버그 수정

그럼 이제 테스트가 통과될 수 있도록 코드를 수정을 해줘야 한다.

- polls/models.py

def was_published_recently(self):
    now = timezone.now()
    return now - datetime.timedelta(days=1) <= self.pub_date <= now

question의 생성날짜가 미래로 넘어가지 않도록
최근의 기준을 현재날짜를 두고 하루로 잡아두었다.

수정을 해준뒤 다시 테스트를 진행해보겠다.

py manage.py test polls

그럼 다음과 같이 수정해준 코드가 테스트를 성공적으로 통과했음을 확인 할 수 있다

Creating test database for alias 'default'...
System check identified no issues (0 silenced).
.
----------------------------------------------------------------------
Ran 1 test in 0.001s

OK
Destroying test database for alias 'default'...

보다 포괄적인 테스트 만들기

테스트 코드를 통해 기능을 더욱 명확히 하기 위해 보다 포괄적인 테스트 코드를 추가해줄 수 있다.

다음과 같이 1일이 넘어갈때에 대한 결과값이 False가 나오고
1일이 넘어가지 않았을때에 대한 결과값이 True가 나오도록 검증을 하는 테스트 코드를 작성해주는 것이다.

-polls/tests.py

def test_was_published_recently_with_old_question(self):
    """
    was_published_recently() returns False for questions whose pub_date
    is older than 1 day.
    """
    time = timezone.now() - datetime.timedelta(days=1, seconds=1)
    old_question = Question(pub_date=time)
    self.assertIs(old_question.was_published_recently(), False)

def test_was_published_recently_with_recent_question(self):
    """
    was_published_recently() returns True for questions whose pub_date
    is within the last day.
    """
    time = timezone.now() - datetime.timedelta(hours=23, minutes=59, seconds=59)
    recent_question = Question(pub_date=time)
    self.assertIs(recent_question.was_published_recently(), True)

이렇게 발생할 수 있는 경우에 대하여 최대한 테스트 코드를 충분하게 작성해주는 것이 좋다

뷰 테스트

---

함수의 기능적인 테스트를 진행했으면, 뷰가 동작을 잘하는지 뷰 테스트를 진행하게 된다.

뷰 테스트는 사용자가 된것처럼 request(요청)을 하고 response를 받아 원하는 결과값을 받았는지 확인하는 것이다.

장고 테스트 클라이언트

장고는 사용자를 시뮬레이트하기 위해 테스트 클라이언트 클래스인 Client를 제공한다.

이 테스트 클라이언트는 tests.py 또는 shell에서 사용할 수 있다

py manage.py shell

현재 사용중인 DB데이터를 이용하여 테스트 하기 위해 다음과 같이 setup_test_environment라는 명령어를 입력해준다.

>>> from django.test.utils import setup_test_environment
>>> setup_test_environment()

다음으로 테스트 클라이언트 클래스인 Client를 import해준다.
이때 client가 테스트 코드에서 사용자 역할을 한다.

>>> from django.test import Client
>>> # create an instance of the client for our use
>>> client = Client()

그럼 이제 client가 웹페이지를 호출하도록 한다.

>>> response = client.get('/')
Not Found: /
>>> response.status_code
404
>>> from django.urls import reverse
>>> response = client.get(reverse('polls:index'))
>>> response.status_code
200
>>> response.content
b'\n    <ul>\n    \n        <li><a href="/polls/1/">What&#x27;s up?</a></li>\n    \n    </ul>\n\n'
>>> response.context['latest_question_list']
<QuerySet [<Question: What's up?>]>

코드를 해석해보자면 다음과 같다.

• response = client.get('/') : 조회를 위해 요청하는 방식인 get을 통해 클라이언트가 웹페이지를 호출
• response.status_code : 상태코드(status_code) 서버에서 응답에 대한 상태를 코드로 전달, 성공하면 200을 반환
• response = client.get(reverse('polls:index')) : 테스트 클라이언트가 polls 앱의 index를 get방식으로 호출하여 결과값을 반환
• response.status_code : 결과값의 상태코드 반환
• response.content : 결과값의 content를 반환
• response.context['latest_question_list'] : 결과값의 context를 반환

이렇게 테스트 코드를 통해서 response값이 원하는 값이 나오는지 확인할 수 있다.

뷰 개선시키기

아직 question 목록(ListView)에는 미래의 생성날짜가 있는 question이 표시된다. 이것을 수정해보도록 하겠다.

- polls/views.py

from django.utils import timezone


def get_queryset(self):
    """
    Return the last five published questions (not including those set to be
    published in the future).
    """
    return Question.objects.filter(
        pub_date__lte=timezone.now()
    ).order_by('-pub_date')[:5]

여기서 __lte는 less than equal로 장고에서 제공하는 필터조건이다.
필터링을 통해 현재날짜보다 작거나 같은 데이터를 가져오게 된다.

뷰 테스트 만들기

이제 shell이 아닌 실제로 뷰 테스트를 만들어보려고 한다.

polls/test.py에 다음 코드를 추가한다.

- polls/test.py

from django.urls import reverse

def create_question(question_text, days):
    """
    Create a question with the given `question_text` and published the
    given number of `days` offset to now (negative for questions published
    in the past, positive for questions that have yet to be published).
    """
    time = timezone.now() + datetime.timedelta(days=days)
    return Question.objects.create(question_text=question_text, pub_date=time)


class QuestionIndexViewTests(TestCase):
    def test_no_questions(self):
        """
        If no questions exist, an appropriate message is displayed.
        """
        response = self.client.get(reverse('polls:index'))
        self.assertEqual(response.status_code, 200)
        self.assertContains(response, "No polls are available.")
        self.assertQuerysetEqual(response.context['latest_question_list'], [])

    def test_past_question(self):
        """
        Questions with a pub_date in the past are displayed on the
        index page.
        """
        question = create_question(question_text="Past question.", days=-30)
        response = self.client.get(reverse('polls:index'))
        self.assertQuerysetEqual(
            response.context['latest_question_list'],
            [question],
        )

    def test_future_question(self):
        """
        Questions with a pub_date in the future aren't displayed on
        the index page.
        """
        create_question(question_text="Future question.", days=30)
        response = self.client.get(reverse('polls:index'))
        self.assertContains(response, "No polls are available.")
        self.assertQuerysetEqual(response.context['latest_question_list'], [])

    def test_future_question_and_past_question(self):
        """
        Even if both past and future questions exist, only past questions
        are displayed.
        """
        question = create_question(question_text="Past question.", days=-30)
        create_question(question_text="Future question.", days=30)
        response = self.client.get(reverse('polls:index'))
        self.assertQuerysetEqual(
            response.context['latest_question_list'],
            [question],
        )

    def test_two_past_questions(self):
        """
        The questions index page may display multiple questions.
        """
        question1 = create_question(question_text="Past question 1.", days=-30)
        question2 = create_question(question_text="Past question 2.", days=-5)
        response = self.client.get(reverse('polls:index'))
        self.assertQuerysetEqual(
            response.context['latest_question_list'],
            [question2, question1],
        )

각 테스트케이스를 자세히 살펴보자면, 다음과 같다

• test_no_questions
  데이터가 없는 경우를 테스트 하며, 사용가능한 투표가 없습니다 라는 메시지 및 latest_question_list가 비어 있음을 확인한다.

• test_past_question
  데이터가 과거인 경우를 테스트한다.
  과거데이터를 하나 만들고 호출해준 뒤 데이터가 나오는지 확인한다.

• test_future_question
  데이터가 미래인 경우를 테스트한다.
  미래데이터를 하나 만들고 데이터가 안나오는지 확인한다.

• test_future_question_and_past_question
  과거데이터, 미래데이터 하나씩 만들고 과거데이터만 나오는지 확인한다.

• test_two_past_questions
  과거데이터 두개를 만들고 두개의 데이터가 잘 나오는지 확인한다.

Detail 뷰 테스트 추가하기

미래의 question들이 목록에 나타나지 않지만, 사용자가 url을 알고 있거나, 추측하면 접근할 수 있기 때문에 detailview에 테스트를 추가해줄 수 있다.

- polls/views.py

class DetailView(generic.DetailView):
    ...
    def get_queryset(self):
        """
        Excludes any questions that aren't published yet.
        """
        return Question.objects.filter(pub_date__lte=timezone.now())

- polls/tests.py

class QuestionDetailViewTests(TestCase):
    def test_future_question(self):
        """
        The detail view of a question with a pub_date in the future
        returns a 404 not found.
        """
        future_question = create_question(question_text='Future question.', days=5)
        url = reverse('polls:detail', args=(future_question.id,))
        response = self.client.get(url)
        self.assertEqual(response.status_code, 404)

    def test_past_question(self):
        """
        The detail view of a question with a pub_date in the past
        displays the question's text.
        """
        past_question = create_question(question_text='Past Question.', days=-5)
        url = reverse('polls:detail', args=(past_question.id,))
        response = self.client.get(url)
        self.assertContains(response, past_question.question_text)

🔎 참고
디장고 공식문서
디장고 공식문서 강의자료