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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stddef.h>
#include <string>
#include "base/sys_byteorder.h"
#include "blimp/net/common.h"
#include "blimp/net/stream_packet_reader.h"
#include "blimp/net/test_common.h"
#include "net/base/completion_callback.h"
#include "net/base/io_buffer.h"
#include "net/base/net_errors.h"
#include "net/base/test_completion_callback.h"
#include "net/socket/socket.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::_;
using testing::DoAll;
using testing::Mock;
using testing::NotNull;
using testing::Return;
using testing::SaveArg;
using testing::WithArg;
namespace blimp {
namespace {
const size_t kTestMaxBufferSize = 1 << 16; // 64KB
class StreamPacketReaderTest : public testing::Test {
public:
StreamPacketReaderTest()
: buffer_(new net::GrowableIOBuffer),
test_msg_("U WOT M8"),
data_reader_(&socket_) {
buffer_->SetCapacity(kTestMaxBufferSize);
}
~StreamPacketReaderTest() override {}
int ReadPacket() {
return data_reader_.ReadPacket(buffer_, callback_.callback());
}
protected:
scoped_refptr<net::GrowableIOBuffer> buffer_;
std::string test_msg_;
net::TestCompletionCallback callback_;
testing::StrictMock<MockStreamSocket> socket_;
testing::InSequence sequence_;
StreamPacketReader data_reader_;
};
// Successful read with 1 async header read and 1 async payload read.
TEST_F(StreamPacketReaderTest, ReadAsyncHeaderAsyncPayload) {
net::CompletionCallback socket_cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(FillBufferFromString<0>(test_msg_),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
socket_cb.Run(kPacketHeaderSizeBytes);
socket_cb.Run(test_msg_.size());
int rv = callback_.WaitForResult();
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
}
// Successful read with 1 async header read and 1 sync payload read.
TEST_F(StreamPacketReaderTest, ReadAsyncHeaderSyncPayload) {
net::CompletionCallback socket_cb;
// Asynchronous payload read expectation.
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)));
// Synchronous payload read expectation. Fills the buffer and returns
// immediately.
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(
DoAll(FillBufferFromString<0>(test_msg_), Return(test_msg_.size())));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
EXPECT_FALSE(callback_.have_result());
socket_cb.Run(kPacketHeaderSizeBytes);
int rv = callback_.WaitForResult();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
}
// Successful read with 1 sync header read and 1 async payload read.
TEST_F(StreamPacketReaderTest, ReadSyncHeaderAsyncPayload) {
net::CompletionCallback socket_cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(FillBufferFromString<0>(test_msg_),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
socket_cb.Run(test_msg_.size());
int rv = callback_.WaitForResult();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
}
// Successful read with 1 sync header read and 1 sync payload read.
TEST_F(StreamPacketReaderTest, ReadSyncHeaderSyncPayload) {
net::CompletionCallback socket_cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(
DoAll(FillBufferFromString<0>(test_msg_), Return(test_msg_.size())));
int rv = ReadPacket();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
EXPECT_FALSE(callback_.have_result());
}
// Successful read of 2 messages, header and payload reads all completing
// synchronously with no partial results.
TEST_F(StreamPacketReaderTest, ReadMultipleMessagesSync) {
net::CompletionCallback socket_cb;
std::string test_msg2 = test_msg_ + "SlightlyLongerString";
// Read the first message's header synchronously.
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)))
.RetiresOnSaturation();
// Read the first message's payload synchronously.
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(
DoAll(FillBufferFromString<0>(test_msg_), Return(test_msg_.size())))
.RetiresOnSaturation();
// Read the second message's header synchronously.
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg2.size())),
Return(kPacketHeaderSizeBytes)))
.RetiresOnSaturation();
// Read the second message's payload synchronously.
EXPECT_CALL(socket_, Read(NotNull(), test_msg2.size(), _))
.WillOnce(
DoAll(FillBufferFromString<0>(test_msg2), Return(test_msg2.size())))
.RetiresOnSaturation();
int rv = ReadPacket();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
rv = ReadPacket();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg2.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
EXPECT_FALSE(callback_.have_result());
}
// Successful read of 2 messages, header and payload reads all completing
// asynchronously with no partial results.
TEST_F(StreamPacketReaderTest, ReadMultipleMessagesAsync) {
net::TestCompletionCallback read_cb1;
net::TestCompletionCallback read_cb2;
net::CompletionCallback socket_cb;
// Read a header asynchronously.
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)))
.RetiresOnSaturation();
// Read a payload asynchronously.
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(FillBufferFromString<0>(test_msg_),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)))
.RetiresOnSaturation();
// Read a header asynchronously.
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)))
.RetiresOnSaturation();
// Read a payload asynchronously.
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(FillBufferFromString<0>(test_msg_),
SaveArg<2>(&socket_cb), Return(net::ERR_IO_PENDING)))
.RetiresOnSaturation();
EXPECT_EQ(net::ERR_IO_PENDING,
data_reader_.ReadPacket(buffer_, read_cb1.callback()));
socket_cb.Run(kPacketHeaderSizeBytes);
socket_cb.Run(test_msg_.size());
int rv = read_cb1.WaitForResult();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_EQ(net::ERR_IO_PENDING,
data_reader_.ReadPacket(buffer_, read_cb2.callback()));
socket_cb.Run(kPacketHeaderSizeBytes);
socket_cb.Run(test_msg_.size());
rv = read_cb2.WaitForResult();
EXPECT_GT(rv, 0);
EXPECT_EQ(rv, static_cast<int>(test_msg_.size()));
EXPECT_TRUE(BufferStartsWith(buffer_.get(), test_msg_));
}
// Verify that partial header reads are supported.
// Read #0: 1 header byte is read.
// Read #1: Remainder of header bytes read.
TEST_F(StreamPacketReaderTest, PartialHeaderReadAsync) {
net::CompletionCallback cb;
std::string header = EncodeHeader(test_msg_.size());
// The first byte is received (sliced via substr()).
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(header.substr(0, 1)),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
// The remainder is received (sliced via substr()).
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes - 1, _))
.WillOnce(DoAll(
FillBufferFromString<0>(header.substr(1, kPacketHeaderSizeBytes - 1)),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
// Verify that we start reading the body once the header has been fully read.
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(Return(net::ERR_IO_PENDING));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
cb.Run(1);
cb.Run(kPacketHeaderSizeBytes - 1);
}
// Verify that partial payload reads are supported.
// Read #0: Header is fully read synchronously.
// Read #1: First payload byte is read. (Um, it's an acoustic cup modem.)
// Read #2: Remainder of payload bytes are read.
TEST_F(StreamPacketReaderTest, PartialPayloadReadAsync) {
net::CompletionCallback cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(FillBufferFromString<0>(test_msg_.substr(0, 1)),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size() - 1, _))
.WillOnce(DoAll(
FillBufferFromString<0>(test_msg_.substr(1, test_msg_.size() - 1)),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
cb.Run(1);
cb.Run(test_msg_.size() - 1);
int rv = callback_.WaitForResult();
EXPECT_GT(rv, 0);
EXPECT_EQ(static_cast<int>(test_msg_.size()), rv);
}
// Verify that synchronous header read errors are reported correctly.
TEST_F(StreamPacketReaderTest, ReadHeaderErrorSync) {
net::CompletionCallback cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(Return(net::ERR_FAILED));
EXPECT_EQ(net::ERR_FAILED, ReadPacket());
}
// Verify that synchronous payload read errors are reported correctly.
TEST_F(StreamPacketReaderTest, ReadPayloadErrorSync) {
net::CompletionCallback cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(Return(net::ERR_FAILED));
EXPECT_EQ(net::ERR_FAILED, ReadPacket());
}
// Verify that async header read errors are reported correctly.
TEST_F(StreamPacketReaderTest, ReadHeaderErrorAsync) {
net::CompletionCallback cb;
net::TestCompletionCallback test_cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
cb.Run(net::ERR_FAILED);
EXPECT_EQ(net::ERR_FAILED, callback_.WaitForResult());
}
// Verify that asynchronous paylod read errors are reported correctly.
TEST_F(StreamPacketReaderTest, ReadPayloadErrorAsync) {
net::CompletionCallback cb;
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING, ReadPacket());
cb.Run(net::ERR_FAILED);
EXPECT_EQ(net::ERR_FAILED, callback_.WaitForResult());
}
// Verify that async header read completions don't break us if the
// StreamPacketReader object was destroyed.
TEST_F(StreamPacketReaderTest, ReaderDeletedDuringAsyncHeaderRead) {
net::CompletionCallback cb;
net::TestCompletionCallback test_cb;
scoped_ptr<StreamPacketReader> reader(new StreamPacketReader(&socket_));
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING,
reader->ReadPacket(buffer_, callback_.callback()));
reader.reset(); // Delete the reader object.
cb.Run(kPacketHeaderSizeBytes); // Complete the socket operation.
}
// Verify that async payload read completions don't break us if the
// StreamPacketReader object was destroyed.
TEST_F(StreamPacketReaderTest, ReaderDeletedDuringAsyncPayloadRead) {
net::CompletionCallback cb;
scoped_ptr<StreamPacketReader> reader(new StreamPacketReader(&socket_));
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(test_msg_.size())),
Return(kPacketHeaderSizeBytes)));
EXPECT_CALL(socket_, Read(NotNull(), test_msg_.size(), _))
.WillOnce(DoAll(SaveArg<2>(&cb), Return(net::ERR_IO_PENDING)));
EXPECT_EQ(net::ERR_IO_PENDING,
reader->ReadPacket(buffer_, callback_.callback()));
reader.reset(); // Delete the reader object.
cb.Run(net::ERR_FAILED); // Complete the socket operation.
}
// Verify that zero-length payload is reported as an erroneous input.
TEST_F(StreamPacketReaderTest, ReadWhatIsThisAPacketForAnts) {
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(DoAll(FillBufferFromString<0>(EncodeHeader(0)),
Return(kPacketHeaderSizeBytes)))
.RetiresOnSaturation();
EXPECT_EQ(net::ERR_INVALID_RESPONSE, ReadPacket());
}
// Verify that an illegally large payloads is reported as an erroneous inputs.
TEST_F(StreamPacketReaderTest, ReadErrorIllegallyLargePayload) {
EXPECT_CALL(socket_, Read(NotNull(), kPacketHeaderSizeBytes, _))
.WillOnce(
DoAll(FillBufferFromString<0>(EncodeHeader(kTestMaxBufferSize + 1)),
Return(kPacketHeaderSizeBytes)));
EXPECT_EQ(net::ERR_INVALID_RESPONSE, ReadPacket());
}
} // namespace
} // namespace blimp
|
