Django & DRF에서 테스트 진행하기

개요

테스트 환경 구성

테스트 폴더 분리

myproject/
├── manage.py
├── myproject/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── myapp/
    ├── __init__.py
    ├── models.py
    ├── views.py
    └── tests/
        ├── __init__.py
        ├── test_models.py
        ├── test_views.py
        └── test_e2e.py

테스트 환경 분리

1. 테스트 실행시 if 분기처리 하기

# 테스트 시 인메모리 sqlite3 DB를 사용하는 예시
if "test" in sys.argv:
    DATABASES = {
        "default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}
    }

2. settings.py 파일 분리하기

HOW TO USE MULTIPLE SETTINGS.PY FILES IN DJANGO

September 30, 2022

https://medium.com/@morganhezekiah111/how-to-use-multiple-settings-py-files-in-django-97f6ead55aa7

myproject/
├── manage.py
└── myproject/
    ├── __init__.py
    ├── settings/
    │   ├── __init__.py
    │   ├── base.py
    │   ├── dev.py
    │   ├── test.py
    │   └── prod.py
    ├── urls.py
    └── wsgi.py

import os
import sys

def main():
    if "test" in sys.argv:
        os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.test")
    else:
        os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.dev")

3. .env 환경변수 파일 분리

4. 테스트시 설정, 환경변수 변경해주기

How to Unit test with different settings in Django?

Is there any simple mechanism for overriding Django settings for a unit test? I have a manager on one of my models that returns a specific number of the latest objects. The number of objects it r...

https://stackoverflow.com/questions/913549/how-to-unit-test-with-different-settings-in-django/41349685#41349685

How do I change an environment variable only during tests in Django?

I have a class that extends the root TestCase. I would like to set an environment variable in each of the tests that extend this class so that I don't cycles on unnecessary API queries. When I plac...

https://stackoverflow.com/questions/69843363/how-do-i-change-an-environment-variable-only-during-tests-in-django

Django TestRunner

Advanced testing topics | Django documentation

The web framework for perfectionists with deadlines.

https://docs.djangoproject.com/en/5.1/topics/testing/advanced/

테스트 실행 방법

장고 기본 테스트

python manage.py test
python manage.py test <app_name> # 특정 앱의 테스트만 실행

VSCode 테스트(django test)

VSCode 테스트(unittest, 비권장)

{
  "python.testing.pytestEnabled": false,
  "python.testing.unittestEnabled": true,
  "python.testing.unittestArgs": ["-v", "-s", ".", "-p", "test*.py"]
}

DJANGO_SETTINGS_MODULE 환경 변수 설정

#!/usr/bin/env python
"""Django's command-line utility for administrative tasks."""
import os
import sys


def main():
    """Run administrative tasks."""
    # manage.py에는 아래와 같이 settings.py 파일을 알려주는 환경변수를 설정해주는 부분이 있다.
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
    ~~~


if __name__ == "__main__":
    main()

import os

from django import setup

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
setup()

환경변수 파일 설정

{
  "python.envFile": "${workspaceFolder}/.env.test"
}

__init__.py 환경변수 설정

import os

from django import setup

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
os.environ.setdefault("ENVIRONMENT", "test") # 다음과 같이 환경변수 추가
setup()

ALLOWED_HOSTS testserver 설정

ALLOWED_HOSTS = env.get("DJANGO_ALLOWED_HOSTS", "").split(" ") + ["testserver"]

팁

테스트에서 인메모리 파일 스토리지 사용하기

@override_settings(DEFAULT_FILE_STORAGE="django.core.files.storage.InMemoryStorage")
class SimpleTestCase(APITestCase):
		def storage_related_test(self):
				~~~

File storage API | Django documentation

The web framework for perfectionists with deadlines.

https://docs.djangoproject.com/en/5.0/ref/files/storage/#django.core.files.storage.InMemoryStorage

가짜 이미지 파일 사용하기

def test_image_something(self):
    # 테스트 이미지 생성
    image_content = base64.b64decode(
        "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAACklEQVR4nGMAAQAABQABDQottAAAAABJRU5ErkJggg=="
    )
    uploaded_file = SimpleUploadedFile(
        "test_thumbnail.png", image_content, content_type="image/png"
    )

    response = self.client.post(
        reverse("image_api", {"image": uploaded_file}, format="multipart")
    )

Unittest

Mock