Add start to integration tests

Author: MrAlias

.github/dependabot.yml

@@ -42,6 +42,10 @@ updates:
     directory: "/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql"
     schedule:
       interval: "daily"
+  - package-ecosystem: "gomod"
+    directory: "/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/test"
+    schedule:
+      interval: "daily"
   - package-ecosystem: "gomod"
     directory: "/instrumentation/github.com/jackc/pgx/splunkpgx"
     schedule:

instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/graphql.go

@@ -23,20 +23,14 @@ import (
 	"github.com/graph-gophers/graphql-go/errors"
 	"github.com/graph-gophers/graphql-go/introspection"
 	"github.com/graph-gophers/graphql-go/trace"
+	gql "github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/internal"
 	"github.com/signalfx/splunk-otel-go/instrumentation/internal"
-	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
 	oteltrace "go.opentelemetry.io/otel/trace"
 )
 
 const instrumentationName = "github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql"
 
-var (
-	graphqlFieldKey = attribute.Key("graphql.field")
-	graphqlQueryKey = attribute.Key("graphql.query")
-	graphqlTypeKey  = attribute.Key("graphql.type")
-)
-
 // otelTracer implements the graphql-go/trace.Tracer interface using
 // OpenTelemetry.
 type otelTracer struct {
@@ -78,7 +72,7 @@ func (t *otelTracer) TraceQuery(ctx context.Context, queryString string, operati
 		ctx,
 		"GraphQL request",
 		oteltrace.WithSpanKind(oteltrace.SpanKindServer),
-		oteltrace.WithAttributes(graphqlQueryKey.String(queryString)),
+		oteltrace.WithAttributes(gql.GraphQLQueryKey.String(queryString)),
 	)
 
 	return spanCtx, traceQueryFinishFunc(span)
@@ -93,9 +87,10 @@ func (t *otelTracer) TraceField(ctx context.Context, label, typeName, fieldName
 	spanCtx, span := t.cfg.ResolveTracer(ctx).Start(
 		ctx,
 		"GraphQL field",
+		oteltrace.WithSpanKind(oteltrace.SpanKindServer),
 		oteltrace.WithAttributes(
-			graphqlFieldKey.String(fieldName),
-			graphqlTypeKey.String(typeName),
+			gql.GraphQLFieldKey.String(fieldName),
+			gql.GraphQLTypeKey.String(typeName),
 		),
 	)
 
@@ -110,6 +105,10 @@ func (t *otelTracer) TraceField(ctx context.Context, label, typeName, fieldName
 
 // TraceValidation traces the schema validation step preceding an operation.
 func (t *otelTracer) TraceValidation(ctx context.Context) trace.TraceValidationFinishFunc {
-	_, span := t.cfg.ResolveTracer(ctx).Start(ctx, "GraphQL validation")
+	_, span := t.cfg.ResolveTracer(ctx).Start(
+		ctx,
+		"GraphQL validation",
+		oteltrace.WithSpanKind(oteltrace.SpanKindInternal),
+	)
 	return traceQueryFinishFunc(span)
 }

instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/internal/tags.go

@@ -0,0 +1,24 @@
+// Copyright Splunk Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package internal
+
+import "go.opentelemetry.io/otel/attribute"
+
+// GraphQL attributes.
+var (
+	GraphQLFieldKey = attribute.Key("graphql.field")
+	GraphQLQueryKey = attribute.Key("graphql.query")
+	GraphQLTypeKey  = attribute.Key("graphql.type")
+)

instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/test/go.mod

@@ -0,0 +1,16 @@
+module github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/test
+
+go 1.16
+
+require (
+	github.com/graph-gophers/graphql-go v1.2.0
+	github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql v0.0.0-00010101000000-000000000000
+	github.com/stretchr/testify v1.7.0
+	go.opentelemetry.io/otel/sdk v1.3.0
+	go.opentelemetry.io/otel/trace v1.3.0
+)
+
+replace (
+	github.com/signalfx/splunk-otel-go => ../../../../../../
+	github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql => ../
+)

instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/test/go.sum

@@ -0,0 +1,36 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/logr v1.2.1 h1:DX7uPQ4WgAWfoh+NGGlbJQswnYIVvz0SRlLS3rPZQDA=
+github.com/go-logr/logr v1.2.1/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/stdr v1.2.0 h1:j4LrlVXgrbIWO83mmQUnK0Hi+YnbD+vzrE1z/EphbFE=
+github.com/go-logr/stdr v1.2.0/go.mod h1:YkVgnZu1ZjjL7xTxrfm/LLZBfkhTqSR1ydtm6jTKKwI=
+github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
+github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/graph-gophers/graphql-go v1.2.0 h1:j3tCG0UcE+3f84OAw/4/6YQKyTr+r0yuUKtnxiu5OH4=
+github.com/graph-gophers/graphql-go v1.2.0/go.mod h1:9CQHMSxwO4MprSdzoIEobiHpoLtHm77vfxsvsIN5Vuc=
+github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU=
+github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+go.opentelemetry.io/contrib/propagators/b3 v1.2.0/go.mod h1:kO8hNKCfa1YmQJ0lM7pzfJGvbXEipn/S7afbOfaw2Kc=
+go.opentelemetry.io/otel v1.2.0/go.mod h1:aT17Fk0Z1Nor9e0uisf98LrntPGMnk4frBO9+dkf69I=
+go.opentelemetry.io/otel v1.3.0 h1:APxLf0eiBwLl+SOXiJJCVYzA1OOJNyAoV8C5RNRyy7Y=
+go.opentelemetry.io/otel v1.3.0/go.mod h1:PWIKzi6JCp7sM0k9yZ43VX+T345uNbAkDKwHVjb2PTs=
+go.opentelemetry.io/otel/exporters/jaeger v1.2.0/go.mod h1:KJLFbEMKTNPIfOxcg/WikIozEoKcPgJRz3Ce1vLlM8E=
+go.opentelemetry.io/otel/sdk v1.2.0/go.mod h1:jNN8QtpvbsKhgaC6V5lHiejMoKD+V8uadoSafgHPx1U=
+go.opentelemetry.io/otel/sdk v1.3.0 h1:3278edCoH89MEJ0Ky8WQXVmDQv3FX4ZJ3Pp+9fJreAI=
+go.opentelemetry.io/otel/sdk v1.3.0/go.mod h1:rIo4suHNhQwBIPg9axF8V9CA72Wz2mKF1teNrup8yzs=
+go.opentelemetry.io/otel/trace v1.2.0/go.mod h1:N5FLswTubnxKxOJHM7XZC074qpeEdLy3CgAVsdMucK0=
+go.opentelemetry.io/otel/trace v1.3.0 h1:doy8Hzb1RJ+I3yFhtDmwNc7tIyw1tNMOIsyPzp1NOGY=
+go.opentelemetry.io/otel/trace v1.3.0/go.mod h1:c/VDhno8888bvQYmbYLqe41/Ldmr/KKunbvWM4/fEjk=
+golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7 h1:iGu644GcxtEcrInvDsQRCwJjtCIOlT2V7IRt6ah2Whw=
+golang.org/x/sys v0.0.0-20210423185535-09eb48e85fd7/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql/test/graphql_test.go

@@ -0,0 +1,121 @@
+// Copyright Splunk Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/*
+Package test provides end-to-end testing of the splunkgraphql instrumentation
+with the default SDK.
+
+This package is in a separate module from the instrumentation it tests to
+isolate the dependency of the default SDK and not impose this as a transitive
+dependency for users.
+*/
+package test
+
+import (
+	"context"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+
+	"github.com/graph-gophers/graphql-go"
+	"github.com/graph-gophers/graphql-go/relay"
+	"github.com/signalfx/splunk-otel-go/instrumentation/github.com/graph-gophers/graphql-go/splunkgraphql"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/otel/sdk/trace"
+	"go.opentelemetry.io/otel/sdk/trace/tracetest"
+	traceapi "go.opentelemetry.io/otel/trace"
+)
+
+const testSchema = `
+	schema {
+		query: Query
+	}
+	type Query {
+		hello: String!
+		helloNonTrivial: String!
+	}
+`
+
+type testResolver struct{}
+
+func (*testResolver) Hello() string                    { return "Hello, world!" }
+func (*testResolver) HelloNonTrivial() (string, error) { return "Hello, world!", nil }
+
+func fixtures(t *testing.T) (*tracetest.SpanRecorder, *httptest.Server) {
+	sr := tracetest.NewSpanRecorder()
+	tp := trace.NewTracerProvider(trace.WithSpanProcessor(sr))
+	t.Cleanup(func() { require.NoError(t, tp.Shutdown(context.Background())) })
+
+	tracer := graphql.Tracer(splunkgraphql.NewTracer(splunkgraphql.WithTracerProvider(tp)))
+	schema := graphql.MustParseSchema(testSchema, new(testResolver), tracer)
+	srv := httptest.NewServer(&relay.Handler{Schema: schema})
+	t.Cleanup(srv.Close)
+
+	return sr, srv
+}
+
+func TestTracerNonTrivial(t *testing.T) {
+	sr, srv := fixtures(t)
+	resp, err := http.Post(srv.URL, "application/json", strings.NewReader(`{
+		"query": "query TestQuery() { hello, helloNonTrivial }",
+		"operationName": "TestQuery"
+	}`))
+	require.NoError(t, err)
+	t.Cleanup(func() { require.NoError(t, resp.Body.Close()) })
+	body, err := io.ReadAll(resp.Body)
+	require.NoError(t, err)
+	assert.Equal(t, `{"data":{"hello":"Hello, world!","helloNonTrivial":"Hello, world!"}}`, string(body))
+
+	spans := sr.Ended()
+	require.Len(t, spans, 3)
+	assert.Equal(t, spans[2].SpanContext().TraceID(), spans[1].SpanContext().TraceID())
+
+	s := spans[0]
+	assert.Equal(t, "GraphQL validation", s.Name())
+	assert.Equal(t, traceapi.SpanKindInternal, s.SpanKind())
+	// FIXME: validate the rest.
+
+	s = spans[1]
+	assert.Equal(t, "GraphQL field", s.Name())
+	assert.Equal(t, traceapi.SpanKindServer, s.SpanKind())
+	// FIXME: validate the rest.
+
+	s = spans[2]
+	assert.Equal(t, "GraphQL request", s.Name())
+	assert.Equal(t, traceapi.SpanKindServer, s.SpanKind())
+	// FIXME: validate the rest.
+}
+
+func TestTracerTrivial(t *testing.T) {
+	sr, srv := fixtures(t)
+	resp, err := http.Post(srv.URL, "application/json", strings.NewReader(`{
+		"query": "{ hello }"
+	}`))
+	require.NoError(t, err)
+	t.Cleanup(func() { require.NoError(t, resp.Body.Close()) })
+	body, err := io.ReadAll(resp.Body)
+	require.NoError(t, err)
+	assert.Equal(t, `{"data":{"hello":"Hello, world!"}}`, string(body))
+
+	spans := sr.Ended()
+	require.Len(t, spans, 2)
+
+	// Trivial queries should not trace a field access.
+	s0, s1 := spans[0], spans[1]
+	assert.Equal(t, "GraphQL validation", s0.Name())
+	assert.Equal(t, "GraphQL request", s1.Name())
+}