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
|
/*
* Copyright (c) 2022, Lucas Chollet <lucas.chollet@free.fr>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibTest/TestCase.h>
#include <AK/CircularBuffer.h>
namespace {
CircularBuffer create_circular_buffer(size_t size)
{
auto buffer_or_error = CircularBuffer::create_empty(size);
EXPECT(!buffer_or_error.is_error());
return buffer_or_error.release_value();
}
void safe_write(CircularBuffer& buffer, u8 i)
{
Bytes b { &i, 1 };
auto written_bytes = buffer.write(b);
EXPECT_EQ(written_bytes, 1ul);
};
void safe_read(CircularBuffer& buffer, u8 supposed_result)
{
u8 read_value {};
Bytes b { &read_value, 1 };
b = buffer.read(b);
EXPECT_EQ(b.size(), 1ul);
EXPECT_EQ(*b.data(), supposed_result);
};
void safe_discard(CircularBuffer& buffer, size_t size)
{
auto result = buffer.discard(size);
EXPECT(!result.is_error());
};
}
TEST_CASE(simple_write_read)
{
auto buffer = create_circular_buffer(1);
safe_write(buffer, 42);
safe_read(buffer, 42);
}
TEST_CASE(writing_above_limits)
{
auto buffer = create_circular_buffer(1);
safe_write(buffer, 1);
u8 value = 42;
Bytes b { &value, 1 };
auto written_bytes = buffer.write(b);
EXPECT_EQ(written_bytes, 0ul);
}
TEST_CASE(usage_with_wrapping_around)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
for (unsigned i {}; i < capacity; ++i)
safe_write(buffer, i + 8);
EXPECT_EQ(buffer.used_space(), capacity);
EXPECT_EQ(buffer.empty_space(), 0ul);
safe_read(buffer, 0 + 8);
safe_read(buffer, 1 + 8);
EXPECT_EQ(buffer.used_space(), capacity - 2);
safe_write(buffer, 5);
safe_write(buffer, 6);
EXPECT_EQ(buffer.used_space(), capacity);
safe_read(buffer, 10);
safe_read(buffer, 5);
safe_read(buffer, 6);
EXPECT_EQ(buffer.used_space(), 0ul);
}
TEST_CASE(full_read_aligned)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
for (unsigned i {}; i < capacity; ++i)
safe_write(buffer, i);
EXPECT_EQ(buffer.used_space(), capacity);
EXPECT_EQ(buffer.empty_space(), 0ul);
u8 const source[] = { 0, 1, 2 };
u8 result[] = { 0, 0, 0 };
auto const bytes_or_error = buffer.read({ result, 3 });
EXPECT_EQ(bytes_or_error.size(), 3ul);
EXPECT_EQ(memcmp(source, result, 3), 0);
}
TEST_CASE(full_read_non_aligned)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
for (unsigned i {}; i < capacity; ++i)
safe_write(buffer, i + 5);
safe_read(buffer, 5);
safe_write(buffer, 42);
EXPECT_EQ(buffer.used_space(), capacity);
EXPECT_EQ(buffer.empty_space(), 0ul);
u8 result[] = { 0, 0, 0 };
auto const bytes = buffer.read({ result, 3 });
EXPECT_EQ(bytes.size(), 3ul);
u8 const source[] = { 6, 7, 42 };
EXPECT_EQ(memcmp(source, result, 3), 0);
}
TEST_CASE(full_write_aligned)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
u8 const source[] = { 12, 13, 14 };
auto written_bytes = buffer.write({ source, 3 });
EXPECT_EQ(written_bytes, 3ul);
EXPECT_EQ(buffer.used_space(), capacity);
EXPECT_EQ(buffer.empty_space(), 0ul);
for (unsigned i {}; i < capacity; ++i)
safe_read(buffer, i + 12);
EXPECT_EQ(buffer.used_space(), 0ul);
}
TEST_CASE(full_write_non_aligned)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
safe_write(buffer, 10);
safe_read(buffer, 10);
u8 const source[] = { 12, 13, 14 };
auto written_bytes = buffer.write({ source, 3 });
EXPECT_EQ(written_bytes, 3ul);
EXPECT_EQ(buffer.used_space(), capacity);
EXPECT_EQ(buffer.empty_space(), 0ul);
for (unsigned i {}; i < capacity; ++i)
safe_read(buffer, i + 12);
EXPECT_EQ(buffer.used_space(), 0ul);
}
TEST_CASE(create_from_bytebuffer)
{
u8 const source[] = { 2, 4, 6 };
auto byte_buffer_or_error = ByteBuffer::copy(source, AK::array_size(source));
EXPECT(!byte_buffer_or_error.is_error());
auto byte_buffer = byte_buffer_or_error.release_value();
auto circular_buffer_or_error = CircularBuffer::create_initialized(move(byte_buffer));
EXPECT(!circular_buffer_or_error.is_error());
auto circular_buffer = circular_buffer_or_error.release_value();
EXPECT_EQ(circular_buffer.used_space(), circular_buffer.capacity());
EXPECT_EQ(circular_buffer.used_space(), 3ul);
safe_read(circular_buffer, 2);
safe_read(circular_buffer, 4);
safe_read(circular_buffer, 6);
}
TEST_CASE(discard)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
safe_write(buffer, 11);
safe_write(buffer, 12);
safe_discard(buffer, 1);
safe_read(buffer, 12);
EXPECT_EQ(buffer.used_space(), 0ul);
EXPECT_EQ(buffer.empty_space(), capacity);
}
TEST_CASE(discard_on_edge)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
safe_write(buffer, 11);
safe_write(buffer, 12);
safe_write(buffer, 13);
safe_discard(buffer, 2);
safe_write(buffer, 14);
safe_write(buffer, 15);
safe_discard(buffer, 2);
safe_read(buffer, 15);
EXPECT_EQ(buffer.used_space(), 0ul);
EXPECT_EQ(buffer.empty_space(), capacity);
}
TEST_CASE(discard_too_much)
{
constexpr size_t capacity = 3;
auto buffer = create_circular_buffer(capacity);
safe_write(buffer, 11);
safe_write(buffer, 12);
safe_discard(buffer, 2);
auto result = buffer.discard(2);
EXPECT(result.is_error());
}
TEST_CASE(offset_of)
{
auto const source = "Well Hello Friends!"sv;
auto byte_buffer_or_error = ByteBuffer::copy(source.bytes());
EXPECT(!byte_buffer_or_error.is_error());
auto byte_buffer = byte_buffer_or_error.release_value();
auto circular_buffer_or_error = CircularBuffer::create_initialized(byte_buffer);
EXPECT(!circular_buffer_or_error.is_error());
auto circular_buffer = circular_buffer_or_error.release_value();
auto result = circular_buffer.offset_of("Well"sv);
EXPECT(result.has_value());
EXPECT_EQ(result.value(), 0ul);
result = circular_buffer.offset_of("Hello"sv);
EXPECT(result.has_value());
EXPECT_EQ(result.value(), 5ul);
safe_discard(circular_buffer, 5);
auto written_bytes = circular_buffer.write(byte_buffer.span().trim(5));
EXPECT_EQ(written_bytes, 5ul);
result = circular_buffer.offset_of("!Well"sv);
EXPECT(result.has_value());
EXPECT_EQ(result.value(), 13ul);
result = circular_buffer.offset_of("!Well"sv, {}, 12);
EXPECT(!result.has_value());
result = circular_buffer.offset_of("e"sv, 2);
EXPECT(result.has_value());
EXPECT_EQ(result.value(), 9ul);
}
TEST_CASE(offset_of_with_until_and_after)
{
auto const source = "Well Hello Friends!"sv;
auto byte_buffer_or_error = ByteBuffer::copy(source.bytes());
EXPECT(!byte_buffer_or_error.is_error());
auto byte_buffer = byte_buffer_or_error.release_value();
auto circular_buffer_or_error = CircularBuffer::create_initialized(byte_buffer);
EXPECT(!circular_buffer_or_error.is_error());
auto circular_buffer = circular_buffer_or_error.release_value();
auto result = circular_buffer.offset_of("Well Hello Friends!"sv, 0, 19);
EXPECT_EQ(result.value_or(42), 0ul);
result = circular_buffer.offset_of(" Hello"sv, 4, 10);
EXPECT_EQ(result.value_or(42), 4ul);
result = circular_buffer.offset_of("el"sv, 3, 10);
EXPECT_EQ(result.value_or(42), 6ul);
safe_discard(circular_buffer, 5);
auto written_bytes = circular_buffer.write(byte_buffer.span().trim(5));
EXPECT_EQ(written_bytes, 5ul);
result = circular_buffer.offset_of("Hello Friends!Well "sv, 0, 19);
EXPECT_EQ(result.value_or(42), 0ul);
result = circular_buffer.offset_of("o Frie"sv, 4, 10);
EXPECT_EQ(result.value_or(42), 4ul);
result = circular_buffer.offset_of("el"sv, 3, 17);
EXPECT_EQ(result.value_or(42), 15ul);
}
TEST_CASE(offset_of_with_until_and_after_wrapping_around)
{
auto const source = "Well Hello Friends!"sv;
auto byte_buffer_or_error = ByteBuffer::copy(source.bytes());
EXPECT(!byte_buffer_or_error.is_error());
auto byte_buffer = byte_buffer_or_error.release_value();
auto circular_buffer_or_error = CircularBuffer::create_empty(19);
EXPECT(!circular_buffer_or_error.is_error());
auto circular_buffer = circular_buffer_or_error.release_value();
auto written_bytes = circular_buffer.write(byte_buffer.span().trim(5));
EXPECT_EQ(written_bytes, 5ul);
auto result = circular_buffer.offset_of("Well "sv, 0, 5);
EXPECT_EQ(result.value_or(42), 0ul);
written_bytes = circular_buffer.write(byte_buffer.span().slice(5));
EXPECT_EQ(written_bytes, 14ul);
result = circular_buffer.offset_of("Hello Friends!"sv, 5, 19);
EXPECT_EQ(result.value_or(42), 5ul);
safe_discard(circular_buffer, 5);
result = circular_buffer.offset_of("Hello Friends!"sv, 0, 14);
EXPECT_EQ(result.value_or(42), 0ul);
written_bytes = circular_buffer.write(byte_buffer.span().trim(5));
EXPECT_EQ(written_bytes, 5ul);
result = circular_buffer.offset_of("Well "sv, 14, 19);
EXPECT_EQ(result.value_or(42), 14ul);
}
|
