Change in flashrom[master]: tests: Add unit tests for layout sanity checks

[Edward O'Callaghan (Code Review)]

Edward O'Callaghan has submitted this change. ( https://review.coreboot.org/c/flashrom/+/56440 )

Change subject: tests: Add unit tests for layout sanity checks
......................................................................

tests: Add unit tests for layout sanity checks

Three more tests in this patch where layout does / does not pass
sanity checks.

BUG=b:193584590
TEST=ninja test

Change-Id: Ia21585d60443b2741f3868d7887476090e35f79b
Signed-off-by: Anastasia Klimchuk 
Reviewed-on: https://review.coreboot.org/c/flashrom/+/56440
Tested-by: build bot (Jenkins) 
Reviewed-by: Edward O'Callaghan 
Reviewed-by: Nico Huber 
---
M tests/layout.c
M tests/tests.c
M tests/tests.h
3 files changed, 111 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Nico Huber: Looks good to me, but someone else must approve
  Edward O'Callaghan: Looks good to me, approved

diff --git a/tests/layout.c b/tests/layout.c
index 5f0aee5..59e409b 100644
--- a/tests/layout.c
+++ b/tests/layout.c
@@ -16,6 +16,7 @@
 #include <include/test.h>
 #include <stdio.h>

+#include "flash.h"
 #include "layout.h"
 #include "libflashrom.h"

@@ -101,3 +102,107 @@
    flashrom_layout_release(layout);
    printf("done\n");
 }
+
+void layout_pass_sanity_checks_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	unsigned int region_start = 0x00021000;
+	unsigned int region_end = 0x00031000;
+	unsigned int start = 0;
+	unsigned int len = 0;
+
+	struct flashrom_layout *layout;
+
+	printf("Creating layout with one included region... ");
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	assert_int_equal(0, flashrom_layout_add_region(layout, region_start, region_end, "region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "region"));
+	printf("done\n");
+
+	printf("Asserting region range... ");
+	get_region_range(layout, "region", &start, &len);
+	assert_int_equal(start, region_start);
+	assert_int_equal(len, region_end - region_start + 1);
+	printf("done\n");
+
+	printf("Layout passes sanity checks... ");
+
+	struct flashchip chip = {
+		.total_size = 1024,
+	};
+	struct flashrom_flashctx flash = {
+		.chip = &chip,
+	};
+	flashrom_layout_set(&flash, layout);
+	assert_int_equal(0, layout_sanity_checks(&flash));
+
+	printf("done\n");
+
+	printf("Releasing layout... ");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
+
+void layout_region_invalid_address_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	struct flashrom_layout *layout;
+
+	printf("Creating layout with one included region... ");
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x60000000, 0x70000000, "region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "region"));
+	printf("done\n");
+
+	printf("Layout does not pass sanity checks... ");
+
+	struct flashchip chip = {
+		/* Make sure layout region addresses exceed total size on chip.  */
+		.total_size = 1,
+	};
+	struct flashrom_flashctx flash = {
+		.chip = &chip,
+	};
+	flashrom_layout_set(&flash, layout);
+	assert_int_equal(1, layout_sanity_checks(&flash));
+
+	printf("done\n");
+
+	printf("Releasing layout... ");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
+
+void layout_region_invalid_range_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	struct flashrom_layout *layout;
+
+	printf("Creating layout with one included region... ");
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	/* Make sure address range of region is not positive i.e. start > end. */
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00000020, 0x00000010, "region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "region"));
+	printf("done\n");
+
+	printf("Layout does not pass sanity checks... ");
+
+	struct flashchip chip = {
+		/* Make sure layout region addresses fit into total size on chip.  */
+		.total_size = 1024,
+	};
+	struct flashrom_flashctx flash = {
+		.chip = &chip,
+	};
+	flashrom_layout_set(&flash, layout);
+	assert_int_equal(1, layout_sanity_checks(&flash));
+
+	printf("done\n");
+
+	printf("Releasing layout... ");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
diff --git a/tests/tests.c b/tests/tests.c
index 78258b0..00c987c 100644
--- a/tests/tests.c
+++ b/tests/tests.c
@@ -240,6 +240,9 @@
    	cmocka_unit_test(included_regions_dont_overlap_test_success),
    	cmocka_unit_test(included_regions_overlap_test_success),
    	cmocka_unit_test(region_not_included_overlap_test_success),
+		cmocka_unit_test(layout_pass_sanity_checks_test_success),
+		cmocka_unit_test(layout_region_invalid_address_test_success),
+		cmocka_unit_test(layout_region_invalid_range_test_success),
    };
    ret |= cmocka_run_group_tests_name("layout.c tests", layout_tests, NULL, NULL);

diff --git a/tests/tests.h b/tests/tests.h
index eccc05f..14cfee0 100644
--- a/tests/tests.h
+++ b/tests/tests.h
@@ -51,5 +51,8 @@
 void included_regions_dont_overlap_test_success(void **state);
 void included_regions_overlap_test_success(void **state);
 void region_not_included_overlap_test_success(void **state);
+void layout_pass_sanity_checks_test_success(void **state);
+void layout_region_invalid_address_test_success(void **state);
+void layout_region_invalid_range_test_success(void **state);

#endif /* TESTS_H */