파이썬의 테스트 주도 개발(TDD) 기초

테스트 주도 개발(Test-Driven Development, TDD)은 소프트웨어 개발 프로세스에서 중요한 방법론으로, 코드 작성을 시작하기 전에 테스트를 먼저 작성하는 방식입니다. TDD는 코드의 품질을 높이고, 버그를 조기에 발견하며, 리팩토링을 쉽게 만들어줍니다. 이번 글에서는 파이썬에서 TDD를 실천하는 방법과 기초 개념을 살펴보겠습니다.

1. TDD란 무엇인가?

1.1. TDD의 원칙

TDD는 다음과 같은 3단계 사이클로 이루어집니다:

1. 테스트 작성 (Red)
   • 구현할 기능에 대한 테스트를 먼저 작성합니다.
   • 아직 구현되지 않은 기능이므로, 테스트는 실패해야 합니다.
2. 코드 작성 (Green)
   • 테스트를 통과할 수 있도록 최소한의 코드를 작성합니다.
   • 목표는 테스트를 통과하는 것이므로, 가능한 한 간단하게 코드를 작성합니다.
3. 리팩토링 (Refactor)
   • 테스트를 통과한 코드를 개선하고, 중복을 제거하며, 코드 구조를 개선합니다.
   • 리팩토링 후에도 테스트는 여전히 통과해야 합니다.

1.2. TDD의 장점

• 버그 예방: 코드 작성 전 테스트를 작성하므로, 버그를 조기에 발견하고 예방할 수 있습니다.
• 리팩토링 용이: 테스트가 존재하므로, 리팩토링 시 코드가 의도한 대로 작동하는지 쉽게 확인할 수 있습니다.
• 코드 품질 향상: TDD는 코드의 응집성과 가독성을 높이며, 결과적으로 코드 품질을 향상시킵니다.

2. 파이썬에서 TDD 환경 설정

파이썬에서는 기본 제공되는 unittest 모듈이나, 더 간편한 pytest를 사용하여 TDD를 실천할 수 있습니다. 여기서는 pytest를 사용하여 TDD를 실습해보겠습니다.

2.1. pytest 설치

pytest는 파이썬에서 널리 사용되는 테스트 프레임워크로, 설치가 간단하고 사용하기 쉽습니다.

pip install pytest

2.2. 디렉토리 구조 설정

TDD를 실습하기 위해 다음과 같은 간단한 디렉토리 구조를 설정합니다:

my_project/
    ├── src/
    │   └── calculator.py
    └── tests/
        └── test_calculator.py

• src/calculator.py: 실제 코드 파일이 위치하는 디렉토리입니다.
• tests/test_calculator.py: 테스트 코드가 위치하는 디렉토리입니다.

3. TDD 실습: 간단한 계산기 만들기

3.1. 테스트 작성 (Red 단계)

먼저, 구현할 기능에 대한 테스트를 작성합니다. 여기서는 간단한 계산기 기능(덧셈, 뺄셈)을 구현할 예정입니다.

tests/test_calculator.py 파일을 작성합니다:

import pytest
from src.calculator import Calculator

def test_add():
    calc = Calculator()
    result = calc.add(2, 3)
    assert result == 5

def test_subtract():
    calc = Calculator()
    result = calc.subtract(5, 2)
    assert result == 3

3.1.1. 코드 설명

• test_add(): add() 메서드가 두 수를 더하여 올바른 결과를 반환하는지 테스트합니다.
• test_subtract(): subtract() 메서드가 두 수를 빼서 올바른 결과를 반환하는지 테스트합니다.
• assert: 테스트가 예상한 결과와 실제 결과를 비교하는 구문입니다.

3.2. 테스트 실행

코드를 아직 작성하지 않았으므로, 테스트는 실패해야 합니다. 다음 명령어로 테스트를 실행합니다:

pytest

테스트가 실패하면, 오류 메시지를 통해 무엇이 잘못되었는지 확인할 수 있습니다.

3.3. 코드 작성 (Green 단계)

테스트를 통과하기 위해 최소한의 코드를 작성합니다. src/calculator.py 파일을 작성합니다:

class Calculator:
    def add(self, a, b):
        return a + b

    def subtract(self, a, b):
        return a - b

3.3.1. 코드 설명

• add(): 두 수를 더한 값을 반환합니다.
• subtract(): 두 수의 차를 반환합니다.

3.4. 테스트 재실행

코드를 작성한 후, 다시 테스트를 실행하여 테스트가 통과하는지 확인합니다:

pytest

모든 테스트가 통과하면, 다음 단계로 넘어갈 수 있습니다.

3.5. 리팩토링 (Refactor 단계)

이제 코드를 리팩토링하여 중복을 제거하거나, 코드를 더 간결하고 효율적으로 만들 수 있습니다. 리팩토링 후에도 모든 테스트가 통과해야 합니다.

4. TDD 실습: 코드 확장

TDD의 강력함은 코드 확장 시 드러납니다. 새로운 기능을 추가하기 전에 먼저 테스트를 작성하고, 이를 기반으로 코드를 확장해보겠습니다.

4.1. 새로운 기능 테스트 추가

곱셈 기능을 추가하고, 이에 대한 테스트를 먼저 작성합니다.

tests/test_calculator.py에 다음 코드를 추가합니다:

def test_multiply():
    calc = Calculator()
    result = calc.multiply(3, 4)
    assert result == 12

4.2. 테스트 실행

테스트를 실행하면, 곱셈 기능이 아직 구현되지 않았으므로 테스트가 실패할 것입니다.

4.3. 코드 확장

이제 테스트를 통과하기 위해 곱셈 기능을 구현합니다.

src/calculator.py를 수정합니다:

class Calculator:
    def add(self, a, b):
        return a + b

    def subtract(self, a, b):
        return a - b

    def multiply(self, a, b):
        return a * b

4.4. 테스트 재실행

테스트를 다시 실행하여 모든 테스트가 통과하는지 확인합니다:

pytest

모든 테스트가 통과하면, 새 기능이 제대로 구현된 것입니다.

5. TDD의 모범 사례

5.1. 작은 단위의 테스트 작성

테스트는 가능한 한 작은 단위로 작성하는 것이 좋습니다. 이렇게 하면 문제 발생 시 원인을 쉽게 파악할 수 있습니다.

5.2. 의미 있는 테스트 명명

테스트 함수의 이름은 테스트의 목적을 명확하게 나타내야 합니다. 예를 들어, test_add 대신 test_add_two_numbers와 같은 이름을 사용하면 더 이해하기 쉬워집니다.

5.3. 지속적인 테스트 실행

테스트는 코드 수정 후 가능한 자주 실행해야 합니다. CI/CD 파이프라인에 테스트를 포함시켜, 코드가 항상 올바르게 작동하는지 확인하는 것이 좋습니다.

6. TDD의 한계와 보완

6.1. 초기 개발 속도 저하

TDD는 코드 작성 전 테스트를 먼저 작성해야 하므로 초기 개발 속도가 느려질 수 있습니다. 그러나 장기적으로는 코드 품질과 유지보수성이 향상되어 전체 개발 속도가 빨라질 수 있습니다.

6.2. 모든 테스트 상황을 고려하기 어려움

테스트를 작성할 때, 모든 경계 조건과 예외 상황을 고려하기 어려울 수 있습니다. 이를 보완하기 위해 테스트 커버리지 도구를 사용하여 코드의 테스트 범위를 분석할 수 있습니다.

6.3. TDD는 만능이 아니다

TDD는 강력한 방법론이지만, 모든 프로젝트나 모든 팀에 적합하지 않을 수 있습니다. 팀의 성향과 프로젝트의 특성에 맞춰 적절히 활용해야 합니다.

결론

이번 글에서는 파이썬을 사용하여 TDD(Test-Driven Development)를 실천하는 방법을 살펴보았습니다. TDD는 코드의 품질을 높이고, 유지보수성을 향상시키며, 버그를 조기에 발견하는 데 매우 유용한 방법론입니다. 실습을 통해 TDD의 기본 개념을 이해하고, 이를 실제 프로젝트에 적용해보세요.

---

이 글을 통해 파이썬에서 TDD를 실천하는 방법을 이해하고, 이를 통해 더 나은 품질의 코드를 작성할 수 있을 것입니다. TDD를 통해 코드를 점진적으로 개선하고, 테스트 기반의 개발 습관을 길러보세요!