Skip to content

Commit d2adb32

Browse files
committed
docs(testing): add three-column reference table for all test targets
Replace the bash listing of test-* targets in Quick Start with a table showing three invocation styles for every target: the dedicated make target, the equivalent make test with arguments, and the direct command without make.
1 parent 31e6f7d commit d2adb32

1 file changed

Lines changed: 21 additions & 22 deletions

File tree

TESTING.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -310,28 +310,27 @@ If both pass, you're ready to run all test types!
310310

311311
### Using Make Targets
312312

313-
The simplest way to run tests:
314-
315-
```bash
316-
# Run default tests (~30 min): integration suite + integration2
317-
make test
318-
319-
# Run every test in the repo (all suites + all tag-based tests + fuzz)
320-
make test-all
321-
322-
# Common shortcuts (run 'make help' for full list)
323-
make test-unit # True unit tests only — no Docker, no build tags
324-
make test-integration # Integration tests via t/ runner with Docker (SUITE=integration)
325-
make test-integration-heavy # All heavy tests: systest-heavy + ldbc + load
326-
make test-core # Core tests (i.e. 'make test SUITE=core')
327-
make test-systest # All systest packages: systest-baseline + systest-heavy
328-
make test-vector # Vector search tests (i.e. 'make test SUITE=vector')
329-
make test-integration2 # Integration2 tests via dgraphtest (i.e. 'make test TAGS=integration2')
330-
make test-upgrade # Upgrade tests (i.e. 'make test TAGS=upgrade')
331-
make test-fuzz # Fuzz tests (i.e. 'make test FUZZ=1')
332-
make test-all # Every test: all t/ suites + integration2 + upgrade + fuzz
333-
make test-benchmark # Go benchmarks (i.e. 'go test -bench')
334-
```
313+
The simplest way to run tests is `make test` (default: `integration` suite + `integration2`). Each
314+
`test-*` target is a shortcut for `make test` with specific arguments. The table below shows all
315+
three ways to run each test type.
316+
317+
| Target | `make test` equivalent | Without make |
318+
| ----------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------- |
319+
| `make test` | _(default)_ | `cd t && ./t --suite=integration` then `go test -v --tags=integration2 ./...` |
320+
| `make test-unit` | `make test SUITE=unit` | `cd t && ./t --suite=unit` |
321+
| `make test-integration` | `make test SUITE=integration` | `cd t && ./t --suite=integration` |
322+
| `make test-core` | `make test SUITE=core` | `cd t && ./t --suite=core` |
323+
| `make test-systest` | `make test SUITE=systest` | `cd t && ./t --suite=systest` |
324+
| `make test-vector` | `make test SUITE=vector` | `cd t && ./t --suite=vector` |
325+
| `make test-integration-heavy` | `make test SUITE=systest-heavy,ldbc,load` | `cd t && ./t --suite=systest-heavy,ldbc,load` |
326+
| `make test-integration2` | `make test TAGS=integration2` | `go test -v --tags=integration2 ./...` |
327+
| `make test-upgrade` | `make test TAGS=upgrade` | `go test -v --tags=upgrade ./...` |
328+
| `make test-fuzz` | `make test FUZZ=1` | `go test -v -fuzz=Fuzz -fuzztime=300s ./dql/...` |
329+
| `make test-benchmark` | _(no equivalent)_ | `go test -bench=. -benchmem ./...` |
330+
| `make test-all` | _(no equivalent)_ | Runs `SUITE=all` + `integration2` + `upgrade` + fuzz sequentially |
331+
332+
> **Tip:** All targets accept `PKG=`, `TEST=`, and `TIMEOUT=` variables. For example:
333+
> `make test-systest PKG=systest/plugin TEST=TestPasswordReturn TIMEOUT=60m`
335334
336335
Run `make help` to see all available targets, variables, and dynamically discovered SUITE/TAGS
337336
values.

0 commit comments

Comments
 (0)