Skip to content

test(api): ephemeral port for the fake orchestrator gRPC server (fix fixed-5008 flake) #3401

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
tvi merged 1 commit into from
Jul 26, 2026
Merged

test(api): ephemeral port for the fake orchestrator gRPC server (fix fixed-5008 flake) #3401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 10 additions & 18 deletions packages/api/internal/orchestrator/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,24 +78,21 @@ func (s *fakeInfoServer) ServiceInfo(context.Context, *emptypb.Empty) (*infogrpc
}, nil
}

// startFakeOrchestratorGRPC starts a gRPC server that responds to ServiceInfo
// requests. When addr is empty it listens on an ephemeral port; otherwise it
// binds to the given address (e.g. "127.0.0.1:5008").
func startFakeOrchestratorGRPC(t *testing.T, nodeID string, addr string) {
// startFakeOrchestratorGRPC starts a fake ServiceInfo server on an ephemeral
// port and returns it; a fixed port flakes on shared runners.
func startFakeOrchestratorGRPC(t *testing.T, nodeID string) int {
t.Helper()

if addr == "" {
addr = "127.0.0.1:0"
}

lis, err := (&net.ListenConfig{}).Listen(t.Context(), "tcp", addr)
lis, err := (&net.ListenConfig{}).Listen(t.Context(), "tcp", "127.0.0.1:0")
require.NoError(t, err)

srv := grpc.NewServer(grpc.Creds(insecure.NewCredentials()))
infogrpc.RegisterInfoServiceServer(srv, &fakeInfoServer{nodeID: nodeID})

go srv.Serve(lis)
t.Cleanup(srv.GracefulStop)

return lis.Addr().(*net.TCPAddr).Port
}

// TestGetOrConnectNode_CacheHit verifies that when a node is already in the
Expand Down Expand Up @@ -268,21 +265,16 @@ func TestConnectToNode_SingleflightDedup(t *testing.T) {
// 3. This API instance has NOT yet synced (node is absent from o.nodes).
// 4. A handler calls getOrConnectNode for a sandbox on that node.
//
// The fake gRPC server listens on consts.OrchestratorAPIPort, matching the
// port carried by the mocked service registration.
// The fake gRPC server and the mocked service registration share an ephemeral
// port, so nomad discovery dials the right listener.
func TestGetOrConnectNode_CacheMiss_DiscoversAndConnects(t *testing.T) {
t.Parallel()

orchestratorNodeID := "orch-node-42"
nomadFullID := "aabbccdd11223344aabbccdd11223344aabbccdd"

// 1. Start a fake gRPC server on consts.OrchestratorAPIPort so that the
// address built by listNomadNodes matches our listener.
listenAddr := fmt.Sprintf("127.0.0.1:%d", consts.OrchestratorAPIPort)
startFakeOrchestratorGRPC(t, orchestratorNodeID, listenAddr)
port := startFakeOrchestratorGRPC(t, orchestratorNodeID)

// 2. Mock Nomad HTTP API returning a single service registration at
// 127.0.0.1.
nomadClient := newNomadMock(t, func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/v1/service/orchestrator" {
resp := []*nomadapi.ServiceRegistration{
Expand All @@ -291,7 +283,7 @@ func TestGetOrConnectNode_CacheMiss_DiscoversAndConnects(t *testing.T) {
ServiceName: "orchestrator",
NodeID: nomadFullID,
Address: "127.0.0.1",
Port: int(consts.OrchestratorAPIPort),
Port: port,
},
}
w.Header().Set("Content-Type", "application/json")
Expand Down
Loading