This repository was archived by the owner on Apr 21, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathDecoderTests.cpp
More file actions
436 lines (354 loc) · 11.3 KB
/
DecoderTests.cpp
File metadata and controls
436 lines (354 loc) · 11.3 KB
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/**
* @file DecoderTests.cpp
* @copyright (c) 2014 by Petr Zemek (s3rvac@gmail.com) and contributors
* @license BSD, see the @c LICENSE file for more details
* @brief Tests for the Decoder class.
*/
#include <memory>
#include <sstream>
#include <gtest/gtest.h>
#include "BDictionary.h"
#include "BInteger.h"
#include "BList.h"
#include "BString.h"
#include "Decoder.h"
#include "TestUtils.h"
namespace bencoding {
namespace tests {
using namespace testing;
class DecoderTests: public Test {
protected:
DecoderTests(): decoder(Decoder::create()) {}
template <typename T>
void assertDecodedAs(std::shared_ptr<BItem> bItem);
protected:
std::unique_ptr<Decoder> decoder;
};
template <typename T>
void DecoderTests::assertDecodedAs(
std::shared_ptr<BItem> bItem) {
ASSERT_NE(bItem, nullptr)
<< "expected a correctly decoded item";
EXPECT_NE(bItem->as<T>(), nullptr)
<< "expected " << typeid(T).name() << ", "
<< "got " << typeid(*bItem).name();
}
//
// Dictionary decoding.
//
TEST_F(DecoderTests,
EmptyDictionaryIsDecodedCorrectly) {
std::string data("de");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BDictionary>(bItem);
auto bDictionary = bItem->as<BDictionary>();
EXPECT_TRUE(bDictionary->empty());
}
TEST_F(DecoderTests,
DictionaryWithSingleItemIsDecodedCorrectly) {
std::string data("d4:testi1ee");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BDictionary>(bItem);
auto bDictionary = bItem->as<BDictionary>();
EXPECT_EQ(1, bDictionary->size());
auto i = bDictionary->begin();
assertDecodedAs<BString>(i->first);
auto key = i->first->as<BString>();
EXPECT_EQ("test", key->value());
assertDecodedAs<BInteger>(i->second);
auto value = i->second->as<BInteger>();
EXPECT_EQ(1, value->value());
}
TEST_F(DecoderTests,
DictionaryWithTwoItemsIsDecodedCorrectly) {
std::string data("d5:test1i1e5:test2i2ee");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BDictionary>(bItem);
auto bDictionary = bItem->as<BDictionary>();
EXPECT_EQ(2, bDictionary->size());
auto i = bDictionary->begin();
assertDecodedAs<BString>(i->first);
auto key1 = i->first->as<BString>();
EXPECT_EQ("test1", key1->value());
assertDecodedAs<BInteger>(i->second);
auto value1 = i->second->as<BInteger>();
EXPECT_EQ(1, value1->value());
++i;
assertDecodedAs<BString>(i->first);
auto key2 = i->first->as<BString>();
EXPECT_EQ("test2", key2->value());
assertDecodedAs<BInteger>(i->second);
auto value2 = i->second->as<BInteger>();
EXPECT_EQ(2, value2->value());
}
TEST_F(DecoderTests,
DictionaryWithKeysThatAreNotSortedIsDecodedCorrectly) {
// Even though the specification says that a dictionary has all its keys
// lexicographically sorted, we support the decoding of dictionaries whose
// keys are not sorted. The resulting dictionary, however, will always have
// its keys sorted to conform to the specification.
std::string data("d1:bi2e1:ai1ee");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BDictionary>(bItem);
auto bDictionary = bItem->as<BDictionary>();
EXPECT_EQ(2, bDictionary->size());
auto i = bDictionary->begin();
assertDecodedAs<BString>(i->first);
auto key1 = i->first->as<BString>();
EXPECT_EQ("a", key1->value());
assertDecodedAs<BInteger>(i->second);
auto value1 = i->second->as<BInteger>();
EXPECT_EQ(1, value1->value());
++i;
assertDecodedAs<BString>(i->first);
auto key2 = i->first->as<BString>();
EXPECT_EQ("b", key2->value());
assertDecodedAs<BInteger>(i->second);
auto value2 = i->second->as<BInteger>();
EXPECT_EQ(2, value2->value());
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingDictionaryWithoutEndingE) {
EXPECT_THROW(decoder->decode("d"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingDictionaryWithKeyNotBeingString) {
EXPECT_THROW(decoder->decode("di1ei2ee"), DecodingError);
}
//
// Integer decoding.
//
TEST_F(DecoderTests,
IntegerZeroIsCorrectlyDecoded) {
std::string data("i0e");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(0, bInteger->value());
}
TEST_F(DecoderTests,
PositiveIntegerIsCorrectlyDecoded) {
std::shared_ptr<BItem> bItem(decoder->decode("i13e"));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(13, bInteger->value());
}
TEST_F(DecoderTests,
ExplicitlyPositiveIntegerIsCorrectlyDecoded) {
std::shared_ptr<BItem> bItem(decoder->decode("i+13e"));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(+13, bInteger->value());
}
TEST_F(DecoderTests,
NegativeIntegerIsCorrectlyDecoded) {
std::shared_ptr<BItem> bItem(decoder->decode("i-13e"));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(-13, bInteger->value());
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerWithoutEndingE) {
EXPECT_THROW(decoder->decode("i13"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerWithoutValue) {
EXPECT_THROW(decoder->decode("ie"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerWithBeginningWhitespace) {
EXPECT_THROW(decoder->decode("i 1e"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerWithTrailingWhitespace) {
EXPECT_THROW(decoder->decode("i1 e"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerIsPaddedWithZeros) {
// From https://wiki.theory.org/BitTorrentSpecification#Bencoding:
//
// "Only the significant digits should be used, one cannot pad the Integer
// with zeroes. such as i04e."
//
EXPECT_THROW(decoder->decode("i001e"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenDecodingIntegerOfInvalidValue) {
EXPECT_THROW(decoder->decode("i e"), DecodingError);
EXPECT_THROW(decoder->decode("i+e"), DecodingError);
EXPECT_THROW(decoder->decode("i-e"), DecodingError);
EXPECT_THROW(decoder->decode("i1-e"), DecodingError);
EXPECT_THROW(decoder->decode("i1+e"), DecodingError);
EXPECT_THROW(decoder->decode("i$e"), DecodingError);
EXPECT_THROW(decoder->decode("i1.1e"), DecodingError);
}
//
// List decoding.
//
TEST_F(DecoderTests,
EmptyListIsCorrectlyDecoded) {
std::string data("le");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BList>(bItem);
auto bList = bItem->as<BList>();
EXPECT_TRUE(bList->empty());
}
TEST_F(DecoderTests,
ListWithSingleIntegerIsDecodedCorrectly) {
std::string data("li1ee");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BList>(bItem);
auto bList = bItem->as<BList>();
ASSERT_EQ(1, bList->size());
auto firstItem = bList->front();
assertDecodedAs<BInteger>(firstItem);
auto firstItemAsInteger = firstItem->as<BInteger>();
EXPECT_EQ(1, firstItemAsInteger->value());
}
TEST_F(DecoderTests,
ListWithTwoStringsIsDecodedCorrectly) {
std::string data("l4:test5:helloe");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BList>(bItem);
auto bList = bItem->as<BList>();
ASSERT_EQ(2, bList->size());
// "test"
auto firstItem = bList->front();
assertDecodedAs<BString>(firstItem);
auto firstItemAsString = firstItem->as<BString>();
EXPECT_EQ("test", firstItemAsString->value());
// "hello"
auto secondItem = bList->back();
assertDecodedAs<BString>(secondItem);
auto secondItemAsString = secondItem->as<BString>();
EXPECT_EQ("hello", secondItemAsString->value());
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenCharEIsMissingFromEndOfList) {
EXPECT_THROW(decoder->decode("li1e"), DecodingError);
EXPECT_THROW(decoder->decode("l4:test"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenListItemIsInvalidIsMissingFromEndOfList) {
EXPECT_THROW(decoder->decode("l$e"), DecodingError);
}
//
// String decoding.
//
TEST_F(DecoderTests,
EmptyStringIsCorrrectlyDecoded) {
std::string data("0:");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BString>(bItem);
auto bString = bItem->as<BString>();
EXPECT_EQ("", bString->value());
}
TEST_F(DecoderTests,
NonemptyStringWithSingleCharacterIsCorrrectlyDecoded) {
std::string data("1:a");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BString>(bItem);
auto bString = bItem->as<BString>();
EXPECT_EQ("a", bString->value());
}
TEST_F(DecoderTests,
NonemptyStringWithTenCharacterIsCorrrectlyDecoded) {
std::string data("10:abcdefghij");
std::shared_ptr<BItem> bItem(decoder->decode(data));
ADD_SCOPED_TRACE;
assertDecodedAs<BString>(bItem);
auto bString = bItem->as<BString>();
EXPECT_EQ("abcdefghij", bString->value());
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenColonIsMissingInString) {
EXPECT_THROW(decoder->decode("1a"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenStringHasNotEnoughCharacters) {
EXPECT_THROW(decoder->decode("3:aa"), DecodingError);
}
//
// Other.
//
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenInputIsEmpty) {
EXPECT_THROW(decoder->decode(""), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenInputIsAtEOF) {
std::istringstream input;
putIntoEOFState(input);
EXPECT_THROW(decoder->decode(input), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenInputIsInError) {
std::istringstream input;
putIntoErrorState(input);
EXPECT_THROW(decoder->decode(input), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenInputBeginsWithInvalidSymbol) {
EXPECT_THROW(decoder->decode("$"), DecodingError);
}
TEST_F(DecoderTests,
DecodeThrowsDecodingErrorWhenInputBeginsWithUnexpectedSymbol) {
EXPECT_THROW(decoder->decode("e"), DecodingError);
}
TEST_F(DecoderTests,
DecodeForStringThrowsDecodingErrorWhenInputIsNotCompletelyRead) {
// Only the first i1e should be decoded, thus leaving i2e unread (such an
// input is invalid as the integers are not inside of a list).
EXPECT_THROW(decoder->decode("i1ei2e"), DecodingError);
}
TEST_F(DecoderTests,
DecodeFromStreamWorksAsDecodeFromString) {
std::istringstream input("i0e");
std::shared_ptr<BItem> bItem(decoder->decode(input));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(0, bInteger->value());
}
TEST_F(DecoderTests,
DecodeForStreamDoesNotReadCharactersPassFirstDecodedItem) {
// The second i2e is supposed to be left in the stream.
std::istringstream input("i1ei2e");
std::shared_ptr<BItem> bItem(decoder->decode(input));
ASSERT_EQ('i', input.get());
ASSERT_EQ('2', input.get());
ASSERT_EQ('e', input.get());
}
TEST_F(DecoderTests,
DecodeFunctionForStringWorksAsCreatingDecoderAndCallingDecode) {
std::string input("i0e");
std::shared_ptr<BItem> bItem(decode(input));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(0, bInteger->value());
}
TEST_F(DecoderTests,
DecodeFunctionForStreamWorksAsCreatingDecoderAndCallingDecode) {
std::istringstream input("i0e");
std::shared_ptr<BItem> bItem(decode(input));
ADD_SCOPED_TRACE;
assertDecodedAs<BInteger>(bItem);
auto bInteger = bItem->as<BInteger>();
EXPECT_EQ(0, bInteger->value());
}
} // namespace tests
} // namespace bencoding