Skip to content

Commit 066ade8

Browse files
authored
[chore] Remove unsage of pipeline.MustNewID in status helper (#40283)
Part of open-telemetry/opentelemetry-collector#12835 effort. Signed-off-by: Bogdan Drutu <[email protected]>
1 parent 5b05b15 commit 066ade8

File tree

8 files changed

+27
-34
lines changed

8 files changed

+27
-34
lines changed

extension/healthcheckv2extension/extension_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020
"go.opentelemetry.io/collector/component/componenttest"
2121
"go.opentelemetry.io/collector/confmap/confmaptest"
2222
"go.opentelemetry.io/collector/extension/extensiontest"
23+
"go.opentelemetry.io/collector/pipeline"
2324

2425
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/testutil"
2526
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/status"
@@ -40,7 +41,7 @@ func TestComponentStatus(t *testing.T) {
4041

4142
require.NoError(t, ext.Start(context.Background(), componenttest.NewNopHost()))
4243

43-
traces := testhelpers.NewPipelineMetadata("traces")
44+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
4445

4546
// StatusStarting will be sent immediately.
4647
for _, id := range traces.InstanceIDs() {

extension/healthcheckv2extension/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ require (
1818
go.opentelemetry.io/collector/extension v1.32.1-0.20250523042642-a867641d12bd
1919
go.opentelemetry.io/collector/extension/extensioncapabilities v0.126.1-0.20250523042642-a867641d12bd
2020
go.opentelemetry.io/collector/extension/extensiontest v0.126.1-0.20250523042642-a867641d12bd
21+
go.opentelemetry.io/collector/pipeline v0.126.1-0.20250523042642-a867641d12bd
2122
go.uber.org/goleak v1.3.0
2223
go.uber.org/multierr v1.11.0
2324
go.uber.org/zap v1.27.0
@@ -59,7 +60,6 @@ require (
5960
go.opentelemetry.io/collector/featuregate v1.32.1-0.20250523042642-a867641d12bd // indirect
6061
go.opentelemetry.io/collector/internal/telemetry v0.126.1-0.20250523042642-a867641d12bd // indirect
6162
go.opentelemetry.io/collector/pdata v1.32.1-0.20250523042642-a867641d12bd // indirect
62-
go.opentelemetry.io/collector/pipeline v0.126.1-0.20250523042642-a867641d12bd // indirect
6363
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
6464
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
6565
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0 // indirect

extension/healthcheckv2extension/internal/grpc/grpc_test.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
"go.opentelemetry.io/collector/component/componenttest"
1616
"go.opentelemetry.io/collector/config/configgrpc"
1717
"go.opentelemetry.io/collector/config/confignet"
18+
"go.opentelemetry.io/collector/pipeline"
1819
"google.golang.org/grpc"
1920
"google.golang.org/grpc/codes"
2021
"google.golang.org/grpc/credentials/insecure"
@@ -39,8 +40,8 @@ func TestCheck(t *testing.T) {
3940
},
4041
}
4142
var server *Server
42-
traces := testhelpers.NewPipelineMetadata("traces")
43-
metrics := testhelpers.NewPipelineMetadata("metrics")
43+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
44+
metrics := testhelpers.NewPipelineMetadata(pipeline.SignalMetrics)
4445

4546
type teststep struct {
4647
step func()
@@ -754,8 +755,8 @@ func TestWatch(t *testing.T) {
754755
},
755756
}
756757
var server *Server
757-
traces := testhelpers.NewPipelineMetadata("traces")
758-
metrics := testhelpers.NewPipelineMetadata("metrics")
758+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
759+
metrics := testhelpers.NewPipelineMetadata(pipeline.SignalMetrics)
759760

760761
// statusUnchanged is a sentinel value to signal that a step does not result
761762
// in a status change. This is important, because checking for a status

extension/healthcheckv2extension/internal/http/server_test.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"go.opentelemetry.io/collector/component/componenttest"
2222
"go.opentelemetry.io/collector/config/confighttp"
2323
"go.opentelemetry.io/collector/confmap/confmaptest"
24+
"go.opentelemetry.io/collector/pipeline"
2425

2526
"github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/common"
2627
internalhelpers "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension/internal/testhelpers"
@@ -154,15 +155,14 @@ type teststep struct {
154155

155156
func TestStatus(t *testing.T) {
156157
var server *Server
157-
traces := testhelpers.NewPipelineMetadata("traces")
158-
metrics := testhelpers.NewPipelineMetadata("metrics")
158+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
159+
metrics := testhelpers.NewPipelineMetadata(pipeline.SignalMetrics)
159160

160161
tests := []struct {
161162
name string
162163
config *Config
163164
legacyConfig LegacyConfig
164165
componentHealthConfig *common.ComponentHealthConfig
165-
pipelines map[string]*testhelpers.PipelineMetadata
166166
teststeps []teststep
167167
}{
168168
{
@@ -2582,7 +2582,6 @@ func TestStatus(t *testing.T) {
25822582
Path: "/status",
25832583
},
25842584
},
2585-
pipelines: testhelpers.NewPipelines("traces"),
25862585
teststeps: []teststep{
25872586
{
25882587
step: func() {

extension/opampextension/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ require (
116116
github.com/tklauser/numcpus v0.8.0 // indirect
117117
github.com/yusufpapurcu/wmi v1.2.4 // indirect
118118
go.opentelemetry.io/collector/pdata v1.32.1-0.20250523042642-a867641d12bd
119-
go.opentelemetry.io/collector/pipeline v0.126.1-0.20250523042642-a867641d12bd // indirect
119+
go.opentelemetry.io/collector/pipeline v0.126.1-0.20250523042642-a867641d12bd
120120
go.opentelemetry.io/otel v1.35.0
121121
go.opentelemetry.io/otel/metric v1.35.0 // indirect
122122
go.opentelemetry.io/otel/sdk v1.35.0 // indirect

extension/opampextension/opamp_agent_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import (
2424
"go.opentelemetry.io/collector/confmap/confmaptest"
2525
"go.opentelemetry.io/collector/extension"
2626
"go.opentelemetry.io/collector/extension/extensiontest"
27+
"go.opentelemetry.io/collector/pipeline"
2728
"go.opentelemetry.io/collector/service"
2829
semconv "go.opentelemetry.io/otel/semconv/v1.27.0"
2930
"go.uber.org/zap"
@@ -545,7 +546,7 @@ func TestHealthReportingForwardComponentHealthToAggregator(t *testing.T) {
545546

546547
assert.NoError(t, o.Start(context.Background(), componenttest.NewNopHost()))
547548

548-
traces := testhelpers.NewPipelineMetadata("traces")
549+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
549550

550551
// StatusStarting will be sent immediately.
551552
for _, id := range traces.InstanceIDs() {

pkg/status/aggregator_test.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020

2121
func TestAggregateStatus(t *testing.T) {
2222
agg := status.NewAggregator(status.PriorityPermanent)
23-
traces := testhelpers.NewPipelineMetadata("traces")
23+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
2424

2525
t.Run("zero value", func(t *testing.T) {
2626
st, ok := agg.AggregateStatus(status.ScopeAll, status.Concise)
@@ -69,7 +69,7 @@ func TestAggregateStatus(t *testing.T) {
6969

7070
func TestAggregateStatusVerbose(t *testing.T) {
7171
agg := status.NewAggregator(status.PriorityPermanent)
72-
traces := testhelpers.NewPipelineMetadata("traces")
72+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
7373
tracesKey := toPipelineKey(traces.PipelineID)
7474

7575
t.Run("zero value", func(t *testing.T) {
@@ -131,7 +131,7 @@ func TestAggregateStatusVerbose(t *testing.T) {
131131

132132
func TestAggregateStatusPriorityRecoverable(t *testing.T) {
133133
agg := status.NewAggregator(status.PriorityRecoverable)
134-
traces := testhelpers.NewPipelineMetadata("traces")
134+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
135135

136136
testhelpers.SeedAggregator(agg, traces.InstanceIDs(), componentstatus.StatusOK)
137137

@@ -174,7 +174,7 @@ func TestAggregateStatusPriorityRecoverable(t *testing.T) {
174174

175175
func TestPipelineAggregateStatus(t *testing.T) {
176176
agg := status.NewAggregator(status.PriorityPermanent)
177-
traces := testhelpers.NewPipelineMetadata("traces")
177+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
178178

179179
t.Run("non existent pipeline", func(t *testing.T) {
180180
st, ok := agg.AggregateStatus("doesnotexist", status.Concise)
@@ -210,7 +210,7 @@ func TestPipelineAggregateStatus(t *testing.T) {
210210

211211
func TestPipelineAggregateStatusVerbose(t *testing.T) {
212212
agg := status.NewAggregator(status.PriorityPermanent)
213-
traces := testhelpers.NewPipelineMetadata("traces")
213+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
214214

215215
t.Run("non existent pipeline", func(t *testing.T) {
216216
st, ok := agg.AggregateStatus("doesnotexist", status.Verbose)
@@ -303,8 +303,8 @@ func TestStreaming(t *testing.T) {
303303
agg := status.NewAggregator(status.PriorityPermanent)
304304
defer agg.Close()
305305

306-
traces := testhelpers.NewPipelineMetadata("traces")
307-
metrics := testhelpers.NewPipelineMetadata("metrics")
306+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
307+
metrics := testhelpers.NewPipelineMetadata(pipeline.SignalMetrics)
308308

309309
traceEvents, traceUnsub := agg.Subscribe(status.Scope(traces.PipelineID.String()), status.Concise)
310310
defer traceUnsub()
@@ -364,7 +364,7 @@ func TestStreamingVerbose(t *testing.T) {
364364
agg := status.NewAggregator(status.PriorityPermanent)
365365
defer agg.Close()
366366

367-
traces := testhelpers.NewPipelineMetadata("traces")
367+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
368368
tracesKey := toPipelineKey(traces.PipelineID)
369369

370370
allEvents, unsub := agg.Subscribe(status.ScopeAll, status.Verbose)
@@ -424,7 +424,7 @@ func TestUnsubscribe(t *testing.T) {
424424
agg := status.NewAggregator(status.PriorityPermanent)
425425
defer agg.Close()
426426

427-
traces := testhelpers.NewPipelineMetadata("traces")
427+
traces := testhelpers.NewPipelineMetadata(pipeline.SignalTraces)
428428

429429
traceEvents, traceUnsub := agg.Subscribe(status.Scope(traces.PipelineID.String()), status.Concise)
430430
allEvents, allUnsub := agg.Subscribe(status.ScopeAll, status.Concise)

pkg/status/testhelpers/helpers.go

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,16 @@ func (p *PipelineMetadata) InstanceIDs() []*componentstatus.InstanceID {
2626
}
2727

2828
// NewPipelineMetadata returns a metadata for a hypothetical pipeline.
29-
func NewPipelineMetadata(typestr string) *PipelineMetadata {
30-
pipelineID := pipeline.MustNewID(typestr)
29+
func NewPipelineMetadata(signal pipeline.Signal) *PipelineMetadata {
30+
pipelineID := pipeline.NewID(signal)
3131
return &PipelineMetadata{
3232
PipelineID: pipelineID,
33-
ReceiverID: componentstatus.NewInstanceID(component.NewIDWithName(component.MustNewType(typestr), "in"), component.KindReceiver).WithPipelines(pipelineID),
33+
ReceiverID: componentstatus.NewInstanceID(component.NewIDWithName(component.MustNewType(signal.String()), "in"), component.KindReceiver).WithPipelines(pipelineID),
3434
ProcessorID: componentstatus.NewInstanceID(component.MustNewID("batch"), component.KindProcessor).WithPipelines(pipelineID),
35-
ExporterID: componentstatus.NewInstanceID(component.NewIDWithName(component.MustNewType(typestr), "out"), component.KindExporter).WithPipelines(pipelineID),
35+
ExporterID: componentstatus.NewInstanceID(component.NewIDWithName(component.MustNewType(signal.String()), "out"), component.KindExporter).WithPipelines(pipelineID),
3636
}
3737
}
3838

39-
// NewPipelines returns a map of hypothetical pipelines identified by their stringified typeVal.
40-
func NewPipelines(typestrs ...string) map[string]*PipelineMetadata {
41-
result := make(map[string]*PipelineMetadata, len(typestrs))
42-
for _, typestr := range typestrs {
43-
result[typestr] = NewPipelineMetadata(typestr)
44-
}
45-
return result
46-
}
47-
4839
// SeedAggregator records a status event for each instanceID.
4940
func SeedAggregator(
5041
agg *status.Aggregator,

0 commit comments

Comments
 (0)