Skip to content

Commit

Permalink
Deprecate metadatatest.Telemetry in favor of componenttest.Telemetry (#…
Browse files Browse the repository at this point in the history
…12218)

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu authored Jan 31, 2025
1 parent 0539856 commit 0a40b4e
Show file tree
Hide file tree
Showing 10 changed files with 95 additions and 55 deletions.
29 changes: 29 additions & 0 deletions .chloggen/dep-mdatagen.yaml
Original file line number Diff line number Diff line change
@@ -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]

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 12 additions & 13 deletions cmd/mdatagen/internal/templates/telemetrytest.go.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand All @@ -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) {
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions service/internal/metadatatest/generated_telemetrytest.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0a40b4e

Please sign in to comment.