ocarina/tests/core/queue.c

/*
 * Copyright 2014 (c) Anna Schumaker.
 */
#include <core/idle.h>
#include <core/queue.h>
#include <core/tags/tags.h>
#include <tests/test.h>


unsigned int count_init    = 0;
unsigned int count_deinit  = 0;
unsigned int count_added   = 0;
unsigned int count_deleted = 0;
unsigned int count_cleared = 0;
unsigned int count_updated = 0;


static void *queue_op_init(struct queue *queue, void *data)
{
	count_init++;
	return GUINT_TO_POINTER(count_init);
}

static void queue_op_deinit(struct queue *queue)
{
	count_deinit++;
}

static void queue_op_added(struct queue *queue, unsigned int pos)
{
	count_added++;
}

static void queue_op_removed(struct queue *queue, unsigned int pos)
{
	count_deleted++;
}

static void queue_op_cleared(struct queue *queue, unsigned int n)
{
	count_cleared++;
}

static void queue_op_updated(struct queue *queue, unsigned int pos)
{
	count_updated++;
}


static const struct queue_ops test_ops = {
	.qop_init    = queue_op_init,
	.qop_deinit  = queue_op_deinit,
	.qop_added   = queue_op_added,
	.qop_removed = queue_op_removed,
	.qop_cleared = queue_op_cleared,
	.qop_updated = queue_op_updated,
};


static void test_init()
{
	struct queue q;
	struct queue_iter it;

	queue_init(&q, 0, NULL, NULL);
	g_assert_cmpuint(count_init, ==, 0);
	g_assert_null(q.q_private);

	g_assert_cmpuint(q.q_cur.it_pos, ==, (unsigned int)-1);
	g_assert_cmpuint(q.q_flags,  ==, 0);
	g_assert_cmpuint(q.q_length, ==, 0);
	g_assert_null(q.q_sort);
	g_assert_null(q.q_ops);
	g_assert_null(queue_next(&q));

	queue_iter_init(&q, &it);
	g_assert_null(it.it_iter);
	g_assert_cmpuint(it.it_pos, ==, (unsigned int)-1);
	g_assert_null(queue_iter_val(&it));

	queue_deinit(&q);
	g_assert_cmpuint(count_deinit, ==, 0);

	queue_init(&q, Q_RANDOM, &test_ops, NULL);
	g_assert_cmpuint(count_init, ==, 1);
	g_assert_cmpuint(GPOINTER_TO_UINT(q.q_private), ==, 1);

	g_assert_cmpuint(q.q_cur.it_pos, ==, (unsigned int)-1);
	g_assert_cmpuint(q.q_flags,  ==, Q_RANDOM);
	g_assert_cmpuint(q.q_length, ==, 0);
	g_assert_null(q.q_sort);
	g_assert(q.q_ops == &test_ops);
	g_assert_null(queue_next(&q));

	queue_deinit(&q);
	g_assert_cmpuint(count_deinit, ==, 1);
}

static void test_flags()
{
	struct queue q;

	queue_init(&q, 0, &test_ops, NULL);
	g_assert_cmpuint(q.q_flags, ==, 0);
	g_assert_false(queue_has_flag(&q, Q_UNUSED_0));
	g_assert_false(queue_has_flag(&q, Q_RANDOM));
	g_assert_false(queue_has_flag(&q, Q_REPEAT));
	g_assert_false(queue_has_flag(&q, Q_UNUSED_3));
	g_assert_false(queue_has_flag(&q, Q_UNUSED_4));
	g_assert_false(queue_has_flag(&q, Q_UNUSED_5));
	g_assert_false(queue_has_flag(&q, Q_UNUSED_6));

	queue_set_flag(&q, Q_RANDOM);
	queue_set_flag(&q, Q_REPEAT);
	g_assert_true(queue_has_flag(&q, Q_RANDOM));
	g_assert_true(queue_has_flag(&q, Q_REPEAT));

	queue_unset_flag(&q, Q_RANDOM);
	queue_unset_flag(&q, Q_REPEAT);
	g_assert_cmpuint(q.q_flags,   ==, 0);
}

static void test_queue(gconstpointer arg)
{
	unsigned int N = GPOINTER_TO_UINT(arg);
	unsigned int ex_length = 0;
	unsigned int ex_size   = N;
	struct queue_iter it;
	struct track *track;
	unsigned int i;
	struct queue q;

	count_added   = 0;
	count_deleted = 0;
	count_cleared = 0;
	count_updated = 0;

	queue_init(&q, 0, &test_ops, NULL);

	/* queue_add() */
	for (i = 0; i < N; i++) {
		track = track_get(i % 13);
		ex_length += track->tr_length;
		g_assert_cmpuint(queue_add(&q, track), ==, i);
		g_assert_cmpuint(count_added, ==, i + 1);
	}
	g_assert_cmpuint(q.q_length,     ==, ex_length);
	g_assert_cmpuint(queue_size(&q), ==, ex_size);

	/* queue_iter_init() */
	if (N > 0) {
		queue_iter_init(&q, &it);
		g_assert_nonnull(it.it_iter);
		g_assert_cmpuint(it.it_pos, ==, 0);
	}

	/* queue_for_each() */
	i = 0;
	queue_for_each(&q, &it) {
		g_assert_cmpuint(it.it_pos, ==, i);
		g_assert(queue_iter_val(&it) == track_get(i % 13));
		i++;
	}
	g_assert_cmpuint(i, ==, N);
	g_assert_cmpuint(queue_size(&q), ==, ex_size);

	/* queue_remove_all() and queue_has() */
	track = track_get(0);
	ex_length -= track->tr_length * (N / 13);
	ex_size   -= (N / 13);
	if (N > 0)
		g_assert_true(queue_has(&q, track));
	else
		g_assert_false(queue_has(&q, track));
	g_assert_cmpuint(queue_remove_all(&q, track), ==, N / 13);
	g_assert_cmpuint(q.q_length,     ==, ex_length);
	g_assert_cmpuint(queue_size(&q), ==, ex_size);
	g_assert_false(queue_has(&q, track));

	/* queue_remove() and queue_erase() == true */
	track = track_get(1);
	ex_length -= track->tr_length * (N / 13);
	ex_size   -= (N / 13);
	for (i = 0; i < ex_size; i += 11) {
		g_assert(queue_at(&q, i) == track);
		queue_remove(&q, i);
	}
	g_assert_cmpuint(q.q_length,     ==, ex_length);
	g_assert_cmpuint(queue_size(&q), ==, ex_size);

	/* queue_updated() */
	track = track_get(2);
	queue_updated(&q, track);
	g_assert_cmpuint(count_updated, ==, N / 13);

	/* Tracks should not be removed. */
	queue_set_flag(&q, Q_REPEAT);
	for (i = 0; i < ex_size; i++) {
		g_assert(queue_next(&q) == track_get((i % 11) + 2));
		g_assert_cmpuint(count_updated, ==, (N / 13) + (2 * i) + 1);
		queue_selected(&q, i);
		g_assert_cmpuint(count_updated, ==, (N / 13) + (2 * i) + 2);
		g_assert_cmpuint(queue_size(&q), ==, ex_size);
	}

	/* Tracks should be removed. */
	queue_unset_flag(&q, Q_REPEAT);
	for (i = 0; i < ex_size / 2; i++) {
		track = queue_next(&q);
		ex_length -= track->tr_length;
		ex_size--;

		g_assert(track == track_get((i % 11) + 2));
		g_assert_cmpuint(queue_size(&q), ==, ex_size);
		g_assert_cmpuint(q.q_length, ==, ex_length);
	}

	queue_clear(&q);
	g_assert_cmpuint(count_cleared,  ==, 1);
	g_assert_cmpuint(queue_size(&q), ==, 0);
	g_assert_cmpuint(q.q_length, ==, 0);

	queue_deinit(&q);
	g_assert_cmpuint(count_cleared, ==, 2);
	g_assert_null(q.q_sort);
}

static void test_rand_select()
{
	unsigned int i;
	struct queue q;

	g_random_set_seed(0);
	queue_init(&q, Q_RANDOM, &test_ops, NULL);

	/* Call next() on an empty queue. */
	for (i = 0; i < 13; i++) {
		g_assert_null(queue_next(&q));
		g_assert_cmpuint(queue_size(&q), ==, 0);
	}

	for (i = 0; i < 13; i++)
		queue_add(&q, track_get(i));
	queue_sort(&q, COMPARE_TRACK, true);

	/*
	 * The comments below use the following notation:
	 * 	<val>: The value pointed to by q._cur.
	 * 	(val): The value selected by q.track_selected().
	 * 	[val]: The value picked by q.next().
	 */

	/* rand() = 9, q = { <>, 1, 2, 3, 4, 5, 6, 7, 8, [9], 10, 11, 12, 13 } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 9);
	g_assert_cmpuint(queue_size(&q), ==, 12);

	/* select = 6, q = { 1, 2, 3, 4, 5, 6, (7), <8>, 10, 11, 12, 13 } */
	g_assert_cmpuint(queue_selected(&q, 6)->tr_track, ==, 7);
	g_assert_cmpuint(queue_size(&q), ==, 11);

	/* rand() = 10, q = { 1, 2, 3, 4, [5], <6>, 8, 10, 11, 12, 13 } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 5);
	g_assert_cmpuint(queue_size(&q), ==, 10);

	/* select = 7, q = { 1, 2, 3, <4>, 6, 8, 10, (11), 12, 13 } */
	g_assert_cmpuint(queue_selected(&q, 7)->tr_track, ==, 11);
	g_assert_cmpuint(queue_size(&q), ==, 9);

	/* rand() = 6, q = { 1, 2, 3, [4], 6, 8, <10>, 12, 13 } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 4);
	g_assert_cmpuint(queue_size(&q), ==, 8);

	/* select = 2, q = { 1, 2, (<3>), 6, 8, 10, 12, 13 } */
	g_assert_cmpuint(queue_selected(&q, 2)->tr_track, ==, 3);
	g_assert_cmpuint(queue_size(&q), ==, 7);

	/* rand() = 1, q = { 1, <2>, [6], 8, 10, 12, 13 } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 6);
	g_assert_cmpuint(queue_size(&q), ==, 6);

	/* select = 1, q = { 1, (<2>), 8, 10, 12, 13 } */
	g_assert_cmpuint(queue_selected(&q, 1)->tr_track, ==, 2);
	g_assert_cmpuint(queue_size(&q), ==, 5);

	/* rand() = 4, q = { <1>, 8, 10, 12, [13] } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 13);
	g_assert_cmpuint(queue_size(&q), ==, 4);

	/* rand() = 1, q = { [1], 8, 10, <12> } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 1);
	g_assert_cmpuint(queue_size(&q), ==, 3);

	/* select = 1, q = { <>, 8, (10), 12 } */
	g_assert_cmpuint(queue_selected(&q, 1)->tr_track, ==, 10);
	g_assert_cmpuint(queue_size(&q), ==, 2);

	/* rand() = 1, q = { <8>, [12] } */
	g_assert_cmpuint(queue_next(&q)->tr_track, ==, 12);
	g_assert_cmpuint(queue_size(&q), ==, 1);

	/* select = 0, q = { (<8>) } */
	g_assert_cmpuint(queue_selected(&q, 0)->tr_track, ==, 8);
	g_assert_cmpuint(queue_size(&q), ==, 0);

	/* q = { } */
	g_assert_null(queue_next(&q));
	g_assert_null(queue_selected(&q, 3));

	queue_deinit(&q);
}

static void test_sorting()
{
	unsigned int ex_count[] = { 7, 8, 9, 10, 11, 12, 13, 1, 2, 3, 4, 5, 6 };
	unsigned int ex_title[] = { 7, 10, 9, 4, 3, 6, 2, 5, 12, 11, 13, 1, 8 };
	unsigned int ex_co_ti[] = { 4, 3, 6, 2, 5, 1, 7, 10, 9, 12, 11, 13, 8 };
	struct track *track;
	unsigned int i;
	struct queue q;

	queue_init(&q, 0, &test_ops, NULL);
	for (i = 0; i < 13; i++) {
		track = track_get(i);
		track->tr_count = (track->tr_track <= 6) ? 4 : 2;
		queue_add_front(&q, track);
	}

	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_dbe.dbe_index, ==, 12 - i);
	}

	queue_sort(&q, COMPARE_TRACK, true);
	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_track, ==, i + 1);
	}

	queue_sort(&q, COMPARE_COUNT, true);
	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_track, ==, ex_count[i]);
	}

	queue_sort(&q, COMPARE_TITLE, true);
	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_track, ==, ex_title[i]);
	}

	queue_sort(&q, COMPARE_COUNT, true);
	queue_sort(&q, COMPARE_TITLE, false);
	queue_sort(&q, COMPARE_COUNT, false);
	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_track, ==, ex_co_ti[i]);
	}

	queue_sort(&q, COMPARE_ARTIST, true);
	queue_sort(&q, COMPARE_ALBUM,  false);
	queue_sort(&q, COMPARE_TRACK,  false);
	queue_sort(&q, COMPARE_TRACK,  false);
	for (i = 0; i < 13; i++) {
		track = queue_at(&q, i);
		g_assert_nonnull(track);
		g_assert_cmpuint(track->tr_track, ==, 13 - i);
	}

	queue_deinit(&q);
	g_assert_cmpuint(q.q_length,    ==, 0);
	g_assert_cmpuint(queue_size(&q),==, 0);
	g_assert_null(q.q_sort);
}

static void test_save_load()
{
	struct file f = FILE_INIT("queue.q", 0);
	struct queue q, r;
	unsigned int i;

	queue_init(&q, 0, &test_ops, NULL);
	queue_init(&r, 0, &test_ops, NULL);

	for (i = 0; i < 13; i++)
		queue_add(&q, track_get(i));

	g_assert_false(file_exists(&f));
	g_assert_true(file_open(&f, OPEN_WRITE));
	queue_save_tracks(&q, &f);
	file_close(&f);
	g_assert_true(file_exists(&f));

	g_assert_true(file_open(&f, OPEN_READ));
	queue_load_tracks(&r, &f);
	file_close(&f);

	g_assert_cmpuint(queue_size(&r), ==, 13);
	for (i = 0; i < 13; i++)
		g_assert_true(queue_has(&r, track_get(i)));

	queue_deinit(&q);
	queue_deinit(&r);
}

int main(int argc, char **argv)
{
	struct library *library;
	int ret;

	idle_init_sync();
	tags_init();
	while (idle_run_task()) {}

	library = library_find("tests/Music");
	track_add(library, "tests/Music/Hyrule Symphony/01 - Title Theme.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/02 - Kokiri Forest.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/03 - Hyrule Field.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/04 - Hyrule Castle.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/05 - Lon Lon Ranch.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/06 - Kakariko Village.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/07 - Death Mountain.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/08 - Zora's Domain.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/09 - Gerudo Valley.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/10 - Ganondorf.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/11 - Princess Zelda.ogg");
	track_add(library, "tests/Music/Hyrule Symphony/12 - Ocarina Medley.ogg");
	track_add(library,
		  "tests/Music/Hyrule Symphony/13 - The Legend of Zelda Medley.ogg");

	g_test_init(&argc, &argv, NULL);
	g_test_add_func("/Core/Queue/Initialization", test_init);
	g_test_add_func("/Core/Queue/Flags", test_flags);
	g_test_add_data_func("/Core/Queue/n = 0",        GUINT_TO_POINTER(     0), test_queue);
	g_test_add_data_func("/Core/Queue/n = 13",       GUINT_TO_POINTER(    13), test_queue);
	g_test_add_data_func("/Core/Queue/n = 100,009)", GUINT_TO_POINTER(100009), test_queue);
	g_test_add_func("/Core/Queue/Random Next and Selection", test_rand_select);
	g_test_add_func("/Core/Queue/Sorting", test_sorting);
	g_test_add_func("/Core/Queue/Save and Load", test_save_load);
	ret = g_test_run();

	tags_deinit();
	idle_deinit();
	return ret;
}