Skip to content

Commit 0bf1137

Browse files
authored
Add test definition in readme (#3807)
1 parent b132fc2 commit 0bf1137

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ make bins
5050
Please check the top of our [Makefile](Makefile) for other useful build targets.
5151

5252
## Run tests
53-
Tests require runtime dependencies. They can be run with `start-dependencies` target (uses `docker-compose` internally). Open new terminal window and run:
53+
We defined three categories of tests.
54+
* 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.
55+
* Integration test: Those tests cover the integration between the server and the dependencies (Cassandra, SQL, ES etc.).
56+
* Functional test: Those tests cover the E2E functionality of Temporal server. They are all under ./tests directory.
57+
58+
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:
5459
```bash
5560
make start-dependencies
5661
```
@@ -70,6 +75,11 @@ Run all integration tests:
7075
make integration-test
7176
```
7277

78+
Run all functional tests:
79+
```bash
80+
make functional-test
81+
```
82+
7383
Or run all the tests at once:
7484
```bash
7585
make test

0 commit comments

Comments
 (0)