DJango 서버개발, 테스트 커버리지 측정 및 CI CD 도구와 통합하기

이번 포스팅에서는 Django를 사용한 서버 개발 과정에서의 테스트 커버리지 측정 및 CI/CD 도구와 통합하는 방법을 상세히 설명하겠습니다. 이 과정을 통해 우리는 보다 신뢰할 수 있는 애플리케이션을 개발할 수 있으며, 코드 품질을 유지하고 배포 과정을 자동화할 수 있습니다.

1. Django 서버 개발

Django는 파이썬으로 작성된 웹 프레임워크로, 애플리케이션의 전반적인 개발 과정을 간소화하고, 빠른 개발을 가능하게 합니다. Django의 주요 특징으로는 MVC 패턴을 따른 웹 애플리케이션 구조, ORM(Object-Relational Mapping)의 제공, 다양한 내장 기능 등이 있습니다.

1.1 Django 설치

우선, Django를 설치하기 위해서는 Python이 필요합니다. Python 및 Django를 설치하는 방법은 다음과 같습니다:

pip install django

1.2 Django 프로젝트 생성

Django 프로젝트를 생성하기 위해서는 다음의 명령어를 실행합니다:

django-admin startproject myproject

이렇게 만들어진 myproject 폴더 안에는 여러 설정 파일이 생성됩니다. 이제 서버를 실행해 보겠습니다:

cd myproject
python manage.py runserver

기본적으로 개발 서버는 http://127.0.0.1:8000에서 실행됩니다. 웹 브라우저에서 이 주소를 입력하면 Django의 환영 페이지를 볼 수 있습니다.

2. Django 애플리케이션 생성

이제 본격적으로 Django 애플리케이션을 생성해 보겠습니다. Django는 하나의 프로젝트 안에 여러 개의 애플리케이션을 포함할 수 있습니다.

python manage.py startapp myapp

이제 myapp 폴더가 생성되었습니다. 이 폴더에는 여러 파일이 포함되어 있으며, models.py, views.py, urls.py 등의 중요한 파일들이 있습니다.

3. 테스트 커버리지 이해하기

테스트 커버리지는 코드의 측정 기준을 제공하는 도구입니다. 코드를 어떤 정도로 테스트했는지 평가하는 데 사용되며, 이는 단위 테스트가 얼마나 많은 부분의 코드를 커버하고 있는지를 나타냅니다. Django에서 테스트 커버리지를 측정하는데 사용할 수 있는 도구 중 하나는 coverage.py입니다.

3.1 테스트 및 커버리지 설치

테스트와 커버리지 측정을 위해 필요한 패키지를 설치합니다:

pip install coverage

3.2 테스트 작성하기

이제 간단한 테스트 케이스를 작성해 보겠습니다. myapp/tests.py 파일을 열고 다음 코드를 추가합니다:

from django.test import TestCase
from .models import MyModel

class MyModelTest(TestCase):
    def setUp(self):
        MyModel.objects.create(name="test", value=10)

    def test_model_str(self):
        my_model = MyModel.objects.get(name="test")
        self.assertEqual(str(my_model), "test")

3.3 커버리지 측정하기

테스트를 실행하고 커버리지를 측정해 보겠습니다. 다음 명령어를 사용합니다:

coverage run manage.py test myapp
coverage report

이 명령어를 통해 실행된 테스트 케이스와 커버리지 비율을 확인할 수 있습니다. 추가적으로, HTML 형식으로 커버리지 리포트를 생성할 수도 있습니다:

coverage html

이 명령어를 실행하면 htmlcov/index.html 파일이 생성되며, 이를 웹 브라우저에서 열면 시각적으로 커버리지 결과를 확인할 수 있습니다.

4. CI/CD 도구와 통합하기

CI/CD(지속적 통합 및 지속적 배포)는 소프트웨어 개발과 배포 프로세스를 자동화하여 효율성을 높이는 기법입니다. Jenkins, GitHub Actions, GitLab CI 등을 사용하여 Django 애플리케이션에 CI/CD를 통합할 수 있습니다. 여기서는 GitHub Actions를 예로 들겠습니다.

4.1 GitHub Actions 설정하기

먼저, 애플리케이션의 루트 디렉토리에 있는 .github/workflows 폴더 안에 새로운 YAML 파일을 생성합니다. 예를 들어, ci.yml라는 파일을 생성합니다.

name: Django CI

on:
  push:
    branches:
      - master
  pull_request:

jobs:
  test:
    runs-on: ubuntu-latest

    services:
      db:
        image: postgres:latest
        env:
          POSTGRES_DB: mydb
          POSTGRES_USER: user
          POSTGRES_PASSWORD: password
        ports:
          - 5432:5432
        health-check:
          test: ["CMD-SHELL", "pg_isready -U user"]
          interval: 5s
          timeout: 5s
          retries: 5

    steps:
      - name: 체크아웃 코드
        uses: actions/checkout@v2

      - name: Python에 대한 의존성 설치
        uses: actions/setup-python@v2
        with:
          python-version: '3.8'

      - name: 의존성 설치
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: 테스트 실시
        run: |
          coverage run manage.py test myapp
          coverage report

위의 설정은 다음과 같은 작업들을 수행합니다:

  • master 브랜치에 푸시하거나 풀 리퀘스트가 생성될 때 작업이 실행됩니다.
  • PostgreSQL 데이터베이스 서비스를 설정합니다.
  • 코드를 체크아웃하고, Python 환경을 설정합니다.
  • 필요한 의존성을 설치하고, 테스팅을 수행합니다.

4.2 CI/CD 실행 확인하기

GitHub에 변경사항을 푸시한 후, Actions 탭으로 이동하면 CI/CD 파이프라인이 실행되는 것을 확인할 수 있습니다. 성공적으로 완료되면 테스트 결과와 커버리지 리포트를 확인할 수 있습니다.

5. 결론

Django 애플리케이션의 서버 개발, 테스트 커버리지 측정 및 CI/CD 도구와의 통합 과정은 애플리케이션의 품질을 유지하고 안정적인 배포를 돕습니다. 이러한 프로세스를 통해 우리는 다수의 사용자에게 신뢰할 수 있는 서비스를 제공할 수 있습니다. 더욱이, 자동화된 테스트 및 배포 과정은 개발자가 보다 효율적으로 작업할 수 있도록 도와줍니다.

이 포스팅을 통해 Django 서버 개발의 기초와 테스트, CI/CD 통합의 중요성을 이해하는 데 도움이 되었기를 바랍니다. DevOps 문화의 일환으로 코드 품질 관리와 배포 자동화는 지금의 개발 환경에서 필수적인 요소가 되고 있습니다. 앞으로의 프로젝트에 이를 적용하여 더 좋은 결과를 만들어 나가길 바랍니다!