1# Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5import logging
6
7from autotest_lib.server.cros import vboot_constants as vboot
8from autotest_lib.server.cros.faft.firmware_test import FirmwareTest
9
10
11class firmware_RollbackKernel(FirmwareTest):
12    """
13    Servo based kernel rollback test.
14
15    This test requires a USB disk plugged-in, which contains a ChromeOS test
16    image (built by "build_image --test"). In normal mode, this test rollbacks
17    kernel A and results kernel B boot. It then rollbacks kernel B and
18    results recovery boot. In developer mode, the firmware ignores kernel
19    rollback check so it remains unchanged.
20    """
21    version = 1
22    NEEDS_SERVO_USB = True
23
24    def ensure_kernel_on_non_recovery(self, part):
25        """Ensure the requested kernel part on normal/dev boot path.
26
27        If not, it may be a test failure during step 2 or 3, try to recover to
28        the requested kernel on normal/dev mode by recovering the whole OS
29        and rebooting.
30
31        @param part: The expected kernel partition number.
32        """
33        if not self.check_root_part_on_non_recovery(part):
34            logging.info('Recover the disk OS by running chromeos-install...')
35            self.faft_client.system.run_shell_command('chromeos-install --yes')
36            self.switcher.mode_aware_reboot()
37
38    def initialize(self, host, cmdline_args, dev_mode=False):
39        """Initialize the test"""
40        super(firmware_RollbackKernel, self).initialize(host, cmdline_args)
41        self.backup_kernel()
42        self.backup_cgpt_attributes()
43        self.switcher.setup_mode('dev' if dev_mode else 'normal')
44        self.setup_usbkey(usbkey=True, host=False)
45        self.setup_kernel('a')
46
47    def cleanup(self):
48        """Cleanup the test"""
49        try:
50            self.ensure_kernel_on_non_recovery('a')
51            self.restore_cgpt_attributes()
52            self.restore_kernel()
53        except Exception as e:
54            logging.error("Caught exception: %s", str(e))
55        super(firmware_RollbackKernel, self).cleanup()
56
57    def run_once(self, dev_mode=False):
58        """Main test logic"""
59        recovery_reason = (vboot.RECOVERY_REASON['DEP_RW_NO_DISK'],
60                           vboot.RECOVERY_REASON['RW_NO_KERNEL'],
61                           vboot.RECOVERY_REASON['RW_INVALID_OS'])
62
63        if dev_mode:
64            logging.info("Rollbacks kernel A.")
65            self.check_state((self.check_root_part_on_non_recovery, 'a'))
66            self.faft_client.kernel.move_version_backward('a')
67            self.switcher.mode_aware_reboot()
68
69            logging.info("Still kernel A boot since dev_mode ignores "
70                         "kernel rollback check.")
71            self.check_state((self.check_root_part_on_non_recovery, 'a'))
72            self.faft_client.kernel.move_version_forward('a')
73        else:
74            logging.info("Rollbacks kernel A.")
75            self.check_state((self.check_root_part_on_non_recovery, 'a'))
76            self.faft_client.kernel.move_version_backward('a')
77            self.switcher.mode_aware_reboot()
78
79            logging.info("Expected kernel B boot and rollbacks kernel B.")
80            self.check_state((self.check_root_part_on_non_recovery, 'b'))
81            self.faft_client.kernel.move_version_backward('b')
82            self.switcher.mode_aware_reboot(wait_for_dut_up=False)
83            self.switcher.bypass_rec_mode()
84            self.switcher.wait_for_client()
85
86            logging.info("Expected recovery boot and restores the OS image.")
87            self.check_state((self.checkers.crossystem_checker, {
88                                  'mainfw_type': 'recovery',
89                                  'recovery_reason': recovery_reason,
90                                  }))
91            self.faft_client.kernel.move_version_forward('a')
92            self.faft_client.kernel.move_version_forward('b')
93            self.switcher.mode_aware_reboot()
94
95            logging.info("Expected kernel A boot and done.")
96            self.check_state((self.check_root_part_on_non_recovery, 'a'))
97