Skip to content

Add context propagation checks to component lifecycle tests #13182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package testhelpers

import (
"context"
"testing"

"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/pdata/plog"
"go.opentelemetry.io/collector/pdata/pmetric"
"go.opentelemetry.io/collector/pdata/ptrace"
)

const (
TestKey = "ctx-prop-key"
TestValue = "expected-value"
)

type ContextCheckLogsConsumer struct {
T *testing.T
}

func (c *ContextCheckLogsConsumer) ConsumeLogs(ctx context.Context, logs plog.Logs) error {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This way of writing tests seems weird, and not really a Go pattern. Why can't we run the assertion inline?

Copy link
Author

@samuelarogbonlo samuelarogbonlo Jun 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback. You're right that the current structure isn’t a typical Go pattern.
I introduced ContextCheck*Consumer as a lightweight reusable helper to avoid duplicating the same context assertion logic in each test case. The idea was to keep individual test methods focused on wiring rather than repeating assertions.
That said, I can definitely refactor it to assert inline if preferred. Let me know if you’d like to see it changed.

val := ctx.Value(TestKey)
require.Equal(c.T, TestValue, val)
return nil
}

type ContextCheckMetricsConsumer struct {
T *testing.T
}

func (c *ContextCheckMetricsConsumer) ConsumeMetrics(ctx context.Context, metrics pmetric.Metrics) error {
val := ctx.Value(TestKey)
require.Equal(c.T, TestValue, val)
return nil
}

type ContextCheckTracesConsumer struct {
T *testing.T
}

func (c *ContextCheckTracesConsumer) ConsumeTraces(ctx context.Context, traces ptrace.Traces) error {
val := ctx.Value(TestKey)
require.Equal(c.T, TestValue, val)
return nil
}

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.

Loading