File: router_kas_stream_forwarder_test.go

package info (click to toggle)
gitlab-agent 16.11.5-1
  • links: PTS, VCS
  • area: contrib
  • in suites: experimental
  • size: 7,072 kB
  • sloc: makefile: 193; sh: 55; ruby: 3
file content (177 lines) | stat: -rw-r--r-- 5,168 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
package tunserver

import (
	"errors"
	"io"
	"testing"
	"time"

	"github.com/stretchr/testify/require"
	"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/mock_modshared"
	"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/mock_rpc"
	"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/testhelpers"
	"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tunnel/rpc"
	"go.uber.org/mock/gomock"
	"go.uber.org/zap/zaptest"
	statuspb "google.golang.org/genproto/googleapis/rpc/status"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

func TestStreamForwarder_ErrorFromRecvOnSendEOF(t *testing.T) {
	f, kasStream, stream := setupForwarder(t)
	sendDone := make(chan struct{})

	// pipeFromKASToStream
	kasStream.EXPECT().
		RecvMsg(gomock.Any()).
		DoAndReturn(func(m interface{}) error {
			<-sendDone
			time.Sleep(20 * time.Millisecond)
			return status.Error(codes.InvalidArgument, "expected error from RecvMsg")
		})
	gomock.InOrder( // pipeFromStreamToKAS
		stream.EXPECT().
			RecvMsg(gomock.Any()),
		kasStream.EXPECT().
			SendMsg(gomock.Any()).
			DoAndReturn(func(m interface{}) error {
				close(sendDone)
				return io.EOF // there is an error, call RecvMsg() to get it
			}),
	)
	err := f.ForwardStream(kasStream, stream)
	require.EqualError(t, err, "rpc error: code = InvalidArgument desc = expected error from RecvMsg")
}

func TestStreamForwarder_VisitorErrorPreferredToGatewayError(t *testing.T) {
	f, kasStream, stream := setupForwarder(t)
	stop := make(chan struct{})
	stopped := make(chan struct{})
	gomock.InOrder( // pipeFromKASToStream
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Header_{
					Header: &rpc.GatewayResponse_Header{},
				},
			})),
		stream.EXPECT().
			SetHeader(gomock.Any()),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Trailer_{
					Trailer: &rpc.GatewayResponse_Trailer{},
				},
			})),
		stream.EXPECT().
			SetTrailer(gomock.Any()),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Error_{
					Error: &rpc.GatewayResponse_Error{
						Status: &statuspb.Status{
							Code:    int32(codes.NotFound),
							Message: "something not found",
						},
					},
				},
			})),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Return(errors.New("visitor error")),
	)
	gomock.InOrder( // pipeFromStreamToKAS
		stream.EXPECT().
			RecvMsg(gomock.Any()).
			DoAndReturn(func(m interface{}) error {
				<-stop // as if this method is blocked on reading from the client
				return io.EOF
			}),
		kasStream.EXPECT().
			CloseSend().
			Do(func() error {
				close(stopped)
				return nil
			}),
	)
	err := f.ForwardStream(kasStream, stream)
	require.EqualError(t, err, "visitor error")
	// ForwardStream returned before stream.RecvMsg(), aborting it, as expected.
	close(stop) // Unblock stream.RecvMsg()
	<-stopped
}

func TestStreamForwarder_GatewayError(t *testing.T) {
	f, kasStream, stream := setupForwarder(t)
	stop := make(chan struct{})
	stopped := make(chan struct{})
	gomock.InOrder( // pipeFromKASToStream
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Header_{
					Header: &rpc.GatewayResponse_Header{},
				},
			})),
		stream.EXPECT().
			SetHeader(gomock.Any()),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Trailer_{
					Trailer: &rpc.GatewayResponse_Trailer{},
				},
			})),
		stream.EXPECT().
			SetTrailer(gomock.Any()),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Do(testhelpers.RecvMsg(&rpc.GatewayResponse{
				Msg: &rpc.GatewayResponse_Error_{
					Error: &rpc.GatewayResponse_Error{
						Status: &statuspb.Status{
							Code:    int32(codes.NotFound),
							Message: "something not found",
						},
					},
				},
			})),
		kasStream.EXPECT().
			RecvMsg(gomock.Any()).
			Return(io.EOF),
	)
	gomock.InOrder( // pipeFromStreamToKAS
		stream.EXPECT().
			RecvMsg(gomock.Any()).
			DoAndReturn(func(m any) error {
				<-stop // as if this method is blocked on reading from the client
				return io.EOF
			}),
		kasStream.EXPECT().
			CloseSend().
			Do(func() error {
				close(stopped)
				return nil
			}),
	)
	err := f.ForwardStream(kasStream, stream)
	require.EqualError(t, err, "rpc error: code = NotFound desc = something not found")
	// ForwardStream returned before stream.RecvMsg(), aborting it, as expected.
	close(stop) // Unblock stream.RecvMsg()
	<-stopped
}

func setupForwarder(t *testing.T) (*kasStreamForwarder, *mock_rpc.MockClientStream, *mock_rpc.MockServerStream) {
	ctrl := gomock.NewController(t)
	rpcAPI := mock_modshared.NewMockRPCAPI(ctrl)
	kasStream := mock_rpc.NewMockClientStream(ctrl)
	stream := mock_rpc.NewMockServerStream(ctrl)
	f := &kasStreamForwarder{
		log:    zaptest.NewLogger(t),
		rpcAPI: rpcAPI,
	}
	return f, kasStream, stream
}