refactor: update all unit tests in instrumetation libraries with InitCollector API (#1036)

refactor: update all unit tests in instrumentation libraries with InitCollector API

Author: Angith

example_httpserver_test.go

@@ -13,10 +13,13 @@ import (
 
 // This example shows how to instrument an HTTP server with Instana tracing
 func Example_tracingNamedHandlerFunc() {
-	sensor := instana.NewSensor("my-http-server")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-server",
+	})
+	defer instana.ShutdownCollector()
 
 	// To instrument a handler function, pass it as an argument to instana.TracingHandlerFunc()
-	http.HandleFunc("/", instana.TracingHandlerFunc(sensor, "/", func(w http.ResponseWriter, req *http.Request) {
+	http.HandleFunc("/", instana.TracingHandlerFunc(c, "/", func(w http.ResponseWriter, req *http.Request) {
 		// Extract the parent span and use its tracer to initialize any child spans to trace the calls
 		// inside the handler, e.g. database queries, 3rd-party API requests, etc.
 		if parent, ok := instana.SpanFromContext(req.Context()); ok {
@@ -32,7 +35,7 @@ func Example_tracingNamedHandlerFunc() {
 	// In case your handler is implemented as an http.Handler, pass its ServeHTTP method instead.
 	// You can also use instana.TracingNamedHandlerFunc() to provide a unique route identifier to
 	// group the calls to this route later in Instana UI.
-	http.HandleFunc("/files", instana.TracingNamedHandlerFunc(sensor, "index", "/:path", http.FileServer(http.Dir("./")).ServeHTTP))
+	http.HandleFunc("/files", instana.TracingNamedHandlerFunc(c, "index", "/:path", http.FileServer(http.Dir("./")).ServeHTTP))
 
 	if err := http.ListenAndServe(":0", nil); err != nil {
 		log.Fatalf("failed to start server: %s", err)
@@ -42,7 +45,10 @@ func Example_tracingNamedHandlerFunc() {
 // This example demonstrates how to instrument a 3rd-party HTTP router that uses pattern matching to make sure
 // the original path template is forwarded to Instana
 func Example_httpRoutePatternMatching() {
-	sensor := instana.NewSensor("my-http-server")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-server",
+	})
+	defer instana.ShutdownCollector()
 
 	// Initialize your router. Here for simplicity we use stdlib http.ServeMux, however you
 	// can use any router that supports http.Handler/http.HandlerFunc, such as github.com/gorilla/mux
@@ -53,7 +59,7 @@ func Example_httpRoutePatternMatching() {
 	// in UI as `http.path_tpl` if the request path is different (we assume that this request
 	// has been routed to the handler via a matched pattern)
 	r.HandleFunc("/articles/{category}/{id:[0-9]+}", instana.TracingHandlerFunc(
-		sensor,
+		c,
 		"/articles/{category}/{id:[0-9]+}",
 		func(w http.ResponseWriter, req *http.Request) {
 			// ...

example_instrumentation_go1.10_test.go

@@ -14,20 +14,23 @@ import (
 func ExampleWrapSQLConnector() {
 	// Here we initialize a new instance of instana.Sensor, however it is STRONGLY recommended
 	// to use a single instance throughout your application
-	sensor := instana.NewSensor("my-http-client")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-client",
+	})
+	defer instana.ShutdownCollector()
 
 	// Instrument the connector. Normally this would be a type provided by the driver library.
 	// Here we use a test mock to avoid bringing external dependencies.
 	//
 	// Note that instana.WrapSQLConnector() requires the connection string to send it later
 	// along with database spans.
-	connector := instana.WrapSQLConnector(sensor, "driver connection string", &sqlConnector{})
+	connector := instana.WrapSQLConnector(c, "driver connection string", &sqlConnector{})
 
 	// Use wrapped connector to initialize the database client. Note that
 	db := sql.OpenDB(connector)
 
 	// Inject parent span into the context
-	span := sensor.Tracer().StartSpan("entry")
+	span := c.Tracer().StartSpan("entry")
 	ctx := instana.ContextWithSpan(context.Background(), span)
 
 	// Query the database, passing the context containing the active span

example_instrumentation_test.go

@@ -15,9 +15,12 @@ import (
 func ExampleTracingHandlerFunc() {
 	// Here we initialize a new instance of instana.Sensor, however it is STRONGLY recommended
 	// to use a single instance throughout your application
-	sensor := instana.NewSensor("my-http-server")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-server",
+	})
+	defer instana.ShutdownCollector()
 
-	http.HandleFunc("/", instana.TracingNamedHandlerFunc(sensor, "root", "/", func(w http.ResponseWriter, req *http.Request) {
+	http.HandleFunc("/", instana.TracingNamedHandlerFunc(c, "root", "/", func(w http.ResponseWriter, req *http.Request) {
 		// handler code
 	}))
 }
@@ -26,16 +29,20 @@ func ExampleTracingHandlerFunc() {
 func ExampleRoundTripper() {
 	// Here we initialize a new instance of instana.Sensor, however it is STRONGLY recommended
 	// to use a single instance throughout your application
-	sensor := instana.NewSensor("my-http-client")
-	span := sensor.Tracer().StartSpan("entry")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-server",
+	})
+	defer instana.ShutdownCollector()
+
+	span := c.Tracer().StartSpan("entry")
 
 	// Make sure to finish the span so it can be properly recorded in the backend
 	defer span.Finish()
 
 	// http.DefaultTransport is used as a default RoundTripper, however you can provide
 	// your own implementation
 	client := &http.Client{
-		Transport: instana.RoundTripper(sensor, nil),
+		Transport: instana.RoundTripper(c, nil),
 	}
 
 	// Inject parent span into the request context
@@ -50,17 +57,20 @@ func ExampleRoundTripper() {
 func ExampleSQLOpen() {
 	// Here we initialize a new instance of instana.Sensor, however it is STRONGLY recommended
 	// to use a single instance throughout your application
-	sensor := instana.NewSensor("my-http-client")
+	c := instana.InitCollector(&instana.Options{
+		Service: "my-http-server",
+	})
+	defer instana.ShutdownCollector()
 
 	// Instrument the driver. Normally this would be a type provided by the driver library, e.g.
 	// pq.Driver{} or mysql.Driver{}, but here we use a test mock to avoid bringing external dependencies
-	instana.InstrumentSQLDriver(sensor, "your_db_driver", sqlDriver{})
+	instana.InstrumentSQLDriver(c, "your_db_driver", sqlDriver{})
 
 	// Replace sql.Open() with instana.SQLOpen()
 	db, _ := instana.SQLOpen("your_db_driver", "driver connection string")
 
 	// Inject parent span into the context
-	span := sensor.Tracer().StartSpan("entry")
+	span := c.Tracer().StartSpan("entry")
 	ctx := instana.ContextWithSpan(context.Background(), span)
 
 	// Query the database, passing the context containing the active span

instrumentation/cloud.google.com/go/pubsub/example_test.go

@@ -15,11 +15,14 @@ import (
 // This example show how to instrument and HTTP handler that receives Google Cloud Pub/Sub messages
 // via the push delivery method.
 func ExampleTracingHandlerFunc() {
-	// Initialize sensor
-	sensor := instana.NewSensor("pubsub-consumer")
+	// Initialize collector
+	c := instana.InitCollector(&instana.Options{
+		Service: "pubsub-consumer",
+	})
+	defer instana.ShutdownCollector()
 
 	// Wrap your Pub/Sub message handler with pubsub.TracingHandlerFunc
-	http.Handle("/", pubsub.TracingHandlerFunc(sensor, "/", func(w http.ResponseWriter, req *http.Request) {
+	http.Handle("/", pubsub.TracingHandlerFunc(c, "/", func(w http.ResponseWriter, req *http.Request) {
 		var delivery struct {
 			Message struct {
 				Data []byte `json:"data"`

instrumentation/cloud.google.com/go/pubsub/pubsub_test.go

@@ -27,12 +27,14 @@ func TestClient_Topic(t *testing.T) {
 	defer teardown()
 
 	recorder := instana.NewTestRecorder()
-	tracer := instana.NewTracerWithEverything(&instana.Options{AgentClient: alwaysReadyClient{}}, recorder)
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    recorder,
+	})
 
-	sensor := instana.NewSensorWithTracer(tracer)
-	defer instana.ShutdownSensor()
+	defer instana.ShutdownCollector()
 
-	pSpan := tracer.StartSpan("parent-span")
+	pSpan := c.StartSpan("parent-span")
 	ctx := context.Background()
 	if pSpan != nil {
 		ctx = instana.ContextWithSpan(ctx, pSpan)
@@ -45,23 +47,23 @@ func TestClient_Topic(t *testing.T) {
 
 	examples := map[string]func(*testing.T, *pubsub.Message) *pubsub.PublishResult{
 		"ClientProject": func(t *testing.T, msg *pubsub.Message) *pubsub.PublishResult {
-			client, err := pubsub.NewClient(ctx, "test-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(ctx, "test-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			top := client.Topic("test-topic")
 
 			return top.Publish(ctx, msg)
 		},
 		"OtherProject": func(t *testing.T, msg *pubsub.Message) *pubsub.PublishResult {
-			client, err := pubsub.NewClient(ctx, "other-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(ctx, "other-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			top := client.TopicInProject("test-topic", "test-project")
 
 			return top.Publish(ctx, msg)
 		},
 		"CreateTopic": func(t *testing.T, msg *pubsub.Message) *pubsub.PublishResult {
-			client, err := pubsub.NewClient(ctx, "test-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(ctx, "test-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			top, err := client.CreateTopic(ctx, "new-test-topic")
@@ -70,7 +72,7 @@ func TestClient_Topic(t *testing.T) {
 			return top.Publish(ctx, msg)
 		},
 		"CreateTopicWithConfig": func(t *testing.T, msg *pubsub.Message) *pubsub.PublishResult {
-			client, err := pubsub.NewClient(ctx, "test-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(ctx, "test-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			conf := &gpubsub.TopicConfig{
@@ -140,13 +142,11 @@ func TestClient_Topics(t *testing.T) {
 	require.NoError(t, err)
 	defer teardown()
 
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(
-			instana.DefaultOptions(),
-			instana.NewTestRecorder(),
-		),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    instana.NewTestRecorder(),
+	})
+	defer instana.ShutdownCollector()
 
 	topicNames := []string{"first-topic", "second-topic"}
 
@@ -157,7 +157,7 @@ func TestClient_Topics(t *testing.T) {
 		require.NoError(t, err)
 	}
 
-	client, err := pubsub.NewClient(context.Background(), "test-project", sensor, option.WithGRPCConn(conn))
+	client, err := pubsub.NewClient(context.Background(), "test-project", c, option.WithGRPCConn(conn))
 	require.NoError(t, err)
 
 	var res []*pubsub.PublishResult
@@ -196,13 +196,11 @@ func TestClient_Subscription(t *testing.T) {
 	require.NoError(t, err)
 	defer teardown()
 
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(
-			instana.DefaultOptions(),
-			instana.NewTestRecorder(),
-		),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    instana.NewTestRecorder(),
+	})
+	defer instana.ShutdownCollector()
 
 	top, err := srv.GServer.CreateTopic(context.Background(), &pb.Topic{
 		Name: "projects/test-project/topics/test-topic",
@@ -221,7 +219,7 @@ func TestClient_Subscription(t *testing.T) {
 			})
 			require.NoError(t, err)
 
-			client, err := pubsub.NewClient(context.Background(), "test-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(context.Background(), "test-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			return client.Subscription("test-subscription")
@@ -237,14 +235,14 @@ func TestClient_Subscription(t *testing.T) {
 			})
 			require.NoError(t, err)
 
-			client, err := pubsub.NewClient(context.Background(), "other-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(context.Background(), "other-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			return client.SubscriptionInProject("test-subscription", "test-project")
 		},
 
 		"CreateSubscriptionWithConfig": func(t *testing.T, topicName string) *pubsub.Subscription {
-			client, err := pubsub.NewClient(context.Background(), "test-project", sensor, option.WithGRPCConn(conn))
+			client, err := pubsub.NewClient(context.Background(), "test-project", c, option.WithGRPCConn(conn))
 			require.NoError(t, err)
 
 			sub, err := client.CreateSubscription(context.Background(), "test-subscription", gpubsub.SubscriptionConfig{
@@ -288,13 +286,11 @@ func TestClient_Subscriptions(t *testing.T) {
 	require.NoError(t, err)
 	defer teardown()
 
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(
-			instana.DefaultOptions(),
-			instana.NewTestRecorder(),
-		),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    instana.NewTestRecorder(),
+	})
+	defer instana.ShutdownCollector()
 
 	top, err := srv.GServer.CreateTopic(context.Background(), &pb.Topic{
 		Name: "projects/test-project/topics/test-topic",
@@ -311,7 +307,7 @@ func TestClient_Subscriptions(t *testing.T) {
 		require.NoError(t, err)
 	}
 
-	client, err := pubsub.NewClient(context.Background(), "test-project", sensor, option.WithGRPCConn(conn))
+	client, err := pubsub.NewClient(context.Background(), "test-project", c, option.WithGRPCConn(conn))
 	require.NoError(t, err)
 
 	var subs []string

instrumentation/cloud.google.com/go/pubsub/push_test.go

@@ -24,10 +24,11 @@ import (
 
 func TestTracingHandler(t *testing.T) {
 	recorder := instana.NewTestRecorder()
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(&instana.Options{AgentClient: alwaysReadyClient{}}, recorder),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    recorder,
+	})
+	defer instana.ShutdownCollector()
 
 	payload, err := ioutil.ReadFile("testdata/message.json")
 	require.NoError(t, err)
@@ -36,7 +37,7 @@ func TestTracingHandler(t *testing.T) {
 		numCalls int
 		reqSpan  opentracing.Span
 	)
-	h := pubsub.TracingHandlerFunc(sensor, "/", func(w http.ResponseWriter, req *http.Request) {
+	h := pubsub.TracingHandlerFunc(c, "/", func(w http.ResponseWriter, req *http.Request) {
 		numCalls++
 
 		var ok bool
@@ -88,16 +89,17 @@ func TestTracingHandler(t *testing.T) {
 
 func TestTracingHandlerFunc_TracePropagation(t *testing.T) {
 	recorder := instana.NewTestRecorder()
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(&instana.Options{AgentClient: alwaysReadyClient{}}, recorder),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    recorder,
+	})
+	defer instana.ShutdownCollector()
 
 	payload, err := ioutil.ReadFile("testdata/message_with_context.json")
 	require.NoError(t, err)
 
 	var numCalls int
-	h := pubsub.TracingHandlerFunc(sensor, "/", func(w http.ResponseWriter, req *http.Request) {
+	h := pubsub.TracingHandlerFunc(c, "/", func(w http.ResponseWriter, req *http.Request) {
 		numCalls++
 
 		_, ok := instana.SpanFromContext(req.Context())
@@ -146,13 +148,14 @@ func TestTracingHandlerFunc_TracePropagation(t *testing.T) {
 
 func TestTracingHandlerFunc_NotPubSub(t *testing.T) {
 	recorder := instana.NewTestRecorder()
-	sensor := instana.NewSensorWithTracer(
-		instana.NewTracerWithEverything(&instana.Options{AgentClient: alwaysReadyClient{}}, recorder),
-	)
-	defer instana.ShutdownSensor()
+	c := instana.InitCollector(&instana.Options{
+		AgentClient: alwaysReadyClient{},
+		Recorder:    recorder,
+	})
+	defer instana.ShutdownCollector()
 
 	var numCalls int
-	h := pubsub.TracingHandlerFunc(sensor, "/", func(w http.ResponseWriter, req *http.Request) {
+	h := pubsub.TracingHandlerFunc(c, "/", func(w http.ResponseWriter, req *http.Request) {
 		numCalls++
 
 		_, ok := instana.SpanFromContext(req.Context())