Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test definition in readme #3807

Merged
merged 1 commit into from
Jan 13, 2023
Merged

Add test definition in readme #3807

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,12 @@ make bins
Please check the top of our [Makefile](Makefile) for other useful build targets.

## Run tests
Tests require runtime dependencies. They can be run with `start-dependencies` target (uses `docker-compose` internally). Open new terminal window and run:
We defined three categories of tests.
* Unit test: Those tests should not have dependencies other than the test target and go mock. We should have unit test coverage as much as possible.
* Integration test: Those tests cover the integration between the server and the dependencies (Cassandra, SQL, ES etc.).
* Functional test: Those tests cover the E2E functionality of Temporal server. They are all under ./tests directory.

Integration and functional tests require runtime dependencies. They can be run with `start-dependencies` target (uses `docker-compose` internally). Open new terminal window and run:
```bash
make start-dependencies
```
Expand All @@ -70,6 +75,11 @@ Run all integration tests:
make integration-test
```

Run all functional tests:
```bash
make functional-test
```

Or run all the tests at once:
```bash
make test
Expand Down