Skip to content

Commit 3b2a96f

Browse files
committed
Add QUICK_TEST mode documentation to testing.md
1 parent 88de8f2 commit 3b2a96f

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

doc/devs/testing.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,64 @@ genhtml interesting.info --output-directory lcov --prefix `pwd`
3030
```
3131

3232
Now open `lcov/index.html` in a browser
33+
34+
# CI Testing
35+
36+
## Quick Test Mode
37+
38+
Quick Test mode allows running CI tests using pre-built binaries from a previous successful pipeline, skipping the ~20 minute C++ build step. This is useful when:
39+
40+
- You're only changing test code, not hived source
41+
- You want fast feedback on test changes
42+
- You're debugging flaky tests
43+
44+
### Usage
45+
46+
Run a pipeline with these variables:
47+
48+
| Variable | Required | Description |
49+
|----------|----------|-------------|
50+
| `QUICK_TEST` | Yes | Set to `true` to enable |
51+
| `QUICK_TEST_BINARY_COMMIT` | No | Specific commit SHA to use (auto-detects if empty) |
52+
| `QUICK_TEST_JOBS` | No | Additional test jobs to run (comma-separated) |
53+
| `QUICK_TEST_BLOCK_LOG_IMAGE` | No | Block log image for test_tools_tests |
54+
55+
**Example - Basic quick test:**
56+
```bash
57+
glab ci run -b my-branch --variables QUICK_TEST:true
58+
```
59+
60+
**Example - With specific binary commit:**
61+
```bash
62+
glab ci run -b my-branch --variables QUICK_TEST:true --variables QUICK_TEST_BINARY_COMMIT:abc1234f
63+
```
64+
65+
**Example - Including test_tools_tests:**
66+
```bash
67+
glab ci run -b my-branch \
68+
--variables QUICK_TEST:true \
69+
--variables QUICK_TEST_JOBS:test_tools_tests \
70+
--variables QUICK_TEST_BLOCK_LOG_IMAGE:registry.gitlab.syncad.com/hive/hive/block-log-5m:latest
71+
```
72+
73+
### What Runs
74+
75+
| Mode | Build Jobs | Test Jobs | Time |
76+
|------|------------|-----------|------|
77+
| Normal | All (~20 min) | All 50+ jobs | ~60+ min |
78+
| Quick Test | None | Unit tests only | ~30 min |
79+
80+
By default, Quick Test runs only unit tests (`chain_test`, `plugin_test`). Use `QUICK_TEST_JOBS` to add more.
81+
82+
### Finding Available Binaries
83+
84+
To list recent testnet images available for Quick Test:
85+
```bash
86+
./scripts/ci-helpers/list-hive-binaries.sh
87+
```
88+
89+
### Limitations
90+
91+
- Binaries must exist in the registry from a previous successful pipeline
92+
- If your changes affect hived behavior, results may not reflect current code
93+
- Auto-detection uses the most recent testnet image tag

0 commit comments

Comments
 (0)