Verified Commit 0807699e authored by Florian Forster's avatar Florian Forster
Browse files

test: Validate the GraphQL schema of queries. 

This check is _optional_ and only done when the schema file is available at
`schema/gitlab.graphql`.
parent 2df0107a

go.mod

+1 −0
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ require ( 
	buf.build/go/protoyaml v0.6.0

	github.com/MakeNowJust/heredoc/v2 v2.0.1

	github.com/google/go-querystring v1.2.0

	github.com/graph-gophers/graphql-go v1.8.0

	github.com/hashicorp/go-cleanhttp v0.5.2

	github.com/hashicorp/go-retryablehttp v0.7.8

	github.com/stretchr/testify v1.11.1

go.sum

+2 −0
Original line number Diff line number Diff line
@@ -31,6 +31,8 @@ github.com/google/go-querystring v1.2.0 h1:yhqkPbu2/OH+V9BfpCVPZkNmUXhb2gBxJArfh 
github.com/google/go-querystring v1.2.0/go.mod h1:8IFJqpSRITyJ8QhQ13bmbeMBDfmeEJZD5A0egEOmkqU=

github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=

github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=

github.com/graph-gophers/graphql-go v1.8.0 h1:NT05/H+PdH1/PONExlUycnhULYHBy98dxV63WYc0Ng8=

github.com/graph-gophers/graphql-go v1.8.0/go.mod h1:23olKZ7duEvHlF/2ELEoSZaY1aNPfShjP782SOoNTyM=

github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=

github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=

github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k=

workitems_test.go

+69 −3
Original line number Diff line number Diff line
@@ -4,13 +4,16 @@ import ( 
	"bytes"

	_ "embed"

	"encoding/json"

	"errors"

	"fmt"

	"io"

	"net/http"

	"os"

	"strings"

	"testing"

	"time"



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

	"github.com/stretchr/testify/assert"

	"github.com/stretchr/testify/require"

)
@@ -105,16 +108,29 @@ func TestGetWorkItem(t *testing.T) { 
		},

	}



	schema := loadSchema(t)



	for _, tt := range tests {

		t.Run(tt.name, func(t *testing.T) {

			t.Parallel()

			mux, client := setup(t)



			mux.HandleFunc("/api/graphql", func(w http.ResponseWriter, r *http.Request) {

				defer r.Body.Close()



				testMethod(t, r, http.MethodPost)



				io.Copy(io.Discard, r.Body)

				r.Body.Close()

				var q GraphQLQuery



				if err := json.NewDecoder(r.Body).Decode(&q); err != nil {

					http.Error(w, err.Error(), http.StatusBadRequest)

					return

				}



				if err := validateSchema(schema, q); err != nil {

					http.Error(w, err.Error(), http.StatusBadRequest)

					return

				}



				w.Header().Set("Content-Type", "application/json")

				tt.response.WriteTo(w)
@@ -281,7 +297,7 @@ func TestListWorkItems(t *testing.T) { 
				ReleaseTag:           []string{"v1.0.0"},

				ReleaseTagWildcardID: Ptr("ANY"),

				State:                Ptr("opened"),

				Subscribed:           Ptr("SUBSCRIBED"),

				Subscribed:           Ptr("EXPLICITLY_SUBSCRIBED"),

				Types:                []string{"ISSUE", "TASK"},

				Weight:               Ptr("5"),

				WeightWildcardID:     Ptr("NONE"),
@@ -368,6 +384,8 @@ func TestListWorkItems(t *testing.T) { 
		},

	}



	schema := loadSchema(t)



	for _, tt := range tests {

		t.Run(tt.name, func(t *testing.T) {

			t.Parallel()
@@ -385,6 +403,11 @@ func TestListWorkItems(t *testing.T) { 
					return

				}



				if err := validateSchema(schema, q); err != nil {

					http.Error(w, err.Error(), http.StatusBadRequest)

					return

				}



				for _, ss := range tt.wantQuerySubstr {

					if !strings.Contains(q.Query, ss) {

						http.Error(w, fmt.Sprintf("want substring %q, got query %q", ss, q.Query), http.StatusBadRequest)
@@ -410,3 +433,46 @@ func TestListWorkItems(t *testing.T) { 
		})

	}

}



func loadSchema(t *testing.T) *graphql.Schema {

	t.Helper()



	const filename = "schema/gitlab.graphql"



	fh, err := os.Open(filename)

	switch {

	case errors.Is(err, os.ErrNotExist):

		t.Logf("GraphQL schema file %q is not available", filename)

		return nil



	case err != nil:

		t.Fatalf("opening schema failed: %v", err)

	}



	data, err := io.ReadAll(fh)

	if err != nil {

		t.Fatalf("reading schema failed: %v", err)

	}



	schema, err := graphql.ParseSchema(string(data), nil)

	if err != nil {

		t.Fatalf("parsing schema failed: %v", err)

	}



	return schema

}



func validateSchema(schema *graphql.Schema, query GraphQLQuery) error {

	if schema == nil {

		return nil

	}



	queryErrors := schema.ValidateWithVariables(query.Query, query.Variables)



	var errs error

	for _, err := range queryErrors {

		errs = errors.Join(errs, err)

	}



	return errs

}