Skip to content

Commit fb863dc

Browse files
authored
Explain test build tags and env variables (#7991)
## What changed? Added documentation for test-related build tags and env variables. ## Why? So help developers with their test setup.
1 parent 17c4c07 commit fb863dc

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/development/testing.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
# Testing
22

3-
This document describes the project's testing utilities and best practices.
3+
This document describes the project's testing setup, utilities and best practices.
4+
5+
## Setup
6+
7+
### Build tags
8+
- `test_dep` (required): This Go build tag is required for running functional tests.
9+
- `TEMPORAL_DEBUG`: Extends functional test timeouts to allow sufficient time for debugging sessions.
10+
11+
### Environment variables
12+
- `CGO_ENABLED`: Set to `0` to disable CGO, which can significantly speed up compilation time.
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+
- `TEMPORAL_TEST_OTEL_OUTPUT`: Enables OpenTelemetry (OTEL) trace output for failed tests to the provided file path.
416

517
## Test helpers
618

0 commit comments

Comments
 (0)