chore(instrument): rework test files (#383)

Use `instrument_test` package for tests of the public API. This ensures
all test packaging styles are in use in this package; which is a good
thing for some package-loading tests.

instrument/instrument.go

@@ -14,33 +14,6 @@ import (
 	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
 )
 
-func getOpName(metadata ...any) string {
-	rank := map[string]int{
-		"verb":          1,
-		"function-name": 2,
-	}
-
-	var (
-		opname string
-		oprank = 10_000 // just a higher number than any key in the rank map.
-	)
-	for i := 0; i < len(metadata); i += 2 {
-		if i+1 >= len(metadata) {
-			break
-		}
-		if k, ok := metadata[i].(string); ok {
-			if r, ok := rank[k]; ok && r < oprank {
-				if on, ok := metadata[i+1].(string); ok {
-					opname = on
-					oprank = r
-					continue
-				}
-			}
-		}
-	}
-	return opname
-}
-
 func Report(ctx context.Context, e event.Event, metadata ...any) context.Context {
 	var span tracer.Span
 	if e == event.EventStart || e == event.EventCall {

instrument/instrument_test.go

@@ -3,12 +3,13 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2023-present Datadog, Inc.
 
-package instrument
+package instrument_test
 
 import (
 	"context"
 	"testing"
 
+	"github.com/DataDog/orchestrion/instrument"
 	"github.com/DataDog/orchestrion/instrument/event"
 
 	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
@@ -17,65 +18,33 @@ import (
 func TestReport(t *testing.T) {
 	t.Run("start", func(t *testing.T) {
 		ctx := context.Background()
-		ctx = Report(ctx, event.EventStart)
+		ctx = instrument.Report(ctx, event.EventStart)
 		if _, ok := tracer.SpanFromContext(ctx); !ok {
 			t.Errorf("Expected Report of StartEvent to generate a new ID.")
 		}
 	})
 
 	t.Run("call", func(t *testing.T) {
 		ctx := context.Background()
-		ctx = Report(ctx, event.EventCall)
+		ctx = instrument.Report(ctx, event.EventCall)
 		if _, ok := tracer.SpanFromContext(ctx); !ok {
 			t.Errorf("Expected Report of CallEvent to generate a new ID.")
 		}
 	})
 
 	t.Run("end", func(t *testing.T) {
 		ctx := context.Background()
-		ctx = Report(ctx, event.EventEnd)
+		ctx = instrument.Report(ctx, event.EventEnd)
 		if _, ok := tracer.SpanFromContext(ctx); ok {
 			t.Errorf("Expected Report of EndEvent not to generate a new ID.")
 		}
 	})
 
 	t.Run("return", func(t *testing.T) {
 		ctx := context.Background()
-		ctx = Report(ctx, event.EventReturn)
+		ctx = instrument.Report(ctx, event.EventReturn)
 		if _, ok := tracer.SpanFromContext(ctx); ok {
 			t.Errorf("Expected Report of ReturnEvent not to generate a new ID.")
 		}
 	})
 }
-
-func TestGetOpName(t *testing.T) {
-	for _, tt := range []struct {
-		metadata []any
-		opname   string
-	}{
-		{
-			metadata: []any{"foo", "bar", "verb", "just-verb"},
-			opname:   "just-verb",
-		},
-		{
-			metadata: []any{"foo", "bar", "function-name", "just-function-name"},
-			opname:   "just-function-name",
-		},
-		{
-			metadata: []any{"foo", "bar", "verb", "verb-function-name", "function-name", "THIS IS WRONG"},
-			opname:   "verb-function-name",
-		},
-		{
-			// Checking different order
-			metadata: []any{"foo", "bar", "function-name", "THIS IS WRONG", "verb", "verb-function-name"},
-			opname:   "verb-function-name",
-		},
-	} {
-		t.Run(tt.opname, func(t *testing.T) {
-			n := getOpName(tt.metadata...)
-			if n != tt.opname {
-				t.Errorf("Expected %s, but got %s\n", tt.opname, n)
-			}
-		})
-	}
-}

instrument/opname.go

@@ -0,0 +1,33 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2023-present Datadog, Inc.
+
+package instrument
+
+func getOpName(metadata ...any) string {
+	rank := map[string]int{
+		"verb":          1,
+		"function-name": 2,
+	}
+
+	var (
+		opname string
+		oprank = 10_000 // just a higher number than any key in the rank map.
+	)
+	for i := 0; i < len(metadata); i += 2 {
+		if i+1 >= len(metadata) {
+			break
+		}
+		if k, ok := metadata[i].(string); ok {
+			if r, ok := rank[k]; ok && r < oprank {
+				if on, ok := metadata[i+1].(string); ok {
+					opname = on
+					oprank = r
+					continue
+				}
+			}
+		}
+	}
+	return opname
+}

instrument/opname_test.go

@@ -0,0 +1,40 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2023-present Datadog, Inc.
+
+package instrument
+
+import "testing"
+
+func TestGetOpName(t *testing.T) {
+	for _, tt := range []struct {
+		metadata []any
+		opname   string
+	}{
+		{
+			metadata: []any{"foo", "bar", "verb", "just-verb"},
+			opname:   "just-verb",
+		},
+		{
+			metadata: []any{"foo", "bar", "function-name", "just-function-name"},
+			opname:   "just-function-name",
+		},
+		{
+			metadata: []any{"foo", "bar", "verb", "verb-function-name", "function-name", "THIS IS WRONG"},
+			opname:   "verb-function-name",
+		},
+		{
+			// Checking different order
+			metadata: []any{"foo", "bar", "function-name", "THIS IS WRONG", "verb", "verb-function-name"},
+			opname:   "verb-function-name",
+		},
+	} {
+		t.Run(tt.opname, func(t *testing.T) {
+			n := getOpName(tt.metadata...)
+			if n != tt.opname {
+				t.Errorf("Expected %s, but got %s\n", tt.opname, n)
+			}
+		})
+	}
+}

instrument/orchestrion.tool.go

@@ -0,0 +1,13 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2023-present Datadog, Inc.
+
+//go:build tools
+
+package instrument
+
+// Ensures that `orchestrion.tool.go` files importing this package include all
+// the necessary transitive dependencies for all possible integrations, and
+// correctly discover the aspects to inject.
+import _ "github.com/DataDog/orchestrion/internal/injector/builtin"