Add a test to prove the Tracer is safe for concurrent calls (#1665)

* Add test to prove the Tracer is safe for concurrent calls * Fix NotToPanic of harness never call the input func * Fix tests Co-authored-by: Tyler Yahn <[email protected]> Co-authored-by: Anthony Mirabella <[email protected]>
open-telemetry · Mar 16, 2021 · 28eaaa9 · 28eaaa9
1 parent 8b1be11
commit 28eaaa9
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 deletions.
diff --git a/internal/matchers/expectation.go b/internal/matchers/expectation.go
@@ -84,8 +84,19 @@ func (e *Expectation) ToBeFalse() {
 }
 
 func (e *Expectation) NotToPanic() {
-	if actual := recover(); actual != nil {
-		e.fail(fmt.Sprintf("Expected panic\n\t%v\nto have not been raised", actual))
+	switch a := e.actual.(type) {
+	case func():
+		func() {
+			defer func() {
+				if recovered := recover(); recovered != nil {
+					e.fail(fmt.Sprintf("Expected panic\n\t%v\nto have not been raised", recovered))
+				}
+			}()
+
+			a()
+		}()
+	default:
+		e.fail(fmt.Sprintf("Cannot check if non-func value\n\t%v\nis truthy", a))
 	}
 }
 

diff --git a/internal/tools/tools.go b/internal/tools/tools.go
@@ -18,8 +18,8 @@ package tools
 
 import (
 	_ "github.com/client9/misspell/cmd/misspell"
+	_ "github.com/gogo/protobuf/protoc-gen-gogofast"
 	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
 	_ "github.com/itchyny/gojq"
 	_ "golang.org/x/tools/cmd/stringer"
-	_ "github.com/gogo/protobuf/protoc-gen-gogofast"
 )
diff --git a/oteltest/harness.go b/oteltest/harness.go
@@ -217,6 +217,44 @@ func (h *Harness) TestTracer(subjectFactory func() trace.Tracer) {
 			e.Expect(csc.TraceID()).NotToEqual(psc.TraceID())
 			e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
 		})
+
+		t.Run("all methods are safe to be called concurrently", func(t *testing.T) {
+			t.Parallel()
+
+			e := matchers.NewExpecter(t)
+			tracer := subjectFactory()
+
+			ctx, parent := tracer.Start(context.Background(), "span")
+
+			runner := func(tp trace.Tracer) <-chan struct{} {
+				done := make(chan struct{})
+				go func(tp trace.Tracer) {
+					var wg sync.WaitGroup
+					for i := 0; i < 20; i++ {
+						wg.Add(1)
+						go func(name string) {
+							defer wg.Done()
+							_, child := tp.Start(ctx, name)
+
+							psc := parent.SpanContext()
+							csc := child.SpanContext()
+
+							e.Expect(csc.TraceID()).ToEqual(psc.TraceID())
+							e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
+						}(fmt.Sprintf("span %d", i))
+					}
+					wg.Wait()
+					done <- struct{}{}
+				}(tp)
+				return done
+			}
+
+			e.Expect(func() {
+				done := runner(tracer)
+
+				<-done
+			}).NotToPanic()
+		})
 	})
 
 	h.testSpan(subjectFactory)