From ae3b7933b769eabd499857363ef7035815638427 Mon Sep 17 00:00:00 2001
From: "S.J.R. van Schaik" <stephan@whiteboxsystems.nl>
Date: Tue, 3 Oct 2017 11:07:17 +0200
Subject: [PATCH] test: ftl: add tests for trace_path()

---
 source/tests/Makefile         |   1 +
 source/tests/ftl/main.c       |   2 +
 source/tests/ftl/trace_path.c | 124 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 127 insertions(+)
 create mode 100644 source/tests/ftl/trace_path.c

diff --git a/source/tests/Makefile b/source/tests/Makefile
index 8c98a10..e9e7064 100644
--- a/source/tests/Makefile
+++ b/source/tests/Makefile
@@ -15,6 +15,7 @@ test-obj-y += source/tests/ftl/read_page_group.o
 test-obj-y += source/tests/ftl/read_page_desc.o
 test-obj-y += source/tests/ftl/write_page_desc.o
 test-obj-y += source/tests/ftl/write_upage.o
+test-obj-y += source/tests/ftl/trace_path.o
 
 test-obj-y += source/tests/ftl/ftl_is_mapped.o
 
diff --git a/source/tests/ftl/main.c b/source/tests/ftl/main.c
index 16d41da..c7d8d20 100644
--- a/source/tests/ftl/main.c
+++ b/source/tests/ftl/main.c
@@ -22,6 +22,7 @@ int test_read_page_group(void);
 int test_read_page_desc(void);
 int test_write_page_desc(void);
 int test_write_upage(void);
+int test_trace_path(void);
 
 int test_ftl_is_mapped(void);
 
@@ -40,6 +41,7 @@ int test_ftl(void)
 	count += test_read_page_desc();
 	count += test_write_page_desc();
 	count += test_write_upage();
+	count += test_trace_path();
 
 	count += test_ftl_is_mapped();
 
diff --git a/source/tests/ftl/trace_path.c b/source/tests/ftl/trace_path.c
new file mode 100644
index 0000000..4c470d2
--- /dev/null
+++ b/source/tests/ftl/trace_path.c
@@ -0,0 +1,124 @@
+#include <stdarg.h>
+#include <stddef.h>
+#include <stdlib.h>
+#include <string.h>
+#include <setjmp.h>
+
+#include <cmocka.h>
+
+#include <bitops.h>
+#include <flash.h>
+#include <ftl.h>
+#include <macros.h>
+
+int __real_trace_path(struct ftl_map *map, struct ftl_page_desc *new_page_desc,
+	uint32_t *page, uint32_t va);
+
+static void test_empty_root(void **state)
+{
+	struct ftl_map map;
+	uint32_t page;
+	int ret;
+
+	(void)state;
+
+	map.log2_page_size = ilog2(4 * KIB);
+	map.root = UINT32_MAX;
+	map.flags = 0;
+
+	ret = __real_trace_path(&map, NULL, &page, 0);
+
+	assert_int_equal(ret, -2);
+}
+
+static void test_trace1(void **state)
+{
+	struct ftl_page_desc descs[] = {
+		{
+			.va = 0x7,
+			.subtrees = {
+				[0] = UINT32_MAX,
+				[28] = 43,
+				[29] = UINT32_MAX,
+			},
+		},
+		{
+			.va = 0xb,
+			.subtrees = {
+				[0] = UINT32_MAX,
+				[29] = 44,
+				[30] = UINT32_MAX,
+			},
+		},
+		{
+			.va = 0xd,
+			.subtrees = {
+				[0] = UINT32_MAX,
+				[30] = 45,
+				[31] = UINT32_MAX,
+			},
+		},
+		{
+			.va = 0xe,
+			.subtrees = {
+				[0] = UINT32_MAX,
+				[31] = 46,
+			},
+		},
+		{
+			.va = 0xf,
+			.subtrees = {
+				UINT32_MAX,
+			},
+		},
+	};
+	struct ftl_map map;
+	uint32_t page;
+	int ret;
+
+	(void)state;
+
+	map.log2_page_size = ilog2(4 * KIB);
+	map.root = 42;
+	map.flags = 0;
+
+	expect_value(__wrap_read_page_desc, map, &map);
+	expect_value(__wrap_read_page_desc, upage, 42);
+	will_return(__wrap_read_page_desc, descs);
+	will_return(__wrap_read_page_desc, 0);
+
+	expect_value(__wrap_read_page_desc, map, &map);
+	expect_value(__wrap_read_page_desc, upage, 43);
+	will_return(__wrap_read_page_desc, descs + 1);
+	will_return(__wrap_read_page_desc, 0);
+
+	expect_value(__wrap_read_page_desc, map, &map);
+	expect_value(__wrap_read_page_desc, upage, 44);
+	will_return(__wrap_read_page_desc, descs + 2);
+	will_return(__wrap_read_page_desc, 0);
+
+	expect_value(__wrap_read_page_desc, map, &map);
+	expect_value(__wrap_read_page_desc, upage, 45);
+	will_return(__wrap_read_page_desc, descs + 3);
+	will_return(__wrap_read_page_desc, 0);
+
+	expect_value(__wrap_read_page_desc, map, &map);
+	expect_value(__wrap_read_page_desc, upage, 46);
+	will_return(__wrap_read_page_desc, descs + 3);
+	will_return(__wrap_read_page_desc, 0);
+
+	ret = __real_trace_path(&map, NULL, &page, 0xf);
+
+	assert_int_equal(ret, 0);
+	assert_int_equal(page, 46);
+}
+
+int test_trace_path(void)
+{
+	const struct CMUnitTest tests[] = {
+		{ "trace_path: empty root", test_empty_root, NULL, NULL, NULL },
+		{ "trace_path: successful trace", test_trace1, NULL, NULL, NULL },
+	};
+
+	return cmocka_run_group_tests_name("trace_path", tests, NULL, NULL);
+}