From 0a40b4e00bdb61f3d68926ddfdbc662837fff6e4 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Fri, 31 Jan 2025 13:31:34 -0800 Subject: [PATCH] Deprecate metadatatest.Telemetry in favor of componenttest.Telemetry (#12218) Signed-off-by: Bogdan Drutu --- .chloggen/dep-mdatagen.yaml | 29 +++++++++++++++++++ .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../internal/templates/telemetrytest.go.tmpl | 25 ++++++++-------- .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../metadatatest/generated_telemetrytest.go | 15 +++++----- .../metadatatest/generated_telemetrytest.go | 3 ++ .../metadatatest/generated_telemetrytest.go | 3 ++ 10 files changed, 95 insertions(+), 55 deletions(-) create mode 100644 .chloggen/dep-mdatagen.yaml diff --git a/.chloggen/dep-mdatagen.yaml b/.chloggen/dep-mdatagen.yaml new file mode 100644 index 00000000000..52103bb9478 --- /dev/null +++ b/.chloggen/dep-mdatagen.yaml @@ -0,0 +1,29 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: deprecation + +# 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: Deprecate metadatatest.Telemetry in favor of componenttest.Telemetry + +# One or more tracking issues or pull requests related to the change +issues: [12218] + +# (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: | + metadatatest.Telemetry -> componenttest.Telemetry | + metadatatest.SetupTelemetry -> componenttest.NewTelemetry | + metadatatest.Telemetry.NewSettings -> metadatatest.NewSettings | + metadatatest.Telemetry.AssertMetrics -> metadatatest.AssertEqual* | + +# 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] diff --git a/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go b/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go index d10db080db3..f5e2b59abff 100644 --- a/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go +++ b/cmd/mdatagen/internal/samplereceiver/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/receiver/receivertest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() receiver.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) receiver.Settings { set := receivertest.NewNopSettings() set.ID = component.NewID(component.MustNewType("sample")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) receiver.Settings { - set := receivertest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("sample")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualBatchSizeTriggerSend(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_batch_size_trigger_send", diff --git a/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl b/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl index a3dd9c12c6b..a5c538af41b 100644 --- a/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl +++ b/cmd/mdatagen/internal/templates/telemetrytest.go.tmpl @@ -20,23 +20,31 @@ import ( {{- end }} ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{ Telemetry: componenttest.NewTelemetry(opts...) } } {{ if or isConnector isExporter isExtension isProcessor isReceiver isScraper }} +// Deprecated: [v0.119.0] Use {{ .Package }}test.NewSettings func (tt *Telemetry) NewSettings() {{ .Status.Class }}.Settings { - set := {{ .Status.Class }}test.NewNopSettings() - set.ID = component.NewID(component.MustNewType("{{ .Type }}")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set + return NewSettings(tt.Telemetry) +} + +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 }} +// Deprecated: [v0.119.0] Use {{ .Package }}test.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -50,15 +58,6 @@ 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) { diff --git a/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go b/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go index ee62395faca..b903d372ddc 100644 --- a/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go +++ b/exporter/exporterhelper/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/exporter/exportertest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() exporter.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) exporter.Settings { set := exportertest.NewNopSettings() set.ID = component.NewID(component.MustNewType("exporterhelper")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) exporter.Settings { - set := exportertest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("exporterhelper")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualExporterEnqueueFailedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_exporter_enqueue_failed_log_records", diff --git a/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go b/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go index 8fa0a2b4d38..cdd85b387d4 100644 --- a/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go +++ b/processor/batchprocessor/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/processor/processortest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() processor.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) processor.Settings { set := processortest.NewNopSettings() set.ID = component.NewID(component.MustNewType("batch")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) processor.Settings { - set := processortest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("batch")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualProcessorBatchBatchSendSize(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.HistogramDataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_batch_batch_send_size", diff --git a/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go b/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go index 010d1b4072f..fd030bc55c9 100644 --- a/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go +++ b/processor/memorylimiterprocessor/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/processor/processortest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() processor.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) processor.Settings { set := processortest.NewNopSettings() set.ID = component.NewID(component.MustNewType("memory_limiter")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) processor.Settings { - set := processortest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("memory_limiter")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualProcessorAcceptedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_accepted_log_records", diff --git a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go index bf7432ade34..7d16af7e430 100644 --- a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go +++ b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/processor/processortest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() processor.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) processor.Settings { set := processortest.NewNopSettings() set.ID = component.NewID(component.MustNewType("processorhelper")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) processor.Settings { - set := processortest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("processorhelper")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualProcessorIncomingItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_incoming_items", diff --git a/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go b/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go index 097b5dbb5a0..b234cc79d47 100644 --- a/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go +++ b/receiver/receiverhelper/internal/metadatatest/generated_telemetrytest.go @@ -16,21 +16,29 @@ import ( "go.opentelemetry.io/collector/receiver/receivertest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.NewSettings func (tt *Telemetry) NewSettings() receiver.Settings { + return NewSettings(tt.Telemetry) +} + +func NewSettings(tt *componenttest.Telemetry) receiver.Settings { set := receivertest.NewNopSettings() set.ID = component.NewID(component.MustNewType("receiverhelper")) set.TelemetrySettings = tt.NewTelemetrySettings() return set } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) @@ -44,13 +52,6 @@ func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, require.Equal(t, len(expected), lenMetrics(md)) } -func NewSettings(tt *componenttest.Telemetry) receiver.Settings { - set := receivertest.NewNopSettings() - set.ID = component.NewID(component.MustNewType("receiverhelper")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualReceiverAcceptedLogRecords(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_receiver_accepted_log_records", diff --git a/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go b/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go index 01d866e6c3f..f015a380c03 100644 --- a/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go +++ b/scraper/scraperhelper/internal/metadatatest/generated_telemetrytest.go @@ -13,14 +13,17 @@ import ( "go.opentelemetry.io/collector/component/componenttest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md)) diff --git a/service/internal/metadatatest/generated_telemetrytest.go b/service/internal/metadatatest/generated_telemetrytest.go index dc2d5cf82ef..8f988ab5952 100644 --- a/service/internal/metadatatest/generated_telemetrytest.go +++ b/service/internal/metadatatest/generated_telemetrytest.go @@ -13,14 +13,17 @@ import ( "go.opentelemetry.io/collector/component/componenttest" ) +// Deprecated: [v0.119.0] Use componenttest.Telemetry type Telemetry struct { *componenttest.Telemetry } +// Deprecated: [v0.119.0] Use componenttest.NewTelemetry func SetupTelemetry(opts ...componenttest.TelemetryOption) Telemetry { return Telemetry{Telemetry: componenttest.NewTelemetry(opts...)} } +// Deprecated: [v0.119.0] Use metadatatest.AssertEqual* func (tt *Telemetry) AssertMetrics(t *testing.T, expected []metricdata.Metrics, opts ...metricdatatest.Option) { var md metricdata.ResourceMetrics require.NoError(t, tt.Reader.Collect(context.Background(), &md))