test/array_tests.c

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

UCX_TEST(test_ucx_array_destroy) {
    UcxArray array;
    ucx_array_init(&array, 16, sizeof(int));
    
    UCX_TEST_BEGIN
    ucx_array_destroy(&array);
    UCX_TEST_ASSERT(array.data == NULL, "data pointer not NULL after destroy");
    UCX_TEST_ASSERT(array.size == 0, "size not zero after destroy");
    UCX_TEST_ASSERT(array.capacity == 0, "capacity not zero after destroy");
    UCX_TEST_ASSERT(array.allocator == ucx_default_allocator(),
            "allocator corrupted during destroy");
    UCX_TEST_END
}

UCX_TEST(test_ucx_array_new) {
    UcxArray* array = ucx_array_new(16, 47);
    
    UCX_TEST_BEGIN
    UCX_TEST_ASSERT(array->data, "no memory allocated");
    UCX_TEST_ASSERT(array->size == 0, "size not initially zero");
    UCX_TEST_ASSERT(array->capacity == 16, "capacity not as requested");
    UCX_TEST_ASSERT(array->elemsize == 47, "element size not as requested");
    UCX_TEST_ASSERT(array->allocator == ucx_default_allocator(),
            "array not using the default allocator");
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_append_from) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    int *elements;
    
    int x = 42;
    ucx_array_append_from(array, &x, 1);
    UCX_TEST_BEGIN
    
    elements = array->data;
    UCX_TEST_ASSERT(elements[0] == 42, "failed");
    
    int y[2] = {13, 37};
    ucx_array_append_from(array, y, 2);
    
    elements = array->data;
    UCX_TEST_ASSERT(array->size == 3, "incorrect size after append");
    UCX_TEST_ASSERT(elements[1] == 13, "failed");
    UCX_TEST_ASSERT(elements[2] == 37, "failed");
    UCX_TEST_ASSERT(elements[0] == 42,
            "append corrupted previously inserted data");
    
    ucx_array_append_from(array, NULL, 2);
    
    elements = array->data;
    UCX_TEST_ASSERT(array->size == 5, "incorrect size after NULL append");
    UCX_TEST_ASSERT(elements[3] == 0, "element is not zeroed");
    UCX_TEST_ASSERT(elements[4] == 0, "element is not zeroed");
    UCX_TEST_ASSERT(elements[0] == 42,
            "NULL append corrupted previously inserted data");
    UCX_TEST_ASSERT(elements[1] == 13,
            "NULL append corrupted previously inserted data");
    UCX_TEST_ASSERT(elements[2] == 37,
            "NULL append corrupted previously inserted data");
    
    UCX_TEST_END
    
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_append_from_struct) {
    struct teststruct {
        unsigned long long x;
        unsigned long long y;
        unsigned long long z;
    };
    
    UcxArray *array = ucx_array_new(16, sizeof(struct teststruct));
    struct teststruct *elements;
    
    struct teststruct data;
    data.x = 13; data.y = 37; data.z = 47;
    
    ucx_array_append_from(array, &data, 1);
    UCX_TEST_BEGIN
    
    elements = array->data;
    UCX_TEST_ASSERT(elements[0].x == 13, "failed");
    UCX_TEST_ASSERT(elements[0].y == 37, "failed");
    UCX_TEST_ASSERT(elements[0].z == 47, "failed");
    
    data.x = 0; data.y = 8; data.z = 15;
    ucx_array_append_from(array, &data, 1);
    
    elements = array->data;
    UCX_TEST_ASSERT(array->size == 2, "incorrect size after append");
    UCX_TEST_ASSERT(elements[1].x == 0, "failed");
    UCX_TEST_ASSERT(elements[1].y == 8, "failed");
    UCX_TEST_ASSERT(elements[1].z == 15, "failed");
    
    UCX_TEST_ASSERT(elements[0].x == 13,
            "append corrupted previously inserted data");
    UCX_TEST_ASSERT(elements[0].y == 37,
            "append corrupted previously inserted data");
    UCX_TEST_ASSERT(elements[0].z == 47,
            "append corrupted previously inserted data");
    
    UCX_TEST_END
    
    ucx_array_destroy(array);
}

UCX_TEST(test_ucx_array_prepend_from) {
    int *elems;
    UcxArray *array = ucx_array_new(16, sizeof(int));
    
    int x = 42;
    ucx_array_prepend_from(array, &x, 1);
    UCX_TEST_BEGIN
    
    elems = array->data;
    UCX_TEST_ASSERT(elems[0] == 42, "failed");
    
    int y[2] = {13, 37};
    ucx_array_prepend_from(array, y, 2);
    
    elems = array->data;
    UCX_TEST_ASSERT(array->size == 3, "incorrect size after prepend");
    UCX_TEST_ASSERT(elems[0] == 13, "failed");
    UCX_TEST_ASSERT(elems[1] == 37, "failed");
    UCX_TEST_ASSERT(elems[2] == 42,
            "prepend corrupted previously inserted data");
    
    ucx_array_prepend_from(array, NULL, 2);
    
    elems = array->data;
    UCX_TEST_ASSERT(array->size == 5, "incorrect size after NULL prepend");
    UCX_TEST_ASSERT(elems[0] == 0, "element is not zeroed");
    UCX_TEST_ASSERT(elems[1] == 0, "element is not zeroed");
    UCX_TEST_ASSERT(elems[2] == 13,
            "NULL prepend corrupted previously inserted data");
    UCX_TEST_ASSERT(elems[3] == 37,
            "NULL prepend corrupted previously inserted data");
    UCX_TEST_ASSERT(elems[4] == 42,
            "NULL prepend corrupted previously inserted data");
    
    UCX_TEST_END
    
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_set_from) {
    int *elems;
    UcxArray *array = ucx_array_new(16, sizeof(int));
    
    int x = 42;

    UCX_TEST_BEGIN

    ucx_array_set_from(array, 7, &x, 1);
    
    elems = array->data;
    UCX_TEST_ASSERT(elems[7] == 42, "failed");
    UCX_TEST_ASSERT(array->size >= 8, "array not resized on set");
    UCX_TEST_ASSERT(array->capacity == 16, "capacity changed unnecessarily");
    
    int y[2] = {13, 37};
    ucx_array_set_from(array, 27, y, 2);
    
    elems = array->data;
    UCX_TEST_ASSERT(elems[27] == 13, "failed");
    UCX_TEST_ASSERT(elems[28] == 37, "failed");
    UCX_TEST_ASSERT(array->size == 29, "array not resized on set");
    UCX_TEST_ASSERT(array->capacity == 32, "capacity not grown");
    
    ucx_array_set_from(array, 7, NULL, 2);
    
    elems = array->data;
    UCX_TEST_ASSERT(elems[7] == 0, "not zeroed on NULL set");
    UCX_TEST_ASSERT(elems[8] == 0, "not zeroed on NULL set");
    
    UCX_TEST_END
    
    ucx_array_free(array);
}


UCX_TEST(test_ucx_array_equals) {
    UcxArray *a1 = ucx_array_new(16, sizeof(int32_t));
    UcxArray *a2 = ucx_array_new(16, sizeof(int32_t));
    UcxArray *a3 = ucx_array_new(16, sizeof(int64_t));
    UcxArray *a4 = ucx_array_new(16, sizeof(int32_t));
    
    int32_t *intelems;
    int64_t *longintelems;
    
    a1->size = 5;
    intelems = a1->data;
    intelems[0] = 47;
    intelems[1] = 11;
    intelems[2] = 0;
    intelems[3] = 8;
    intelems[4] = 15;
    a2->size = 5;
    intelems = a2->data;
    intelems[0] = 47;
    intelems[1] = 11;
    intelems[2] = 0;
    intelems[3] = 8;
    intelems[4] = 15;
    a3->size = 5;
    longintelems = a3->data;
    longintelems[0] = 47;
    longintelems[1] = 11;
    longintelems[2] = 0;
    longintelems[3] = 8;
    longintelems[4] = 15;
    a4->size = 5;
    intelems = a4->data;
    intelems[0] = 47;
    intelems[1] = 11;
    intelems[2] = -6;
    intelems[3] = 8;
    intelems[4] = 15;
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(ucx_array_equals(a1, a2, ucx_cmp_int32, NULL), "failed");
    UCX_TEST_ASSERT(!ucx_array_equals(a1, a4, ucx_cmp_int32, NULL), "failed");
    UCX_TEST_ASSERT(!ucx_array_equals(a4, a1, ucx_cmp_int32, NULL), "failed");
    UCX_TEST_ASSERT(!ucx_array_equals(a1, a3, ucx_cmp_int64, NULL),
            "comparing arrays of different element size shall fail");
    UCX_TEST_ASSERT(!ucx_array_equals(a3, a1, ucx_cmp_int64, NULL),
            "comparing arrays of different element size shall fail");
    
    UCX_TEST_ASSERT(ucx_array_equals(a1, a2, NULL, NULL),
            "compare using memcmp() failed");
    UCX_TEST_ASSERT(!ucx_array_equals(a1, a4, NULL, NULL),
            "compare using memcmp() failed");
    
    UCX_TEST_END
    ucx_array_free(a1);
    ucx_array_free(a2);
    ucx_array_free(a3);
    ucx_array_free(a4);
}

UCX_TEST(test_ucx_array_concat) {
    UcxArray *a1 = ucx_array_new(16, sizeof(int));
    UcxArray *a2 = ucx_array_new(16, sizeof(int));
    int *elems;
    
    a1->size = 2;
    elems = a1->data;
    elems[0] = 47;
    elems[1] = 11;
    a2->size = 3;
    elems = a2->data;
    elems[0] = 0;
    elems[1] = 8;
    elems[2] = 15;
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(!ucx_array_concat(a1, a2), "failed");
    UCX_TEST_ASSERT(a1->size == 5, "failed");
    elems = a1->data;
    UCX_TEST_ASSERT(elems[0] == 47, "failed");
    UCX_TEST_ASSERT(elems[1] == 11, "failed");
    UCX_TEST_ASSERT(elems[2] == 0, "failed");
    UCX_TEST_ASSERT(elems[3] == 8, "failed");
    UCX_TEST_ASSERT(elems[4] == 15, "failed");
    
    a1->elemsize *= 2;
    UCX_TEST_ASSERT(ucx_array_concat(a1, a2),
            "arrays of different element size must not be concatenated");
    UCX_TEST_ASSERT(a1->size == 5,
            "arrays of different element size must not be concatenated");
    
    UCX_TEST_END
    ucx_array_free(a1);
    ucx_array_free(a2);    
}

UCX_TEST(test_ucx_array_at) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    
    int x[3] = {42, 13, 5};
    ucx_array_append_from(array, x, 3);
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(*(int*)ucx_array_at(array, 1) == 13, "failed");
    *(int*)ucx_array_at(array, 1) = 80;
    UCX_TEST_ASSERT(*(int*)ucx_array_at(array, 1) == 80, "assignment failed");
    
    UCX_TEST_ASSERT(*(int*)ucx_array_at(array, 0) == 42, "corrupted data");
    UCX_TEST_ASSERT(*(int*)ucx_array_at(array, 2) == 5, "corrupted data");
    
    UCX_TEST_END
    
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_find) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    int *elems;
    
    array->size = 5;
    elems = array->data;
    elems[0] = 47;
    elems[1] = 11;
    elems[2] = 0;
    elems[3] = 8;
    elems[4] = 15;
    
    int x = 8;
    int y = 90;
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(ucx_array_find(array,(void*)&x,ucx_cmp_int,NULL) == 3,
        "doesn't find element");
    UCX_TEST_ASSERT(ucx_array_find(array,(void*)&y,ucx_cmp_int,NULL) == 5,
        "finds non-existing element");
    
    UCX_TEST_ASSERT(ucx_array_find(array,(void*)&x,NULL,NULL) == 3,
        "failed using memcmp()");
    UCX_TEST_ASSERT(ucx_array_find(array,(void*)&y,NULL,NULL) == 5,
        "failed using memcmp()");
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_contains) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    int *elems;
    
    array->size = 5;
    elems = array->data;
    elems[0] = 47;
    elems[1] = 11;
    elems[2] = 0;
    elems[3] = 8;
    elems[4] = 15;
    
    int x = 8;
    int y = 90;
    
    UCX_TEST_BEGIN
    
    UCX_TEST_ASSERT(ucx_array_contains(array,(void*)&x,ucx_cmp_int,NULL),
        "false negative");
    UCX_TEST_ASSERT(!ucx_array_contains(array,(void*)&y,ucx_cmp_int,NULL),
        "false positive");
    
    UCX_TEST_ASSERT(ucx_array_contains(array,(void*)&x,NULL,NULL),
        "false negative using memcmp()");
    UCX_TEST_ASSERT(!ucx_array_contains(array,(void*)&y,NULL,NULL),
        "false positive using memcmp()");
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_remove) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    int *elems;
    
    array->size = 5;
    elems = array->data;
    elems[0] = 47;
    elems[1] = 11;
    elems[2] = 0;
    elems[3] = 8;
    elems[4] = 15;
        
    UCX_TEST_BEGIN
    
    ucx_array_remove(array, 2);
    elems = array->data;
    UCX_TEST_ASSERT(
            elems[0] == 47 &&
            elems[1] == 11 &&
            elems[2] == 8 &&
            elems[3] == 15,
            "wrong contents after remove");
    UCX_TEST_ASSERT(array->size == 4, "wrong size after remove");
    
    ucx_array_remove_fast(array, 1);
    elems = array->data;
    UCX_TEST_ASSERT(
            elems[0] == 47 &&
            elems[1] == 15 &&
            elems[2] == 8,
            "wrong contents after fast remove");
    UCX_TEST_ASSERT(array->size == 3, "wrong size after fast remove");
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_clone) {
    UcxArray array;
    UcxArray copy;
    ucx_array_init(&array, 16, sizeof(int));
    ucx_array_init(&copy, 4, 2*sizeof(double));
    int *elems;
    
    array.size = 5;
    elems = array.data;
    elems[0] = 47;
    elems[1] = 11;
    elems[2] = 0;
    elems[3] = 8;
    elems[4] = 15;
    
    ucx_array_clone(&copy, &array);
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(array.data != copy.data, "no true copy");
    UCX_TEST_ASSERT(array.size == copy.size, "size mismatch");
    UCX_TEST_ASSERT(array.capacity == copy.capacity, "capacity mismatch");
    UCX_TEST_ASSERT(array.elemsize == copy.elemsize, "element size mismatch");
    UCX_TEST_ASSERT(array.allocator == copy.allocator, "allocator mismatch");
    UCX_TEST_ASSERT(ucx_array_equals(&array, &copy, ucx_cmp_int, NULL),
            "contents do not match after clone");
    
    UCX_TEST_END

    ucx_array_destroy(&array);
    ucx_array_destroy(&copy);
}

static int ucx_cmp_int_reverse(const void* x, const void* y, void* data) {
    return -ucx_cmp_int(x,y,data);
}

UCX_TEST(test_ucx_array_sort) {
    int *elems;

    UcxArray *array = ucx_array_new(16, sizeof(int));    
    array->size = 5;
    elems = array->data;
    elems[0] = 47;
    elems[1] = 11;
    elems[2] = 0;
    elems[3] = 8;
    elems[4] = 15;
    
    UcxArray *expected = ucx_array_new(16, sizeof(int));
    expected->size = 5;
    elems = expected->data;
    elems[0] = 0;
    elems[1] = 8;
    elems[2] = 11;
    elems[3] = 15;
    elems[4] = 47;
    
    UcxArray *expectedrev = ucx_array_new(16, sizeof(int));
    expectedrev->size = 5;
    elems = expectedrev->data;
    elems[0] = 47;
    elems[1] = 15;
    elems[2] = 11;
    elems[3] = 8;
    elems[4] = 0;
    

    UCX_TEST_BEGIN
    void* original_ptr = array->data;
    ucx_array_sort(array, ucx_cmp_int, NULL);
    UCX_TEST_ASSERT(ucx_array_equals(array, expected, NULL, NULL), "failed");
    UCX_TEST_ASSERT(array->size == 5, "size corrupted");
    UCX_TEST_ASSERT(array->data == original_ptr, "shall not reallocate");
    
    ucx_array_sort(array, ucx_cmp_int_reverse, NULL);
    UCX_TEST_ASSERT(ucx_array_equals(array, expectedrev, NULL, NULL), "failed");

    ucx_array_reserve(array, 32);
    ucx_array_reserve(expected, 32);
    array->size = expected->size = 32;
    for (size_t i = 0 ; i < 32 ; i++) {
        ((int*)array->data)[i]= ((i%2==0)?-1:1) * ((int) i);
        ((int*)expected->data)[i] = (-30+2*i) - (i > 15 ? 1 : 0);
    }
    
    /* dummy third argument to trigger a possible fallback for qsort_s */
    ucx_array_sort(array, ucx_cmp_int, array->data);
    UCX_TEST_ASSERT(ucx_array_equals(array, expected, NULL, NULL),
            "failed for bigger arrays");
    UCX_TEST_END

    ucx_array_free(expectedrev);
    ucx_array_free(expected);
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_shrink) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    array->size = 4;
    
    UCX_TEST_BEGIN
    UCX_TEST_ASSERT(!ucx_array_shrink(array), "failed");
    UCX_TEST_ASSERT(array->capacity == 4, "incorrect capacity after shrink");
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_resize) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    array->size = 8;
    
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(!ucx_array_resize(array, 32), "failed");
    UCX_TEST_ASSERT(array->capacity == 32, "incorrect capacity after resize");
    UCX_TEST_ASSERT(array->size == 8, "incorrect size after resize");
    
    UCX_TEST_ASSERT(!ucx_array_resize(array, 4), "failed");
    UCX_TEST_ASSERT(array->capacity == 4, "incorrect capacity after resize");
    UCX_TEST_ASSERT(array->size == 4, "incorrect size after resize");
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_reserve) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(!ucx_array_reserve(array, 4), "failed");
    UCX_TEST_ASSERT(array->capacity == 16, "reserve shall not shrink");
            
    UCX_TEST_ASSERT(!ucx_array_resize(array, 32), "failed");
    UCX_TEST_ASSERT(array->capacity == 32, "incorrect capacity after reserve");    
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_grow) {
    UcxArray *array = ucx_array_new(16, sizeof(int));
    array->size = 12;
    
    UCX_TEST_BEGIN

    UCX_TEST_ASSERT(!ucx_array_grow(array, 4), "failed");
    UCX_TEST_ASSERT(array->capacity == 16, "shall be noop if contents fit");
    /* subsequent calls shall also be noops */
    UCX_TEST_ASSERT(!ucx_array_grow(array, 4), "failed");
    UCX_TEST_ASSERT(array->capacity == 16, "shall be noop if contents fit");
            
    UCX_TEST_ASSERT(!ucx_array_grow(array, 6), "failed");
    UCX_TEST_ASSERT(array->capacity == 18, "incorrect capacity after grow");    
    
    UCX_TEST_END
    ucx_array_free(array);
}

UCX_TEST(test_ucx_array_util_set) {
    size_t capacity = 16;
    int* array = malloc(sizeof(int)*capacity);
    int x;

    UCX_TEST_BEGIN

    x = 42;
    ucx_array_util_set(&array, &capacity, sizeof(int), 7, &x);
    
    UCX_TEST_ASSERT(array[7] == 42, "failed");
    UCX_TEST_ASSERT(capacity == 16, "capacity changed unnecessarily");
    
    x = 13;
    ucx_array_util_set(&array, &capacity, sizeof(int), 37, &x);
    x = 37;
    ucx_array_util_set(&array, &capacity, sizeof(int), 38, &x);
    
    UCX_TEST_ASSERT(array[37] == 13, "failed");
    UCX_TEST_ASSERT(array[38] == 37, "failed");
    UCX_TEST_ASSERT(capacity == 64, "capacity not grown");
        
    UCX_TEST_END
    
    free(array);
}


UCX_TEST(test_ucx_array_util_setptr) {
    size_t capacity = 16;
    double** array = malloc(sizeof(double*)*capacity);
    double x, y, z;

    UCX_TEST_BEGIN

    ucx_array_util_setptr(&array, &capacity, 7, &x);
    
    UCX_TEST_ASSERT(array[7] == &x, "failed");
    UCX_TEST_ASSERT(capacity == 16, "capacity changed unnecessarily");
    
    ucx_array_util_setptr(&array, &capacity, 37, &y);
    ucx_array_util_setptr(&array, &capacity, 38, &z);
    
    UCX_TEST_ASSERT(array[37] == &y, "failed");
    UCX_TEST_ASSERT(array[38] == &z, "failed");
    UCX_TEST_ASSERT(capacity == 64, "capacity not grown");
        
    UCX_TEST_END
    
    free(array);
}