test/test_list.c

/*
 * 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/linked_list.h"
#include "test_config.h"
#include "util_allocator.h"

int cmp_int(int const *l, int const *r) {
    int left = *l, right = *r;
    return left == right ? 0 : (left < right ? -1 : 1);
}

void test_linked_list_create(void) {
    cxTestingAllocatorReset();

    CxList list = cxLinkedListCreate(cxTestingAllocator, (CxListComparator) cmp_int, sizeof(int));

    CU_ASSERT_EQUAL(list->size, 0)
    CU_ASSERT_EQUAL(list->capacity, (size_t) -1)
    CU_ASSERT_PTR_EQUAL(list->allocator, cxTestingAllocator)
    CU_ASSERT_EQUAL(list->itemsize, sizeof(int))
    CU_ASSERT_PTR_EQUAL(list->cmpfunc, cmp_int)

    // assume this structure for a linked list
    struct ll_check {
        cx_list_s base;
        void *begin;
        void *end;
        ptrdiff_t ploc;
        ptrdiff_t nloc;
    };

    struct ll_check *actual = (struct ll_check *) list;
    CU_ASSERT_PTR_NULL(actual->begin)
    CU_ASSERT_PTR_NULL(actual->end)
    CU_ASSERT_EQUAL(0, actual->ploc)
    CU_ASSERT_EQUAL(sizeof(void *), actual->nloc)

    cxLinkedListDestroy(list);

    CU_ASSERT_TRUE(cxTestingAllocatorVerify())
}

void test_linked_list_at(void) {
    struct node {
        void *next;
        void *prev;
    };
    const ptrdiff_t loc_prev = offsetof(struct node, prev);
    const ptrdiff_t loc_next = offsetof(struct node, next);

    struct node a, b, c, d;
    a.prev = NULL;
    a.next = &b;
    b.prev = &a;
    b.next = &c;
    c.prev = &b;
    c.next = &d;
    d.prev = &c;
    d.next = NULL;

    CU_ASSERT_PTR_EQUAL(&a, cx_linked_list_at(&a, 0, loc_next, 0));
    CU_ASSERT_PTR_EQUAL(&b, cx_linked_list_at(&a, 0, loc_next, 1));
    CU_ASSERT_PTR_EQUAL(&c, cx_linked_list_at(&a, 0, loc_next, 2));
    CU_ASSERT_PTR_EQUAL(&d, cx_linked_list_at(&a, 0, loc_next, 3));
    CU_ASSERT_PTR_NULL(cx_linked_list_at(&a, 0, loc_next, 4));

    CU_ASSERT_PTR_EQUAL(&a, cx_linked_list_at(&b, 1, loc_prev, 0));
    CU_ASSERT_PTR_EQUAL(&b, cx_linked_list_at(&b, 1, loc_next, 1));
    CU_ASSERT_PTR_EQUAL(&c, cx_linked_list_at(&b, 1, loc_next, 2));
    CU_ASSERT_PTR_EQUAL(&d, cx_linked_list_at(&b, 1, loc_next, 3));
    CU_ASSERT_PTR_NULL(cx_linked_list_at(&b, 1, loc_next, 4));

    CU_ASSERT_PTR_EQUAL(&a, cx_linked_list_at(&d, 3, loc_prev, 0));
    CU_ASSERT_PTR_EQUAL(&b, cx_linked_list_at(&d, 3, loc_prev, 1));
}

void test_cx_linked_list_add(void) {
    struct node {
        void *prev;
        void *next;
        int value;
    };
    
    struct node nodes[4];
    
    // test with begin, end / prev, next
    memset(nodes, 0, 4*sizeof(struct node));
    void *begin = NULL;
    void *end = NULL;
    
    ptrdiff_t loc_prev = offsetof(struct node, prev);
    ptrdiff_t loc_next = offsetof(struct node, next);
    
    int ret;
    ret = cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[0]);
    CU_ASSERT_EQUAL(ret, 0);
    CU_ASSERT_PTR_EQUAL(begin, &nodes[0]);
    CU_ASSERT_PTR_EQUAL(end, &nodes[0]);
    CU_ASSERT_PTR_EQUAL(nodes[0].prev, NULL);
    CU_ASSERT_PTR_EQUAL(nodes[0].next, NULL);
    
    ret = cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[1]);
    CU_ASSERT_EQUAL(ret, 0);
    CU_ASSERT_PTR_EQUAL(begin, &nodes[0]);
    CU_ASSERT_PTR_EQUAL(end, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(nodes[0].next, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(nodes[1].prev, &nodes[0]);
    
    // test with begin only / prev, next
    memset(nodes, 0, 4*sizeof(struct node));
    begin = NULL;
    end = NULL;
    
    ret = cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[0]);
    CU_ASSERT_EQUAL(ret, 0);
    CU_ASSERT_PTR_EQUAL(begin, &nodes[0]);
    ret = cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[1]);
    CU_ASSERT_EQUAL(ret, 0);
    CU_ASSERT_PTR_EQUAL(begin, &nodes[0]);
    CU_ASSERT_PTR_EQUAL(nodes[0].next, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(nodes[1].prev, &nodes[0]);
    
    ret = cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[2]);
    CU_ASSERT_PTR_EQUAL(nodes[1].next, &nodes[2]);
    CU_ASSERT_PTR_EQUAL(nodes[2].prev, &nodes[1]);
    
    // test with begin, end / next
    memset(nodes, 0, 4*sizeof(struct node));
    begin = NULL;
    end = NULL;
    
    ret = cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[0]);
    CU_ASSERT_EQUAL(ret, 0);
    CU_ASSERT_PTR_EQUAL(begin, &nodes[0]);
    CU_ASSERT_PTR_EQUAL(end, &nodes[0]);
    ret = cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(end, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(nodes[0].next, &nodes[1]);
    CU_ASSERT_PTR_EQUAL(nodes[1].prev, NULL);
}

int main() {
    CU_pSuite suite = NULL;
    
    if (CUE_SUCCESS != CU_initialize_registry()) {
        return CU_get_error();
    }

    suite = CU_add_suite("linked list suite", NULL, NULL);
    
    CU_add_test(suite, "linked list: create and destroy", test_linked_list_create);
    CU_add_test(suite, "linked list: get node at index", test_linked_list_at);
    CU_add_test(suite, "linked list: add", test_cx_linked_list_add);

    CU_basic_set_mode(UCX_CU_BRM);

    int exitcode;
    if (CU_basic_run_tests()) {
        exitcode = CU_get_error();
    } else {
        exitcode = CU_get_number_of_failures() == 0 ? 0 : 1;
    }
    CU_cleanup_registry();
    return exitcode;
}