테스트하기 쉬운 코드 작성법

F-Lab : 상위 1% 개발자들의 멘토링

2023-11-15

왜? 테스트하기 쉬운 코드를 작성해야 해?

소프트웨어 엔지니어로 일을 하다 보면 테스트를 작성하는 것이 중요하다는 말을 참 많이 듣게 됩니다. 소프트웨어 테스트는 어플리케이션이 기대한 대로 동작하는지를 보장하기 위한 장치입니다. 소프트웨어 테스트는 소프트웨어 개발 과정에서 품질을 향상시키고 버그를 최소화하는데 꼭 필요합니다. 테스트가 존재하지 않는 소프트웨어는 시간이 지남에 따라 소프트웨어가 기대한 대로 동작하는지를 보장하는것이 점점 더 어려워지고 코드 개선이나 새로운 기능 추가에도 더 많은 노력이 들어가게 됩니다.

테스트가 품질 관리를 위해 꼭 필요하다면 테스트를 잘 작성하는 것 뿐만 아니라 테스트하기 쉬운 코드를 작성하는것도 소프트웨어 품질 관리를 위한 노력이라고 할 수 있을 것 같습니다. 테스트하기 쉬운 코드란 어떤 것일까요? 여기에 대해서는 사람들마다 다양한 의견을 가지고 있을 수 있습니다. 하지만 동일한 행동을 하는 코드도 어떻게 작성되었느냐에 따라서 테스트를 작성하는 일의 쉽고 어려움이 크게 차이날 수 있다는 점에는 크게 이견이 없습니다. 아래의 파이썬 코드로 예시를 들어 보겠습니다.

# 예시 1 
def add(a, b):
  return a + b
 
if __name__ == '__main__':
  print(add(1, 2))


# 예시 2
def add(a, b):
  print(a + b)
 
if __name__ == '__main__':
 add(1, 2)

두 코드는 동일한 일을 합니다. 1과 2라는 두 값을 받아서 덧셈을 수행하고 그 값을 출력하는 간단한 코드입니다. 하지만 예시 1은 테스트를 어떻게 작성하면 좋을 지 명백한 반면에 예시 2는 그렇지 못합니다. 파이썬에 익숙한 독자라면 여러가지 편법을 동원하지 않고는 예시 2 의 코드를 테스트하기가 쉽지 않아 보인다고 느낄 것입니다. 이 블로그 글에서는 테스트하기 쉬운 코드를 작성하기 위한 잘 알려진 가이드라인들을 알아보고 코드로 예시를 들어 보도록 하겠습니다.

소프트웨어 공학에서 테스트의 중요성이 대두되면서 테스트 주도 개발 (TDD) 이라는 방법론이 생겨났습니다. 테스트 주도 개발은 작은 단위의 테스트를 추가하고 테스트를 만족시키는 코드를 작성하는 과정을 반복하여서 소프트웨어를 개발하는 방법론입니다. 테스트 주도 개발 내에서도 어떤 방식으로 코드를 검사할 것인가에 대해서는 다양한 의견이 있지만 어떤 코드가 테스트를 하기에 유리한지에 대해서는 대체로 비슷한 의견들이 제시됩니다. 아래에 제 나름대로의 경험을 바탕으로 중요하다고 여겨지는 항목들을 추려내 보았습니다.

테스트 하기에 유리한 항목

1. 인터페이스 기반의 상호작용

어플리케이션의 각 계층 간에 인터페이스를 정의하고, 이를 기반으로 상호작용하도록 코드를 작성합니다. 인터페이스를 사용하면 각 계층을 독립적으로 테스트할 수 있으며, 결합도를 낮출 수 있습니다. 가령 아래 코드는 간단한 가위바위보 게임을 구현한 것입니다.

from random import randrange
  
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = ['가위', '바위', '보'].index(input())
    except ValueError:
      continue
    computer = randrange(3)
    if (user - computer) % 3  == 2:
      print('패배')
    elif (user - computer) % 3  == 1:
      print('승리')
    else:
      print('무승부')

사용자의 입력을 받는 코드와 게임의 규칙, 출력을 담당하는 코드가 모두 한곳에 존재합니다. 입력과 출력, 게임의 규칙을 묶어서 검사해야 하기 때문에 하나의 테스트 안에서 해야 할 일이 많이 늘어납니다. 아래와 같이 담당하는 기능에 따라서 코드를 함수로 분리하고 인자를 주고받는 방식으로 상호작용하도록 하면 기능 별로 테스트를 하기도 쉽고 다른 기능이 추가되었을때도 기존 테스트 코드를 많이 수정하지 않아도 됩니다.

from random import randrange
 
def convert_input(input_):
  return ['가위', '바위', '보'].index(input_)
 
def run_game(user, computer):
  return user - computer % 3
 
def convert_outcome(outcome_):
  if outcome_ == 2:
    return '패배'
  elif outcome_ == 1:
    return '승리'
  else:
    return '무승부'
 
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = convert_input(input())
    except ValueError:
      continue
    computer = randrange(3)
    outcome = run_game(user, computer)
    print(convert_outcome(outcome))

2. 외부 상태에 의존하지 않기

코드를 작성할 때 가능한 외부 상태에 의존하지 않도록 주의합니다. 외부 상태에 의존하는 코드는 테스트하기 어렵고 예측 불가능한 동작을 일으킬 수 있습니다. 외부 상태에 의존하는 코드의 좋은 예시로는 시간에 따라서 동작이 바뀌는 코드가 있습니다. 가령 아래 함수는 현재 시간을 확인하고 오전인지 오후인지에 따라서 지정된 문자열을 반환해주는 일을 합니다.

from datetime import datetime
 
def get_am_pm():
  if datetime.now().hour >= 12:
    return 'pm'
  else:
    return 'am'

테스트를 할 때 마다 컴퓨터의 시계를 특정 시간으로 설정해주는 등의 편법 없이는 원할 때 마다 시간에 맞게 원하는 결과가 반환되는지 확인하기 어려울 것 같습니다. 아래와 같이 코드를 수정해서 시간 정보를 인자로 받을 수 있도록 하면 문제를 해결할 수 있습니다.

from datetime import datetime
 
# 인자 now 는 datetime object 이다.
def get_am_pm(now):
  if now.hour >= 12:
    return 'pm'
  else:
    return 'am'

3. 의존성 분리하기

의존성을 주입 가능한 형태로 분리하고, 의존성 주입(Dependency Injection)을 통해 테스트 가능한 코드를 작성합니다. 이를 통해 모의 객체(Mock Object) 또는 스텁(Stub)을 활용하여 테스트할 수 있습니다. “인터페이스 기반의 상호작용” 항목에서 사용했던 가위바위보 게임 코드를 조금 바꾸어 보았습니다. 이제 프로그램은 가위바위보 게임의 결과를 파일에 기록합니다. 하지만 프로그램이 파일 시스템에 접근할 수 있는 권한을 가지고 있지 않거나 디스크가 꽉 차서 파일을 쓸 수 없는 경우 이 프로그램이 정확한지와 관계없이 테스트는 항상 실패하게 됩니다.

from random import randrange
 
def convert_input(input_):
  return ['가위', '바위', '보'].index(input_)
 
def run_game(user, computer):
  outcome = user - computer % 3
  with open('./game_log.txt', 'w') as game_log:
    game_log.write(str(outcome))
    game_log.write('\\n')
  return user - computer % 3
 
def convert_outcome(outcome_):
  if outcome_ == 2:
    return '패배'
  elif outcome_ == 1:
    return '승리'
  else:
    return '무승부'
 
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = convert_input(input())
    except ValueError:
      continue
    computer = randrange(3)
    outcome = run_game(user, computer)
    print(convert_outcome(outcome))

아래와 같이 파일에 결과를 작성하는 기능을 분리하고 외부에서 주입할 수 있도록 코드를 변경하는 것으로 위에서 언급된 문제를 해결할 수 있습니다.

from random import randrange
 
def convert_input(input_):
  return ['가위', '바위', '보'].index(input_)
 
def run_game(user, computer, log):
  outcome = user - computer % 3
  # 파일에 직접 결과를 작성하는 대신 함수 타입의 인자 log에 결과를 넘겨준다
  log(outcome)
  return user - computer % 3
 
def convert_outcome(outcome_):
  if outcome_ == 2:
    return '패배'
  elif outcome_ == 1:
    return '승리'
  else:
    return '무승부'
 
# 파일에 결과를 기록하는 함수
def file_log(outcome):
  with open('./game_log.txt', 'w') as game_log:
    game_log.write(str(outcome))
    game_log.write('\\n')
 
# 이 함수는 위와 동일한 인터페이스를 가지지만 아무것도 하지 않는다. 테스트 실행시에는 이 함수를 사용할 수 있다
def stub_log(outcome):
  return None
 
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = convert_input(input())
    except ValueError:
      continue
    computer = randrange(3)
    outcome = run_game(user, computer, file_log)
    print(convert_outcome(outcome))

4. 한 번에 한 가지 일을 하는 코드 작성하기

코드는 한 번에 한 가지 일을 해야 합니다. 함수나 메서드는 하나의 명확한 작업을 수행하도록 작성되어야 하며, 이를 통해 코드의 읽기 쉬움과 테스트 용이성을 높일 수 있습니다. 아래는 금전출납기를 구현한 클래스입니다.

add_items 라는 메소드는 판매할 상품들을 등록하는 일도 하지만 등록이 끝난 후에는 판매 상품의 리스트와 항목별 가격, 전체 가격을 출력하는 일도 함께 수행합니다. 메소드의 이름만 보고는 어떤 일을 하는지 파악하기 어려울 것이고 판매할 상품을 등록하는것과 가격 등을 출력하는 역할을 구분해서 테스트할 수 없습니다.

class CashRegister:
  # 판매되는 상품들의 이름과 가격을 저장합니다
  catalog = {
    "사과": 1
    "배": 2
    "바나나": 3
  }
 
  # 판매될 상품들의 이름과 갯수를 저장합니다
  items = {}
 
  def add_items(self, items_):
    for name, quantity in items_.items():
      if name in catalog:
        self.items[name] = self.items.get(name, 0) + quantity
 
    print('Items sold:')
    total = 0
    for name, quantity in self.items.items():
      print('{} - quantity: {} / price: {}'.format(name, quantity, quantity * self.catalog[name])
      total += quantity * self.catalog[name]
 
    print('Total: {}'.format(total))

아래와 같이 역할 또는 작업 내용에 따라서 메소드를 분리해주면 위와 같은 문제를 해결할 수 있습니다.

class CashRegister:
  # 판매되는 상품들의 이름과 가격을 저장합니다
  catalog = {
    "사과": 1
    "배": 2
    "바나나": 3
  }
 
  # 판매될 상품들의 이름과 갯수를 저장합니다
  items = {}
 
  def add_items(self, items_):
    for name, quantity in items_.items():
      if name in catalog:
        self.items[name] = self.items.get(name, 0) + quantity
 
  def print_receipt(self):
    print('Items sold:')
    total = 0
    for name, quantity in self.items.items():
      print('{} - quantity: {} / price: {}'.format(name, quantity, quantity * self.catalog[name])
      total += quantity * self.catalog[name]
 
    print('Total: {}'.format(total))

5. 추상화의 수준 맞추기

함께 위치한 코드는 가능한 같은 추상화 수준을 가져야 합니다. 서로 다른 추상화 수준을 가진 코드들이 함께 존재하게 되면 코드의 가독성이 떨어지고 해당 코드 뭉치의 역할을 정의하기 어려워집니다. 코드의 역할을 잘 정의하지 못하면 테스트의 역할을 너무 넓거나 너무 좁게 잡게 되고 하나의 테스트가 해야 할 일이 과도하게 늘어날 수 있습니다. 너무 많은 일을 하는 테스트는 실패하기 쉽고 수정하기 어렵기 때문에 지양해야 합니다.

“3. 의존성 분리하기” 에서 예시로 든 코드를 다시 들여다 보겠습니다. 가위바위보 게임의 규칙에 따라 결과를 생성하는 run_game 함수의 내부에서 결과를 파일에 기록하는 함수가 호출됩니다. 프로그램의 기능들을 나열해 봤을때 “결과를 파일에 기록하기" 라는 기능은 “가위바위보 게임의 결과를 생성하기" 라는 기능의 일부로 취급하기 보다는 다른 기능으로 취급하는것이 더 적절할 것 같습니다.

from random import randrange
 
def convert_input(input_):
  return ['가위', '바위', '보'].index(input_)
 
def run_game(user, computer, log):
  outcome = user - computer % 3
  # 파일에 직접 결과를 작성하는 대신 함수 타입의 인자 log에 결과를 넘겨준다
  log(outcome)
  return user - computer % 3
 
def convert_outcome(outcome_):
  if outcome_ == 2:
    return '패배'
  elif outcome_ == 1:
    return '승리'
  else:
    return '무승부'
 
# 파일에 결과를 기록하는 함수
def file_log(outcome):
  with open('./game_log.txt', 'w') as game_log:
    game_log.write(str(outcome))
    game_log.write('\\n')
 
# 이 함수는 위와 동일한 인터페이스를 가지지만 아무것도 하지 않는다. 테스트 실행시에는 이 함수를 사용할 수 있다
def stub_log(outcome):
  return None
 
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = convert_input(input())
    except ValueError:
      continue
    computer = randrange(3)
    outcome = run_game(user, computer, file_log)
    print(convert_outcome(outcome))

아래와 같이 해당 기능을 convert_outcome 함수가 호출되는 것과 같은 위치로 옮겨주면 더 읽기도 쉽고 “결과를 파일에 기록하기" 와 “결과를 생성하기" 각각을 분리해서 테스트할 수 있습니다.

from random import randrange
 
def convert_input(input_):
  return ['가위', '바위', '보'].index(input_)
 
def run_game(user, computer, log):
  outcome = user - computer % 3
  # 파일에 직접 결과를 작성하는 대신 함수 타입의 인자 log에 결과를 넘겨준다
  log(outcome)
  return user - computer % 3
 
def convert_outcome(outcome_):
  if outcome_ == 2:
    return '패배'
  elif outcome_ == 1:
    return '승리'
  else:
    return '무승부'
 
# 파일에 결과를 기록하는 함수
def file_log(outcome):
  with open('./game_log.txt', 'w') as game_log:
    game_log.write(str(outcome))
    game_log.write('\\n')
 
if __name__ == '__main__':
  while True:
    print('가위, 바위, 보 중 하나를 입력해 주세요') 
    try:
      user = convert_input(input())
    except ValueError:
      continue
    computer = randrange(3)
    outcome = run_game(user, computer)
    file_log(outcome)
    print(convert_outcome(outcome))

더 나아가서

다섯가지 항목으로 테스트하기 쉬운 코드를 작성하기 위해서는 어떤 점들을 고려해야 하는지 알아봤습니다. 위에서 언급된 항목들은 대부분의 사람들이 동의할 만 한 것들이지만 예시로 든 코드는 개념을 설명하기 위해서 쓰여진 것으로 비슷한 흐름의 코드를 작성하실때 꼭 위와 같은 방식으로 코드를 작성하셔야 하는 것은 아닙니다.

세상에는 다양한 소프트웨어 개발 방법론들이 존재하지만 모두 더 안전하고 쉽게 소프트웨어를 개발한다는 목표를 공유합니다. 독자 여러분도 이 블로그 글을 통해서 테스트를 쉽게 작성하는 방법들을 배울 뿐만 아니라 테스트를 작성하는 일, 나아가서는 선호하는 개발 방법론들이 지향하는 바에 대해서 고민해보고 왜 그러한 방향으로 사람들이 나아가게 되었는지 생각해보셨으면 좋겠습니다.