|
| 1 | +// SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package v1 |
| 5 | + |
| 6 | +import ( |
| 7 | + "context" |
| 8 | + "io" |
| 9 | + "net" |
| 10 | + "sync" |
| 11 | + "testing" |
| 12 | + |
| 13 | + pb "github.com/NVIDIA/OpenShell/sdk/go/proto/openshellv1" |
| 14 | + "github.com/stretchr/testify/assert" |
| 15 | + "github.com/stretchr/testify/require" |
| 16 | + "google.golang.org/grpc" |
| 17 | + "google.golang.org/grpc/codes" |
| 18 | + "google.golang.org/grpc/credentials/insecure" |
| 19 | + "google.golang.org/grpc/metadata" |
| 20 | + "google.golang.org/grpc/status" |
| 21 | + "google.golang.org/grpc/test/bufconn" |
| 22 | +) |
| 23 | + |
| 24 | +// routingServer reports owner from GetSandbox and records the replica header |
| 25 | +// of every streaming call ("" when unrouted). Routed calls fail with routedErr. |
| 26 | +type routingServer struct { |
| 27 | + pb.UnimplementedOpenShellServer |
| 28 | + owner string |
| 29 | + routedErr error |
| 30 | + |
| 31 | + mu sync.Mutex |
| 32 | + wantedBy []string |
| 33 | + routes []string |
| 34 | +} |
| 35 | + |
| 36 | +func (s *routingServer) GetSandbox(ctx context.Context, _ *pb.GetSandboxRequest) (*pb.SandboxResponse, error) { |
| 37 | + md, _ := metadata.FromIncomingContext(ctx) |
| 38 | + s.mu.Lock() |
| 39 | + s.wantedBy = append(s.wantedBy, firstValue(md, ownerRequestHeader)) |
| 40 | + s.mu.Unlock() |
| 41 | + if s.owner != "" { |
| 42 | + _ = grpc.SetHeader(ctx, metadata.Pairs(ownerReplicaHeader, s.owner)) |
| 43 | + } |
| 44 | + return &pb.SandboxResponse{Sandbox: &pb.Sandbox{}}, nil |
| 45 | +} |
| 46 | + |
| 47 | +// route records the call and returns the error a routed call should fail with. |
| 48 | +func (s *routingServer) route(ctx context.Context) error { |
| 49 | + md, _ := metadata.FromIncomingContext(ctx) |
| 50 | + replica := firstValue(md, routeReplicaHeader) |
| 51 | + s.mu.Lock() |
| 52 | + defer s.mu.Unlock() |
| 53 | + s.routes = append(s.routes, replica) |
| 54 | + if replica != "" { |
| 55 | + return s.routedErr |
| 56 | + } |
| 57 | + return nil |
| 58 | +} |
| 59 | + |
| 60 | +func (s *routingServer) ExecSandbox(_ *pb.ExecSandboxRequest, stream grpc.ServerStreamingServer[pb.ExecSandboxEvent]) error { |
| 61 | + if err := s.route(stream.Context()); err != nil { |
| 62 | + return err |
| 63 | + } |
| 64 | + return stream.Send(exitEvent()) |
| 65 | +} |
| 66 | + |
| 67 | +func (s *routingServer) ExecSandboxInteractive(stream grpc.BidiStreamingServer[pb.ExecSandboxInput, pb.ExecSandboxEvent]) error { |
| 68 | + if _, err := stream.Recv(); err != nil { |
| 69 | + return err |
| 70 | + } |
| 71 | + if err := s.route(stream.Context()); err != nil { |
| 72 | + return err |
| 73 | + } |
| 74 | + return stream.Send(exitEvent()) |
| 75 | +} |
| 76 | + |
| 77 | +func (s *routingServer) ForwardTcp(stream grpc.BidiStreamingServer[pb.TcpForwardFrame, pb.TcpForwardFrame]) error { //nolint:revive // proto-generated method name |
| 78 | + if _, err := stream.Recv(); err != nil { |
| 79 | + return err |
| 80 | + } |
| 81 | + if err := s.route(stream.Context()); err != nil { |
| 82 | + return err |
| 83 | + } |
| 84 | + return stream.Send(&pb.TcpForwardFrame{Payload: &pb.TcpForwardFrame_Data{Data: []byte("pong")}}) |
| 85 | +} |
| 86 | + |
| 87 | +func exitEvent() *pb.ExecSandboxEvent { |
| 88 | + return &pb.ExecSandboxEvent{Payload: &pb.ExecSandboxEvent_Exit{Exit: &pb.ExecSandboxExit{}}} |
| 89 | +} |
| 90 | + |
| 91 | +func firstValue(md metadata.MD, key string) string { |
| 92 | + if v := md.Get(key); len(v) > 0 { |
| 93 | + return v[0] |
| 94 | + } |
| 95 | + return "" |
| 96 | +} |
| 97 | + |
| 98 | +func routingClients(t *testing.T, srv *routingServer) (*execClient, *tcpClient) { |
| 99 | + t.Helper() |
| 100 | + lis := bufconn.Listen(bufSize) |
| 101 | + gs := grpc.NewServer() |
| 102 | + pb.RegisterOpenShellServer(gs, srv) |
| 103 | + go func() { _ = gs.Serve(lis) }() |
| 104 | + conn, err := grpc.NewClient("passthrough:///bufconn", |
| 105 | + grpc.WithContextDialer(func(context.Context, string) (net.Conn, error) { return lis.Dial() }), |
| 106 | + grpc.WithTransportCredentials(insecure.NewCredentials()), |
| 107 | + ) |
| 108 | + require.NoError(t, err) |
| 109 | + t.Cleanup(func() { |
| 110 | + _ = conn.Close() |
| 111 | + gs.Stop() |
| 112 | + }) |
| 113 | + sandboxes := newSandboxClient(conn) |
| 114 | + return newExecClient(conn, sandboxes), newTCPClient(conn, sandboxes, nil) |
| 115 | +} |
| 116 | + |
| 117 | +func TestExecRoutesToOwner(t *testing.T) { |
| 118 | + srv := &routingServer{owner: "openshell-1"} |
| 119 | + exec, _ := routingClients(t, srv) |
| 120 | + |
| 121 | + _, err := exec.Run(context.Background(), "default", "box", []string{"true"}) |
| 122 | + require.NoError(t, err) |
| 123 | + |
| 124 | + assert.Equal(t, []string{"1"}, srv.wantedBy) |
| 125 | + assert.Equal(t, []string{"openshell-1"}, srv.routes) |
| 126 | +} |
| 127 | + |
| 128 | +func TestExecWithoutOwnerIsUnrouted(t *testing.T) { |
| 129 | + srv := &routingServer{} |
| 130 | + exec, _ := routingClients(t, srv) |
| 131 | + |
| 132 | + _, err := exec.Run(context.Background(), "default", "box", []string{"true"}) |
| 133 | + require.NoError(t, err) |
| 134 | + |
| 135 | + assert.Equal(t, []string{""}, srv.routes) |
| 136 | +} |
| 137 | + |
| 138 | +func TestRoutedCallsRetryOnceWithoutHintWhenOwnerHasNoEndpoints(t *testing.T) { |
| 139 | + srv := &routingServer{owner: "openshell-1", routedErr: status.Error(codes.Unavailable, "")} |
| 140 | + exec, tcp := routingClients(t, srv) |
| 141 | + ctx := context.Background() |
| 142 | + |
| 143 | + _, err := exec.Run(ctx, "default", "box", []string{"true"}) |
| 144 | + require.NoError(t, err) |
| 145 | + |
| 146 | + stream, err := exec.Stream(ctx, "default", "box", []string{"true"}) |
| 147 | + require.NoError(t, err) |
| 148 | + code, err := stream.ExitCode() |
| 149 | + require.NoError(t, err) |
| 150 | + assert.Zero(t, code) |
| 151 | + |
| 152 | + session, err := exec.Interactive(ctx, "default", "box", []string{"sh"}, 80, 24) |
| 153 | + require.NoError(t, err) |
| 154 | + _, err = session.ExitCode() |
| 155 | + require.NoError(t, err) |
| 156 | + |
| 157 | + conn, err := tcp.Forward(ctx, "default", "box", 8080) |
| 158 | + require.NoError(t, err) |
| 159 | + buf := make([]byte, 4) |
| 160 | + _, err = io.ReadFull(conn, buf) |
| 161 | + require.NoError(t, err) |
| 162 | + assert.Equal(t, "pong", string(buf)) |
| 163 | + _ = conn.Close() |
| 164 | + |
| 165 | + // Each call is attempted routed, then once unrouted. |
| 166 | + assert.Equal(t, []string{ |
| 167 | + "openshell-1", "", "openshell-1", "", "openshell-1", "", "openshell-1", "", |
| 168 | + }, srv.routes) |
| 169 | +} |
| 170 | + |
| 171 | +func TestRoutedCallDoesNotRetryOnGatewayError(t *testing.T) { |
| 172 | + srv := &routingServer{owner: "openshell-1", routedErr: status.Error(codes.Unavailable, "supervisor not connected")} |
| 173 | + exec, tcp := routingClients(t, srv) |
| 174 | + ctx := context.Background() |
| 175 | + |
| 176 | + _, err := exec.Run(ctx, "default", "box", []string{"true"}) |
| 177 | + require.Error(t, err) |
| 178 | + _, err = tcp.Forward(ctx, "default", "box", 8080) |
| 179 | + require.Error(t, err) |
| 180 | + |
| 181 | + assert.Equal(t, []string{"openshell-1", "openshell-1"}, srv.routes) |
| 182 | +} |
| 183 | + |
| 184 | +func TestRetryUnrouted(t *testing.T) { |
| 185 | + assert.True(t, retryUnrouted(status.Error(codes.Unavailable, ""))) |
| 186 | + assert.True(t, retryUnrouted(status.Error(codes.Unavailable, "no healthy upstream"))) |
| 187 | + assert.True(t, retryUnrouted(status.Error(codes.Unavailable, "upstream connect error: connection failure"))) |
| 188 | + assert.False(t, retryUnrouted(status.Error(codes.Unavailable, "supervisor not connected"))) |
| 189 | + assert.False(t, retryUnrouted(status.Error(codes.NotFound, ""))) |
| 190 | + assert.False(t, retryUnrouted(io.EOF)) |
| 191 | + assert.False(t, retryUnrouted(nil)) |
| 192 | +} |
0 commit comments