Skip to content

Commit 8d3ae16

Browse files
committed
refactor(test): rename test-everything → test-full
Shorter, clearer name for the target that runs every test in the repo (all suites + integration + integration2 + upgrade + fuzz).
1 parent f6e5e74 commit 8d3ae16

4 files changed

Lines changed: 38 additions & 12 deletions

File tree

AGENTS.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,42 @@
11
# Repository Guidelines
22

33
## Project Structure & Module Organization
4-
The Go module is rooted here, with entrypoints and CLI tooling under `dgraph/` for Alpha, Zero, Live, and companions. Core execution sits in `worker/`, `query/`, and `posting/`, the GraphQL adapters in `graphql/`, and shared helpers in packages like `x/` and `testutil/`. Protocol definitions live in `protos/` (regenerate via `make regenerate` inside that folder). Integration harnesses are in `t/`, broader system scenarios in `systest/`, and container assets under `contrib/` and `compose/`.
4+
5+
The Go module is rooted here, with entrypoints and CLI tooling under `dgraph/` for Alpha, Zero,
6+
Live, and companions. Core execution sits in `worker/`, `query/`, and `posting/`, the GraphQL
7+
adapters in `graphql/`, and shared helpers in packages like `x/` and `testutil/`. Protocol
8+
definitions live in `protos/` (regenerate via `make regenerate` inside that folder). Integration
9+
harnesses are in `t/`, broader system scenarios in `systest/`, and container assets under `contrib/`
10+
and `compose/`.
511

612
## Build, Test, and Development Commands
7-
Use `make dgraph` to compile the Linux AMD64 binaries into `./dgraph/dgraph`, or `make install` to drop them into `$GOPATH/bin`. Run `go test ./path/to/package` for focused checks or `go test ./...` for a fast repo-wide sweep. `make test` (no args) runs the default suite (`unit,systest,core` + `integration2`, ~30 min); use `make test SUITE=all` for all t/ runner suites or `make test-everything` for every test in the repo. Keep Docker running for integration tests. When debugging version info, `make version` surfaces the embedded build metadata.
13+
14+
Use `make dgraph` to compile the Linux AMD64 binaries into `./dgraph/dgraph`, or `make install` to
15+
drop them into `$GOPATH/bin`. Run `go test ./path/to/package` for focused checks or `go test ./...`
16+
for a fast repo-wide sweep. `make test` (no args) runs the default suite (`unit,systest,core` +
17+
`integration2`, ~30 min); use `make test SUITE=all` for all t/ runner suites or `make test-full` for
18+
every test in the repo. Keep Docker running for integration tests. When debugging version info,
19+
`make version` surfaces the embedded build metadata.
820

921
## Coding Style & Naming Conventions
10-
Follow standard Go conventions: exported identifiers start with capitals, packages use lowercase, and tests use `TestXxx` names. Format every change with `go fmt` (or `gofmt -w`) before committing; CI runs `golangci-lint`, so keep `//nolint` waivers rare and justified. Maintain the SPDX license header block on all new source files and avoid introducing unused helpers or dead code.
22+
23+
Follow standard Go conventions: exported identifiers start with capitals, packages use lowercase,
24+
and tests use `TestXxx` names. Format every change with `go fmt` (or `gofmt -w`) before committing;
25+
CI runs `golangci-lint`, so keep `//nolint` waivers rare and justified. Maintain the SPDX license
26+
header block on all new source files and avoid introducing unused helpers or dead code.
1127

1228
## Testing Guidelines
13-
Unit tests live beside their packages in `_test.go` files and run with `go test`. The `t/` harness drives integration clusters; add new scenarios under targeted subdirectories. `systest/` and `graphql/e2e/` capture longer system flows—mirror their layout when extending coverage. Before opening a PR, run `go test ./...` and the `t` or `systest` suites touched by your change, and include regression tests for new behaviour.
29+
30+
Unit tests live beside their packages in `_test.go` files and run with `go test`. The `t/` harness
31+
drives integration clusters; add new scenarios under targeted subdirectories. `systest/` and
32+
`graphql/e2e/` capture longer system flows—mirror their layout when extending coverage. Before
33+
opening a PR, run `go test ./...` and the `t` or `systest` suites touched by your change, and
34+
include regression tests for new behaviour.
1435

1536
## Commit & Pull Request Guidelines
16-
Recent history favors `type(scope): short message` commits (for example, `fix(compose): ...` or `chore: ...`). Keep commits atomic with clear intent, sign when possible, and reference issues using `Fixes #1234` when applicable. PRs should describe the motivation, summarize testing (`go test ./...`, `make test`, etc.), and call out configuration or data migrations. Include doc updates for user-facing behaviour changes and attach CLI output or screenshots if tooling UX shifts.
37+
38+
Recent history favors `type(scope): short message` commits (for example, `fix(compose): ...` or
39+
`chore: ...`). Keep commits atomic with clear intent, sign when possible, and reference issues using
40+
`Fixes #1234` when applicable. PRs should describe the motivation, summarize testing
41+
(`go test ./...`, `make test`, etc.), and call out configuration or data migrations. Include doc
42+
updates for user-facing behaviour changes and attach CLI output or screenshots if tooling UX shifts.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The simplest way to run tests is via Make:
148148
make test
149149

150150
# Run every test in the repo
151-
make test-everything
151+
make test-full
152152

153153
# Run specific test types
154154
make test-unit # Unit tests only (no Docker)

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,8 @@ test-load: ## Heavy load tests (i.e. 'make test SUITE=load')
165165
$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-load; use 'make test SUITE=...' instead))
166166
@SUITE=load $(MAKE) test
167167

168-
.PHONY: test-everything
169-
test-everything: ## Every test: all suites + integration + integration2 + upgrade + fuzz
168+
.PHONY: test-full
169+
test-full: ## Every test: all suites + integration + integration2 + upgrade + fuzz
170170
$(MAKE) test-suites
171171
$(MAKE) test-integration
172172
$(MAKE) test-integration2

TESTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ The simplest way to run tests:
308308
make test
309309

310310
# Run every test in the repo (all suites + all tag-based tests + fuzz)
311-
make test-everything
311+
make test-full
312312

313313
# Common shortcuts (run 'make help' for full list)
314314
make test-suites # All t/ runner suites (i.e. 'make test SUITE=all')
@@ -342,8 +342,8 @@ For more control, pass variables to `make test`:
342342
| `FUZZ` | Enable fuzz testing | `make test FUZZ=1` |
343343
| `FUZZTIME` | Fuzz duration per package | `make test FUZZ=1 FUZZTIME=60s` |
344344

345-
**Precedence:** `TAGS` > `FUZZ` > `SUITE` > default (first match wins). When no
346-
variable is set, `make test` runs suites `unit,systest,core` plus `integration2`.
345+
**Precedence:** `TAGS` > `FUZZ` > `SUITE` > default (first match wins). When no variable is set,
346+
`make test` runs suites `unit,systest,core` plus `integration2`.
347347

348348
### Examples
349349

@@ -1293,7 +1293,7 @@ The following items from the original wishlist have been implemented:
12931293
- **✅ Unified test interface:** A single `make test` entry point that accepts arguments to run any
12941294
test type (unit, integration, integration2, upgrade, fuzz) with environment variables for control.
12951295
The default (`make test` with no args) runs `unit,systest,core` suites plus `integration2` for a
1296-
fast feedback loop (~30 min). Use `make test-everything` to run all tests.
1296+
fast feedback loop (~30 min). Use `make test-full` to run all tests.
12971297

12981298
- **✅ Example commands that "just work":** The following now work as expected:
12991299

0 commit comments

Comments
 (0)