Skip to content

Commit 65310d5

Browse files
chore: Document process.env.DEBUG in node integration tests README (#16558)
A new "Debugging Tests" section was added to `dev-packages/node-integration-tests/README.md`. This section documents the `DEBUG` environment variable, which enables verbose logging for the integration test suite. When `DEBUG=1` is set (e.g., `DEBUG=1 yarn test`), the test runner provides detailed output, including: * Test scenario startup information (path, flags, DSN). * Docker Compose output when tests use `withDockerCompose`. * Child process stdout and stderr. * HTTP requests made during tests. * Process errors and exceptions. * Line-by-line output from test scenarios. This addition improves discoverability and understanding of the debugging capabilities, aiding in troubleshooting failing tests and analyzing test execution flow. --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent ba3728d commit 65310d5

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

dev-packages/node-integration-tests/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,20 @@ To run tests with Vitest's watch mode:
4747
To filter tests by their title:
4848

4949
`yarn test -t "set different properties of a scope"`
50+
51+
## Debugging Tests
52+
53+
To enable verbose logging during test execution, set the `DEBUG` environment variable:
54+
55+
`DEBUG=1 yarn test`
56+
57+
When `DEBUG` is enabled, the test runner will output:
58+
59+
- Test scenario startup information (path, flags, DSN)
60+
- Docker Compose output when using `withDockerCompose`
61+
- Child process stdout and stderr output
62+
- HTTP requests made during tests
63+
- Process errors and exceptions
64+
- Line-by-line output from test scenarios
65+
66+
This is particularly useful when debugging failing tests or understanding the test execution flow.

0 commit comments

Comments
 (0)