Skip to content

Fix port collision flakes in correctness tests #46909

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.

Sign up for GitHub

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

Merged
codeboten merged 3 commits into from
Mar 16, 2026
Merged

Fix port collision flakes in correctness tests #46909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a7d702
fix port collision flakes in correctness tests
dashpole Mar 14, 2026
1215f07
lint
dashpole Mar 14, 2026
1d9d058
Merge branch 'main' into correctness_flake_fix
dashpole Mar 14, 2026
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
16 changes: 10 additions & 6 deletions testbed/correctnesstests/connectors/correctness_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,6 @@ func testWithGoldenDataset(
require.NoError(t, err, "default components resulted in: %v", err)
runner := testbed.NewInProcessCollector(factories)
validator := testbed.NewCorrectTestValidator(sender.ProtocolName(), receiver.ProtocolName(), dataProvider)
config := correctnesstests.CreateConfigYaml(t, sender, receiver, connector, processors)
log.Println(config)
configCleanup, cfgErr := runner.PrepareConfig(t, config)
require.NoError(t, cfgErr, "collector configuration resulted in: %v", cfgErr)
defer configCleanup()
tc := testbed.NewTestCase(
t,
dataProvider,
Expand All @@ -78,8 +73,17 @@ func testWithGoldenDataset(
)
defer tc.Stop()

tc.EnableRecording()
tc.StartBackend()

// CreateConfigYaml must be called after StartBackend to ensure the receiver port is bound.
// This prevents CreateConfigYaml from picking the same port for Prometheus telemetry.
config := correctnesstests.CreateConfigYaml(t, sender, receiver, connector, processors)
log.Println(config)
configCleanup, cfgErr := runner.PrepareConfig(t, config)
require.NoError(t, cfgErr, "collector configuration resulted in: %v", cfgErr)
defer configCleanup()

tc.EnableRecording()
tc.StartAgent()

tc.StartLoad(testbed.LoadOptions{
Expand Down
16 changes: 10 additions & 6 deletions testbed/correctnesstests/traces/correctness_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,6 @@ func testWithTracingGoldenDataset(
require.NoError(t, err, "default components resulted in: %v", err)
runner := testbed.NewInProcessCollector(factories)
validator := testbed.NewCorrectTestValidator(sender.ProtocolName(), receiver.ProtocolName(), dataProvider)
config := correctnesstests.CreateConfigYaml(t, sender, receiver, nil, processors)
log.Println(config)
configCleanup, cfgErr := runner.PrepareConfig(t, config)
require.NoError(t, cfgErr, "collector configuration resulted in: %v", cfgErr)
defer configCleanup()
tc := testbed.NewTestCase(
t,
dataProvider,
Expand All @@ -76,8 +71,17 @@ func testWithTracingGoldenDataset(
)
defer tc.Stop()

tc.EnableRecording()
tc.StartBackend()

// CreateConfigYaml must be called after StartBackend to ensure the receiver port is bound.
// This prevents CreateConfigYaml from picking the same port for Prometheus telemetry.
config := correctnesstests.CreateConfigYaml(t, sender, receiver, nil, processors)
log.Println(config)
configCleanup, cfgErr := runner.PrepareConfig(t, config)
require.NoError(t, cfgErr, "collector configuration resulted in: %v", cfgErr)
defer configCleanup()

tc.EnableRecording()
tc.StartAgent()

tc.StartLoad(testbed.LoadOptions{
Expand Down
22 changes: 20 additions & 2 deletions testbed/correctnesstests/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ package correctnesstests // import "github.com/open-telemetry/opentelemetry-coll
import (
"bufio"
"fmt"
"net"
"os"
"path/filepath"
"slices"
"strings"
"testing"

Expand Down Expand Up @@ -35,6 +37,22 @@ func CreateConfigYaml(
connector testbed.DataConnector,
processors []ProcessorNameAndConfigBody,
) string {
var plannedPorts []int
if sender != nil {
if tcpAddr, ok := sender.GetEndpoint().(*net.TCPAddr); ok {
plannedPorts = append(plannedPorts, tcpAddr.Port)
}
}

// Avoid picking a telemetry port that is already planned for the sender.
// This prevents port collisions between the collector's Prometheus telemetry
// and the collector's receivers (sender endpoint), which can happen if CreateConfigYaml
// is called before the receivers are started (bound).
telemetryPort := testutil.GetAvailablePort(tb)
for slices.Contains(plannedPorts, telemetryPort) {
telemetryPort = testutil.GetAvailablePort(tb)
}

// Prepare extra processor config section and comma-separated list of extra processor
// names to use in corresponding "processors" settings.
processorsSections := ""
Expand Down Expand Up @@ -103,7 +121,7 @@ service:
receiver.GenConfigYAMLStr(),
processorsSections,
connector.GenConfigYAMLStr(),
testutil.GetAvailablePort(tb),
telemetryPort,
pipeline1,
sender.ProtocolName(),
processorsList,
Expand Down Expand Up @@ -146,7 +164,7 @@ service:
sender.GenConfigYAMLStr(),
receiver.GenConfigYAMLStr(),
processorsSections,
testutil.GetAvailablePort(tb),
telemetryPort,
pipeline1,
sender.ProtocolName(),
processorsList,
Expand Down
Loading