Skip to content

Commit a7ccf74

Browse files
committed
Explain test build tags and env variables
1 parent c762ad2 commit a7ccf74

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/development/testing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This document describes the project's testing utilities and best practices.
44

5+
## Setup
6+
7+
### Build tags
8+
- `test_dep` (required): This Go build tag is required for running functional tests.
9+
10+
### Environment variables
11+
- `CGO_ENABLED`: Set to 0 to disable CGO, which can significantly speed up compilation time.
12+
- `TEMPORAL_DEBUG`: Extends functional test timeouts to allow sufficient time for debugging sessions.
13+
- `TEMPORAL_TEST_LOG_FORMAT`: Controls the output format for test logs. Available options: `json` or `console`
14+
- `TEMPORAL_TEST_LOG_LEVEL`: Sets the verbosity level for test logging. Available levels: `debug`, `info`, `warn`, `error`, `fatal`
15+
516
## Test helpers
617

718
Test helpers can be found in the [common/testing](../../common/testing) package.

0 commit comments

Comments
 (0)