🔥 TIL#13. kakao signin에 대한 unit test

Today I Learned

개발중인 project에 'kakao 계정연동 signin' 기능이 있다. 그리고 이 View 에는 kakao api와 연동하는 로직이 들어있다. unit test 대상으로 test 코드를 작성하려 해도 로직 자체가 이미 Integration test 범위에 속하는데 이를 unit test 하려면 어떻게 해야 할까?
'kakao로 요청해서 데이터를 받는 과정'을 가상처리 할 수는 없을까?

View에서 requests 모듈로 요청 및 이에 대한 response를 받는 과정을 가상처리 하기

kakao 계정연동 signin을 unit test하는데 있어 [성공, 예외, 실패] 3가지 test를 진행해야 한다.
이를 위해 해당 기능의 로직은 아래와 같다.

Frontend가 kakao api를 이용, access_token을 얻어 Backend로 signin 요청시 함계 보낸다. Backend는 kakao로 access_token을 보내 사용자 정보를 받아 처리 한다.

[예외, 실패] 의 경우 frontend로부터 가상으로 잘못된 access_token을 받거나 잘못된 데이터를 받는 것으로 Test가 가능하다.
[성공]의 경우 가상으로 kakao로부터 '사용자정보'를 받아 이를 처리해야 한다. 그 얘기는 View내부에서 kakao로 요청하는 과정이 실행되면 안된다는 것이다.
어떻게 실제기능을 가상기능으로 우회할 수 있을까?

이를 위해선 unittest module 중 patch와 MagicMock 에 대해 알아야 한다.
진행에 앞서 project에 반영한 test code를 보자.

# user/tests.py

from django.test import TestCase, Client

from unittest import patch, MagicMock

class UserTest(TestCase):
    def setUp(self):
    	client=Client()
   
    @patch('user.views.requests')
    def test_user_signin_with_kakao_success(self, mocked_request):
        class FakeResponse:
            def json(self):
               return {
                        'id'            : 12345,
                        'kakao_account' : {
                            'profile'   : {
                                'nickname':'test_user',
                                'thumbnail_image_url':'image_url_info',
                                'email':'test@example.com'
                            }
                        }
                    }

            mocked_request.post = MagicMock(return_value=FakeResponse())

            headers = {'HTTP_Authorization':'fake_token.1234'}
            response = self.client.post('/user/kakao_sign_in',
                            content_type='application/json',
                            **headers
                        )

            self.assertEqual(response.status_code, 200)

위는 kakao 계정연동 signin view에 대해 success test code 이다.
우선 'patch' 를 알아보자.

patch는 test 대상 모듈에서 클래스나 객체를 mocking할 수 있도록 하는 decorater이다.

위 code를 보면 user app의 views 모듈안에 있는 requests 모듈을 patch 대상으로 하고 있다. 이는 views내의 requests를 mocking 한다는 의미이다. 확인을 위해 아래 user.views code를 보자.

# user/views.py

class SignInWithKakaoView(View):
    @transaction.atomic
    def post(self, request):
        try:
            token         = request.headers['Authorization']
            profile       = requests.post(
                                    "https://kapi.kakao.com/v2/user/me",
                                    headers = {'Authorization':f'Bearer {token}'},
                                    data    = 'property_keys=["kakao_account.email"]'
                                )
            profile       = profile.json()
            user_id       = profile.get('id', None)

            if not user_id:
                return JsonResponse({"message":"INVALID_TOKEN"}, status=400)

            kakao_account = profile.get('kakao_account')
            nickname      = kakao_account['profile'].get('nickname', '')
            thumbnail     = kakao_account['profile'].get('thumbnail_image_url', '')
            email         = kakao_account.get('email', '')
            user          = User.objects.update_or_create(
                                email    = email,
                                defaults = {
                                            'kakao_id'  : str(user_id),
                                            'nickname'  : nickname,
                                            'image_url' : thumbnail,
                                            'updated_at': datetime.now(),
                                            'email'     : email,
                                            }
                             )
            token         = generate_token(user[0].id)

            return JsonResponse({"message":"SUCCESS", "access_token":token}, status=200)

        except KeyError:
            return JsonResponse({"message":"KEY_ERROR"}, status=400)

해당 View를 보면 kakao로 사용자 정보 요청을 위해 requests 모듈을 사용하고 있는 것을 알 수 있다.

즉 unit test시에는 requests를 patching 함으로서 실제 요청과정을 무시하도록 한다. 그리고 kakao로부터 받아야하는'사용자정보'는 MagicMock과 FakeResponse class를 통해 mocking한다.

MagicMock은 Mock함수를 만드는 모듈로 mock data를 return하는 함수라 보면 된다.
자세한 설명은 Mock & MagicMock 을 참고.

patching 한 requests의 post 호출에 대한 응답값으로 Mocking data을 대입하면 Test시에는 requests.post() 의 결과로 mock data가 나오게 된다.
이 방법을 통해 requests 에 대한 patching, mocking 이 가능하다.