Skip to content

Commit d6bf3b0

Browse files
committed
Document timeout flags and handler recovery in README.md
1 parent ba73694 commit d6bf3b0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,20 @@ make runner
5252

5353
# Run the test runner against your handler binary
5454
./build/runner --handler <path-to-your-handler>
55+
56+
# Configure timeouts (optional)
57+
./build/runner --handler <path-to-your-handler> \
58+
--handler-timeout 30s \ # Max wait per test case (default: 10s)
59+
--timeout 2m # Total execution limit (default: 30s)
5560
```
5661

62+
#### Timeout Flags
63+
64+
- **`--handler-timeout`** (default: 10s): Maximum time to wait for handler response to each test case. Prevents hangs on unresponsive handlers.
65+
- **`--timeout`** (default: 30s): Total execution time limit across all test suites. Ensures bounded test runs.
66+
67+
The runner automatically detects and recovers from crashed/unresponsive handlers, allowing remaining tests to continue.
68+
5769
### Testing the Runner
5870

5971
Build and test the runner:

0 commit comments

Comments
 (0)