Update readme

This commit is contained in:
Pedro Silva 2023-03-26 18:12:26 +01:00
parent f8f13ed2c7
commit 37ba34cf94
2 changed files with 17 additions and 5 deletions

View File

@ -3,20 +3,32 @@
The QA Core API tests are a jest suite that run directly against the budibase backend APIs.
## Auto Setup
You can run the whole test suite with one command, that spins up the budibase server and runs the jest tests:
`yarn api:test`
`yarn api:test`
## Setup Server Only
You can also just stand up the budibase server alone.
`yarn api:server:setup`
`yarn api:server:setup`
## Run Tests
If you configured the server using the previous command, you can run the whole test suite by using:
`yarn test`
`yarn test`
for watch mode, where the tests will run on every change:
`yarn test:watch`
`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`

View File

@ -21,7 +21,7 @@
"api:test:ci": "start-server-and-test api:server:setup:ci http://localhost:4100/builder test",
"api:test": "start-server-and-test api:server:setup http://localhost:4100/builder test",
"api:test:local": "env-cmd jest --runInBand --testPathIgnorePatterns=\\\"\\/dataSources\\/\\\"",
"api:test:withDataSources": "env-cmd jest --runInBand --outputFile=testResults.json"
"api:test:nightly": "env-cmd jest --runInBand --outputFile=testResults.json"
},
"jest": {
"preset": "ts-jest",