Skip to content

Commit af85b07

Browse files
committed
docs: add TESTING.md and update testing documentation
- Add TESTING.md as comprehensive testing guide (renamed from TESTING_GUIDE.md) - Update CONTRIBUTING.md to link to TESTING.md with quick start examples - Simplify t/README.md macOS section to reflect automated build system - Add cross-references between documentation files The macOS testing instructions are now much simpler since the build system handles cross-compilation automatically.
1 parent c4f9643 commit af85b07

3 files changed

Lines changed: 1271 additions & 66 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,23 +137,25 @@ then use this local image to test Dgraph in your local Docker setup.
137137

138138
### Testing
139139

140-
Dgraph employs a ~~complex~~ sophisticated testing framework that includes extensive test coverage.
141-
Due to the comprehensive nature of these tests, a complete test run can take several hours,
142-
depending on your hardware. To manage this complex testing process efficiently, we've developed a
143-
custom test framework implemented in Go, which resides in the [./t](/t) directory. This specialized
144-
framework provides enhanced control and flexibility beyond what's available through standard Go
145-
testing framework.
140+
For comprehensive testing documentation, see [TESTING.md](TESTING.md).
141+
142+
Dgraph employs a sophisticated testing framework that includes extensive test coverage. Due to the
143+
comprehensive nature of these tests, a complete test run can take several hours, depending on your
144+
hardware. To manage this complex testing process efficiently, we've developed a custom test
145+
framework implemented in Go, which resides in the [./t](/t) directory.
146146

147147
For dependencies, runner flags and instructions for running tests on non-Linux machines, see the
148148
[README](t/README.md) in the [_t_](t) folder.
149149

150-
Other integration tests do not use the testing framework located in the `t` folder. Consult the
151-
[github workflow definitions](.github/workflows) folder to discover the tests we run as part of our
152-
continuous integration process.
150+
Quick start:
151+
152+
```bash
153+
# Run unit tests
154+
go test github.com/dgraph-io/dgraph/v25/dql
153155

154-
Non-integration unit tests exist for many core packages that can be exercised without invoking the
155-
testing framework. For instance, to unit test the core DQL parsing package:
156-
`go test github.com/dgraph-io/dgraph/v25/dql`.
156+
# Run integration tests (requires Docker)
157+
cd t && go build . && ./t --suite=unit
158+
```
157159

158160
## Contributing
159161

0 commit comments

Comments
 (0)