tests/test_list.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2023 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/test.h"
#include "util_allocator.h"
#include "cx/compare.h"

#include "cx/array_list.h"
#include "cx/linked_list.h"

#include <stdarg.h>

typedef struct node {
    struct node *next;
    struct node *prev;
    int data;
} node;

const ptrdiff_t loc_prev = offsetof(struct node, prev);
const ptrdiff_t loc_next = offsetof(struct node, next);
const ptrdiff_t loc_data = offsetof(struct node, data);

static node *create_nodes_test_data(size_t len) {
    node *begin = calloc(1, sizeof(node));
    void *prev = begin;
    for (size_t i = 1; i < len; i++) {
        node *n = calloc(1, sizeof(node));
        cx_linked_list_link(prev, n, loc_prev, loc_next);
        prev = n;
    }
    return begin;
}

void assign_nodes_test_data(node *n, ...) {
    va_list ap;
    va_start(ap, n);
    while (n != NULL) {
        n->data = va_arg(ap, int);
        n = n->next;
    }
    va_end(ap);
}

static void destroy_nodes_test_data(node *n) {
    while (n != NULL) {
        void *next = n->next;
        free(n);
        n = next;
    }
}

static int *int_test_data(size_t len) {
    int *data = malloc(len*sizeof(int));
    for (size_t i = 0 ; i < len ; i++) {
        data[i] = rand(); // NOLINT(*-msc50-cpp)
    }
    return data;
}

CX_TEST(test_linked_list_link_unlink) {
    node a = {0}, b = {0}, c = {0};

    CX_TEST_DO {
        cx_linked_list_link(&a, &b, loc_prev, loc_next);
        CX_TEST_ASSERT(a.prev == NULL);
        CX_TEST_ASSERT(a.next == &b);
        CX_TEST_ASSERT(b.prev == &a);
        CX_TEST_ASSERT(b.next == NULL);

        cx_linked_list_unlink(&a, &b, loc_prev, loc_next);
        CX_TEST_ASSERT(a.prev == NULL);
        CX_TEST_ASSERT(a.next == NULL);
        CX_TEST_ASSERT(b.prev == NULL);
        CX_TEST_ASSERT(b.next == NULL);

        cx_linked_list_link(&b, &c, loc_prev, loc_next);
        cx_linked_list_link(&a, &b, loc_prev, loc_next);
        cx_linked_list_unlink(&b, &c, loc_prev, loc_next);
        CX_TEST_ASSERT(a.prev == NULL);
        CX_TEST_ASSERT(a.next == &b);
        CX_TEST_ASSERT(b.prev == &a);
        CX_TEST_ASSERT(b.next == NULL);
        CX_TEST_ASSERT(c.prev == NULL);
        CX_TEST_ASSERT(c.next == NULL);
    }
}

CX_TEST(test_linked_list_at) {
    node a = {0}, b = {0}, c = {0}, d = {0};

    cx_linked_list_link(&a, &b, loc_prev, loc_next);
    cx_linked_list_link(&b, &c, loc_prev, loc_next);
    cx_linked_list_link(&c, &d, loc_prev, loc_next);

    CX_TEST_DO {
        CX_TEST_ASSERT(cx_linked_list_at(&a, 0, loc_next, 0) == &a);
        CX_TEST_ASSERT(cx_linked_list_at(&a, 0, loc_next, 1) == &b);
        CX_TEST_ASSERT(cx_linked_list_at(&a, 0, loc_next, 2) == &c);
        CX_TEST_ASSERT(cx_linked_list_at(&a, 0, loc_next, 3) == &d);
        CX_TEST_ASSERT(cx_linked_list_at(&a, 0, loc_next, 4) == NULL);
        CX_TEST_ASSERT(cx_linked_list_at(&b, 1, loc_prev, 0) == &a);
        CX_TEST_ASSERT(cx_linked_list_at(&b, 1, loc_next, 1) == &b);
        CX_TEST_ASSERT(cx_linked_list_at(&b, 1, loc_next, 2) == &c);
        CX_TEST_ASSERT(cx_linked_list_at(&b, 1, loc_next, 3) == &d);
        CX_TEST_ASSERT(cx_linked_list_at(&b, 1, loc_next, 4) == NULL);
        CX_TEST_ASSERT(cx_linked_list_at(&d, 3, loc_prev, 0) == &a);
        CX_TEST_ASSERT(cx_linked_list_at(&d, 3, loc_prev, 1) == &b);
    }
}

CX_TEST(test_linked_list_find) {
    void *list = create_nodes_test_data(4);
    assign_nodes_test_data(list, 2, 4, 6, 8);
    CX_TEST_DO {
        int s;
        s = 2;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) == 0);
        s = 4;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) == 1);
        s = 6;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) == 2);
        s = 8;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) == 3);
        s = 10;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) < 0);
        s = -2;
        CX_TEST_ASSERT(cx_linked_list_find(list, loc_next, loc_data, cx_cmp_int, &s) < 0);
    }
    destroy_nodes_test_data(list);
}

CX_TEST(test_linked_list_compare) {
    void *la = create_nodes_test_data(4);
    void *lb = create_nodes_test_data(3);
    void *lc = create_nodes_test_data(4);
    assign_nodes_test_data(la, 2, 4, 6, 8);
    assign_nodes_test_data(lb, 2, 4, 6);
    assign_nodes_test_data(lc, 2, 4, 6, 9);
    CX_TEST_DO {
        CX_TEST_ASSERT(cx_linked_list_compare(la, lb, loc_next, loc_data, cx_cmp_int) > 0);
        CX_TEST_ASSERT(cx_linked_list_compare(lb, la, loc_next, loc_data, cx_cmp_int) < 0);
        CX_TEST_ASSERT(cx_linked_list_compare(lc, la, loc_next, loc_data, cx_cmp_int) > 0);
        CX_TEST_ASSERT(cx_linked_list_compare(la, lc, loc_next, loc_data, cx_cmp_int) < 0);
        CX_TEST_ASSERT(cx_linked_list_compare(la, la, loc_next, loc_data, cx_cmp_int) == 0);
    }
    destroy_nodes_test_data(la);
    destroy_nodes_test_data(lb);
    destroy_nodes_test_data(lc);
}

CX_TEST(test_linked_list_add) {
    node nodes[4];
    void *begin, *end;
    CX_TEST_DO {
        // test with begin, end / prev, next
        memset(nodes, 0, sizeof(node)*4);
        end = begin = NULL;

        cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].prev == NULL);
        CX_TEST_ASSERT(nodes[0].next == NULL);

        cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[1]);
        CX_TEST_ASSERT(nodes[0].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == &nodes[0]);

        // test with begin only / prev, next
        memset(nodes, 0, sizeof(node)*4);
        end = begin = NULL;

        cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == &nodes[0]);

        cx_linked_list_add(&begin, NULL, loc_prev, loc_next, &nodes[2]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[2]);
        CX_TEST_ASSERT(nodes[2].prev == &nodes[1]);

        // test with end only / prev, next
        memset(nodes, 0, sizeof(node)*4);
        end = begin = NULL;

        cx_linked_list_add(NULL, &end, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        cx_linked_list_add(NULL, &end, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(end == &nodes[1]);
        CX_TEST_ASSERT(nodes[0].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == &nodes[0]);

        cx_linked_list_add(NULL, &end, loc_prev, loc_next, &nodes[2]);
        CX_TEST_ASSERT(end == &nodes[2]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[2]);
        CX_TEST_ASSERT(nodes[2].prev == &nodes[1]);

        // test with begin, end / next
        memset(nodes, 0, sizeof(node)*4);
        end = begin = NULL;

        cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[1]);
        CX_TEST_ASSERT(end == &nodes[1]);
        CX_TEST_ASSERT(nodes[0].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == NULL);
    }
}

CX_TEST(test_linked_list_prepend) {
    node nodes[4];
    void *begin, *end;
    CX_TEST_DO {
        // test with begin, end / prev, next
        memset(nodes, 0, sizeof(node) * 4);
        end = begin = NULL;

        cx_linked_list_prepend(&begin, &end, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].prev == NULL);
        CX_TEST_ASSERT(nodes[0].next == NULL);

        cx_linked_list_prepend(&begin, &end, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(begin == &nodes[1]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].prev == &nodes[1]);

        // test with begin only / prev, next
        memset(nodes, 0, sizeof(node) * 4);
        end = begin = NULL;

        cx_linked_list_prepend(&begin, NULL, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        cx_linked_list_prepend(&begin, NULL, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(begin == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].prev == &nodes[1]);

        cx_linked_list_prepend(&begin, NULL, loc_prev, loc_next, &nodes[2]);
        CX_TEST_ASSERT(begin == &nodes[2]);
        CX_TEST_ASSERT(nodes[2].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == &nodes[2]);

        // test with end only / prev, next
        memset(nodes, 0, sizeof(node) * 4);
        end = begin = NULL;

        cx_linked_list_prepend(NULL, &end, loc_prev, loc_next, &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        cx_linked_list_prepend(NULL, &end, loc_prev, loc_next, &nodes[1]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[0]);
        CX_TEST_ASSERT(nodes[0].prev == &nodes[1]);

        cx_linked_list_prepend(NULL, &end, loc_prev, loc_next, &nodes[2]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[2].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == &nodes[2]);

        // test with begin, end / next
        memset(nodes, 0, sizeof(node) * 4);
        end = begin = NULL;

        cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[0]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[0]);
        cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[1]);
        cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[2]);
        CX_TEST_ASSERT(begin == &nodes[2]);
        CX_TEST_ASSERT(end == &nodes[0]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[0]);
        CX_TEST_ASSERT(nodes[2].next == &nodes[1]);
        CX_TEST_ASSERT(nodes[1].prev == NULL);
        CX_TEST_ASSERT(nodes[0].prev == NULL);
    }
}

CX_TEST(test_linked_list_insert) {
    node nodes[4];
    void *begin, *end;
    CX_TEST_DO {
        // insert mid list
        memset(nodes, 0, sizeof(node) * 4);
        begin = &nodes[0];
        end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);

        cx_linked_list_insert(&begin, &end, loc_prev, loc_next, &nodes[1], &nodes[3]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[2]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[3]);
        CX_TEST_ASSERT(nodes[2].prev == &nodes[3]);
        CX_TEST_ASSERT(nodes[3].prev == &nodes[1]);
        CX_TEST_ASSERT(nodes[3].next == &nodes[2]);

        // insert end
        memset(nodes, 0, sizeof(node) * 4);
        begin = &nodes[0];
        end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);

        cx_linked_list_insert(&begin, &end, loc_prev, loc_next, &nodes[2], &nodes[3]);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[3]);
        CX_TEST_ASSERT(nodes[2].next == &nodes[3]);
        CX_TEST_ASSERT(nodes[3].prev == &nodes[2]);
        CX_TEST_ASSERT(nodes[3].next == NULL);

        // insert begin
        memset(nodes, 0, sizeof(node) * 4);
        begin = &nodes[0];
        end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);

        cx_linked_list_insert(&begin, &end, loc_prev, loc_next, NULL, &nodes[3]);
        CX_TEST_ASSERT(begin == &nodes[3]);
        CX_TEST_ASSERT(end == &nodes[2]);
        CX_TEST_ASSERT(nodes[0].prev == &nodes[3]);
        CX_TEST_ASSERT(nodes[3].prev == NULL);
        CX_TEST_ASSERT(nodes[3].next == &nodes[0]);
    }
}

CX_TEST(test_linked_list_insert_chain) {
    node nodes[5];
    void *begin, *end;
    CX_TEST_DO {
        // insert mid list
        memset(nodes, 0, sizeof(node) * 5);
        begin = &nodes[0]; end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
        cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);

        cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, &nodes[1], &nodes[3], NULL);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[2]);
        CX_TEST_ASSERT(nodes[1].next == &nodes[3]);
        CX_TEST_ASSERT(nodes[2].prev == &nodes[4]);
        CX_TEST_ASSERT(nodes[3].prev == &nodes[1]);
        CX_TEST_ASSERT(nodes[4].next == &nodes[2]);

        // insert end
        memset(nodes, 0, sizeof(node) * 5);
        begin = &nodes[0]; end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
        cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);

        cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, &nodes[2], &nodes[3], NULL);
        CX_TEST_ASSERT(begin == &nodes[0]);
        CX_TEST_ASSERT(end == &nodes[4]);
        CX_TEST_ASSERT(nodes[2].next == &nodes[3]);
        CX_TEST_ASSERT(nodes[3].prev == &nodes[2]);
        CX_TEST_ASSERT(nodes[4].next == NULL);

        // insert begin
        memset(nodes, 0, sizeof(node) * 5);
        begin = &nodes[0]; end = &nodes[2];

        cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
        cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
        cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);

        cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, NULL, &nodes[3], NULL);
        CX_TEST_ASSERT(begin == &nodes[3]);
        CX_TEST_ASSERT(end == &nodes[2]);
        CX_TEST_ASSERT(nodes[0].prev == &nodes[4]);
        CX_TEST_ASSERT(nodes[3].prev == NULL);
        CX_TEST_ASSERT(nodes[4].next == &nodes[0]);
    }
}

CX_TEST(test_linked_list_first) {
    node *testdata = create_nodes_test_data(3);
    void *begin = testdata;
    CX_TEST_DO {
        CX_TEST_ASSERT(begin == cx_linked_list_first(testdata, loc_prev));
        CX_TEST_ASSERT(begin == cx_linked_list_first(testdata->next, loc_prev));
        CX_TEST_ASSERT(begin == cx_linked_list_first(testdata->next->next, loc_prev));
    }
    destroy_nodes_test_data(testdata);
}

CX_TEST(test_linked_list_last) {
    node *testdata = create_nodes_test_data(3);
    void *end = testdata->next->next;
    CX_TEST_DO {
        CX_TEST_ASSERT(end == cx_linked_list_last(testdata, loc_next));
        CX_TEST_ASSERT(end == cx_linked_list_last(testdata->next, loc_next));
        CX_TEST_ASSERT(end == cx_linked_list_last(testdata->next->next, loc_next));
    }
    destroy_nodes_test_data(testdata);
}

CX_TEST(test_linked_list_prev) {
    node *testdata = create_nodes_test_data(3);
    CX_TEST_DO {
        CX_TEST_ASSERT(cx_linked_list_prev(testdata, loc_next, testdata) == NULL);
        CX_TEST_ASSERT(cx_linked_list_prev(testdata, loc_next, testdata->next) == testdata);
        CX_TEST_ASSERT(cx_linked_list_prev(testdata, loc_next, testdata->next->next) == testdata->next);
    }
    destroy_nodes_test_data(testdata);
}

CX_TEST(test_linked_list_remove) {
    node *testdata = create_nodes_test_data(3);
    assign_nodes_test_data(testdata, 2, 4, 6);
    node *first = testdata;
    node *second = first->next;
    node *third = second->next;
    void *begin = testdata;
    void *end = third;

    CX_TEST_DO {
        cx_linked_list_remove(&begin, &end, loc_prev, loc_next, second);
        CX_TEST_ASSERT(begin == first);
        CX_TEST_ASSERT(end == third);
        CX_TEST_ASSERT(first->prev == NULL);
        CX_TEST_ASSERT(first->next == third);
        CX_TEST_ASSERT(third->prev == first);
        CX_TEST_ASSERT(third->next == NULL);

        cx_linked_list_remove(&begin, &end, loc_prev, loc_next, third);
        CX_TEST_ASSERT(begin == first);
        CX_TEST_ASSERT(end == first);
        CX_TEST_ASSERT(first->prev == NULL);
        CX_TEST_ASSERT(first->next == NULL);

        cx_linked_list_remove(&begin, &end, loc_prev, loc_next, first);
        CX_TEST_ASSERT(begin == NULL);
        CX_TEST_ASSERT(end == NULL);
    }
    // list is not intact anymore, we have to free nodes individually
    free(first);
    free(second);
    free(third);
}

CX_TEST(test_linked_list_size) {
    node *td5 = create_nodes_test_data(5);
    node *td13 = create_nodes_test_data(13);
    CX_TEST_DO {
        CX_TEST_ASSERT(cx_linked_list_size(NULL, loc_next) == 0);
        CX_TEST_ASSERT(cx_linked_list_size(td5, loc_next) == 5);
        CX_TEST_ASSERT(cx_linked_list_size(td13, loc_next) == 13);
    }
    destroy_nodes_test_data(td5);
    destroy_nodes_test_data(td13);
}

CX_TEST(test_linked_list_sort_empty) {
    void *begin = NULL;
    CX_TEST_DO {
        // cannot assert something, we can just test that it does not crash
        cx_linked_list_sort(&begin, NULL, loc_prev, loc_next, loc_data, cx_cmp_int);
        CX_TEST_ASSERT(true);
    }
}

CX_TEST(test_linked_list_sort) {
    const size_t len = 1500;
    int *testdata = int_test_data(len);
    void *scrambled = create_nodes_test_data(len);
    node *n = scrambled;
    for (size_t i = 0; i < len; i++) {
        n->data = testdata[i];
        n = n->next;
    }
    int *sorted = malloc(len*sizeof(int));
    memcpy(sorted, testdata, len*sizeof(int));
    qsort(sorted, len, sizeof(int), cx_cmp_int);

    void *begin = scrambled;
    void *end = cx_linked_list_last(begin, loc_next);

    CX_TEST_DO {
        cx_linked_list_sort(&begin, &end, loc_prev, loc_next, loc_data, cx_cmp_int);
        node *check = begin;
        node *check_last = NULL;
        for (size_t i = 0; i < len; i++) {
            CX_TEST_ASSERT(check->data == sorted[i]);
            CX_TEST_ASSERT(check->prev == check_last);
            if (i < len - 1) {
                CX_TEST_ASSERT(check->next != NULL);
            }
            check_last = check;
            check = check->next;
        }
        CX_TEST_ASSERT(check == NULL);
        CX_TEST_ASSERT(end == check_last);
    }
    destroy_nodes_test_data(begin);
    free(sorted);
    free(testdata);
}

CX_TEST(test_linked_list_reverse) {
    void *testdata = create_nodes_test_data(4);
    void *expected = create_nodes_test_data(4);
    assign_nodes_test_data(testdata, 2, 4, 6, 8);
    assign_nodes_test_data(expected, 8, 6, 4, 2);
    void *begin = testdata;
    CX_TEST_DO {
        void *end = cx_linked_list_last(begin, loc_next);
        void *orig_begin = begin, *orig_end = end;

        cx_linked_list_reverse(&begin, &end, loc_prev, loc_next);
        CX_TEST_ASSERT(end == orig_begin);
        CX_TEST_ASSERT(begin == orig_end);
        CX_TEST_ASSERT(0 == cx_linked_list_compare(begin, expected, loc_next, loc_data, cx_cmp_int));
    }
    destroy_nodes_test_data(begin);
    destroy_nodes_test_data(expected);
}


CX_TEST(test_empty_list_size) {
    CX_TEST_DO {
        CX_TEST_ASSERT(cxEmptyList->size == 0);
        CX_TEST_ASSERT(cxListSize(cxEmptyList) == 0);
    }
}

CX_TEST(test_empty_list_iterator) {
    CxList *list = cxEmptyList;

    CxIterator it1 = cxListIterator(list);
    CxIterator it2 = cxListBackwardsIterator(list);
    CxMutIterator it3 = cxListMutIterator(list);
    CxMutIterator it4 = cxListMutBackwardsIterator(list);

    CX_TEST_DO {
        CX_TEST_ASSERT(!cxIteratorValid(it1));
        CX_TEST_ASSERT(!cxIteratorValid(it2));
        CX_TEST_ASSERT(!cxIteratorValid(it3));
        CX_TEST_ASSERT(!cxIteratorValid(it4));

        int c = 0;
        cx_foreach(void*, data, it1) c++;
        cx_foreach(void*, data, it2) c++;
        cx_foreach(void*, data, it3) c++;
        cx_foreach(void*, data, it4) c++;
        CX_TEST_ASSERT(c == 0);
    }
}

CX_TEST(test_empty_list_noops) {
    CX_TEST_DO {
        CxList copy = *cxEmptyList;
        cxListSort(cxEmptyList);
        cxListClear(cxEmptyList);
        cxListDestroy(cxEmptyList);
        CX_TEST_ASSERT(0 == memcmp(&copy, cxEmptyList, sizeof(CxList))); // NOLINT(*-suspicious-memory-comparison)
    }
}

CX_TEST(test_empty_list_at) {
    CX_TEST_DO {
        CX_TEST_ASSERT(cxListAt(cxEmptyList, 0) == NULL);
        CX_TEST_ASSERT(cxListAt(cxEmptyList, 1) == NULL);
    }
}

CX_TEST(test_empty_list_find) {
    int x = 42, y = 1337;
    CX_TEST_DO {
        CX_TEST_ASSERT(cxListFind(cxEmptyList, &x) < 0);
        CX_TEST_ASSERT(cxListFind(cxEmptyList, &y) < 0);
    }
}

CX_TEST(test_empty_list_compare) {
    CxList *empty = cxEmptyList;
    CxList *ll = cxLinkedListCreateSimple(sizeof(int));
    CxList *al = cxArrayListCreateSimple(sizeof(int), 8);
    int x = 5;
    CX_TEST_DO {
        CX_TEST_ASSERT(0 == cxListCompare(empty, cxEmptyList));
        CX_TEST_ASSERT(0 == cxListCompare(ll, cxEmptyList));
        CX_TEST_ASSERT(0 == cxListCompare(al, cxEmptyList));
        CX_TEST_ASSERT(0 == cxListCompare(cxEmptyList, ll));
        CX_TEST_ASSERT(0 == cxListCompare(cxEmptyList, al));

        cxListAdd(ll, &x);
        cxListAdd(al, &x);

        CX_TEST_ASSERT(0 < cxListCompare(ll, cxEmptyList));
        CX_TEST_ASSERT(0 < cxListCompare(al, cxEmptyList));
        CX_TEST_ASSERT(0 > cxListCompare(cxEmptyList, ll));
        CX_TEST_ASSERT(0 > cxListCompare(cxEmptyList, al));
    }
    cxListDestroy(ll);
    cxListDestroy(al);
}

CX_TEST(test_list_ll_create) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        CxList *list = cxLinkedListCreate(alloc, cx_cmp_int, sizeof(int));
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(int));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == alloc);
        CX_TEST_ASSERT(list->cmpfunc == cx_cmp_int);
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
        cxListDestroy(list);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CX_TEST(test_list_ll_create_simple) {
    CxList *list = cxLinkedListCreateSimple(sizeof(int));
    CX_TEST_DO {
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(int));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == cxDefaultAllocator);
        CX_TEST_ASSERT(list->cmpfunc == NULL);
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
    }
    cxListDestroy(list);
}

CX_TEST(test_list_ll_store_pointers) {
    CxList *list = cxLinkedListCreateSimple(47);
    CX_TEST_DO {
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
        cxListStorePointers(list);
        CX_TEST_ASSERT(list->item_size == sizeof(void *));
        CX_TEST_ASSERT(list->cl != NULL);
        CX_TEST_ASSERT(list->climpl != NULL);
        CX_TEST_ASSERT(cxListIsStoringPointers(list));
        cxListStoreObjects(list);
        CX_TEST_ASSERT(list->cl != NULL);
        CX_TEST_ASSERT(list->climpl == NULL);
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
    }
    cxListDestroy(list);
}

CX_TEST(test_list_ll_create_simple_for_pointers) {
    CxList *list = cxLinkedListCreateSimple(CX_STORE_POINTERS);
    CX_TEST_DO {
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(void*));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == cxDefaultAllocator);
        CX_TEST_ASSERT(list->cmpfunc == cx_cmp_ptr);
        CX_TEST_ASSERT(cxListIsStoringPointers(list));
    }
    cxListDestroy(list);
}

CX_TEST(test_list_arl_create) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        CxList *list = cxArrayListCreate(alloc, cx_cmp_int, sizeof(int), 8);
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(int));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == alloc);
        CX_TEST_ASSERT(list->cmpfunc == cx_cmp_int);
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
        cxListDestroy(list);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CX_TEST(test_list_arl_create_simple) {
    CxList *list = cxArrayListCreateSimple(sizeof(int), 8);
    CX_TEST_DO {
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(int));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == cxDefaultAllocator);
        CX_TEST_ASSERT(list->cmpfunc == NULL);
        CX_TEST_ASSERT(!cxListIsStoringPointers(list));
    }
    cxListDestroy(list);
}

CX_TEST(test_list_arl_create_simple_for_pointers) {
    CxList *list = cxArrayListCreateSimple(CX_STORE_POINTERS, 8);
    CX_TEST_DO {
        CX_TEST_ASSERT(list != NULL);
        CX_TEST_ASSERT(list->item_size == sizeof(void*));
        CX_TEST_ASSERT(list->simple_destructor == NULL);
        CX_TEST_ASSERT(list->advanced_destructor == NULL);
        CX_TEST_ASSERT(list->destructor_data == NULL);
        CX_TEST_ASSERT(cxListSize(list) == 0);
        CX_TEST_ASSERT(list->allocator == cxDefaultAllocator);
        CX_TEST_ASSERT(list->cmpfunc == cx_cmp_ptr);
        CX_TEST_ASSERT(cxListIsStoringPointers(list));
    }
    cxListDestroy(list);
}

static void test_fake_simple_int_destr(void *elem) {
    *(int *) elem = 42;
}

CX_TEST(test_list_pll_destroy_no_destr) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        void *item = cxMalloc(alloc, sizeof(int));
        CxList *list = cxLinkedListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS);
        cxListAdd(list, item);
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxListDestroy(list);
        // item is not yet freed
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxFree(alloc, item);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CX_TEST(test_list_pll_destroy_simple_destr) {
    CX_TEST_DO {
        int item = 0;
        CxList *list = cxLinkedListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS);
        list->simple_destructor = test_fake_simple_int_destr;
        cxListAdd(list, &item);
        cxListDestroy(list);
        CX_TEST_ASSERT(item == 42);
    }
}

CX_TEST(test_list_pll_destroy_adv_destr) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        void *item = cxMalloc(alloc, sizeof(int));
        CxList *list = cxLinkedListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS);
        list->destructor_data = alloc;
        list->advanced_destructor = (cx_destructor_func2) cxFree;
        cxListAdd(list, item);
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxListDestroy(list);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CX_TEST(test_list_parl_destroy_no_destr) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        void *item = cxMalloc(alloc, sizeof(int));
        CxList *list = cxArrayListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS, 4);
        cxListAdd(list, item);
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxListDestroy(list);
        // item is not yet freed
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxFree(alloc, item);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CX_TEST(test_list_parl_destroy_simple_destr) {
    CX_TEST_DO {
        int item = 0;
        CxList *list = cxArrayListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS, 4);
        list->simple_destructor = test_fake_simple_int_destr;
        cxListAdd(list, &item);
        cxListDestroy(list);
        CX_TEST_ASSERT(item == 42);
    }
}

CX_TEST(test_list_parl_destroy_adv_destr) {
    CxTestingAllocator talloc;
    cx_testing_allocator_init(&talloc);
    CxAllocator *alloc = &talloc.base;
    CX_TEST_DO {
        void *item = cxMalloc(alloc, sizeof(int));
        CxList *list = cxArrayListCreate(cxDefaultAllocator, cx_cmp_int, CX_STORE_POINTERS, 4);
        list->destructor_data = alloc;
        list->advanced_destructor = (cx_destructor_func2) cxFree;
        cxListAdd(list, item);
        CX_TEST_ASSERT(!cx_testing_allocator_verify(&talloc));
        cxListDestroy(list);
        CX_TEST_ASSERT(cx_testing_allocator_verify(&talloc));
    }
    cx_testing_allocator_destroy(&talloc);
}

CxTestSuite *cx_test_suite_array_list(void) {
    CxTestSuite *suite = cx_test_suite_new("array_list");

    cx_test_register(suite, test_list_arl_create);
    cx_test_register(suite, test_list_arl_create_simple);
    cx_test_register(suite, test_list_arl_create_simple_for_pointers);
    cx_test_register(suite, test_list_parl_destroy_no_destr);
    cx_test_register(suite, test_list_parl_destroy_simple_destr);
    cx_test_register(suite, test_list_parl_destroy_adv_destr);

    return suite;
}

CxTestSuite *cx_test_suite_linked_list(void) {
    CxTestSuite *suite = cx_test_suite_new("linked_list");

    cx_test_register(suite, test_linked_list_link_unlink);
    cx_test_register(suite, test_linked_list_at);
    cx_test_register(suite, test_linked_list_find);
    cx_test_register(suite, test_linked_list_compare);
    cx_test_register(suite, test_linked_list_add);
    cx_test_register(suite, test_linked_list_prepend);
    cx_test_register(suite, test_linked_list_insert);
    cx_test_register(suite, test_linked_list_insert_chain);
    cx_test_register(suite, test_linked_list_first);
    cx_test_register(suite, test_linked_list_last);
    cx_test_register(suite, test_linked_list_prev);
    cx_test_register(suite, test_linked_list_remove);
    cx_test_register(suite, test_linked_list_size);
    cx_test_register(suite, test_linked_list_sort_empty);
    cx_test_register(suite, test_linked_list_sort);
    cx_test_register(suite, test_linked_list_reverse);

    cx_test_register(suite, test_list_ll_create);
    cx_test_register(suite, test_list_ll_create_simple);
    cx_test_register(suite, test_list_ll_store_pointers);
    cx_test_register(suite, test_list_ll_create_simple_for_pointers);
    cx_test_register(suite, test_list_pll_destroy_no_destr);
    cx_test_register(suite, test_list_pll_destroy_simple_destr);
    cx_test_register(suite, test_list_pll_destroy_adv_destr);

    return suite;
}

CxTestSuite *cx_test_suite_empty_list(void) {
    CxTestSuite *suite = cx_test_suite_new("empty list dummy");

    cx_test_register(suite, test_empty_list_size);
    cx_test_register(suite, test_empty_list_iterator);
    cx_test_register(suite, test_empty_list_noops);
    cx_test_register(suite, test_empty_list_at);
    cx_test_register(suite, test_empty_list_find);
    cx_test_register(suite, test_empty_list_compare);

    return suite;
}