[chore] Enable goleak for tests failing on opencensus-go (open-teleme…

…try#30457)

**Description:** 
This enables `goleak` checks for all packages whose only failure is due
to [a known
issue](census-instrumentation/opencensus-go#1191)
within the `opencensus-go` package. I believe it's safe to ignore for
two main reasons:
1. All references that I'm aware of are indirect, the contrib repo isn't
directly using the stat's worker functionality. The goroutine is started
in the dependency's `init()` so it's not something that we're causing.
2. We're actively moving away from the opencensus dependency, and hope
to remove it entirely soon. Relevant issue:
open-telemetry/opentelemetry-collector#816.
Once this work is complete the ignore will no longer be necessary and we
can safely remove it.

The only changes in this PR are test related. The same file is being
copied into different packages, and then we run `make gotidy`. No
functionality has been changed.

**Link to tracking Issue:** open-telemetry#30438

cmd/configschema/cfgmetadatagen/cfgmetadatagen/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cfgmetadatagen
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

cmd/configschema/go.mod

@@ -14,6 +14,7 @@ require (
  go.opentelemetry.io/collector/config/configtls v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/collector/otelcol v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/collector/receiver/otlpreceiver v0.93.1-0.20240125183026-3cacd40b27e8
+ go.uber.org/goleak v1.3.0
  golang.org/x/mod v0.14.0
  golang.org/x/text v0.14.0
  gopkg.in/yaml.v2 v2.4.0

cmd/mdatagen/go.mod

@@ -13,6 +13,7 @@ require (
  go.opentelemetry.io/collector/semconv v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/multierr v1.11.0
  go.uber.org/zap v1.26.0
  golang.org/x/text v0.14.0

cmd/mdatagen/internal/metadata/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package metadata
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/countconnector/go.mod

@@ -16,6 +16,7 @@ require (
  go.opentelemetry.io/collector/pdata v1.0.2-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/zap v1.26.0
 )
 

connector/countconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package countconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/exceptionsconnector/go.mod

@@ -15,6 +15,7 @@ require (
  go.opentelemetry.io/collector/semconv v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/zap v1.26.0
  google.golang.org/grpc v1.60.1
 )

connector/exceptionsconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package exceptionsconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/failoverconnector/go.mod

@@ -11,6 +11,7 @@ require (
  go.opentelemetry.io/collector/pdata v1.0.2-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/zap v1.26.0
 )
 

connector/failoverconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package failoverconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/routingconnector/go.mod

@@ -12,6 +12,7 @@ require (
  go.opentelemetry.io/collector/pdata v1.0.2-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/zap v1.26.0
 )
 

connector/routingconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package routingconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/servicegraphconnector/go.mod

@@ -11,6 +11,7 @@ require (
  go.opentelemetry.io/collector/consumer v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
 )
 
 require (

connector/servicegraphconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package servicegraphconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

connector/spanmetricsconnector/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package spanmetricsconnector
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/awskinesisexporter/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package awskinesisexporter
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/carbonexporter/go.mod

@@ -15,6 +15,7 @@ require (
  go.opentelemetry.io/collector/semconv v0.93.1-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/multierr v1.11.0
 )
 

exporter/carbonexporter/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package carbonexporter
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/cassandraexporter/go.mod

@@ -13,6 +13,7 @@ require (
  go.opentelemetry.io/collector/pdata v1.0.2-0.20240125183026-3cacd40b27e8
  go.opentelemetry.io/otel/metric v1.22.0
  go.opentelemetry.io/otel/trace v1.22.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/zap v1.26.0
 )
 

exporter/cassandraexporter/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package cassandraexporter
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/clickhouseexporter/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package clickhouseexporter
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/datadogexporter/internal/clientutil/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package clientutil
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}

exporter/datadogexporter/internal/logs/package_test.go

@@ -0,0 +1,17 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package logs
+
+import (
+ "testing"
+
+ "go.uber.org/goleak"
+)
+
+// The IgnoreTopFunction call prevents catching the leak generated by opencensus
+// defaultWorker.Start which at this time is part of the package's init call.
+// See https://github.com/census-instrumentation/opencensus-go/issues/1191 for more information.
+func TestMain(m *testing.M) {
+ goleak.VerifyTestMain(m, goleak.IgnoreTopFunction("go.opencensus.io/stats/view.(*worker).start"))
+}