Change in flashrom[master]: tests: Add layout tests for overlapping regions

[Edward O'Callaghan (Code Review)]

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

Change subject: tests: Add layout tests for overlapping regions
......................................................................

tests: Add layout tests for overlapping regions

There are no tests for layout, it would be great to add some.

Also partially inspired by
commit 06a89d713951a2e08ef8fb698a7688357baa83d1
and commit c9039fc27916c03e21ba91365d01e6bc49503053

BUG=b:193584590
TEST=ninja test

Change-Id: I7aa8dc0c9bc5a22fe5deea757eea1a151b969cea
Signed-off-by: Anastasia Klimchuk 
Reviewed-on: https://review.coreboot.org/c/flashrom/+/56324
Reviewed-by: Edward O'Callaghan 
Reviewed-by: Angel Pons 
Tested-by: build bot (Jenkins) 
---
A tests/layout.c
M tests/meson.build
M tests/tests.c
M tests/tests.h
4 files changed, 116 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Angel Pons: Looks good to me, approved
  Edward O'Callaghan: Looks good to me, approved

diff --git a/tests/layout.c b/tests/layout.c
new file mode 100644
index 0000000..e3e9539
--- /dev/null
+++ b/tests/layout.c
@@ -0,0 +1,103 @@
+/*
+ * This file is part of the flashrom project.
+ *
+ * Copyright 2021 Google LLC
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <include/test.h>
+#include <stdio.h>
+
+#include "layout.h"
+#include "libflashrom.h"
+
+void included_regions_dont_overlap_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	printf("Creating layout...\n");
+	struct flashrom_layout *layout;
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	printf("done\n");
+
+	printf("Adding and including first region...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00021000, 0x00031000, "first region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "first region"));
+	printf("done\n");
+
+	printf("Adding and including second (non-overlapping) region...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00031001, 0x0023efc0, "second region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "second region"));
+	printf("done\n");
+
+	printf("Asserting included regions do not overlap...\n");
+	assert_int_equal(0, included_regions_overlap(layout));
+	printf("done\n");
+
+	printf("Releasing layout...\n");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
+
+void included_regions_overlap_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	printf("Creating layout...\n");
+	struct flashrom_layout *layout;
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	printf("done\n");
+
+	printf("Adding and including first region...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00021000, 0x00031000, "first region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "first region"));
+	printf("done\n");
+
+	printf("Adding and including second (overlapping) region...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00027100, 0x0023efc0, "second region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "second region"));
+	printf("done\n");
+
+	printf("Asserting included regions overlap...\n");
+	assert_int_equal(1, included_regions_overlap(layout));
+	printf("done\n");
+
+	printf("Releasing layout...\n");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
+
+void region_not_included_overlap_test_success(void **state)
+{
+	(void) state; /* unused */
+
+	printf("Creating layout...\n");
+	struct flashrom_layout *layout;
+	assert_int_equal(0, flashrom_layout_new(&layout));
+	printf("done\n");
+
+	printf("Adding and including first region...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00021000, 0x00031000, "first region"));
+	assert_int_equal(0, flashrom_layout_include_region(layout, "first region"));
+	printf("done\n");
+
+	printf("Adding second (overlapping) region, not included...\n");
+	assert_int_equal(0, flashrom_layout_add_region(layout, 0x00027100, 0x0023efc0, "second region"));
+	printf("done\n");
+
+	printf("Asserting included regions do not overlap...\n");
+	assert_int_equal(0, included_regions_overlap(layout));
+	printf("done\n");
+
+	printf("Releasing layout...\n");
+	flashrom_layout_release(layout);
+	printf("done\n");
+}
diff --git a/tests/meson.build b/tests/meson.build
index 0bc0560..5776862 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -19,6 +19,7 @@
   'flashrom.c',
   'spi25.c',
   'init_shutdown.c',
+  'layout.c',
 ]

mocks = [
diff --git a/tests/tests.c b/tests/tests.c
index 592d896..78258b0 100644
--- a/tests/tests.c
+++ b/tests/tests.c
@@ -236,5 +236,12 @@
    };
    ret |= cmocka_run_group_tests_name("init_shutdown.c tests", init_shutdown_tests, NULL, NULL);

+	const struct CMUnitTest layout_tests[] = {
+		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),
+	};
+	ret |= cmocka_run_group_tests_name("layout.c tests", layout_tests, NULL, NULL);
+
    return ret;
 }
diff --git a/tests/tests.h b/tests/tests.h
index 2007695..eccc05f 100644
--- a/tests/tests.h
+++ b/tests/tests.h
@@ -47,4 +47,9 @@
 void ene_lpc_init_and_shutdown_test_success(void **state);
 void linux_spi_init_and_shutdown_test_success(void **state);

+/* layout.c */
+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);
+
 #endif /* TESTS_H */