core/tests/RingBufferTests.cpp

#include "tests/RingBufferTests.h"

#include "data/RingBuffer.h"
#include "test/Test.h"

using String = Core::ArrayString<128>;

template<typename T>
static String build(const T& t) {
    String s;
    CORE_TEST_FALSE(s.append(t));
    return s;
}

struct Tester final {
    static int ids;
    static int sum;
    int id;

    Tester() : id(++ids) {
        sum += id;
    }

    Tester(const Tester&) : id(++ids) {
        sum += id;
    }

    Tester(Tester&&) : id(++ids) {
        sum += id;
    }

    Tester& operator=(const Tester&) {
        return *this;
    }

    Tester& operator=(Tester&&) {
        return *this;
    }

    ~Tester() {
        sum -= id;
    }

    // returns true on error
    template<int L>
    check_return bool toString(Core::ArrayString<L>& s) const {
        return s.append(id);
    }
};

int Tester::ids = 0;
int Tester::sum = 0;

static void resetTester() {
    Tester::ids = 0;
    Tester::sum = 0;
}

static void testReadAndWrite() {
    Core::RingBuffer<int, 5> buffer;
    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_EQUAL(0, buffer.getLength());
    CORE_TEST_NOT_NULL(buffer.add(4));
    CORE_TEST_EQUAL(1, buffer.getLength());
    CORE_TEST_TRUE(buffer.canRemove());
    CORE_TEST_EQUAL(4, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_EQUAL(0, buffer.getLength());
}

static void testOverflow() {
    Core::RingBuffer<int, 3> buffer;
    CORE_TEST_NOT_NULL(buffer.add(1));
    CORE_TEST_NOT_NULL(buffer.add(2));
    CORE_TEST_NOT_NULL(buffer.add(3));
    CORE_TEST_NULL(buffer.add(4));
    CORE_TEST_NULL(buffer.add(5));
    CORE_TEST_EQUAL(3, buffer.getLength());
    CORE_TEST_EQUAL(1, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(2, buffer.getLength());
    CORE_TEST_EQUAL(2, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(1, buffer.getLength());
    CORE_TEST_EQUAL(3, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_EQUAL(0, buffer.getLength());
}

static void testRefill() {
    Core::RingBuffer<int, 3> buffer;
    CORE_TEST_NOT_NULL(buffer.add(1));
    CORE_TEST_NOT_NULL(buffer.add(2));
    CORE_TEST_NOT_NULL(buffer.add(3));
    CORE_TEST_NULL(buffer.add(4));
    CORE_TEST_EQUAL(3, buffer.getLength());
    CORE_TEST_TRUE(buffer.canRemove());
    CORE_TEST_EQUAL(1, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(2, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(3, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(0, buffer.getLength());

    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_NOT_NULL(buffer.add(5));
    CORE_TEST_NOT_NULL(buffer.add(6));
    CORE_TEST_EQUAL(2, buffer.getLength());
    CORE_TEST_TRUE(buffer.canRemove());
    CORE_TEST_EQUAL(5, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(6, buffer[0]);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_EQUAL(0, buffer.getLength());
}

static void testClear() {
    Core::RingBuffer<int, 3> buffer;
    CORE_TEST_NOT_NULL(buffer.add(1));
    CORE_TEST_NOT_NULL(buffer.add(2));
    CORE_TEST_EQUAL(2, buffer.getLength());
    buffer.clear();
    CORE_TEST_FALSE(buffer.canRemove());
    CORE_TEST_EQUAL(0, buffer.getLength());
}

static void testConstructDestruct() {
    resetTester();
    Core::RingBuffer<Tester, 3> buffer;
    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(1, Tester::sum);
    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(3, Tester::sum);
    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(6, Tester::sum);

    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(5, Tester::sum);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(3, Tester::sum);
    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(0, Tester::sum);
}

static void testCopyDestruct() {
    resetTester();
    {
        Core::RingBuffer<Tester, 3> buffer;
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(1, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(3, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(6, Tester::sum);
        {
            Core::RingBuffer<Tester, 3> copy = buffer;
            CORE_TEST_EQUAL(6 + 4 + 5 + 6, Tester::sum);
        }
        CORE_TEST_EQUAL(6, Tester::sum);
    }
    CORE_TEST_EQUAL(0, Tester::sum);
}

static void testCopyAssignmentDestruct() {
    resetTester();
    {
        Core::RingBuffer<Tester, 3> buffer;
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(1, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(3, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(6, Tester::sum);
        {
            Core::RingBuffer<Tester, 3> copy;
            copy = buffer;
            CORE_TEST_EQUAL(6 + 4 + 5 + 6, Tester::sum);
        }
        CORE_TEST_EQUAL(6, Tester::sum);
    }
    CORE_TEST_EQUAL(0, Tester::sum);
}

static void testMoveDestruct() {
    resetTester();
    {
        Core::RingBuffer<Tester, 3> buffer;
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(1, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(3, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(6, Tester::sum);
        {
            Core::RingBuffer<Tester, 3> move = Core::move(buffer);
            CORE_TEST_EQUAL(4 + 5 + 6, Tester::sum);
            CORE_TEST_EQUAL(0, buffer.getLength());
        }
        CORE_TEST_EQUAL(0, Tester::sum);
    }
    CORE_TEST_EQUAL(0, Tester::sum);
}

static void testMoveAssignmentDestruct() {
    resetTester();
    {
        Core::RingBuffer<Tester, 3> buffer;
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(1, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(3, Tester::sum);
        CORE_TEST_NOT_NULL(buffer.add());
        CORE_TEST_EQUAL(6, Tester::sum);
        {
            Core::RingBuffer<Tester, 3> move;
            move = Core::move(buffer);
            CORE_TEST_EQUAL(4 + 5 + 6, Tester::sum);
            CORE_TEST_EQUAL(0, buffer.getLength());
        }
        CORE_TEST_EQUAL(0, Tester::sum);
    }
    CORE_TEST_EQUAL(0, Tester::sum);
}

static void testOverall() {
    resetTester();
    Core::RingBuffer<Tester, 3> buffer;

    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(build("[1, 2, 3]"), build(buffer));
    CORE_TEST_EQUAL(3, buffer.getLength());
    CORE_TEST_EQUAL(6, Tester::sum);

    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(build("[2, 3]"), build(buffer));
    CORE_TEST_EQUAL(2, buffer.getLength());
    CORE_TEST_EQUAL(5, Tester::sum);

    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(build("[2, 3, 4]"), build(buffer));
    CORE_TEST_EQUAL(3, buffer.getLength());
    CORE_TEST_EQUAL(9, Tester::sum);

    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(build("[3, 4]"), build(buffer));
    CORE_TEST_EQUAL(2, buffer.getLength());
    CORE_TEST_EQUAL(7, Tester::sum);

    CORE_TEST_NOT_NULL(buffer.add());
    CORE_TEST_EQUAL(build("[3, 4, 5]"), build(buffer));
    CORE_TEST_EQUAL(3, buffer.getLength());
    CORE_TEST_EQUAL(12, Tester::sum);

    CORE_TEST_FALSE(buffer.remove());
    CORE_TEST_EQUAL(build("[4, 5]"), build(buffer));
    CORE_TEST_EQUAL(2, buffer.getLength());
    CORE_TEST_EQUAL(9, Tester::sum);

    buffer.clear();
    CORE_TEST_EQUAL(build("[]"), build(buffer));
    CORE_TEST_EQUAL(0, buffer.getLength());
    CORE_TEST_EQUAL(0, Tester::sum);
}

void Core::RingBufferTests::test() {
    testReadAndWrite();
    testOverflow();
    testRefill();
    testClear();
    testConstructDestruct();
    testCopyDestruct();
    testCopyAssignmentDestruct();
    testMoveDestruct();
    testMoveAssignmentDestruct();
    testOverall();
}