test/test_buffer.cpp

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include "cx/buffer.h"

#include <gtest/gtest.h>
#include "util_allocator.h"

static void expect_default_flush_config(CxBuffer *buf) {
    EXPECT_EQ(buf->flush_blkmax, 0);
    EXPECT_EQ(buf->flush_blksize, 4096);
    EXPECT_EQ(buf->flush_threshold, SIZE_MAX);
    EXPECT_EQ(buf->flush_func, nullptr);
}

TEST(BufferInit, WrapSpace) {
    CxTestingAllocator alloc;
    CxBuffer buf;
    void *space = cxMalloc(&alloc, 16);
    cxBufferInit(&buf, space, 16, &alloc, CX_BUFFER_DEFAULT);
    expect_default_flush_config(&buf);
    EXPECT_EQ(buf.space, space);
    EXPECT_EQ(buf.flags & CX_BUFFER_AUTO_EXTEND, 0);
    EXPECT_EQ(buf.flags & CX_BUFFER_FREE_CONTENTS, 0);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_EQ(buf.capacity, 16);
    EXPECT_EQ(buf.allocator, &alloc);
    cxBufferDestroy(&buf);
    EXPECT_FALSE(alloc.verify());
    cxFree(&alloc, space);
    EXPECT_TRUE(alloc.verify());
}

TEST(BufferInit, WrapSpaceAutoExtend) {
    CxTestingAllocator alloc;
    CxBuffer buf;
    void *space = cxMalloc(&alloc, 16);
    cxBufferInit(&buf, space, 16, &alloc, CX_BUFFER_AUTO_EXTEND);
    expect_default_flush_config(&buf);
    EXPECT_EQ(buf.space, space);
    EXPECT_EQ(buf.flags & CX_BUFFER_AUTO_EXTEND, CX_BUFFER_AUTO_EXTEND);
    EXPECT_EQ(buf.flags & CX_BUFFER_FREE_CONTENTS, 0);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_EQ(buf.capacity, 16);
    EXPECT_EQ(buf.allocator, &alloc);
    cxBufferDestroy(&buf);
    EXPECT_FALSE(alloc.verify());
    cxFree(&alloc, space);
    EXPECT_TRUE(alloc.verify());
}

TEST(BufferInit, WrapSpaceAutoFree) {
    CxTestingAllocator alloc;
    CxBuffer buf;
    void *space = cxMalloc(&alloc, 16);
    cxBufferInit(&buf, space, 16, &alloc, CX_BUFFER_FREE_CONTENTS);
    expect_default_flush_config(&buf);
    EXPECT_EQ(buf.space, space);
    EXPECT_EQ(buf.flags & CX_BUFFER_AUTO_EXTEND, 0);
    EXPECT_EQ(buf.flags & CX_BUFFER_FREE_CONTENTS, CX_BUFFER_FREE_CONTENTS);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_EQ(buf.capacity, 16);
    EXPECT_EQ(buf.allocator, &alloc);
    EXPECT_FALSE(alloc.verify());
    cxBufferDestroy(&buf);
    EXPECT_TRUE(alloc.verify());
}

TEST(BufferInit, FreshSpace) {
    CxTestingAllocator alloc;
    CxBuffer buf;
    cxBufferInit(&buf, nullptr, 8, &alloc, CX_BUFFER_DEFAULT);
    expect_default_flush_config(&buf);
    EXPECT_NE(buf.space, nullptr);
    EXPECT_EQ(buf.flags & CX_BUFFER_AUTO_EXTEND, 0);
    EXPECT_EQ(buf.flags & CX_BUFFER_FREE_CONTENTS, CX_BUFFER_FREE_CONTENTS);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_EQ(buf.capacity, 8);
    EXPECT_EQ(buf.allocator, &alloc);
    EXPECT_FALSE(alloc.verify()); // space is still allocated
    cxBufferDestroy(&buf);
    EXPECT_TRUE(alloc.verify());
}

class BufferShiftFixture : public ::testing::Test {
protected:
    void SetUp() override {
        ASSERT_TRUE(alloc.verify());
        cxBufferInit(&buf, nullptr, 16, &alloc, CX_BUFFER_DEFAULT);
        memcpy(buf.space, "test____________", 16);
        buf.capacity = 8; // purposely pretend that the buffer has less capacity s.t. we can test beyond the range
        buf.pos = 4;
        buf.size = 4;
    }

    void TearDown() override {
        cxBufferDestroy(&buf);
        EXPECT_TRUE(alloc.verify());
    }

    CxTestingAllocator alloc;
    CxBuffer buf{};
};

class BufferShiftLeft : public BufferShiftFixture {
};

TEST_F(BufferShiftLeft, Zero) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShiftLeft(&buf, 0);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 4);
    EXPECT_EQ(buf.size, 4);
    EXPECT_TRUE(memcmp(buf.space, "test________", 8) == 0);
}

TEST_F(BufferShiftLeft, Standard) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShiftLeft(&buf, 2);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 2);
    EXPECT_EQ(buf.size, 2);
    EXPECT_TRUE(memcmp(buf.space, "stst________", 8) == 0);
}

TEST_F(BufferShiftLeft, Overshift) {
    ASSERT_LT(buf.pos, 6);
    ASSERT_LT(buf.size, 6);
    int ret = cxBufferShiftLeft(&buf, 6);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_TRUE(memcmp(buf.space, "test________", 8) == 0);
}

TEST_F(BufferShiftLeft, OvershiftPosOnly) {
    buf.pos = 2;
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShiftLeft(&buf, 3);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 0);
    EXPECT_EQ(buf.size, 1);
    EXPECT_TRUE(memcmp(buf.space, "test________", 8) == 0);
}

TEST_F(BufferShiftLeft, OffsetInterface) {
    buf.pos = 3;
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShift(&buf, -2);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 1);
    EXPECT_EQ(buf.size, 2);
    EXPECT_TRUE(memcmp(buf.space, "stst________", 8) == 0);
}

class BufferShiftRight : public BufferShiftFixture {
};

TEST_F(BufferShiftRight, Zero) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShiftRight(&buf, 0);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 4);
    EXPECT_EQ(buf.size, 4);
    EXPECT_TRUE(memcmp(buf.space, "test________", 8) == 0);
}

TEST_F(BufferShiftRight, Standard) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShiftRight(&buf, 3);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 7);
    EXPECT_EQ(buf.size, 7);
    EXPECT_TRUE(memcmp(buf.space, "testest_____", 8) == 0);
}

TEST_F(BufferShiftRight, OvershiftDiscard) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    ASSERT_EQ(buf.capacity, 8);
    int ret = cxBufferShiftRight(&buf, 6);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 8);
    EXPECT_EQ(buf.size, 8);
    EXPECT_EQ(buf.capacity, 8);
    EXPECT_TRUE(memcmp(buf.space, "test__te____", 8) == 0);
}

TEST_F(BufferShiftRight, OvershiftExtend) {
    ASSERT_EQ(buf.pos, 4);
    ASSERT_EQ(buf.size, 4);
    ASSERT_EQ(buf.capacity, 8);
    buf.flags |= CX_BUFFER_AUTO_EXTEND;
    int ret = cxBufferShiftRight(&buf, 6);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 10);
    EXPECT_EQ(buf.size, 10);
    EXPECT_GE(buf.capacity, 10);
    EXPECT_TRUE(memcmp(buf.space, "test__test__", 8) == 0);
}

TEST_F(BufferShiftRight, OffsetInterface) {
    buf.pos = 3;
    ASSERT_EQ(buf.size, 4);
    int ret = cxBufferShift(&buf, 2);
    EXPECT_EQ(ret, 0);
    EXPECT_EQ(buf.pos, 5);
    EXPECT_EQ(buf.size, 6);
    EXPECT_TRUE(memcmp(buf.space, "tetest______", 8) == 0);
}

TEST(BufferMinimumCapacity, Sufficient) {
    CxTestingAllocator alloc;
    auto space = cxMalloc(&alloc, 8);
    CxBuffer buf;
    cxBufferInit(&buf, space, 8, &alloc, CX_BUFFER_FREE_CONTENTS);
    memcpy(space, "Testing", 8);
    buf.size = 8;
    cxBufferMinimumCapacity(&buf, 6);
    EXPECT_EQ(buf.capacity, 8);
    EXPECT_EQ(buf.size, 8);
    EXPECT_TRUE(memcmp(buf.space, "Testing", 8) == 0);
    cxBufferDestroy(&buf);
    EXPECT_TRUE(alloc.verify());
}

TEST(BufferMinimumCapacity, Extend) {
    CxTestingAllocator alloc;
    auto space = cxMalloc(&alloc, 8);
    CxBuffer buf;
    cxBufferInit(&buf, space, 8, &alloc, CX_BUFFER_FREE_CONTENTS); // NO auto extend!
    memcpy(space, "Testing", 8);
    buf.size = 8;
    cxBufferMinimumCapacity(&buf, 16);
    EXPECT_EQ(buf.capacity, 16);
    EXPECT_EQ(buf.size, 8);
    EXPECT_TRUE(memcmp(buf.space, "Testing", 8) == 0);
    cxBufferDestroy(&buf);
    EXPECT_TRUE(alloc.verify());
}

TEST(BufferClear, Test) {
    char space[16];
    strcpy(space, "clear test");
    CxBuffer buf;
    cxBufferInit(&buf, space, 16, cxDefaultAllocator, CX_BUFFER_DEFAULT);
    ASSERT_EQ(buf.size, 0);
    // only clear the used part of the buffer
    cxBufferClear(&buf);
    EXPECT_EQ(memcmp(space, "clear test", 10), 0);
    buf.size = 5;
    buf.pos = 3;
    cxBufferClear(&buf);
    EXPECT_EQ(memcmp(space, "\0\0\0\0\0 test", 10), 0);
    EXPECT_EQ(buf.size, 0);
    EXPECT_EQ(buf.pos, 0);
    cxBufferDestroy(&buf);
}

class BufferWrite : public ::testing::Test {
protected:
    CxBuffer buf{};

    void SetUp() override {
        cxBufferInit(&buf, nullptr, 16, cxDefaultAllocator, CX_BUFFER_DEFAULT);
        buf.capacity = 8; // artificially reduce capacity to check OOB writes
        memset(buf.space, 0, 16);
        memcpy(buf.space, "prep", 4);
        buf.size = buf.pos = 4;
    }

    void TearDown() override {
        cxBufferDestroy(&buf);
    }
};

TEST_F(BufferWrite, SizeOneFit) {
    const char *data = "test";
    ASSERT_EQ(buf.capacity, 8);
    ASSERT_EQ(buf.pos, 4);
    size_t written = cxBufferWrite(data, 1, 4, &buf);
    EXPECT_EQ(written, 4);
    EXPECT_EQ(buf.size, 8);
    EXPECT_EQ(buf.pos, 8);
    EXPECT_EQ(buf.capacity, 8);
    EXPECT_EQ(memcmp(buf.space, "preptest", 8), 0);
}

TEST_F(BufferWrite, SizeOneOverwrite) {

}

TEST_F(BufferWrite, SizeOnePartialOverwrite) {

}

TEST_F(BufferWrite, SizeOneDiscard) {
    const char *data = "testing";
    ASSERT_EQ(buf.capacity, 8);
    ASSERT_EQ(buf.pos, 4);
    size_t written = cxBufferWrite(data, 1, 7, &buf);
    EXPECT_EQ(written, 4);
    EXPECT_EQ(buf.size, 8);
    EXPECT_EQ(buf.pos, 8);
    EXPECT_EQ(buf.capacity, 8);
    EXPECT_EQ(memcmp(buf.space, "preptest\0", 9), 0);
}

TEST_F(BufferWrite, SizeOneExtend) {
    buf.flags |= CX_BUFFER_AUTO_EXTEND;
    const char *data = "testing";
    ASSERT_EQ(buf.capacity, 8);
    ASSERT_EQ(buf.pos, 4);
    size_t written = cxBufferWrite(data, 1, 7, &buf);
    EXPECT_EQ(written, 7);
    EXPECT_EQ(buf.size, 11);
    EXPECT_EQ(buf.pos, 11);
    EXPECT_GE(buf.capacity, 11);
    EXPECT_EQ(memcmp(buf.space, "preptesting", 11), 0);
}

TEST_F(BufferWrite, MultibyteOverwrite) {

}

TEST_F(BufferWrite, MultibytePartialOverwrite) {

}

TEST_F(BufferWrite, MultibyteFit) {

}

TEST_F(BufferWrite, MultibyteDiscard) {
    // remember: whole elements are discarded if they do not fit
}

TEST_F(BufferWrite, MultibyteExtend) {

}

TEST_F(BufferWrite, PutcWrapperFit) {

}

TEST_F(BufferWrite, PutcWrapperOverwrite) {

}

TEST_F(BufferWrite, PutcWrapperPartialOverwrite) {

}

TEST_F(BufferWrite, PutcWrapperDiscard) {

}

TEST_F(BufferWrite, PutcWrapperExtend) {

}

TEST_F(BufferWrite, PutStringWrapperFit) {

}

TEST_F(BufferWrite, PutStringWrapperOverwrite) {

}

TEST_F(BufferWrite, PutStringWrapperPartialOverwrite) {

}

TEST_F(BufferWrite, PutStringWrapperDiscard) {

}

TEST_F(BufferWrite, PutStringWrapperExtend) {

}