test/buffer_tests.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2013 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 "buffer_tests.h"
#include "ucx/utils.h"

/*
 * TODO: refactor tests
 *  
 * ucx_buffer_extend
 * ucx_buffer_extract
 * ucx_buffer_write
 * 
 */

UCX_TEST(test_ucx_buffer_new) {
    UcxBuffer *b = ucx_buffer_new(NULL, 16, UCX_BUFFER_AUTOEXTEND);
    UcxBuffer *b2 = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(b->capacity==16, "wrong capacity");
    UCX_TEST_ASSERT(b2->capacity==32, "wrong capacity");
    
    UCX_TEST_ASSERT(b->size==0, "wrong size");
    UCX_TEST_ASSERT(b2->size==0, "wrong size");
    
    UCX_TEST_ASSERT(b->pos==0, "wrong position");
    UCX_TEST_ASSERT(b2->pos==0, "wrong position");
    
    UCX_TEST_ASSERT(b->flags==(UCX_BUFFER_AUTOEXTEND|UCX_BUFFER_AUTOFREE),
        "wrong flags for autoextending buffer");
    UCX_TEST_ASSERT(b2->flags==UCX_BUFFER_AUTOFREE,
        "wrong flags for default bufer");
    
    UCX_TEST_END
    ucx_buffer_free(b2);
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_new_prealloc) {
    char* test = (char*) malloc(16);
    UcxBuffer *b = ucx_buffer_new(test, 16, UCX_BUFFER_DEFAULT);
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(b->capacity==16, "wrong capacity");
    UCX_TEST_ASSERT(b->size==0, "wrong size");    
    UCX_TEST_ASSERT(b->pos==0, "wrong position");
    
    UCX_TEST_ASSERT(b->flags==0, "wrong flags - all should be cleared");
    
    UCX_TEST_END
    free(test);
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_eof) {
    char *test = "0123456789ABCDEF";
    UcxBuffer *b = ucx_buffer_new(test, 16, UCX_BUFFER_DEFAULT);
    UCX_TEST_BEGIN
    b->pos = 9; b->size = 10;
    UCX_TEST_ASSERT(!ucx_buffer_eof(b), "false positive");
    b->pos = 10; b->size = 10;
    UCX_TEST_ASSERT(ucx_buffer_eof(b), "pos == size should be EOF");
    b->pos = 11; b->size = 10;
    UCX_TEST_ASSERT(ucx_buffer_eof(b), "false negative");
    UCX_TEST_END
}

UCX_TEST(test_ucx_buffer_seek_overflow) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->size = 32;
    int r;
    
    UCX_TEST_BEGIN
    size_t bigpos = SIZE_MAX - 5000;
    b->pos = bigpos;
    r = ucx_buffer_seek(b, 5016, SEEK_CUR);
    UCX_TEST_ASSERT(r != 0, "seek cur overflow");
    UCX_TEST_ASSERT(b->pos == bigpos,
            "failed seek shall leave pos unchanged");
    
    b->pos = 0;
    b->size = SIZE_MAX / 2 + 32;
    off_t bigoff = SIZE_MAX / 2 - 16;
    r = ucx_buffer_seek(b, -bigoff, SEEK_CUR);
    UCX_TEST_ASSERT(r != 0, "seek cur underflow");
    UCX_TEST_ASSERT(b->pos == 0,
            "failed seek shall leave pos unchanged");
    
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_seek_invalid) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->pos = 7;
    int r;
    
    UCX_TEST_BEGIN
    r = ucx_buffer_seek(b, 0, ~(SEEK_SET|SEEK_CUR|SEEK_END));
    UCX_TEST_ASSERT(r != 0, "invalid whence shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_seek_oob) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->size = 16; // less than capacity
    b->pos = 7;
    int r;

    UCX_TEST_BEGIN
    
    r = ucx_buffer_seek(b, -1, SEEK_SET);
    UCX_TEST_ASSERT(r != 0, "seek SET below bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    
    r = ucx_buffer_seek(b, 16, SEEK_SET);
    UCX_TEST_ASSERT(r != 0, "seek SET above bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    
    r = ucx_buffer_seek(b, -8, SEEK_CUR);
    UCX_TEST_ASSERT(r != 0, "seek CUR below bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    
    r = ucx_buffer_seek(b, 9, SEEK_CUR);
    UCX_TEST_ASSERT(r != 0, "seek CUR above bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    
    r = ucx_buffer_seek(b, -17, SEEK_END);
    UCX_TEST_ASSERT(r != 0, "seek END below bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");
    
    r = ucx_buffer_seek(b, 1, SEEK_END);
    UCX_TEST_ASSERT(r != 0, "seek END above bounds shall fail");
    UCX_TEST_ASSERT(b->pos == 7,
            "failed seek shall leave pos unchanged");

    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_seek_set) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->size = 16;
    int r;

    UCX_TEST_BEGIN

    r = ucx_buffer_seek(b, 5, SEEK_SET);
    UCX_TEST_ASSERT(r == 0, "seek SET+5 failed");
    UCX_TEST_ASSERT(b->pos == 5, "seek SET+5 set wrong position");
    
    
    r = ucx_buffer_seek(b, 10, SEEK_SET);
    UCX_TEST_ASSERT(r == 0, "seek SET+10 failed");
    UCX_TEST_ASSERT(b->pos == 10, "seek SET+10 set wrong position");

    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_seek_cur) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->size = 16;
    int r;

    UCX_TEST_BEGIN
    
    b->pos = 7;
    r = ucx_buffer_seek(b, 5, SEEK_CUR);
    UCX_TEST_ASSERT(r == 0, "seek CUR+5 failed");
    UCX_TEST_ASSERT(b->pos == 12, "seek CUR+5 set wrong position");

    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_seek_end) {
    UcxBuffer *b = ucx_buffer_new(NULL, 32, UCX_BUFFER_DEFAULT);
    b->size = 16;
    int r;

    UCX_TEST_BEGIN
    
    r = ucx_buffer_seek(b, -5, SEEK_END);
    UCX_TEST_ASSERT(r == 0, "seek END-5 failed");
    UCX_TEST_ASSERT(b->pos == 11, "seek END-5 set wrong position");


    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_putc) {
    char *buffer = (char*) malloc(16);
    memset(buffer, 32, 16);

    UcxBuffer *b = ucx_buffer_new(buffer, 16, UCX_BUFFER_DEFAULT);
    b->size = b->capacity;

    UCX_TEST_BEGIN

    ucx_buffer_seek(b, 0, SEEK_SET);
    UCX_TEST_ASSERT(ucx_buffer_putc(b, '0'|~0xFF) == '0',
            "putc shall return (arg & 0xFF)");
    ucx_buffer_putc(b, '0');
    ucx_buffer_putc(b, '0');
    
    UCX_TEST_ASSERT(b->pos == 3, "pos wrong after first 3 puts");
    ucx_buffer_seek(b, 10, SEEK_CUR);
    
    ucx_buffer_putc(b, '0');
    ucx_buffer_putc(b, '0');
    ucx_buffer_putc(b, '0');
    
    UCX_TEST_ASSERT(b->pos == 16, "pos wrong after last 3 puts");
    
    UCX_TEST_ASSERT(!memcmp(b->space, "000          000", 16),
            "buffer content wrong")
    UCX_TEST_END
    ucx_buffer_free(b);
    free(buffer);
}
    
UCX_TEST(test_ucx_buffer_putc_oob) {
    UcxBuffer *b = ucx_buffer_new(NULL, 2, UCX_BUFFER_DEFAULT);
    
    UCX_TEST_BEGIN
    b->pos = b->size = b->capacity = 1;
    b->space[1] = 'X';
    
    UCX_TEST_ASSERT(ucx_buffer_putc(b, 48) == EOF, "put shall return EOF "
            "when buffer is full and auto extend is disabled");
    UCX_TEST_ASSERT(!memcmp(b->space, "\0X", 2),
            "wrong buffer content after failed putc");

    UCX_TEST_END

    ucx_buffer_free(b);
}


UCX_TEST(test_ucx_buffer_putc_ae) {
    UcxBuffer *b = ucx_buffer_new(NULL, 2, UCX_BUFFER_AUTOEXTEND);
    ucx_buffer_putc(b, '0');
    ucx_buffer_putc(b, '1');
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(b->pos == 2, "pos wrong after first 2 puts");
    UCX_TEST_ASSERT(b->size == 2, "size wrong after first 2 puts");
    UCX_TEST_ASSERT(b->capacity == 2, "buffer erroneously extended");
    UCX_TEST_ASSERT(!memcmp(b->space,"01", 2), "wrong content");
    
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_putc_oobae) {
    UcxBuffer *b = ucx_buffer_new(NULL, 2, UCX_BUFFER_AUTOEXTEND);
    ucx_buffer_putc(b, '0');
    ucx_buffer_putc(b, '1');
    
    UCX_TEST_BEGIN
    
    ucx_buffer_putc(b, 'a');
    
    UCX_TEST_ASSERT(b->pos == 3, "pos wrong after put");
    UCX_TEST_ASSERT(b->capacity == 4, "buffer not properly extended");
    UCX_TEST_ASSERT(b->size == 3, "wrong buffer size");
    
    UCX_TEST_ASSERT(!memcmp(b->space,"01a\0", 4), "wrong content");
    
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_putc_size) {
    UcxBuffer *b = ucx_buffer_new(NULL, 4, UCX_BUFFER_DEFAULT);
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(b->size == 0, "wrong initial size");
    ucx_buffer_putc(b, 'a');
    ucx_buffer_putc(b, 'b');
    ucx_buffer_putc(b, 'c');
    UCX_TEST_ASSERT(b->size == 3, "size does not increase");
    ucx_buffer_seek(b, 1, SEEK_SET);
    ucx_buffer_putc(b, 'd');
    UCX_TEST_ASSERT(b->size == 3, "size shall not decrease");
    UCX_TEST_ASSERT(b->pos == 2, "wrong position after seek and putc");

    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_getc) {
    char *buffer = (char*) malloc(16);
    memset(buffer, 32, 8);
    for (int i = 8; i < 16 ; i++) {
        buffer[i] = 40+i;
    }

    UcxBuffer *b = ucx_buffer_new(buffer, 16, UCX_BUFFER_DEFAULT);
    b->size = b->capacity;

    UCX_TEST_BEGIN

    char rb[16];
    for (size_t i = 0 ; i < 16 ; i++) {
        UCX_TEST_ASSERT(b->pos == i, "wrong position");
        UCX_TEST_ASSERT(!ucx_buffer_eof(b), "EOF false positive");
        rb[i] = ucx_buffer_getc(b);
    }
    UCX_TEST_ASSERT(memcmp(rb, "        01234567", 16) == 0,
        "read data incorrect");
        
    UCX_TEST_ASSERT(ucx_buffer_eof(b), "EOF not set after last possible read");
    UCX_TEST_ASSERT(b->pos == 16, "wrong position after EOF");
    
    UCX_TEST_ASSERT(ucx_buffer_getc(b) == EOF,
        "out of bounds read does not return EOF");
    UCX_TEST_ASSERT(b->pos == 16, "wrong position after out of bounds read");

    UCX_TEST_END

    ucx_buffer_free(b);
    free(buffer);
}

UCX_TEST(test_ucx_buffer_write) {
    char *buffer = (char*) malloc(16);
    memset(buffer, 32, 8);
    for (int i = 8; i < 16 ; i++) {
        buffer[i] = 40+i;
    }

    UcxBuffer *b = ucx_buffer_new(buffer, 16, UCX_BUFFER_DEFAULT);
    int r;

    UCX_TEST_BEGIN

    const char* teststring = "this is way too much";
    r = ucx_buffer_write((void*)teststring, 1, 20, b);
    UCX_TEST_ASSERT(r == 16, "string not correctly trimed");
    UCX_TEST_ASSERT(memcmp(buffer, teststring, 16) == 0,
            "buffer data incorrect");
    UCX_TEST_ASSERT(ucx_buffer_eof(b), "eof shall be set");

    ucx_buffer_seek(b, 8, SEEK_SET);
    r = ucx_buffer_write((void*)"not", 1, 3, b);
    UCX_TEST_ASSERT(r == 3, "three bytes should be replace");
    UCX_TEST_ASSERT(memcmp(buffer, "this is not too much", 16) == 0,
            "modified buffer is incorrect");

    const char* threebytestring = "  t  h  r  e  e   ";
    memset(buffer, 49, 16);
    ucx_buffer_seek(b, 0, SEEK_SET);
    r = ucx_buffer_write((void*)threebytestring, 3, 6, b);
    UCX_TEST_ASSERT(r == 5, "three byte string not correctly trimed");
    UCX_TEST_ASSERT(b->pos == 15,
            "position after write of three byte string incorrect");
    UCX_TEST_ASSERT(!ucx_buffer_eof(b), "eof shall not be set");
    UCX_TEST_ASSERT(memcmp(buffer, "  t  h  r  e  e1", 16) == 0,
                "bufer is incorrect after three byte string has been written");

    UCX_TEST_END

    ucx_buffer_free(b);
    free(buffer);
}

UCX_TEST(test_ucx_buffer_write_ax) {
    char *buffer = (char*) malloc(16);

    UcxBuffer *b = ucx_buffer_new(buffer, 16,
            UCX_BUFFER_AUTOEXTEND | UCX_BUFFER_AUTOFREE);
    int r;

    UCX_TEST_BEGIN

    const char* teststring = "this is way too much";
    r = ucx_buffer_write((void*)teststring, 1, 20, b);
    buffer = (char*) b->space; /*autoextend enabled, we MUST retrieve pointer*/
    UCX_TEST_ASSERT(r == 20, "not all characters written");
    UCX_TEST_ASSERT(b->capacity == 32, "buffer not properly extended");
    UCX_TEST_ASSERT(b->pos == 20, "position incorrect");
    UCX_TEST_ASSERT(memcmp(buffer,
            "this is way too much\0\0\0\0\0\0\0\0\0\0\0\0", 32) == 0,
            "incorrect buffer content");

    UCX_TEST_END

    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_read) {
    UcxBuffer *b = ucx_buffer_new(NULL, 8, UCX_BUFFER_AUTOFREE);
    ucx_buffer_write("01234567", 1, 8, b);
    b->pos = 0;
    
    char buf[32];
    memset(buf, 'X', 32);
    int r;
    
    UCX_TEST_BEGIN
    
    ucx_buffer_seek(b, 2, SEEK_SET);
    r = ucx_buffer_read(buf, 1, 2, b);
    UCX_TEST_ASSERT(r == 2, "wrong number of bytes read (2 items)");
    UCX_TEST_ASSERT(buf[0] == '2' && buf[1] == '3' && buf[2] == 'X',
            "buffer incorrect after read");
    UCX_TEST_ASSERT(b->pos == 4, "wrong position after read (2 items)");
    
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_read_oob) {
    UcxBuffer *b = ucx_buffer_new(NULL, 8, UCX_BUFFER_AUTOFREE);
    ucx_buffer_write("01234567", 1, 8, b);
    
    char buf[32];
    memset(buf, 'X', 32);
    int r;
    
    UCX_TEST_BEGIN

    b->pos = 2;
    r = ucx_buffer_read(buf + 2, 1, 8, b);
    UCX_TEST_ASSERT(r == 6, "wrong number of bytes read (8 items)");
    UCX_TEST_ASSERT(memcmp(buf, "XX234567XX", 10) == 0,
            "buffer incorrect after read");
    UCX_TEST_ASSERT(b->pos == 8,
        "wrong position after read (8 items out of bound)");

    b->pos = 0;
    memset(buf, 'X', 32);
    
    r = ucx_buffer_read(buf, 3, 3, b);
    
    UCX_TEST_ASSERT(r == 2, "wrong number of blocks read");
    UCX_TEST_ASSERT(memcmp(buf, "012345XX", 8) == 0,
            "buffer incorrect after block out of bounds read");
    
    r = ucx_buffer_read(buf+6, 1, 5, b);
    
    UCX_TEST_ASSERT(r == 2, "wrong number of remaining bytes read");
    UCX_TEST_ASSERT(memcmp(buf, "01234567XX", 10) == 0,
            "buffer incorrect after remaining byte read");
    
    UCX_TEST_END
    
    ucx_buffer_free(b);
}

UCX_TEST(test_ucx_buffer_extract) {
    char *buffer = (char*) malloc(16);
    strcpy(buffer, "this is a test!");

    UcxBuffer *src = ucx_buffer_new(buffer, 16, UCX_BUFFER_AUTOFREE);
    src->size = 15;
    UcxBuffer *dst = ucx_buffer_extract(src, 5, 5, UCX_BUFFER_DEFAULT);

    UCX_TEST_BEGIN
    UCX_TEST_ASSERT(dst != NULL, "ucx_buffer_extract returned NULL");
            
    UCX_TEST_ASSERT((dst->flags & UCX_BUFFER_AUTOFREE) == UCX_BUFFER_AUTOFREE,
            "autofree flag shall be enforced");
    UCX_TEST_ASSERT(dst->size == 5, "wrong size for new buffer");
    char rb[5];
    ucx_buffer_read(rb, 1, 5, dst);
    UCX_TEST_ASSERT(memcmp(rb, "is a ", 5) == 0,
            "new buffer has incorrect content");

    UCX_TEST_ASSERT(ucx_buffer_extract(dst, 3, 3, UCX_BUFFER_DEFAULT) == NULL,
            "extract shall fail on invalid bounds");

    UCX_TEST_END

    ucx_buffer_free(dst);
    ucx_buffer_free(src);
}

UCX_TEST(test_ucx_stream_copy) {
    UcxBuffer *b1 = ucx_buffer_new(NULL, 64, UCX_BUFFER_DEFAULT);
    UcxBuffer *b2 = ucx_buffer_new(NULL, 2, UCX_BUFFER_AUTOEXTEND);
    
    UCX_TEST_BEGIN
    
    ucx_buffer_write("01234567", 1, 8, b1);
    ucx_buffer_write("abcdefgh", 1, 8, b1);
    UCX_TEST_ASSERT(b1->size == 16, "failed to fill buffer b1");
    ucx_buffer_seek(b1, 0, SEEK_SET);
    
    size_t ncp = ucx_stream_hcopy(b1, b2, ucx_buffer_read, ucx_buffer_write);
    UCX_TEST_ASSERT(ncp == 16, "wrong number of copied bytes");
    UCX_TEST_ASSERT(b2->size == 16, "b2 has wrong size");
    UCX_TEST_ASSERT(memcmp(b1->space, b2->space, 16) == 0,
            "b1 and b2 have not the same content");
    
    memset(b2->space, 0, b2->capacity);
    b2->pos = 0;
    b2->size = 0;
    ucx_buffer_seek(b1, 0, SEEK_SET);
    
    FILE *file = tmpfile();
    UCX_TEST_ASSERT(file, "test file cannot be opened, test aborted");
    
    ncp = ucx_stream_hcopy(b1, file, ucx_buffer_read, fwrite);
    UCX_TEST_ASSERT(ncp == 16, "copied wrong number of bytes to file");
    
    fseek(file, 0, SEEK_SET);
    
    ncp = ucx_stream_hcopy(file, b2, fread, ucx_buffer_write);
    UCX_TEST_ASSERT(ncp == 16, "copied wrong number of bytes from file");
    
    UCX_TEST_ASSERT(memcmp(b1->space, b2->space, 16) == 0,
            "b1 and b2 content mismatch");
    
    fclose(file);

    ucx_buffer_clear(b1);
    ucx_buffer_seek(b2, 0, SEEK_SET);
    ncp = ucx_stream_ncopy(b2, b1, ucx_buffer_read, ucx_buffer_write, 8);
    UCX_TEST_ASSERT(ncp == 8, "copied wrong number of bytes with ncopy");
    UCX_TEST_ASSERT(memcmp(b1->space, "01234567\0\0\0\0\0\0\0\0", 16) == 0,
        "content wrong after ncopy");
    
    UCX_TEST_END
    
    ucx_buffer_free(b1);
    ucx_buffer_free(b2);
}