detachables: The Big Refactor

This patch shuffles around most of the detachable UI code to try to make
it more readable and maintainable. The goal is to get the business logic
out of the main UI loop functions as much as possible, and concentrate
the code handling each individual menu option in a single location.

This is a pure refactor and should not change behavior in any
(important) way. The adjustments to unit tests are only needed since the
old code displayed the same screen twice in certain circumstances, and
returning from the LANGUAGE menu to DEVELOPER selected the default
option Power Off, although other transitions to that screen select the
current default boot target.

BRANCH=None
BUG=None
TEST=make runtests, boot Scarlet and play with all screens.

Change-Id: Ibe05cbcb23c964d81f80de741bbd6f2231a2522d
Signed-off-by: Julius Werner <jwerner@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/888082
Reviewed-by: Randall Spangler <rspangler@chromium.org>
Reviewed-by: Furquan Shaikh <furquan@chromium.org>
Reviewed-by: Shelley Chen <shchen@chromium.org>

1 files changed, 61 insertions, 59 deletions

diff --git a/tests/vboot_detach_menu_tests.c b/tests/vboot_detach_menu_tests.c
index 0a20e192..5917e9cd 100644
--- a/tests/vboot_detach_menu_tests.c
+++ b/tests/vboot_detach_menu_tests.c
@@ -325,9 +325,7 @@ static void VbBootDevTest(void)
 		"  warning screen");
 	TEST_EQ(screens_displayed[2], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  tonorm screen");
-	TEST_EQ(screens_displayed[3], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
-		"  tonorm screen");
-	TEST_EQ(screens_displayed[4], VB_SCREEN_TO_NORM_CONFIRMED,
+	TEST_EQ(screens_displayed[3], VB_SCREEN_TO_NORM_CONFIRMED,
 		"  confirm screen");
 	TEST_EQ(vb2_nv_get(&ctx, VB2_NV_DISABLE_DEV_REQUEST), 1,
 		"  disable dev request");
@@ -374,13 +372,11 @@ static void VbBootDevTest(void)
 	TEST_EQ(VbBootDeveloperMenu(&ctx), 1002,
 		"Can't tonorm gbb-dev");
 	TEST_EQ(screens_displayed[0], VB_SCREEN_DEVELOPER_WARNING_MENU,
-		"  warning screen");
+		"  warning screen: power off");
 	TEST_EQ(screens_displayed[1], VB_SCREEN_DEVELOPER_WARNING_MENU,
-		"  tonorm screen");
+		"  wanring screen: enable verification");
 	TEST_EQ(screens_displayed[2], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
-		"  warning screen");
-	TEST_EQ(screens_displayed[3], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
-		"  warning screen");
+		"  tonorm screen: confirm");
 
 	/* Shutdown requested at tonorm screen */
 	ResetMocks();
@@ -493,8 +489,6 @@ static void VbBootDevTest(void)
 		"  power button");
 	TEST_EQ(screens_displayed[4], VB_SCREEN_DEVELOPER_MENU,
 		"  dev menu: USB boot");
-	TEST_EQ(screens_displayed[5], VB_SCREEN_DEVELOPER_MENU,
-		"  dev menu: USB boot");
 
 	/* If no USB, eventually times out and tries fixed disk */
 	ResetMocks();
@@ -509,15 +503,17 @@ static void VbBootDevTest(void)
 	/* If dev mode is disabled, goes to TONORM screen repeatedly */
 	ResetMocks();
 	VbApiKernelGetFwmp()->flags |= FWMP_DEV_DISABLE_BOOT;
-	mock_keypress[0] = '\x1b';  /* Just causes TONORM again */
+	mock_keypress[0] = 0x04;  /* Just stays on TONORM and flashes screen */
 	mock_keypress[1] = '\r';
 	TEST_EQ(VbBootDeveloperMenu(&ctx), VBERROR_REBOOT_REQUIRED,
 		"FWMP dev disabled");
 	TEST_EQ(screens_displayed[0], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  tonorm screen");
-	TEST_EQ(screens_displayed[1], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[1], VB_SCREEN_BLANK,
+		"  screen flash");
+	TEST_EQ(screens_displayed[2], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  tonorm screen");
-	TEST_EQ(screens_displayed[2], VB_SCREEN_TO_NORM_CONFIRMED,
+	TEST_EQ(screens_displayed[3], VB_SCREEN_TO_NORM_CONFIRMED,
 		"  confirm screen");
 	TEST_EQ(vb2_nv_get(&ctx, VB2_NV_DISABLE_DEV_REQUEST), 1,
 		"  disable dev request");
@@ -827,76 +823,82 @@ static void VbTestLanguageMenu(void)
 
 	/* Navigate to all language menus from developer menu */
 	ResetMocks();
+	i = 0;
 	shared->flags = VBSD_BOOT_DEV_SWITCH_ON;
-	mock_keypress[0] = 0x63; // volume down: language
-	mock_keypress[1] = 0x90; // power button: select language
-	mock_keypress[2] = 0x90; // power button: select current language
-	mock_keypress[3] = 0x62; // volume up: enable root verification
-	mock_keypress[4] = 0x90; // power button: select enable root verification
-	mock_keypress[5] = 0x63; // volume down: cancel
-	mock_keypress[6] = 0x63; // volume down: power off
-	mock_keypress[7] = 0x63; // volume down: language
-	mock_keypress[8] = 0x90; // power button: select language
-	mock_keypress[9] = 0x90; // power button: select current language
-	mock_keypress[10] = 0x63; // volume down: cancel
-	mock_keypress[11] = 0x90; // power button: return to dev warning screen
-	mock_keypress[12] = 0x62; // volume up: enable root verification
-	mock_keypress[13] = 0x62; // volume up: show debug info
-	mock_keypress[14] = 0x62; // volume up: developer options
-	mock_keypress[15] = 0x90; // power button: select developer options
-	mock_keypress[16] = 0x63; // volume down: cancel
-	mock_keypress[17] = 0x63; // volume down: power off
-	mock_keypress[18] = 0x63; // volume down: language
-	mock_keypress[19] = 0x90; // power button: select language
-	mock_keypress[20] = 0x90; // power button: select current language
-	mock_keypress[21] = 0x90; // power button: select power off
+	mock_keypress[i++] = 0x63; // volume down: language
+	mock_keypress[i++] = 0x90; // power button: select language
+	mock_keypress[i++] = 0x90; // power button: select current language
+	mock_keypress[i++] = 0x62; // volume up: enable root verification
+	mock_keypress[i++] = 0x90; // power button: select enable root verification
+	mock_keypress[i++] = 0x63; // volume down: cancel
+	mock_keypress[i++] = 0x63; // volume down: power off
+	mock_keypress[i++] = 0x63; // volume down: language
+	mock_keypress[i++] = 0x90; // power button: select language
+	mock_keypress[i++] = 0x90; // power button: select current language
+	mock_keypress[i++] = 0x63; // volume down: cancel
+	mock_keypress[i++] = 0x90; // power button: return to dev warning screen
+	mock_keypress[i++] = 0x62; // volume up: enable root verification
+	mock_keypress[i++] = 0x62; // volume up: show debug info
+	mock_keypress[i++] = 0x62; // volume up: developer options
+	mock_keypress[i++] = 0x90; // power button: select developer options
+	mock_keypress[i++] = 0x63; // volume down: cancel
+	mock_keypress[i++] = 0x63; // volume down: power off
+	mock_keypress[i++] = 0x63; // volume down: language
+	mock_keypress[i++] = 0x90; // power button: select language
+	mock_keypress[i++] = 0x90; // power button: select current language
+	mock_keypress[i++] = 0x63; // volume down: cancel
+	mock_keypress[i++] = 0x63; // volume down: power off
+	mock_keypress[i++] = 0x90; // power button: select power off
+	i = 0;
 	TEST_EQ(VbBootDeveloperMenu(&ctx), VBERROR_SHUTDOWN_REQUESTED,
 		" scroll through all language menus in developer options");
-	TEST_EQ(screens_displayed[0], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: power off");
-	TEST_EQ(screens_displayed[1], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: language");
-	TEST_EQ(screens_displayed[2], VB_SCREEN_LANGUAGES_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_LANGUAGES_MENU,
 		"  language menu: select current language");
-	TEST_EQ(screens_displayed[3], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: cancel ");
-	TEST_EQ(screens_displayed[4], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: enable root verification");
-	TEST_EQ(screens_displayed[5], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: cancel");
-	TEST_EQ(screens_displayed[6], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: power off");
-	TEST_EQ(screens_displayed[7], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: language");
-	TEST_EQ(screens_displayed[8], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: language");
-	TEST_EQ(screens_displayed[9], VB_SCREEN_LANGUAGES_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_LANGUAGES_MENU,
 		"  language menu: select current language");
-	TEST_EQ(screens_displayed[10], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: confirm enabling os verification");
-	TEST_EQ(screens_displayed[11], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_TO_NORM_MENU,
 		"  to norm screen: cancel");
-	TEST_EQ(screens_displayed[12], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: enable root verification");
-	TEST_EQ(screens_displayed[13], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: show debug info");
-	TEST_EQ(screens_displayed[14], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  warning screen: developer options");
-	TEST_EQ(screens_displayed[15], VB_SCREEN_DEVELOPER_WARNING_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_WARNING_MENU,
 		"  select developer options");
-	TEST_EQ(screens_displayed[16], VB_SCREEN_DEVELOPER_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
 		"  developer menu: boot developer image");
-	TEST_EQ(screens_displayed[17], VB_SCREEN_DEVELOPER_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
 		"  developer menu: cancel");
-	TEST_EQ(screens_displayed[18], VB_SCREEN_DEVELOPER_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
 		"  developer menu: power off");
-	TEST_EQ(screens_displayed[19], VB_SCREEN_DEVELOPER_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
 		"  developer menu: language");
-	TEST_EQ(screens_displayed[20], VB_SCREEN_LANGUAGES_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_LANGUAGES_MENU,
 		"  language menu");
-	TEST_EQ(screens_displayed[21], VB_SCREEN_DEVELOPER_MENU,
-		"  select current language");
-	TEST_EQ(screens_displayed[22], VB_SCREEN_DEVELOPER_MENU,
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
+		"  developer menu: boot from disk");
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
+		"  developer menu: cancel");
+	TEST_EQ(screens_displayed[i++], VB_SCREEN_DEVELOPER_MENU,
 		"  developer menu: power off");
 
   	printf("...done.\n");