[test] 쉽게 시작하는 파이썬 테스트 코드

소프트웨어 테스트는 소프트웨어 개발 프로세스의 중요한 단계로서, 개발된 소프트웨어가 목표에 부합하며 안정적이고 효율적으로 동작하는지를 확인하기 위한 과정입니다. 테스트는 버그를 찾고 수정하며, 소프트웨어의 품질을 향상시키고 사용자에게 신뢰성 있는 제품을 제공하는 데 도움을 줍니다.

 

함수에 어떤 입력이 주어졌을때 기대한 결과를 만들어 내는지와 같은 간단한 테스트부터 한 번에 여러 사용자가 접속할때 애플리케이션이 잘 처리하는 것 까지 다양한 테스트가 있습니다. 테스트를 수행하는 것은 버그가 재발하는 것을 방지하고, 이후 리팩토링 과정에서 시간을 절약해줄 수 있습니다. 

 

[ 테스트의 종류 ] - 단위 테스트(Unit Testing): 개별 모듈 또는 함수가 올바르게 작동하는지 확인하는 테스트입니다. - 통합 테스트(Integration Testing): 각 모듈이 결합되어 전체 시스템이 예상대로 작동하는지 확인하는 테스트입니다. - 시스템 테스트(System Testing): 전체 시스템이 사용자의 요구 사항을 충족시키고 예상대로 작동하는지 확인하는 테스트입니다. - 인수 테스트(Acceptance Testing): 최종 사용자 또는 고객이 시스템의 기능 및 성능을 확인하는 테스트입니다.

 

이번 게시글에서는 간단한 단위 테스트와 통합 테스트 코드를 작성합니다. 파이썬 내장 패키지인 unittest를 이용하여 테스트를 작성해보고, 마지막에는 좀 더 사용하기 편리한 pytest를 사용하는 방법도 알아봅니다.

 

단위 테스트(unit testing)

단위 테스트는 소프트웨어의 모든 작은 부분들이 동작하는지를 확인하고, 엔드투엔드 테스트 같은 대규모 테스트를 위한 토대를 마련해줍니다. 모든 개별 코드 단위가 예상한대로 작동하는지 검사할 수 있습니다.

파이썬에 내장된 unittest로 테스트를 수행할 수 있습니다. 터미널에 `python -m unittest`라고 입력하면 테스트를 실행할 수 있으며 아래와 같은 과정으로 테스트가 진행됩니다.

 

1. 현재 디렉터리 및 하위 디렉터리에서 test_* 또는 *_test라는 이름의 모듈 찾기

2. 해당 모듈에서 unittest.TestCase를 상속한 클래스를 찾기

3. 해당 클래스에서 test_로 시작하는 메서드를 찾기

 

테스트를 위해서 전자상거래 시스템의 상품 클래스를 만들어봅니다. 

# pruduct.py
class Product:
    def __init__(self, name, size, color):  # Product 인스턴스가 생성될 때 상품 속성이 지정
        self.name = name
        self.size = size
        self.color = color

    def transform_name_for_sku(self):
        return self.name.upper()

    def transform_color_for_sku(self):
        return self.color.upper()

    def generate_sku(self):  # SKU는 상품 속성을 고유하게 식별합니다.
        """
        Generates a SKU for this product.

        Example:
            >>> small_black_shoes = Product('shoes', 'S', 'black')
            >>> small_black_shoes.generate_sku()
            'SHOES-S-BLACK'
        """
        name = self.transform_name_for_sku()
        color = self.transform_color_for_sku()
        return f'{name}-{self.size}-{color}'

 

이 클래스는 전자상거래 시스템에서 구매할 상품을 나타냅니다. 상품은 이름, 사이즈 옵션, 색상 속성을 가지고 있고 이러한 속성의 조합이 재고관리단위(Stock Keeping Unit, SKU)를 생성합니다. SKU는 가격과 재고 관리를 위해 사용되는 고유한 식별자입니다.

 

기능 테스트의 구조는 아래와 같이 이루어져 있습니다.

입력 준비 -> 예상 결과 식별 -> 실제 결과 얻기 -> 예상 결과와 실제 결과 비교

 

`Pruduct` 클래스의 `transform_name_for_sku`를 테스트 하고 싶다면 아래의 과정으로 테스트를 진행하면 됩니다.

 

1. 이름, 사이즈, 색상으로 Product 인스턴스 생성

2. `transform_name_for_sku`가 `name.upper()`를 반환하는지를 확인. 예상 결과는 대문자 이름

3. `Product` 인스턴스의 `transform_name_for_sku` 메서드를 호출하고, 그 결과를 변수에 저장

4. 예상 결과와 실제 결과를 비교

 

첫 번째 테스트 코드를 작성해봅니다.

# test_product.py
import unittest

from product import Product

class ProductTestCase(unittest.TestCase):
    def test_transform_name_for_sku(self):
        # 이 속성을 가진 상품을 만들어서 transform_name_for_sku 를 테스트하기 위한 준비를 합니다.
        small_black_shoes = Product('shoes', 'S', 'black')
        # 예상되는 값입니다.
        expected_value = 'SHOES'  
        # 비교를 위해 실제 값을 얻습니다.
        actual_value = small_black_shoes.transform_name_for_sku()  
        # 두 값을 비교합니다(같다고 가정하기 때문에 assertEqual를 사용합니다.)
        self.assertEqual(expected_value, actual_value)

 

이렇게 작성한 후에 unittest를 실행합니다.

> python -m unittest
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

정상적으로 테스트를 통과하여 OK가 표시됩니다.  위의 expected_value를 'SHOEZ'로 변경하고 다시 코드를 실행해봅니다.

> python -m unittest
F
======================================================================
FAIL: test_transform_name_for_sku (test_product.ProductTestCase.test_transform_name_for_sku)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_product.py", line 10, in test_transform_name_for_sku
    self.assertEqual(expected_value, actual_value) 
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 'SHOEZ' != 'SHOES'
- SHOEZ
?     ^
+ SHOES
?     ^


----------------------------------------------------------------------
Ran 1 test in 0.002s

예상되는 결과와 다른 값이 나올때는 테스트에 실패하였다는 알림이 표시됩니다.

 

통합 테스트(integration testing)

통합테스트는 일련의 단위 작업 전체가 잘 동작하는지에 초점을 둡니다. 만약 10개의 완벽한 단위기능이 있다고 하더라도 이것들을 결합하여 원하는 작업을 할 수 없다면 올바른 기능을 할 수 없습니다. 통합 테스트에 걸리는 시간은 일반적으로 단위 테스트보다 오래 걸립니다. 

통합 테스트 케이스를 작성하기 위해 `shoppingCart` 클래스를 만들어서 상품을 추가 또는 삭제할 수 있게 합니다. 장바구니 데이터는 아래와 같이 딕셔너리 형태로 사용합니다.

{
    'SHOES-S-BLUE': {'quantity': 1},
    'SHIRT-M-GRAY': {'quantity': 1}
}

 

 `shoppingCart` 클래스는 위의 딕셔너리 데이터를 관리하는 방식으로 상품을 추가하거나 제거할 수 있는 메서드가 있습니다.

# cart.py
from collections import defaultdict

class ShoppingCart:
    def __init__(self):
        self.products = defaultdict(lambda: defaultdict(int)) # defaultdict를 사용하면 딕셔너리에 제품이 이미 있는지 검사하는 로직이 단순해집니다.

    def add_product(self, product, quantity=1):  # 상품 수량 추가하기
        self.products[product.generate_sku()]['quantity'] += quantity

    def remove_product(self, product, quantity=1):  # 장바구니에서 상품 제거하기
        sku = product.generate_sku()
        self.products[sku]['quantity'] -= quantity
        if self.products[sku]['quantity'] <= 0:
            del self.products[sku]

 

다음과 같은 과정으로 통합 테스트를 진행합니다.

- 장바구니는 Product 인스턴스의 generate_sku 메서드를 사용합니다.

- 상품을 추가하고 제거하는 작업은 순차적으로 실행되어야 하며, 이전에 추가된 제품도 제거할 수 있어야 합니다.

# test_cart.py
import unittest
from cart import ShoppingCart
from product import Product

class ShoppingCartTestCase(unittest.TestCase):
    def test_cart_initially_empty(self):
        cart = ShoppingCart()
        # 카트가 비어있는지 테스트합니다.
        self.assertDictEqual({}, cart.products)

    def test_add_two_of_a_product(self):
        cart = ShoppingCart()
        product = Product('shoes', 'S', 'blue')
        # 카트에 상품을 추가합니다.
        cart.add_product(product, quantity=2)
        # 추가된 상품이 동일한지 확인합니다.
        self.assertDictEqual({'SHOES-S-BLUE': {'quantity': 2}}, cart.products)

    def test_add_two_different_products(self):
        cart = ShoppingCart()
        product_one = Product('shoes', 'S', 'blue')
        product_two = Product('shirt', 'M', 'gray')
        # 두 개의 상품을 추가합니다.
        cart.add_product(product_one)
        cart.add_product(product_two)
        # 예상되는 결과와 비교합니다.
        self.assertDictEqual(
            {
                'SHOES-S-BLUE': {'quantity': 1},
                'SHIRT-M-GRAY': {'quantity': 1}
            },
            cart.products
        )

    def test_add_and_remove_product(self):
        cart = ShoppingCart()
        product = Product('shoes', 'S', 'blue')
        # 상품을 추가하고 제거합니다.
        cart.add_product(product)
        cart.remove_product(product)
        # 카트의 제품이 비어있는지 확인합니다.
        self.assertDictEqual({}, cart.products)

    def test_remove_too_many_products(self):
        cart = ShoppingCart()
        product = Product('shoes', 'S', 'blue')

        cart.add_product(product)
        cart.remove_product(product, quantity=2)
        # 카트의 제품이 비었는지 확인합니다.
        self.assertDictEqual({}, cart.products)

 

 

파이썬에 내장된 unittest도 훌륭하지만 조금 더 간결한 방식으로 테스트를 하고 싶다면 pytest를 이용할 수 있습니다.

pytest를 설치하면 간단하게 pytest만 입력하면 다음과 같은 결과를 제공해줍니다.

> pytest
==================== test session starts ==================== 
platform win32 -- Python 3.9.12, pytest-7.1.1, pluggy-1.3.0   
rootdir: [테스트 실행한 절대 경로]
plugins: anyio-3.5.0
collected 3 items                                             

test_product.py ...                                    [100%] 

===================== 3 passed in 0.03s =====================

 

unittest를 pytest로 전환하기 위해서는

- unittest import 구문을 제거하고 unittest.TestCase의 상속을 제거합니다.

- 모든 self.assertEquel(expect, actual)은 assert actual == expect로 변경합니다. 

from product import Product

class TestProduct:  # 기본 클래스를 상속하지 않아도 됩니다.
    def test_transform_name_for_sku(self):
        small_black_shoes = Product('shoes', 'S', 'black')
        assert small_black_shoes.transform_name_for_sku() == 'SHOES'  # assert를 사용하여 비교할 수 있습니다.

    def test_transform_color_for_sku(self):
        small_black_shoes = Product('shoes', 'S', 'black')
        assert small_black_shoes.transform_color_for_sku() == 'BLACK'

    def test_generate_sku(self):
        small_black_shoes = Product('shoes', 'S', 'black')
        assert small_black_shoes.generate_sku() == 'SHOES-S-BLACK'

 

위와 같이 더 읽기 쉬운 테스트 코드를 작성할 수 있습니다. 

 

이번 게시글에서는 간단한 코드를 통해 테스트를 수행하는 방법에 대해 알아보았습니다. 오늘 게시글의 내용을 요약해보면 아래와 같습니다.

- 기능 테스트는 주어진 입력에 대해 예상한 결과를 반환하는 지 확인합니다.

- 테스트는 버그를 잡아주고 리팩토링 코드를 더 쉽게 만들어주어 장기적으로 시간을 절약하는 효과를 냅니다.

- unittest와 pytest는 파이썬에서 널리 사용되는 단위/통합 테스트 프레임워크입니다.

 

reference

데인 힐라드, 프로그래머를 위한 파이썬