TDD, Django 기반의 프로젝트를 진행하면서 Functional test 시작 부분에 자주 사용되는 코드를 decorator를 이용하여 구현해보았다. 기본적인 decorator를 구현하는 방법에 대해서 먼저 알아보았고 decorator 함수 내에서 decorator가 지정될 함수의 self를 이용하여 구현하였다.
python decorator (‘@’)
python에 decorator라는 기능이 있다. 함수를 꾸며준다는 의미로 함수 정의 부분 위에 ‘@’기호로 시작하는 문장을 추가하여 사용한다. 함수의 앞뒤에 추가적으로 넣고 싶은 코드를 한 문장으로 지정하여 쉽게 재사용할 수 있도록 해주는 편리한 기능이다. 여러 함수들의 시작, 종료에 공통적으로 사용되는 코드가 있는 경우 decorator를 만들어서 사용할 수 있다.
함수 기반의 decorator
아래와 같은 함수 두개가 있다.
def hi_function():
print('함수 시작')
print('hi')
print('함수 끝')
def hello_function():
print('함수 시작')
print('hello')
print('함수 끝')
각각 함수를 호출해서 결과를 확인해보면 아래와 같은 메세지가 출력된다.
함수 시작
hi
함수 끝
함수 시작
hello
함수 끝
함수를 이용한 decorator
중복되는 부분인 print('함수 시작'), print('함수 끝')를 decorator 함수로 만들어서 사용해 보려고 한다.
def decorator_exam(func):
def decorator_func():
print('함수 시작')
func()
print('함수 끝')
return decorator_func()
@decorator_exam
def hi_function():
print('hi')
@decorator_exam
def hello_function():
print('hello')
두 함수를 호출해서 확인해보면 decorator를 적용하기 전의 결과와 동일하다.
class를 이용한 decorator
class DecoratorExam:
def __init__(self, func):
self.func = func
def __call__(self, *args, **kwargs):
print('함수 시작')
self.func(*args, **kwargs)
print('함수 끝')
decorator 지정 될 함수의 self 이용하기
게시판의 기능 테스트에서 시작 전에 매번 수행되는 로그인 부분을 decorator 함수를 만들어서 사용한 부분이다.
decorator가 지정된 함수의 self를 통해서 로그인을 수행한다.
from functools import wraps
def login_test_user(self):
if hasattr(self, 'browser'):
self.browser.get(self.live_server_url)
self.browser.find_element_by_id('login_button').click()
self.browser.find_element_by_id('id_username').send_keys(self.test_user.username)
self.browser.find_element_by_id('id_password').send_keys('kboard123')
self.browser.find_element_by_class_name('btn-primary').click()
def login_test_user_with_browser(method):
@wraps(method)
def _impl(self, *args, **kwargs):
login_test_user(self)
method(self, *args, **kwargs)
return _impl
게시글이 삭제되는지 테스트하는 코드에 decorator를 지정해서 이용한다.
호출되는 decorator 함수는 DeletePostTest 객체의 self를 통해서 로그인을 수행한다.
class DeletePostTest(FunctionalTest):
@login_test_user_with_browser
def test_delete_post(self):
# 지훈이는 게시글을 삭제하는 기능이 제대로 동작하는지 확인하기 위해 기본 게시판으로 이동한다.
self.move_to_default_board()
[...]
자주 사용되는 로그인 기능을 매번 작성하지 않고 decorator를 이용하여서 가독성과 재사용성을 높일 수 있었다.