2c341ee755
This PR includes various fixes to anchor links used in the documentation. There are certain characters GitHub doesn't support for the use of anchor links in markdown files. The general rule I've found is to only use a-z or A-Z characters in anchor links. All other characters should be removed. For example, consider the section title How do I connect to the Mailhog simulated server?. The valid GitHub anchor link for this section is #how-do-i-connect-to-the-mailhog-simulated-server. Notice no ?. Closes #494
3.4 KiB
Testing & Local Development
Test suite
To execute the basic unit tests, run the following from the root of the repository:
MYSQL_TEST=1 REDIS_TEST=1 make test
It is a good idea to run make test before submitting a Pull Request.
Go unit tests
To run all Go unit tests, run the following:
make test-go
Go linters
To run all Go linters and static analyzers, run the following:
make lint-go
Javascript unit tests
To run all JS unit tests, run the following:
make test-js
or
yarn test
Javascript linters
To run all JS linters and static analyzers, run the following:
make lint-js
or
yarn lint
MySQL tests
To run MySQL integration tests set environment variables as follows:
MYSQL_TEST=1 make test-go
Redis tests
To run Redis integration tests set environment variables as follows:
REDIS_TEST=1 make test-go
Email tests
To run email related integration tests using MailHog set environment as follows:
MAIL_TEST=1 make test-go
Viewing test coverage
When you run make test or make test-go from the root of the repository, test coverage reports are generated in every subpackage. For example, the server subpackage will have a coverage report generated in ./server/server.cover
To explore a test coverage report on a line-by-line basis in the browser, run the following:
# substitute ./datastore/datastore.cover, etc
go tool cover -html=./server/server.cover
To view test a test coverage report in a terminal, run the following:
# substitute ./datastore/datastore.cover, etc
go tool cover -func=./server/server.cover
End-to-end tests
E2E tests are run using Docker and Cypress.
Preparation
Make sure dependencies are up to date and the Fleet binaries are built locally.
make e2e-reset-db
make e2e-serve
This will start a local Fleet server connected to the E2E database. Leave this server running for the duration of end-to-end testing.
make e2e-setup
This will initialize the E2E instance with a user.
Run tests
Tests can be run in interactive mode, or from the command line.
Interactive
yarn cypress open
Use the graphical UI controls to run and view tests.
Command line
yarn cypress run
Tests will run automatically and results are reported to the shell.
Manually testing email with MailHog
To intercept sent emails while running a Fleet development environment, make sure that you've set the SMTP address to localhost:1025 and leave the username and password blank. Then, visit http://localhost:8025 in a web browser to view the MailHog UI.
When Fleet sends emails, the contents of the messages are available in the MailHog UI.
Database Backup/Restore
In the course of development (particularly when crafting database migrations), it may be useful to backup and restore the MySQL database. This can be achieved with the following commands:
Backup:
./tools/backup_db/backup.sh
The database dump is stored in backup.sql.gz.
Restore:
./tools/backup_db/restore.sh
Note that a "restore" will replace the state of the development database with the state from the backup.