API test 說明

啟用時機

透過 gitHub Actions 在成功部屬後自動執行測試

事先準備

1. cd to the test directory
2. yarn install 來安裝需要的 package (jest, supertest)

註: 沒有 yarn 的話可以使用 npm install -g yarn 先安裝

1. 新增 .env flie
   1. 新增 JWT for access_token
   2. 若要使用 MockData.js 來 "測試" test.js file，將 USE_MOCK_DATA 設為 true

USE_MOCK_DATA = ""
TEST_ACCESS_TOKEN = ""

使用方式

• yarn test 來 run 所有的 test file
• yarn testwatch 來在 watch mode 下進行test
  • will reload test on saved changes
• yarn test [XXXX.test.js]: run 單一測試檔，推薦使用這個

⚠️註: 單一 API endpoint 至少要通過 test.js 的驗證，test file 的命名方式為{http method + api endpoint}，例: GET_admin_lottery.test.js

Mock Data 使用

若需要使用 mockData 驗證測試檔案是否正確無誤，可以使用新增.env 來啟用 mockData 測試。

1. 新增 .env
2. 在裡面新增內容: USE_MOCK_DATA = "true"