gqlcheck: GraphQL testing library

gqlcheck is a library for testing GraphQL servers.

Example

You can test the target API by passing the handler of the GraphQL server or the URL of the running GraphQL server.

The following is a test sample of the server included in testdata/gqlgen-todo. gqlgen-todo is the server described in gqlgen's Getting Started.

func TestServer(t *testing.T) {
	h := handler.New(
		graph.NewExecutableSchema(
			graph.Config{
				Resolvers: &graph.Resolver{},
			},
		),
	)
	h.AddTransport(transport.POST{})

	checker := gqlcheck.New(h, gqlcheck.Debug())
	checker.Test(t).
		WithHeader("Content-Type", "application/json").
		Query(`query {todos {text}}`).
		Check().
		HasStatusOK().
		HasNoError().
		HasData(map[string]any{
			"todos": []any{},
		})
}

OUTPUT:

=== RUN   TestServer
2024/02/05 11:31:12 == POST http://127.0.0.1:61506
2024/02/05 11:31:12 >> header map[Content-Type:[application/json]]
2024/02/05 11:31:12 >> body: {"query":"query {todos {text}}"}
2024/02/05 11:31:12 << status: 200 OK
2024/02/05 11:31:12 << body: {"data":{"todos":[]}}
--- PASS: TestServer (0.00s)
PASS

GET Query Support

gqlcheck also supports GET requests for GraphQL queries, following the GraphQL over HTTP specification.

Use TestWithMethod to specify the HTTP method:

func TestServerViaGet(t *testing.T) {
	h := handler.New(
		graph.NewExecutableSchema(
			graph.Config{
				Resolvers: &graph.Resolver{},
			},
		),
	)
	h.AddTransport(transport.GET{})

	checker := gqlcheck.New(h, gqlcheck.Debug())
	checker.TestWithMethod(t, http.MethodGet).
		Query(`query {todos {text}}`).
		Check().
		HasStatusOK().
		HasNoErrors().
		HasData(map[string]any{
			"todos": []any{},
		})
}

OUTPUT:

=== RUN   TestServerViaGet
2024/02/05 11:31:12 == GET http://127.0.0.1:61506?query=query+%7Btodos+%7Btext%7D%7D
2024/02/05 11:31:12 >> header map[]
2024/02/05 11:31:12 >> body: nil
2024/02/05 11:31:12 << status: 200 OK
2024/02/05 11:31:12 << body: {"data":{"todos":[]}}
--- PASS: TestServerViaGet (0.00s)
PASS

You can also pass variables using QueryWithVariables():

checker.TestWithMethod(t, http.MethodGet).
	QueryWithVariables(
		`query GetUser($id: ID!) { user(id: $id) { name } }`,
		map[string]any{"id": "123"},
	).
	Check().
	HasStatusOK()

---

MIT