Skip to content

Commit

Permalink
[receivertest] Continue DataType deprecations in receivertest (#11304)
Browse files Browse the repository at this point in the history
#### Description

Continues deprecation/rename processor for
`NewNopFactoryForTypeWithSignal` and
`CheckConsumeContractParams.DataType`.

#### Link to tracking issue
Related to
#9429
  • Loading branch information
TylerHelmuth authored Sep 30, 2024
1 parent f9e73e2 commit 2181bdc
Show file tree
Hide file tree
Showing 17 changed files with 63 additions and 69 deletions.
25 changes: 25 additions & 0 deletions .chloggen/receivertest-continue-deprecation-2.yaml
Original file line number Diff line number Diff line change
@@ -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: deprecation

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: receivertest

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecated `NewNopFactoryForTypeWithSignal`. Use `NewNopFactoryForType` instead.

# One or more tracking issues or pull requests related to the change
issues: [11304]

# (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]
25 changes: 25 additions & 0 deletions .chloggen/receivertest-continue-deprecation.yaml
Original file line number Diff line number Diff line change
@@ -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: breaking

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: receivertest

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove deprecated `CheckConsumeContractParams.DataType`. Use `CheckConsumeContractParams.Signal` instead.

# One or more tracking issues or pull requests related to the change
issues: [11304]

# (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]
3 changes: 0 additions & 3 deletions cmd/mdatagen/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ require (
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/internal/globalsignal v0.110.0 // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.110.0 // indirect
Expand Down Expand Up @@ -96,5 +95,3 @@ replace go.opentelemetry.io/collector/receiver/receiverprofiles => ../../receive
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
3 changes: 0 additions & 3 deletions exporter/debugexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configretry v1.16.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumertest v0.110.0 // indirect
Expand Down Expand Up @@ -94,5 +93,3 @@ replace go.opentelemetry.io/collector/exporter/exporterprofiles => ../exporterpr
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
2 changes: 0 additions & 2 deletions exporter/exporterprofiles/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,3 @@ replace go.opentelemetry.io/collector/receiver/receiverprofiles => ../../receive
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
3 changes: 0 additions & 3 deletions exporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/internal/globalsignal v0.110.0 // indirect
go.opentelemetry.io/collector/receiver/receiverprofiles v0.110.0 // indirect
Expand Down Expand Up @@ -84,5 +83,3 @@ replace go.opentelemetry.io/collector/receiver/receiverprofiles => ../receiver/r
replace go.opentelemetry.io/collector/exporter/exporterprofiles => ./exporterprofiles

replace go.opentelemetry.io/collector/internal/globalsignal => ../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../component/componentprofiles
3 changes: 0 additions & 3 deletions exporter/loggingexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configretry v1.16.0 // indirect
go.opentelemetry.io/collector/consumer v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
Expand Down Expand Up @@ -99,5 +98,3 @@ replace go.opentelemetry.io/collector/exporter/exporterprofiles => ../exporterpr
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
3 changes: 0 additions & 3 deletions exporter/nopexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.110.0 // indirect
go.opentelemetry.io/collector/consumer v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
Expand Down Expand Up @@ -89,5 +88,3 @@ replace go.opentelemetry.io/collector/exporter/exporterprofiles => ../exporterpr
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
3 changes: 0 additions & 3 deletions exporter/otlpexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ require (
github.com/mostynb/go-grpc-compression v1.2.3 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/client v1.16.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/confignet v1.16.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.110.0 // indirect
go.opentelemetry.io/collector/config/internal v0.110.0 // indirect
Expand Down Expand Up @@ -128,8 +127,6 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles

replace go.opentelemetry.io/collector => ../..

replace go.opentelemetry.io/collector/component/componentstatus => ../../component/componentstatus
Expand Down
3 changes: 0 additions & 3 deletions exporter/otlphttpexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ require (
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/rs/cors v1.11.1 // indirect
go.opentelemetry.io/collector/client v1.16.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configauth v0.110.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.110.0 // indirect
go.opentelemetry.io/collector/config/internal v0.110.0 // indirect
Expand Down Expand Up @@ -129,8 +128,6 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles

retract (
v0.76.0 // Depends on retracted pdata v1.0.0-rc10 module, use v0.76.1
v0.69.0 // Release failed, use v0.69.1
Expand Down
2 changes: 1 addition & 1 deletion otelcol/factories_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func nopFactories() (Factories, error) {
factories.ExtensionModules[ext.Type()] = "go.opentelemetry.io/collector/extension/extensiontest v1.2.3"
}

if factories.Receivers, err = receiver.MakeFactoryMap(receivertest.NewNopFactory(), receivertest.NewNopFactoryForTypeWithSignal(pipeline.SignalLogs)); err != nil {
if factories.Receivers, err = receiver.MakeFactoryMap(receivertest.NewNopFactory(), receivertest.NewNopFactoryForType(pipeline.SignalLogs)); err != nil {
return Factories{}, err
}
factories.ReceiverModules = make(map[component.Type]string, len(factories.Receivers))
Expand Down
5 changes: 1 addition & 4 deletions receiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ require (
github.com/google/uuid v1.6.0
github.com/stretchr/testify v1.9.0
go.opentelemetry.io/collector/component v0.110.0
go.opentelemetry.io/collector/component/componentprofiles v0.110.0
go.opentelemetry.io/collector/config/configtelemetry v0.110.0
go.opentelemetry.io/collector/consumer v0.110.0
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0
go.opentelemetry.io/collector/consumer/consumertest v0.110.0
go.opentelemetry.io/collector/internal/globalsignal v0.110.0
go.opentelemetry.io/collector/pdata v1.16.0
go.opentelemetry.io/collector/pipeline v0.110.0
go.opentelemetry.io/collector/receiver/receiverprofiles v0.110.0
Expand All @@ -34,6 +32,7 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/internal/globalsignal v0.110.0 // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.110.0 // indirect
golang.org/x/net v0.28.0 // indirect
golang.org/x/sys v0.25.0 // indirect
Expand Down Expand Up @@ -67,5 +66,3 @@ retract v0.76.0 // Depends on retracted pdata v1.0.0-rc10 module
replace go.opentelemetry.io/collector/pipeline => ../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../component/componentprofiles
3 changes: 0 additions & 3 deletions receiver/nopreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ require (
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.110.0 // indirect
go.opentelemetry.io/collector/consumer/consumerprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/internal/globalsignal v0.110.0 // indirect
Expand Down Expand Up @@ -77,5 +76,3 @@ replace go.opentelemetry.io/collector/receiver/receiverprofiles => ../receiverpr
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
3 changes: 0 additions & 3 deletions receiver/otlpreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ require (
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/rs/cors v1.11.1 // indirect
go.opentelemetry.io/collector/client v1.16.0 // indirect
go.opentelemetry.io/collector/component/componentprofiles v0.110.0 // indirect
go.opentelemetry.io/collector/config/configcompression v1.16.0 // indirect
go.opentelemetry.io/collector/config/configopaque v1.16.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.110.0 // indirect
Expand Down Expand Up @@ -126,8 +125,6 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles

retract (
v0.76.0 // Depends on retracted pdata v1.0.0-rc10 module, use v0.76.1
v0.69.0 // Release failed, use v0.69.1
Expand Down
2 changes: 0 additions & 2 deletions receiver/receiverprofiles/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,3 @@ replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/co
replace go.opentelemetry.io/collector/pipeline => ../../pipeline

replace go.opentelemetry.io/collector/internal/globalsignal => ../../internal/globalsignal

replace go.opentelemetry.io/collector/component/componentprofiles => ../../component/componentprofiles
25 changes: 2 additions & 23 deletions receiver/receivertest/contract_checker.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import (
"github.com/stretchr/testify/require"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componentprofiles"
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/consumer/consumererror"
Expand Down Expand Up @@ -56,13 +55,7 @@ type CheckConsumeContractParams struct {
T *testing.T
// Factory that allows to create a receiver.
Factory receiver.Factory

// DataType to test for.
//
// Deprecated: [v0.110.0] Use Signal instead.
DataType component.DataType // nolint

Signal pipeline.Signal
Signal pipeline.Signal
// Config of the receiver to use.
Config component.Config
// Generator that can send data to the receiver.
Expand Down Expand Up @@ -118,21 +111,7 @@ func checkConsumeContractScenario(params CheckConsumeContractParams, decisionFun
// Create and start the receiver.
var receiver component.Component
var err error

s := params.Signal
// nolint
switch params.DataType {
case component.DataTypeTraces:
s = pipeline.SignalTraces
case component.DataTypeMetrics:
s = pipeline.SignalMetrics
case component.DataTypeLogs:
s = pipeline.SignalLogs
case componentprofiles.DataTypeProfiles:
s = componentprofiles.SignalProfiles
}

switch s {
switch params.Signal {
case pipeline.SignalLogs:
receiver, err = params.Factory.CreateLogs(ctx, NewNopSettings(), params.Config, consumer)
case pipeline.SignalTraces:
Expand Down
19 changes: 9 additions & 10 deletions receiver/receivertest/nop_receiver.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/consumer"
"go.opentelemetry.io/collector/consumer/consumerprofiles"
"go.opentelemetry.io/collector/internal/globalsignal"
"go.opentelemetry.io/collector/pipeline"
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/receiverprofiles"
Expand Down Expand Up @@ -43,15 +42,7 @@ func NewNopFactory() receiver.Factory {

// NewNopFactoryForType returns a receiver.Factory that constructs nop receivers supporting only the
// given data type.
//
// Deprecated: [v0.110.0] Use NewNopFactoryForTypeWithSignal instead
func NewNopFactoryForType(dataType component.DataType) receiver.Factory {
return NewNopFactoryForTypeWithSignal(globalsignal.MustNewSignal(dataType.String()))
}

// NewNopFactoryForTypeWithSignal returns a receiver.Factory that constructs nop receivers supporting only the
// given signal.
func NewNopFactoryForTypeWithSignal(signal pipeline.Signal) receiver.Factory {
func NewNopFactoryForType(signal pipeline.Signal) receiver.Factory {
var factoryOpt receiver.FactoryOption
switch signal {
case pipeline.SignalTraces:
Expand All @@ -68,6 +59,14 @@ func NewNopFactoryForTypeWithSignal(signal pipeline.Signal) receiver.Factory {
return receiver.NewFactory(componentType, func() component.Config { return &nopConfig{} }, factoryOpt)
}

// NewNopFactoryForTypeWithSignal returns a receiver.Factory that constructs nop receivers supporting only the
// given signal.
//
// Deprecated: [v0.111.0] Use NewNopFactoryForType instead
func NewNopFactoryForTypeWithSignal(signal pipeline.Signal) receiver.Factory {
return NewNopFactoryForType(signal)
}

type nopConfig struct{}

func createTraces(context.Context, receiver.Settings, component.Config, consumer.Traces) (receiver.Traces, error) {
Expand Down

0 comments on commit 2181bdc

Please sign in to comment.