Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix interceptor regexp #683

Merged
merged 18 commits into from
May 7, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions plugin/grpctrace/interceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -426,12 +426,11 @@ func peerInfoFromContext(ctx context.Context) []core.KeyValue {
return peerInfoFromTarget(p.Addr.String())
}

var fullMethodRegexp = regexp.MustCompile(`^/\S*\.(\S*)/\S*$`)
var fullMethodRegexp = regexp.MustCompile(`^/(?:\S*/)?(?:\S*\.)?(\S*)/\S*$`)
stefanprisca marked this conversation as resolved.
Show resolved Hide resolved

func serviceFromFullMethod(method string) string {
match := fullMethodRegexp.FindAllStringSubmatch(method, 1)
stefanprisca marked this conversation as resolved.
Show resolved Hide resolved

if len(match) != 1 && len(match[1]) != 2 {
if (len(match) == 0) || (len(match) > 1 && len(match[1]) != 2) {
Aneurysm9 marked this conversation as resolved.
Show resolved Hide resolved
return ""
}

Expand Down
128 changes: 128 additions & 0 deletions plugin/grpctrace/interceptor_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
// Copyright The OpenTelemetry Authors
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just playing around a bit to see how to test this part. Should still wait on #684 and then merge these tests with those.

//
// 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 grpctrace

import (
"context"
"fmt"
"testing"

"google.golang.org/grpc"

"go.opentelemetry.io/otel/api/global"
export "go.opentelemetry.io/otel/sdk/export/trace"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

type testExporter struct {
spanMap map[string][]*export.SpanData
}

func (t *testExporter) ExportSpan(ctx context.Context, s *export.SpanData) {
var spans []*export.SpanData
var ok bool

if spans, ok = t.spanMap[s.Name]; !ok {
stefanprisca marked this conversation as resolved.
Show resolved Hide resolved
spans = []*export.SpanData{}
t.spanMap[s.Name] = spans
}
spans = append(spans, s)
t.spanMap[s.Name] = spans
}

type mockCCInvoker struct {
ctx context.Context
}

func (mcci *mockCCInvoker) invoke(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, opts ...grpc.CallOption) error {
mcci.ctx = ctx
return nil
}

type mockProtoMessage struct {
}

func (mm *mockProtoMessage) Reset() {}
func (mm *mockProtoMessage) String() string { return "mock" }
func (mm *mockProtoMessage) ProtoMessage() {}

func TestUCIFullyQualifiedMethodNameSetsServiceNameAttribute(t *testing.T) {

expectedServiceName := "serviceName"
fullyQualifiedName := fmt.Sprintf("/foo.%s/bar", expectedServiceName)

testUCISetsExpectedNameAttribute(t, fullyQualifiedName, expectedServiceName)
}

func TestUCISimpleMethodNameSetsServiceNameAttribute(t *testing.T) {
expectedServiceName := "serviceName"
simpleName := fmt.Sprintf("/%s/bar", expectedServiceName)

testUCISetsExpectedNameAttribute(t, simpleName, expectedServiceName)
}

func TestUCIUnamedMethodSetsEmptyNameAttribute(t *testing.T) {
expectedServiceName := ""
emptyName := fmt.Sprintf("/%s/bar", expectedServiceName)

testUCISetsExpectedNameAttribute(t, emptyName, expectedServiceName)
}

func TestUCILongMethodNameSetsServiceNameAttribute(t *testing.T) {
expectedServiceName := "serviceName"
emptyServiceFullName := fmt.Sprintf("/github.com/foo.baz/bar/foo.%s/bar", expectedServiceName)

testUCISetsExpectedNameAttribute(t, emptyServiceFullName, expectedServiceName)
}

func testUCISetsExpectedNameAttribute(t *testing.T, fullServiceName, expectedServiceName string) {
exp := &testExporter{make(map[string][]*export.SpanData)}
tp, _ := sdktrace.NewProvider(sdktrace.WithSyncer(exp), sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}))
global.SetTraceProvider(tp)
stefanprisca marked this conversation as resolved.
Show resolved Hide resolved

tr := tp.Tracer("grpctrace/client")
ctx, span := tr.Start(context.Background(), "test")
defer span.End()

clientConn, err := grpc.Dial("fake:connection", grpc.WithInsecure())

if err != nil {
t.Fatalf("failed to create client connection: %v", err)
}

unaryInt := UnaryClientInterceptor(tr)

req := &mockProtoMessage{}
reply := &mockProtoMessage{}
ccInvoker := &mockCCInvoker{}

err = unaryInt(ctx, fullServiceName, req, reply, clientConn, ccInvoker.invoke)
if err != nil {
t.Fatalf("failed to run unary interceptor: %v", err)
}

attributes := exp.spanMap[fullServiceName][0].Attributes

var actualServiceName string
for _, attr := range attributes {
if attr.Key == rpcServiceKey {
actualServiceName = attr.Value.AsString()
stefanprisca marked this conversation as resolved.
Show resolved Hide resolved
}
}

if expectedServiceName != actualServiceName {
t.Fatalf("invalid service name found. expected %s, actual %s",
expectedServiceName, actualServiceName)
}
}