Skip to content

Commit

Permalink
Update with additional flags and common pitfalls
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewmcneely committed Jan 14, 2025
1 parent 33e53ab commit c88a229
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions t/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,22 +70,32 @@ to test the GraphQL system:
./t --pkg=graphql/e2e/normal
```

Multiple packages can be specified by separated them with a comma.

### Testing suites

You can test a "suite" of functionality using the `--suite` flag. For instance:
You can test one or more "suites" of functionality using the `--suite` flag. For instance:

```sh
./t --suite=core
./t --suite=core,vector
```

The `--help` flag lists the available suites.

### Testing single test functions

```sh
./t --test=TestParseCountValError
```

This flag uses `ack` to find all tests matching the specified name(s).

### Other useful flags

The `--dry` (dry-run) flag can be used to list the packages that will be included for testing without
actually invoking the tests.

The `--skip-slow` flag will skips tests known to be slow to complete.
The `--skip-slow` flag will skip tests known to be slow to complete.

## Docker Compose Conventions

Expand Down Expand Up @@ -132,7 +142,12 @@ Example:
```sh
export GOPATH=`go env GOPATH`
export DGRAPH_BINARY=$GOPATH/bin/dgraph_osx
export DOCKER_HOST=~/.docker/run/docker.sock
export DOCKER_HOST=unix://${HOME}/.docker/run/docker.sock
```

At this point, the `t` executable can be run as described above.

### Common Pitfalls

If you see `exec format error` output from test runs, it is most likely because some tests attempt to run the Dgraph
image copied from the filesystem in the Docker environment. This is a known issue with some integration tests.

0 comments on commit c88a229

Please sign in to comment.