[chore] Rename internal/scrapertest module to comparetest (#16802)

There is need to compare other types (not metrics only) and in other places (not scrapers only). So the module should be renamed to something more generic for comparing pdata instances in tests. Other name suggestions are welcome

.github/CODEOWNERS

@@ -101,7 +101,7 @@ internal/docker/                                     @open-telemetry/collector-c
 internal/k8sconfig/                                  @open-telemetry/collector-contrib-approvers @pmcollins @dmitryax
 internal/kubelet/                                    @open-telemetry/collector-contrib-approvers @dmitryax
 internal/metadataproviders/                          @open-telemetry/collector-contrib-approvers @jrcamp @Aneurysm9 @dashpole
-internal/scrapertest/                                @open-telemetry/collector-contrib-approvers @djaglowski
+internal/comparetest/                                @open-telemetry/collector-contrib-approvers @djaglowski
 internal/splunk/                                     @open-telemetry/collector-contrib-approvers @pmcollins @dmitryax
 internal/tools/                                      @open-telemetry/collector-contrib-approvers
 internal/coreinternal/                               @open-telemetry/collector-contrib-approvers @open-telemetry/collector-approvers

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -89,13 +89,13 @@ body:
       - extension/storage/dbstorage
       - extension/storage/filestorage
       - internal/aws
+      - internal/comparetest
       - internal/core
       - internal/docker
       - internal/filter
       - internal/k8sconfig
       - internal/kubelet
       - internal/metadataproviders
-      - internal/scrapertest
       - internal/sharedcomponent
       - internal/splunk
       - internal/tools

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -83,13 +83,13 @@ body:
       - extension/storage/dbstorage
       - extension/storage/filestorage
       - internal/aws
+      - internal/comparetest
       - internal/core
       - internal/docker
       - internal/filter
       - internal/k8sconfig
       - internal/kubelet
       - internal/metadataproviders
-      - internal/scrapertest
       - internal/sharedcomponent
       - internal/splunk
       - internal/tools

.github/ISSUE_TEMPLATE/other.yaml

@@ -83,13 +83,13 @@ body:
       - extension/storage/dbstorage
       - extension/storage/filestorage
       - internal/aws
+      - internal/comparetest
       - internal/core
       - internal/docker
       - internal/filter
       - internal/k8sconfig
       - internal/kubelet
       - internal/metadataproviders
-      - internal/scrapertest
       - internal/sharedcomponent
       - internal/splunk
       - internal/tools

.github/dependabot.yml

@@ -346,6 +346,10 @@ updates:
     directory: "/internal/common"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "gomod"
+    directory: "/internal/comparetest"
+    schedule:
+      interval: "weekly"
   - package-ecosystem: "gomod"
     directory: "/internal/coreinternal"
     schedule:
@@ -370,10 +374,6 @@ updates:
     directory: "/internal/metadataproviders"
     schedule:
       interval: "weekly"
-  - package-ecosystem: "gomod"
-    directory: "/internal/scrapertest"
-    schedule:
-      interval: "weekly"
   - package-ecosystem: "gomod"
     directory: "/internal/sharedcomponent"
     schedule:

cmd/configschema/go.mod

@@ -714,7 +714,7 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/kubel
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/metadataproviders => ../../internal/metadataproviders
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent => ../../internal/sharedcomponent
 

cmd/otelcontribcol/go.mod

@@ -734,7 +734,7 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/metad
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/metrics => ../../internal/aws/metrics
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/otlpjsonfilereceiver => ../../receiver/otlpjsonfilereceiver
 

cmd/oteltestbedcol/go.mod

@@ -282,7 +282,7 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/exporter/f5clo
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk => ../../internal/splunk
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/receiver/dotnetdiagnosticsreceiver => ../../receiver/dotnetdiagnosticsreceiver
 

exporter/datadogexporter/go.mod

@@ -215,7 +215,7 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza =>
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage => ../../extension/storage
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/filter => ../../internal/filter
 

go.mod

@@ -718,7 +718,7 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/kubel
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/metadataproviders => ./internal/metadataproviders
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ./internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ./internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/sharedcomponent => ./internal/sharedcomponent
 

internal/scrapertest/README.md → internal/comparetest/README.md

@@ -1,4 +1,4 @@
-# scrapertest
+# comparetest
 
 This module provides a mechanism for capturing and comparing expected metric results.
 
@@ -23,7 +23,7 @@ func TestScraper(t *testing.T) {
   expectedMetrics, err := golden.ReadMetrics(expectedFile)
   require.NoError(t, err)
 
-  require.NoError(t, scrapertest.CompareMetrics(expectedMetrics, actualMetrics))
+  require.NoError(t, comparetest.CompareMetrics(expectedMetrics, actualMetrics))
 }
 ```
 
@@ -60,6 +60,6 @@ func TestScraper(t *testing.T) {
   expectedMetrics, err := golden.ReadMetrics(expectedFile)
   require.NoError(t, err)
 
-  require.NoError(t, scrapertest.CompareMetrics(expectedMetrics, actualMetrics))
+  require.NoError(t, comparetest.CompareMetrics(expectedMetrics, actualMetrics))
 }
 ```

internal/scrapertest/compare.go → internal/comparetest/compare.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package scrapertest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
+package comparetest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
 
 import (
 	"fmt"

internal/scrapertest/compare_test.go → internal/comparetest/compare_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package scrapertest
+package comparetest
 
 import (
 	"errors"
@@ -22,7 +22,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/multierr"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 )
 
 type expectation struct {

internal/scrapertest/go.mod → internal/comparetest/go.mod

@@ -1,4 +1,4 @@
-module github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest
+module github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest
 
 go 1.18
 

internal/scrapertest/golden/golden.go → internal/comparetest/golden/golden.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package golden // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+package golden // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 
 import (
 	"encoding/json"

internal/scrapertest/mask.go → internal/comparetest/mask.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package scrapertest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
+package comparetest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
 
 import (
 	"fmt"

internal/scrapertest/sort/attributes.go → internal/comparetest/sort/attributes.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package sort // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/sort"
+package sort // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/sort"
 
 import (
 	"strings"

internal/scrapertest/util.go → internal/comparetest/util.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package scrapertest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
+package comparetest // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
 
 import (
 	"fmt"

pkg/winperfcounters/go.mod

@@ -16,6 +16,6 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 retract v0.65.0

processor/metricstransformprocessor/go.mod

@@ -3,7 +3,7 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/processor/metri
 go 1.18
 
 require (
-	github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest v0.66.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest v0.66.0
 	github.com/stretchr/testify v1.8.1
 	go.opentelemetry.io/collector v0.66.1-0.20221202005155-1c54042beb70
 	go.opentelemetry.io/collector/component v0.66.1-0.20221202005155-1c54042beb70
@@ -50,6 +50,6 @@ replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/translator
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal => ../../internal/coreinternal
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 retract v0.65.0

processor/metricstransformprocessor/metrics_transform_processor_group_test.go

@@ -29,8 +29,8 @@ import (
 	"go.opentelemetry.io/collector/processor/processorhelper"
 	"go.uber.org/zap"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 )
 
 type metricsGroupingTest struct {
@@ -102,7 +102,7 @@ func TestMetricsGrouping(t *testing.T) {
 
 				got := next.AllMetrics()
 				require.Equal(t, 1, len(got))
-				require.NoError(t, scrapertest.CompareMetrics(expected, got[0], scrapertest.IgnoreMetricValues()))
+				require.NoError(t, comparetest.CompareMetrics(expected, got[0], comparetest.IgnoreMetricValues()))
 
 				assert.NoError(t, mtp.Shutdown(context.Background()))
 			})

receiver/activedirectorydsreceiver/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/google/go-cmp v0.5.9
-	github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest v0.66.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest v0.66.0
 	github.com/open-telemetry/opentelemetry-collector-contrib/pkg/winperfcounters v0.66.0
 	github.com/stretchr/testify v1.8.1
 	go.opentelemetry.io/collector v0.66.1-0.20221202005155-1c54042beb70
@@ -44,7 +44,7 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 replace github.com/open-telemetry/opentelemetry-collector-contrib/pkg/winperfcounters => ../../pkg/winperfcounters
 

receiver/activedirectorydsreceiver/integration_test.go

@@ -25,8 +25,8 @@ import (
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 )
 
 /*
@@ -54,7 +54,7 @@ func TestIntegration(t *testing.T) {
 	expectedMetrics, err := golden.ReadMetrics(goldenScrapePath)
 	require.NoError(t, err)
 
-	err = scrapertest.CompareMetrics(expectedMetrics, actualMetrics, scrapertest.IgnoreMetricValues())
+	err = comparetest.CompareMetrics(expectedMetrics, actualMetrics, comparetest.IgnoreMetricValues())
 	require.NoError(t, err)
 
 	err = recv.Shutdown(context.Background())

receiver/activedirectorydsreceiver/scraper_test.go

@@ -27,8 +27,8 @@ import (
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/receiver/scrapererror"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/winperfcounters"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/activedirectorydsreceiver/internal/metadata"
 )
@@ -56,7 +56,7 @@ func TestScrape(t *testing.T) {
 		expectedMetrics, err := golden.ReadMetrics(goldenScrapePath)
 		require.NoError(t, err)
 
-		err = scrapertest.CompareMetrics(expectedMetrics, scrapeData)
+		err = comparetest.CompareMetrics(expectedMetrics, scrapeData)
 		require.NoError(t, err)
 
 		err = scraper.shutdown(context.Background())
@@ -91,7 +91,7 @@ func TestScrape(t *testing.T) {
 		expectedMetrics, err := golden.ReadMetrics(partialScrapePath)
 		require.NoError(t, err)
 
-		err = scrapertest.CompareMetrics(expectedMetrics, scrapeData)
+		err = comparetest.CompareMetrics(expectedMetrics, scrapeData)
 		require.NoError(t, err)
 
 		err = scraper.shutdown(context.Background())

receiver/aerospikereceiver/go.mod

@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/aerospike/aerospike-client-go/v6 v6.7.0
-	github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest v0.66.0
+	github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest v0.66.0
 	github.com/stretchr/testify v1.8.1
 	github.com/testcontainers/testcontainers-go v0.15.0
 	go.opentelemetry.io/collector v0.66.1-0.20221202005155-1c54042beb70
@@ -68,6 +68,6 @@ require (
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
-replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest => ../../internal/scrapertest
+replace github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest => ../../internal/comparetest
 
 retract v0.65.0

receiver/aerospikereceiver/integration_test.go

@@ -34,8 +34,7 @@ import (
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest/golden"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest/golden"
 )
 
 type doneCheckable interface {
@@ -316,7 +315,7 @@ func TestAerospikeIntegration(t *testing.T) {
 	expectedMetrics, err := golden.ReadMetrics(expectedFile)
 	require.NoError(t, err, "failed reading expected metrics")
 
-	require.NoError(t, scrapertest.CompareMetrics(expectedMetrics, actualMetrics, scrapertest.IgnoreMetricValues(), scrapertest.IgnoreResourceAttributeValue("aerospike.node.name")))
+	require.NoError(t, comparetest.CompareMetrics(expectedMetrics, actualMetrics, comparetest.IgnoreMetricValues(), comparetest.IgnoreResourceAttributeValue("aerospike.node.name")))
 
 	// now do a run in cluster mode
 	cfg.CollectClusterMetrics = true
@@ -338,6 +337,6 @@ func TestAerospikeIntegration(t *testing.T) {
 	expectedMetrics, err = golden.ReadMetrics(expectedFile)
 	require.NoError(t, err, "failed reading expected metrics")
 
-	require.NoError(t, scrapertest.CompareMetrics(expectedMetrics, actualMetrics, scrapertest.IgnoreMetricValues(), scrapertest.IgnoreResourceAttributeValue("aerospike.node.name")))
+	require.NoError(t, comparetest.CompareMetrics(expectedMetrics, actualMetrics, comparetest.IgnoreMetricValues(), comparetest.IgnoreResourceAttributeValue("aerospike.node.name")))
 
 }

receiver/aerospikereceiver/scraper_test.go

@@ -28,7 +28,7 @@ import (
 	"go.opentelemetry.io/collector/pdata/pmetric"
 	"go.uber.org/zap"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/scrapertest"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/comparetest"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/aerospikereceiver/internal/metadata"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/aerospikereceiver/mocks"
 )
@@ -152,7 +152,7 @@ func TestScrape_CollectClusterMetrics(t *testing.T) {
 	require.EqualError(t, err, "failed to parse int64 for AerospikeNamespaceMemoryUsage, value was badval: strconv.ParseInt: parsing \"badval\": invalid syntax")
 
 	expectedMetrics := expectedMB.Emit()
-	require.NoError(t, scrapertest.CompareMetrics(expectedMetrics, actualMetrics))
+	require.NoError(t, comparetest.CompareMetrics(expectedMetrics, actualMetrics))
 
 	require.NoError(t, receiver.shutdown(context.Background()))