[metadatatest] Generate NewSettings that accepts componenttest.Telemetry

Signed-off-by: Bogdan Drutu <[email protected]>

Author: bogdandrutu

.chloggen/newsettings.yaml

@@ -0,0 +1,25 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: metadatatest
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Generate NewSettings that accepts componenttest.Telemetry
+
+# One or more tracking issues or pull requests related to the change
+issues: [12216]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go

@@ -26,17 +26,17 @@ func TestGeneratedMetrics(t *testing.T) {
 }
 
 func TestComponentTelemetry(t *testing.T) {
-	tt := metadatatest.SetupTelemetry()
+	tt := componenttest.NewTelemetry()
 	factory := NewFactory()
-	receiver, err := factory.CreateMetrics(context.Background(), tt.NewSettings(), componenttest.NewNopHost(), new(consumertest.MetricsSink))
+	receiver, err := factory.CreateMetrics(context.Background(), metadatatest.NewSettings(tt), componenttest.NewNopHost(), new(consumertest.MetricsSink))
 	require.NoError(t, err)
-	metadatatest.AssertEqualBatchSizeTriggerSend(t, tt.Telemetry,
+	metadatatest.AssertEqualBatchSizeTriggerSend(t, tt,
 		[]metricdata.DataPoint[int64]{
 			{
 				Value: 1,
 			},
 		}, metricdatatest.IgnoreTimestamp())
-	metadatatest.AssertEqualProcessRuntimeTotalAllocBytes(t, tt.Telemetry,
+	metadatatest.AssertEqualProcessRuntimeTotalAllocBytes(t, tt,
 		[]metricdata.DataPoint[int64]{
 			{
 				Value: 2,
@@ -45,7 +45,7 @@ func TestComponentTelemetry(t *testing.T) {
 	rcv, ok := receiver.(nopReceiver)
 	require.True(t, ok)
 	rcv.initOptionalMetric()
-	metadatatest.AssertEqualQueueLength(t, tt.Telemetry,
+	metadatatest.AssertEqualQueueLength(t, tt,
 		[]metricdata.DataPoint[int64]{
 			{
 				Value: 3,

cmd/mdatagen/internal/samplereceiver/metrics_test.go

@@ -21,7 +21,7 @@ import (
 )
 
 type Telemetry struct {
-	componenttest.Telemetry
+	*componenttest.Telemetry
 }
 
 func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry {
@@ -50,9 +50,18 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics,
 	require.Equal(t, len(expected), lenMetrics(md))
 }
 
+{{ if or isConnector isExporter isExtension isProcessor isReceiver isScraper }}
+func NewSettings(tt *componenttest.Telemetry) {{ .Status.Class }}.Settings {
+set := {{ .Status.Class }}test.NewNopSettings()
+set.ID = component.NewID(component.MustNewType("{{ .Type }}"))
+set.TelemetrySettings = tt.NewTelemetrySettings()
+return set
+}
+{{- end }}
+
 {{ range $name, $metric := .Telemetry.Metrics }}
 
-func AssertEqual{{ $name.Render }}(t *testing.T, tt componenttest.Telemetry, dps []metricdata.{{- if eq $metric.Data.Type "Histogram" }} {{$metric.Data.Type}} {{- end }}DataPoint[{{ $metric.Data.BasicType }}], opts ...metricdatatest.Option) {
+func AssertEqual{{ $name.Render }}(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.{{- if eq $metric.Data.Type "Histogram" }} {{$metric.Data.Type}} {{- end }}DataPoint[{{ $metric.Data.BasicType }}], opts ...metricdatatest.Option) {
 	want := metricdata.Metrics{
 		Name:        "otelcol_{{ $name }}",
 		Description: "{{ $metric.Description }}{{ $metric.Stability }}",
@@ -73,7 +82,7 @@ func AssertEqual{{ $name.Render }}(t *testing.T, tt componenttest.Telemetry, dps
 
 {{- end }}
 
-func getMetric(t *testing.T, tt componenttest.Telemetry, name string) metricdata.Metrics {
+func getMetric(t *testing.T, tt *componenttest.Telemetry, name string) metricdata.Metrics {
 	var md metricdata.ResourceMetrics
 	require.NoError(t, tt.Reader.Collect(context.Background(), &md))
 	return getMetricFromResource(name, md)

cmd/mdatagen/internal/templates/telemetrytest.go.tmpl

@@ -26,7 +26,7 @@ const (
 )
 
 type TestTelemetry struct {
-	Telemetry
+	*Telemetry
 	id component.ID
 }
 

component/componenttest/obsreporttest.go

@@ -47,7 +47,7 @@ type Telemetry struct {
 	traceProvider *sdktrace.TracerProvider
 }
 
-func NewTelemetry(opts ...TelemetryOption) Telemetry {
+func NewTelemetry(opts ...TelemetryOption) *Telemetry {
 	reader := sdkmetric.NewManualReader()
 	spanRecorder := new(tracetest.SpanRecorder)
 	tOpts := telemetryOption{
@@ -57,7 +57,7 @@ func NewTelemetry(opts ...TelemetryOption) Telemetry {
 	for _, opt := range opts {
 		opt.apply(&tOpts)
 	}
-	return Telemetry{
+	return &Telemetry{
 		Reader:        reader,
 		SpanRecorder:  spanRecorder,
 		meterProvider: sdkmetric.NewMeterProvider(tOpts.metricOpts...),