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
// Copyright (C) 2009-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#include <config.h>

#include <exceptions/exceptions.h>
#include <util/buffer.h>

#ifdef EXPECT_DEATH
#include <util/unittests/resource.h>
#include <util/unittests/check_valgrind.h>
#endif /* EXPECT_DEATH */

#include <gtest/gtest.h><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

using namespace isc;
using namespace isc::util;

namespace {

class BufferTest : public ::testing::Test {
protected:
    BufferTest() : ibuffer(testdata, sizeof(testdata)), obuffer(0),
                   expected_size(0) {
        data16 = (2 << 8) | 3;
        data32 = (4 << 24) | (5 << 16) | (6 << 8) | 7;
        memset(vdata, 0, sizeof(testdata));
    }

    InputBuffer ibuffer;
    OutputBuffer obuffer;
    static const uint8_t testdata[5];
    uint8_t vdata[sizeof(testdata)];
    size_t expected_size;
    uint16_t data16;
    uint32_t data32;
    std::vector<uint8_t> datav;
};

const uint8_t BufferTest::testdata[5] = {1, 2, 3, 4, 5};

TEST_F(BufferTest, outputBufferClear) {
    obuffer.writeData(testdata, sizeof(testdata));
    obuffer.clear();
    ASSERT_EQ(0, obuffer.getLength());
    ASSERT_FALSE(obuffer.getData());
}

TEST_F(BufferTest, outputBufferCopy) {
    ASSERT_NO_THROW({
        obuffer.writeData(testdata, sizeof(testdata));

        OutputBuffer copy(obuffer);
        ASSERT_EQ(sizeof(testdata), copy.getLength());
        ASSERT_NE(obuffer.getData(), copy.getData());
        for (size_t i = 0; i < sizeof(testdata); ++i) {
            ASSERT_EQ(testdata[i], copy[i]);
            if (i + 1 < sizeof(testdata)) {
                obuffer.writeUint16At(0, i);
            }
            ASSERT_EQ(testdata[i], copy[i]);
        }
        obuffer.clear();
        ASSERT_EQ(sizeof(testdata), copy.getLength());
    });
}

TEST_F(BufferTest, outputEmptyBufferCopy) {
    ASSERT_NO_THROW({
        OutputBuffer copy(obuffer);
        ASSERT_EQ(0, copy.getLength());
        ASSERT_FALSE(copy.getData());
    });
}

TEST_F(BufferTest, outputBufferAssign) {
    ASSERT_NO_THROW({
        OutputBuffer another(0);
        another.clear();
        obuffer.writeData(testdata, sizeof(testdata));

        another = obuffer;
        ASSERT_EQ(sizeof(testdata), another.getLength());
        ASSERT_NE(obuffer.getData(), another.getData());
        for (size_t i = 0; i < sizeof(testdata); ++i) {
            ASSERT_EQ(testdata[i], another[i]);
            if (i + 1 < sizeof(testdata)) {
                obuffer.writeUint16At(0, i);
            }
            ASSERT_EQ(testdata[i], another[i]);
        }
        obuffer.clear();
        ASSERT_EQ(sizeof(testdata), another.getLength());
    });
}

TEST_F(BufferTest, outputEmptyBufferAssign) {
    OutputBuffer copy(0);
    ASSERT_NO_THROW(copy = obuffer;);<--- There is an unknown macro here somewhere. Configuration is required. If ASSERT_NO_THROW is a macro then please configure it.
    ASSERT_EQ(0, copy.getLength());
    ASSERT_EQ(0, copy.getData());
}

// Check assign to self doesn't break stuff
TEST_F(BufferTest, outputBufferAssignSelf) {
    ASSERT_NO_THROW(obuffer = obuffer);
}

TEST_F(BufferTest, inputBufferException) {
    ASSERT_THROW(ibuffer.setPosition(6), isc::OutOfRange);

    ibuffer.setPosition(sizeof(testdata));
    ASSERT_THROW(ibuffer.peekUint8(), isc::OutOfRange);
    ASSERT_THROW(ibuffer.readUint8(), isc::OutOfRange);

    ibuffer.setPosition(sizeof(testdata) - 1);
    ASSERT_THROW(ibuffer.peekUint16(), isc::OutOfRange);
    ASSERT_THROW(ibuffer.readUint16(), isc::OutOfRange);

    ibuffer.setPosition(sizeof(testdata) - 3);
    ASSERT_THROW(ibuffer.peekUint32(), isc::OutOfRange);
    ASSERT_THROW(ibuffer.readUint32(), isc::OutOfRange);

    ibuffer.setPosition(sizeof(testdata) - 4);
    ASSERT_THROW(ibuffer.peekData(vdata, sizeof(vdata)), isc::OutOfRange);
    ASSERT_THROW(ibuffer.readData(vdata, sizeof(vdata)), isc::OutOfRange);
    ASSERT_THROW(ibuffer.peekVector(datav, sizeof(vdata)), isc::OutOfRange);
    ASSERT_THROW(ibuffer.readVector(datav, sizeof(vdata)), isc::OutOfRange);
}

TEST_F(BufferTest, outputBufferExtend) {
    ASSERT_EQ(0, obuffer.getCapacity());
    ASSERT_EQ(0, obuffer.getLength());
    obuffer.writeUint8(10);
    ASSERT_LT(0, obuffer.getCapacity());
    ASSERT_EQ(1, obuffer.getLength());
}

TEST_F(BufferTest, outputBufferSkip) {
    obuffer.skip(4);
    ASSERT_EQ(4, obuffer.getLength());

    obuffer.skip(2);
    ASSERT_EQ(6, obuffer.getLength());
}

TEST_F(BufferTest, outputBufferTrim) {
    obuffer.writeData(testdata, sizeof(testdata));
    ASSERT_EQ(5, obuffer.getLength());

    obuffer.trim(1);
    ASSERT_EQ(4, obuffer.getLength());

    obuffer.trim(2);
    ASSERT_EQ(2, obuffer.getLength());

    ASSERT_THROW(obuffer.trim(3), OutOfRange);
}

TEST_F(BufferTest, inputBufferRead) {
    ASSERT_EQ(5, ibuffer.getLength());
    ASSERT_EQ(1, ibuffer.peekUint8());
    ASSERT_EQ(0, ibuffer.getPosition());
    ASSERT_EQ(1, ibuffer.readUint8());
    ASSERT_EQ(1, ibuffer.getPosition());
    data16 = ibuffer.peekUint16();
    ASSERT_EQ(1, ibuffer.getPosition());
    ASSERT_EQ(data16, ibuffer.readUint16());
    ASSERT_EQ((2 << 8) | 3, data16);
    ASSERT_EQ(3, ibuffer.getPosition());
    ibuffer.setPosition(1);
    ASSERT_EQ(1, ibuffer.getPosition());
    data32 = ibuffer.peekUint32();
    ASSERT_EQ(1, ibuffer.getPosition());
    ASSERT_EQ(data32, ibuffer.readUint32());
    ASSERT_EQ((2 << 24) | (3 << 16) | (4 << 8) | 5, data32);
    ibuffer.setPosition(0);
    memset(vdata, 0, sizeof(vdata));
    ibuffer.peekData(vdata, sizeof(vdata));
    ASSERT_EQ(0, memcmp(vdata, testdata, sizeof(testdata)));
    ASSERT_EQ(0, ibuffer.getPosition());
    memset(vdata, 0, sizeof(vdata));
    ibuffer.readData(vdata, sizeof(vdata));
    ASSERT_EQ(0, memcmp(vdata, testdata, sizeof(testdata)));
    ASSERT_EQ(sizeof(vdata), ibuffer.getPosition());
    ibuffer.setPosition(0);
    datav.clear();
    ibuffer.peekVector(datav, sizeof(vdata));
    ASSERT_EQ(sizeof(vdata), datav.size());
    ASSERT_EQ(0, memcmp(&vdata[0], testdata, sizeof(testdata)));
    ASSERT_EQ(0, ibuffer.getPosition());
    datav.clear();
    ibuffer.readVector(datav, sizeof(vdata));
    ASSERT_EQ(sizeof(vdata), datav.size());
    ASSERT_EQ(0, memcmp(&vdata[0], testdata, sizeof(testdata)));
    ASSERT_EQ(sizeof(vdata), ibuffer.getPosition());
}

TEST_F(BufferTest, outputBufferReadAt) {
    obuffer.writeData(testdata, sizeof(testdata));
    for (size_t i = 0; i < sizeof(testdata); ++i) {
        ASSERT_EQ(testdata[i], obuffer[i]);
    }
    ASSERT_THROW(obuffer[sizeof(testdata)], isc::OutOfRange);
}

TEST_F(BufferTest, inputBufferReadVectorChunks) {
    std::vector<uint8_t> vec;

    // check that vector can read the whole buffer
    ibuffer.readVector(vec, 3);
    ASSERT_EQ(3, vec.size());
    ASSERT_EQ(0, memcmp(&vec[0], testdata, 3));
    ASSERT_NO_THROW(ibuffer.readVector(vec, 2));
    ASSERT_EQ(2, vec.size());
    ASSERT_EQ(0, memcmp(&vec[0], &testdata[3], 2));
}

TEST_F(BufferTest, outputBufferWrite) {
    obuffer.writeUint8(1);
    expected_size += sizeof(uint8_t);
    ASSERT_EQ(expected_size, obuffer.getLength());
    const uint8_t* cp = obuffer.getData();
    ASSERT_EQ(1, *cp);

    obuffer.writeUint16(data16);
    expected_size += sizeof(data16);
    cp = obuffer.getData();
    ASSERT_EQ(expected_size, obuffer.getLength());
    ASSERT_EQ(2, *(cp + 1));
    ASSERT_EQ(3, *(cp + 2));

    obuffer.writeUint32(data32);
    expected_size += sizeof(data32);
    cp = obuffer.getData();
    ASSERT_EQ(expected_size, obuffer.getLength());
    ASSERT_EQ(4, *(cp + 3));
    ASSERT_EQ(5, *(cp + 4));
    ASSERT_EQ(6, *(cp + 5));
    ASSERT_EQ(7, *(cp + 6));

    obuffer.writeData(testdata, sizeof(testdata));
    expected_size += sizeof(testdata);
    ASSERT_EQ(expected_size, obuffer.getLength());
    cp = obuffer.getData();
    ASSERT_EQ(0, memcmp(cp + 7, testdata, sizeof(testdata)));

    datav = obuffer.getVector();
    ASSERT_EQ(expected_size, datav.size());
    std::vector<uint8_t> expected = { 1, 2, 3, 4, 5, 6, 7 };
    expected.insert(expected.end(), testdata, testdata + sizeof(testdata));
    ASSERT_EQ(expected_size, expected.size());
    ASSERT_EQ(0, memcmp(&expected[0], &datav[0], expected_size));
}

TEST_F(BufferTest, outputBufferWriteAt) {
    obuffer.writeUint32(data32);
    expected_size += sizeof(data32);

    // overwrite 2nd byte
    obuffer.writeUint8At(4, 1);
    ASSERT_EQ(expected_size, obuffer.getLength()); // length shouldn't change
    const uint8_t* cp = obuffer.getData();
    ASSERT_EQ(4, *(cp + 1));

    // overwrite 2nd and 3rd bytes
    obuffer.writeUint16At(data16, 1);
    ASSERT_EQ(expected_size, obuffer.getLength()); // length shouldn't change
    cp = obuffer.getData();
    ASSERT_EQ(2, *(cp + 1));
    ASSERT_EQ(3, *(cp + 2));

    // overwrite 3rd and 4th bytes
    obuffer.writeUint16At(data16, 2);
    ASSERT_EQ(expected_size, obuffer.getLength());
    cp = obuffer.getData();
    ASSERT_EQ(2, *(cp + 2));
    ASSERT_EQ(3, *(cp + 3));

    ASSERT_THROW(obuffer.writeUint8At(data16, 5), isc::OutOfRange);
    ASSERT_THROW(obuffer.writeUint8At(data16, 4), isc::OutOfRange);
    ASSERT_THROW(obuffer.writeUint16At(data16, 3), isc::OutOfRange);
    ASSERT_THROW(obuffer.writeUint16At(data16, 4), isc::OutOfRange);
    ASSERT_THROW(obuffer.writeUint16At(data16, 5), isc::OutOfRange);
}

// Tests whether uint64 can be written properly.
TEST_F(BufferTest, writeUint64) {
    uint64_t val1 = 0x0102030405060708ul;
    uint64_t val2 = 0xfffffffffffffffful;
    uint8_t exp_val1[] = { 1, 2, 3, 4, 5, 6, 7, 8 };
    uint8_t exp_val2[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };

    obuffer.writeUint64(val1);
    ASSERT_EQ(sizeof(uint64_t), obuffer.getLength());
    const uint8_t* cp = obuffer.getData();
    ASSERT_TRUE(cp);
    ASSERT_FALSE(memcmp(exp_val1, obuffer.getData(), sizeof(uint64_t)));

    ASSERT_NO_THROW(obuffer.clear());
    obuffer.writeUint64(val2);
    ASSERT_EQ(sizeof(uint64_t), obuffer.getLength());
    cp = obuffer.getData();
    ASSERT_TRUE(cp);
    ASSERT_FALSE(memcmp(exp_val2, obuffer.getData(), sizeof(uint64_t)));
}

}