2022-10-01 03:03:38 +13:00
|
|
|
# QA Core API Tests
|
|
|
|
|
|
|
|
|
|
The QA Core API tests are a jest suite that run directly against the budibase backend APIs.
|
|
|
|
|
|
|
|
|
|
## Auto Setup
|
2023-03-27 06:12:26 +13:00
|
|
|
|
2022-10-01 03:03:38 +13:00
|
|
|
You can run the whole test suite with one command, that spins up the budibase server and runs the jest tests:
|
|
|
|
|
|
2023-03-27 06:12:26 +13:00
|
|
|
`yarn api:test`
|
2022-10-01 03:03:38 +13:00
|
|
|
|
|
|
|
|
## Setup Server Only
|
2023-03-27 06:12:26 +13:00
|
|
|
|
2022-10-01 03:03:38 +13:00
|
|
|
You can also just stand up the budibase server alone.
|
|
|
|
|
|
2023-03-27 06:12:26 +13:00
|
|
|
`yarn api:server:setup`
|
2022-10-01 03:03:38 +13:00
|
|
|
|
|
|
|
|
## Run Tests
|
2023-03-27 06:12:26 +13:00
|
|
|
|
2022-10-01 03:03:38 +13:00
|
|
|
If you configured the server using the previous command, you can run the whole test suite by using:
|
|
|
|
|
|
2023-03-27 06:12:26 +13:00
|
|
|
`yarn test`
|
2022-10-01 03:03:38 +13:00
|
|
|
|
|
|
|
|
for watch mode, where the tests will run on every change:
|
|
|
|
|
|
2023-03-27 06:12:26 +13:00
|
|
|
`yarn test:watch`
|
|
|
|
|
|
|
|
|
|
To run tests locally against a cloud service you can use the command:
|
|
|
|
|
`yarn run api:test:local`
|
|
|
|
|
|
|
|
|
|
To run the tests in CI, it assumes the correct environment variables are set, and the server is already running. Use the command:
|
|
|
|
|
`yarn run api:test:ci`
|
|
|
|
|
|
|
|
|
|
To run the nightly tests against the QA environment, use the command:
|
|
|
|
|
`yarn run api:test:nightly`
|
