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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
Copyright 2023 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package websocket
import (
"context"
"errors"
"io"
"net/http"
"net/http/httptest"
"net/url"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/httpstream"
"k8s.io/apimachinery/pkg/util/httpstream/wsstream"
"k8s.io/apimachinery/pkg/util/remotecommand"
restclient "k8s.io/client-go/rest"
)
func TestWebSocketRoundTripper_RoundTripperSucceeds(t *testing.T) {
// Create fake WebSocket server.
websocketServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
conns, err := webSocketServerStreams(req, w)
if err != nil {
t.Fatalf("error on webSocketServerStreams: %v", err)
}
defer conns.conn.Close()
}))
defer websocketServer.Close()
// Create the wrapped roundtripper and websocket upgrade roundtripper and call "RoundTrip()".
websocketLocation, err := url.Parse(websocketServer.URL)
require.NoError(t, err)
req, err := http.NewRequestWithContext(context.Background(), "GET", websocketServer.URL, nil)
require.NoError(t, err)
rt, wsRt, err := RoundTripperFor(&restclient.Config{Host: websocketLocation.Host})
require.NoError(t, err)
requestedProtocol := remotecommand.StreamProtocolV5Name
req.Header[wsstream.WebSocketProtocolHeader] = []string{requestedProtocol}
_, err = rt.RoundTrip(req)
require.NoError(t, err)
// WebSocket Connection is stored in websocket RoundTripper.
// Compare the expected negotiated subprotocol with the actual subprotocol.
actualProtocol := wsRt.Connection().Subprotocol()
assert.Equal(t, requestedProtocol, actualProtocol)
}
func TestWebSocketRoundTripper_RoundTripperFails(t *testing.T) {
testCases := map[string]struct {
statusCode int
body string
status *metav1.Status
expectedError string
}{
"Empty response status still returns basic websocket error": {
statusCode: -1,
body: "",
expectedError: "websocket: bad handshake",
},
"Empty response body still returns status": {
statusCode: http.StatusForbidden,
body: "",
expectedError: "(403 Forbidden)",
},
"Error response body returned as string when can not be cast as metav1.Status": {
statusCode: http.StatusForbidden,
body: "RBAC violated",
expectedError: "(403 Forbidden): RBAC violated",
},
"Error returned as metav1.Status within response body": {
statusCode: http.StatusBadRequest,
body: "",
status: &metav1.Status{
TypeMeta: metav1.TypeMeta{
APIVersion: "meta.k8s.io/v1",
Kind: "Status",
},
Status: "Failure",
Reason: "Unable to negotiate sub-protocol",
Code: http.StatusBadRequest,
},
},
}
encoder := statusCodecs.LegacyCodec(metav1.SchemeGroupVersion)
for testName, testCase := range testCases {
t.Run(testName, func(t *testing.T) {
// Create fake WebSocket server.
websocketServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
if testCase.statusCode > 0 {
w.WriteHeader(testCase.statusCode)
}
if testCase.status != nil {
statusBytes, err := runtime.Encode(encoder, testCase.status)
if err != nil {
t.Errorf("unexpected error %v", err)
return
}
_, err = w.Write(statusBytes)
if err != nil {
t.Errorf("unexpected error %v", err)
return
}
} else if len(testCase.body) > 0 {
_, err := w.Write([]byte(testCase.body))
if err != nil {
t.Errorf("unexpected error %v", err)
return
}
}
}))
defer websocketServer.Close()
// Create the wrapped roundtripper and websocket upgrade roundtripper and call "RoundTrip()".
websocketLocation, err := url.Parse(websocketServer.URL)
require.NoError(t, err)
req, err := http.NewRequestWithContext(context.Background(), "GET", websocketServer.URL, nil)
require.NoError(t, err)
rt, _, err := RoundTripperFor(&restclient.Config{Host: websocketLocation.Host})
require.NoError(t, err)
_, err = rt.RoundTrip(req)
require.Error(t, err)
assert.True(t, httpstream.IsUpgradeFailure(err))
if testCase.status != nil {
upgradeErr := &httpstream.UpgradeFailureError{}
validErr := errors.As(err, &upgradeErr)
assert.True(t, validErr, "could not cast error as httpstream.UpgradeFailureError")
statusErr := upgradeErr.Cause
apiErr := &apierrors.StatusError{}
validErr = errors.As(statusErr, &apiErr)
assert.True(t, validErr, "could not cast error as apierrors.StatusError")
assert.Equal(t, *testCase.status, apiErr.ErrStatus)
} else {
assert.Contains(t, err.Error(), testCase.expectedError,
"expected (%s), got (%s)", testCase.expectedError, err.Error())
}
})
}
}
func TestWebSocketRoundTripper_NegotiateCreatesConnection(t *testing.T) {
// Create fake WebSocket server.
websocketServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
conns, err := webSocketServerStreams(req, w)
if err != nil {
t.Fatalf("error on webSocketServerStreams: %v", err)
}
defer conns.conn.Close()
}))
defer websocketServer.Close()
// Create the websocket roundtripper and call "Negotiate" to create websocket connection.
websocketLocation, err := url.Parse(websocketServer.URL)
require.NoError(t, err)
req, err := http.NewRequestWithContext(context.Background(), "GET", websocketServer.URL, nil)
require.NoError(t, err)
rt, wsRt, err := RoundTripperFor(&restclient.Config{Host: websocketLocation.Host})
require.NoError(t, err)
requestedProtocol := remotecommand.StreamProtocolV5Name
conn, err := Negotiate(rt, wsRt, req, requestedProtocol)
require.NoError(t, err)
// Compare the expected negotiated subprotocol with the actual subprotocol.
actualProtocol := conn.Subprotocol()
assert.Equal(t, requestedProtocol, actualProtocol)
}
// websocketStreams contains the WebSocket connection and streams from a server.
type websocketStreams struct {
conn io.Closer
}
func webSocketServerStreams(req *http.Request, w http.ResponseWriter) (*websocketStreams, error) {
conn := wsstream.NewConn(map[string]wsstream.ChannelProtocolConfig{
remotecommand.StreamProtocolV5Name: {
Binary: true,
Channels: []wsstream.ChannelType{},
},
})
conn.SetIdleTimeout(4 * time.Hour)
// Opening the connection responds to WebSocket client, negotiating
// the WebSocket upgrade connection and the subprotocol.
_, _, err := conn.Open(w, req)
if err != nil {
return nil, err
}
return &websocketStreams{conn: conn}, nil
}
|
