[flashrom-gerrit] Change in flashrom[master]: tests: Extract setup and teardown for chip tests

[Anastasia Klimchuk (Code Review)]

Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/57436 )

Change subject: tests: Extract setup and teardown for chip tests
......................................................................

tests: Extract setup and teardown for chip tests

Steps to setup and teardown for a chip test are repeated for every
test, so they can be extracted into their own functions.

BUG=b:181803212
TEST=builds and ninja test

Change-Id: If59315646f06344664df08b145866d9ce846d751
Signed-off-by: Anastasia Klimchuk 
---
M tests/chip.c
1 file changed, 52 insertions(+), 55 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/36/57436/1

diff --git a/tests/chip.c b/tests/chip.c
index 0cb05ad..cef8d42 100644
--- a/tests/chip.c
+++ b/tests/chip.c
@@ -86,6 +86,50 @@
    return 0;
 }

+static void reset_global_chip_state()
+{
+	g_chip_state.unlock_calls = 0;
+}
+
+static void setup_for_chip(struct flashrom_flashctx *flash, struct flashrom_layout **layout,
+		struct flashchip *chip, const char *programmer_param)
+{
+	flash->chip = chip;
+
+	reset_global_chip_state();
+
+	printf("Creating layout with one included region... ");
+	assert_int_equal(0, flashrom_layout_new(layout));
+	/* One region which covers total size of chip. */
+	assert_int_equal(0, flashrom_layout_add_region(*layout, 0, chip->total_size * 1024 - 1, "region"));
+	assert_int_equal(0, flashrom_layout_include_region(*layout, "region"));
+
+	flashrom_layout_set(flash, *layout);
+	printf("done\n");
+
+	/*
+	 * We need some programmer (any), and dummy is a very good one,
+	 * because it doesn't need any mocking. So no extra complexity
+	 * from a programmer side, and test can focus on working with the chip.
+	 */
+	printf("Dummyflasher initialising with param="%s"... ", programmer_param);
+	assert_int_equal(0, programmer_init(&programmer_dummy, programmer_param));
+	/* Assignment below normally happens while probing, but this test is not probing. */
+	flash->mst = &registered_masters[0];
+	printf("done\n");
+}
+
+static void teardown(struct flashrom_layout **layout)
+{
+	printf("Dummyflasher shutdown... ");
+	assert_int_equal(0, programmer_shutdown());
+	printf("done\n");
+
+	printf("Releasing layout... ");
+	flashrom_layout_release(*layout);
+	printf("done\n");
+}
+
 void erase_chip_test_success(void **state)
 {
    (void) state; /* unused */
@@ -108,43 +152,17 @@
    		.block_erase = block_erase_chip,
    	 }},
    };
-	struct flashrom_flashctx flash = {
-		.chip = &chip,
-	};
-
+	struct flashrom_flashctx flash = { 0 };
    struct flashrom_layout *layout;
+	const char *param = ""; /* Default values for all params. */

-	printf("Creating layout with one included region... ");
-	assert_int_equal(0, flashrom_layout_new(&layout));
-	/* One region which covers total size of chip. */
-	assert_int_equal(0, flashrom_layout_add_region(layout, 0, chip.total_size * 1024 - 1, "region"));
-	assert_int_equal(0, flashrom_layout_include_region(layout, "region"));
-
-	flashrom_layout_set(&flash, layout);
-	printf("done\n");
-
-	/*
-	 * We need some programmer (any), and dummy is a very good one,
-	 * because it doesn't need any mocking. So no extra complexity
-	 * from a programmer side, and test can focus on the code which
-	 * erases the chip.
-	 */
-	const char *param = ""; /* default values for all params */
-	printf("Dummyflasher initialising... ");
-	assert_int_equal(0, programmer_init(&programmer_dummy, param));
-	printf("done\n");
+	setup_for_chip(&flash, &layout, &chip, param);

printf("Erase chip operation started.\n");
    assert_int_equal(0, do_erase(&flash));
    printf("Erase chip operation done.\n");

-	printf("Dummyflasher shutdown... ");
-	assert_int_equal(0, programmer_shutdown());
-	printf("done\n");
-
-	printf("Releasing layout... ");
-	flashrom_layout_release(layout);
-	printf("done\n");
+	teardown(&layout);
 }

void erase_chip_with_dummyflasher_test_success(void **state)
@@ -184,43 +202,22 @@
    		}
    	},
    };
-	struct flashrom_flashctx flash = {
-		.chip = &chip,
-	};

+	struct flashrom_flashctx flash = { 0 };
    struct flashrom_layout *layout;
-
-	printf("Creating layout with one included region... ");
-	assert_int_equal(0, flashrom_layout_new(&layout));
-	/* One region which covers total size of chip. */
-	assert_int_equal(0, flashrom_layout_add_region(layout, 0, chip.total_size * 1024 - 1, "region"));
-	assert_int_equal(0, flashrom_layout_include_region(layout, "region"));
-
-	flashrom_layout_set(&flash, layout);
-	printf("done\n");
-
    /*
     * Dummyflasher is capable to emulate a chip, so we ask it to do this.
     * Nothing to mock, dummy is taking care of this already.
     */
    char *param_dup = strdup("bus=spi,emulate=W25Q128FV");
-	printf("Dummyflasher initialising to emulate W25Q128FV... ");
-	assert_int_equal(0, programmer_init(&programmer_dummy, param_dup));
-	/* Assignment below normally happens while probing, but this test is not probing. */
-	flash.mst = &registered_masters[0];
-	printf("done\n");
+
+	setup_for_chip(&flash, &layout, &chip, param_dup);

printf("Erase chip operation started.\n");
    assert_int_equal(0, do_erase(&flash));
    printf("Erase chip operation done.\n");

-	printf("Dummyflasher shutdown... ");
-	assert_int_equal(0, programmer_shutdown());
-	printf("done\n");
-
-	printf("Releasing layout... ");
-	flashrom_layout_release(layout);
-	printf("done\n");
+	teardown(&layout);

free(param_dup);
 }