-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Adam Scarr
committed
Aug 23, 2018
1 parent
15d8d4a
commit a81147d
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Describe your PR and link to any relevant issues. | ||
|
||
I have: | ||
- [ ] Added tests covering the bug / feature (see [testing](https://github.com/99designs/gqlgen/blob/master/TESTING.md)) | ||
- [ ] Updated any relevant documentation (see [docs](https://github.com/99designs/gqlgen/tree/master/docs/content)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
How to write tests for gqlgen | ||
=== | ||
|
||
Testing generated code is a little tricky, heres how its currently set up. | ||
|
||
### Testing responses from a server | ||
|
||
There is a server in `codegen/testserver` that is generated as part | ||
of `go generate ./...`, and tests written against it. | ||
|
||
There are also a bunch of tests in against the examples, feel free to take examples from there. | ||
|
||
|
||
### Testing the errors generated by the binary | ||
|
||
These tests are **really** slow, because they need to run the whole codegen step. Use them very sparingly. If you can, find a way to unit test it instead. | ||
|
||
Take a look at `codegen/input_test.go` for an example. | ||
|
||
### Testing introspection | ||
|
||
Introspection is tested by diffing the output of `graphql get-schema` against an expected output. | ||
|
||
Setting up the integration environment is a little tricky: | ||
```bash | ||
cd integration | ||
go generate ./... | ||
go run ./server/server.go | ||
``` | ||
in another terminal | ||
```bash | ||
cd integration | ||
npm install | ||
SERVER_URL=http://localhost:8080/query ./node_modules/.bin/graphql get-schema | ||
``` | ||
|
||
will write the schema to `integration/schema-fetched.graphql`, compare that with `schema-expected.graphql` | ||
|
||
CI will run this and fail the build if the two files dont match. | ||
|