Skip to content

Commit 9704ad2

Browse files
committed
Update docs
1 parent 2b65f6d commit 9704ad2

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

integrationTests/utils/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This method should be used in the `before()` lifecycle hook for a test suite. It
3434
1. Creates a Harper instance in a temporary directory
3535
2. Assigns a unique loopback address from the loopback address pool
3636
3. Starts Harper with test configuration (which self-installs)
37-
4. Waits for Harper to be fully started (default: 5 seconds, configurable via `options.startupDelayMs`)
37+
4. Waits for Harper to be fully started, waiting for the startup message to appear in stdout
3838
5. Populates the `context.harper` object with connection details
3939

4040
**Important:** Always call `teardownHarper(ctx)` in the `after()` hook to properly clean up resources, or you will have phantom Harper processes after tests complete.
@@ -77,16 +77,28 @@ export interface SetupHarperOptions {
7777
* @default 30000
7878
*/
7979
startupTimeoutMs?: number;
80+
/**
81+
* Additional configuration options to pass to the Harper CLI.
82+
*/
83+
config: any;
84+
/**
85+
* Environment variables to set when running Harper.
86+
*/
87+
env: any;
8088
}
8189
```
8290

8391
**Properties:**
8492

85-
- **`startupDelayMs`** - `number` (optional) - Time in milliseconds to wait after starting Harper before considering it ready. Defaults to 5000 (5 seconds), or the value of the `HARPER_INTEGRATION_TEST_STARTUP_DELAY_MS` environment variable if set.
93+
30000 (5 seconds), or the value of the `HARPER_INTEGRATION_TEST_STARTUP_TIMEOUT_MS` environment variable if set.
94+
95+
- **`config`** - `object` (optional) - Additional configuration options to pass to the Harper CLI.
96+
- **`env`** - `object` (optional) - Additional environment variables to set when starting Harper.
97+
- **`startupTimeoutMs`** - `number` (optional) - Timeout in milliseconds to wait for Harper to start. Defaults to
8698

8799
**Environment Variables:**
88100

89-
- `HARPER_INTEGRATION_TEST_STARTUP_DELAY_MS` - Sets the default startup delay for all tests when `startupDelayMs` is not explicitly provided
101+
- `HARPER_INTEGRATION_TEST_STARTUP_TIMEOUT_MS` - Sets the default startup delay for all tests when `startupTimeoutMs` is not explicitly provided
90102

91103
---
92104

0 commit comments

Comments
 (0)