subscriptions.go

package gqltesting

import (
	"bytes"
	"context"
	"encoding/json"
	"strconv"
	"testing"

	graphql "github.com/graph-gophers/graphql-go"
	"github.com/graph-gophers/graphql-go/errors"
)

// TestResponse models the expected response
type TestResponse struct {
	Data   json.RawMessage
	Errors []*errors.QueryError
}

// TestSubscription is a GraphQL test case to be used with RunSubscribe.
type TestSubscription struct {
	Name            string
	Schema          *graphql.Schema
	Query           string
	OperationName   string
	Variables       map[string]interface{}
	ExpectedResults []TestResponse
	ExpectedErr     error
}

// RunSubscribes runs the given GraphQL subscription test cases as subtests.
func RunSubscribes(t *testing.T, tests []*TestSubscription) {
	for i, test := range tests {
		if test.Name == "" {
			test.Name = strconv.Itoa(i + 1)
		}

		t.Run(test.Name, func(t *testing.T) {
			RunSubscribe(t, test)
		})
	}
}

// RunSubscribe runs a single GraphQL subscription test case.
func RunSubscribe(t *testing.T, test *TestSubscription) {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	c, err := test.Schema.Subscribe(ctx, test.Query, test.OperationName, test.Variables)
	if err != nil {
		if err.Error() != test.ExpectedErr.Error() {
			t.Fatalf("unexpected error: got %+v, want %+v", err, test.ExpectedErr)
		}

		return
	}

	var results []*graphql.Response
	for res := range c {
		results = append(results, res.(*graphql.Response))
	}

	for i, expected := range test.ExpectedResults {
		res := results[i]

		checkErrorStrings(t, expected.Errors, res.Errors)

		resData, err := res.Data.MarshalJSON()
		if err != nil {
			t.Fatal(err)
		}
		got, err := formatJSON(resData)
		if err != nil {
			t.Fatalf("got: invalid JSON: %s; raw: %s", err, resData)
		}

		expectedData, err := expected.Data.MarshalJSON()
		if err != nil {
			t.Fatal(err)
		}
		want, err := formatJSON(expectedData)
		if err != nil {
			t.Fatalf("got: invalid JSON: %s; raw: %s", err, expectedData)
		}

		if !bytes.Equal(got, want) {
			t.Logf("got:  %s", got)
			t.Logf("want: %s", want)
			t.Fail()
		}
	}
}

func checkErrorStrings(t *testing.T, expected, actual []*errors.QueryError) {
	expectedCount, actualCount := len(expected), len(actual)

	if expectedCount != actualCount {
		t.Fatalf("unexpected number of errors: want %d, got %d", expectedCount, actualCount)
	}

	if expectedCount > 0 {
		for i, want := range expected {
			got := actual[i]

			if got.Error() != want.Error() {
				t.Fatalf("unexpected error: got %+v, want %+v", got, want)
			}
		}

		// Return because we're done checking.
		return
	}

	for _, err := range actual {
		t.Errorf("unexpected error: '%s'", err)
	}
}