log weekly November 2023 docker test FastAPI query parameter pytest

세상에 나쁜 테스트는 있다.

2023년 11월 24일 TIL

Today I Learned

날짜

2023년 11월 24일 금요일

내용

테스트 코드 실행과 관련해서 Docker 내에서 실행해보라는 조언이 있어서 실행했다. 약간의 에러만 해결한 이후, 빠르게 테스트 코드 작성에 들어갈 수 있었다.

Docker 내 실행

  • 환경변수 건드리지말고 docker-compose exec 로 도커내에서 실행해보라는 태용님의 조언이 있었다.
  • docker-compose exec service이름 실행내용 -v 을 통해 review 컨테이너 내에서 pytest를 진행했다. 하지만 오류로 테스트가 진행되지 않았다.
  • 오류는 안뜨고 5성공, 5실패가 뜬다.

테스트 코드 작성

test_setup

  1. reviews_id 가 NOT NULL 인데 안들어가는 걸로 파악했다.
  2. Factory로 만들어진 review들의 id값을 확인할 수 있도록 코드를 수정했더니 모두 null값이 들어가 있었다.
  3. Factory 파일에선, Product는 id값을 1씩 증가하도록 배정해준반면 review에는 그러한 코드가 없었다.
  4. 둘다 모델 설정에는 BigInteger 이자 primary_key, index, unique로 지정되어있다.
  5. primary key가 True라면 자동으로 배정되야 하는지 나중에 찾아보자!
  6. 일단 factory처럼 증가하는 숫자를 넣었다. ⇒ 통과!

test_get_widget

  1. 테스트 함수에서 parameter로 없는 것이 작성되어 있었다.
  2. 실제로 저 메서드를 찾아가보니 없길래 테스트 코드에서도 삭제해주었다.
  3. type으로 들어간 값은 schemas 파일에서 클래스를 가져와 그중 1개를 선택하도록 변경하였다.
  4. 기능 함수 내의 또다른 기능 함수의 반환이 예상과 다르다는 오류가 발생했다.
  5. 여기서 내가 기능 함수를 함부로 수정하면 안될것 같아 리더님께 여쭤봤는데, 현재 잘 작동되고 있는 메서드이고, 중요한 기능이라 시간을 들여 테스트 코드를 제대로 작성하는 쪽으로 진행하는게 좋다고 말씀해주셨다. 역시 “해도되나?” 는 안하는게 맞다.
  6. 테스트 코드 내 함수에서 param을 수정하였다.
  7. 기능 함수의 일부 params는 Query[None] 타입이다. 이는 값이 존재할 땐 Query로 처리하지만 없을땐 None으로 처리하겠다는 의미로 FastAPI에서만 쓰인다. 이 값이 데이터베이스 쿼리에 포함되면서 오류가 발생함.
  8. 실제 배포 서비스에서는 해당 값들이 어떤 이유로든 반드시 입력되어서 오류가 발생하지 않은 걸까?
  9. 일부 param들에 구체적인 값을 넣어줬더니 PASS 처리 되었다. 하지만 확실한 테스트를 위해 내 가설을 검증할 필요가 있다.
  10. 검증 사항 : 위 값들은 항상 주어질 수 밖에 없는 값인가?
    • 모든 종류의 입력에서 무조건 설정하게 되있는 경우
    • 입력이 없을때 넣을 값에 대한 로직이 존재하는 경우
    • 기본값 있는 경우
  11. 따라서 이 값들은 입력값이 반드시 존재한다. schemas 상 범위 내의 값을 무작위로 넣어주면 될듯 ⇒ 통과

회고

이번에는 테스트 해야 할 함수들이 정상적으로 작동하고 있다는 확신이 있기 때문에 테스트 코드만 집중적으로 공략할 수 있었다. 만약 내가 방금 만들어낸 코드의 테스트가 실패했을 때, 내 테스트 코드를 신뢰할 수 없다면 오히려 코드의 정확성을 망치게 될 것 같다. 확실하게 무엇을 테스트 해야하는지, 공부했던 규칙들을 지키면서 신뢰성 있는 테스트 코드를 공부하자.

CATALOG
    weekly