# Copyright (c) 2011 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import logging
import time

from autotest_lib.client.common_lib import error
from autotest_lib.server.cros.faft.firmware_test import FirmwareTest


class firmware_FwScreenCloseLid(FirmwareTest):
    """
    Servo based lid close triggered shutdown test during firmware screens.

    This test requires a USB disk plugged-in, which contains a Chrome OS test
    image (built by "build_image --test"). On runtime, this test triggers
    firmware screens (developer, remove, insert, yuck, to_norm screens),
    and then closes the lid in order to power the machine down.
    """
    version = 1

    SHORT_SHUTDOWN_CONFIRMATION_PERIOD = 0.1

    def wait_fw_screen_and_close_lid(self):
        """Wait for firmware warning screen and close lid."""
        time.sleep(self.faft_config.firmware_screen)
        self.servo.lid_close()

    def wait_longer_fw_screen_and_close_lid(self):
        """Wait for firmware screen without timeout and close lid."""
        time.sleep(self.faft_config.firmware_screen)
        self.wait_fw_screen_and_close_lid()

    def wait_second_screen_and_close_lid(self):
        """Wait and trigger TO_NORM or RECOVERY INSERT screen and close lid."""
        self.switcher.trigger_dev_to_rec()
        self.wait_longer_fw_screen_and_close_lid()

    def wait_yuck_screen_and_close_lid(self):
        """Wait and trigger yuck screen and clod lid."""
        # Insert a corrupted USB stick. A yuck screen is expected.
        self.servo.switch_usbkey('dut')
        time.sleep(self.faft_config.usb_plug)
        self.wait_longer_fw_screen_and_close_lid()

    def initialize(self, host, cmdline_args):
        """Initialize the test"""
        super(firmware_FwScreenCloseLid, self).initialize(host, cmdline_args)
        if self.faft_config.has_lid:
            self.switcher.setup_mode('dev')
            self.setup_usbkey(True, host=True)
            usb_dev = self.servo.probe_host_usb_dev()
            # Corrupt the kernel of USB stick. It is needed for triggering a
            # yuck screen later.
            self.corrupt_usb_kernel(usb_dev)

    def cleanup(self):
        """Cleanup the test"""
        try:
            if self.faft_config.has_lid:
                self.servo.switch_usbkey('host')
                usb_dev = self.servo.probe_host_usb_dev()
                # Restore kernel of USB stick which is corrupted on setup phase.
                self.restore_usb_kernel(usb_dev)
        except Exception as e:
            logging.error("Caught exception: %s", str(e))
        super(firmware_FwScreenCloseLid, self).cleanup()

    def run_once(self):
        """Main test logic"""
        if not self.faft_config.has_lid:
            logging.info('This test does nothing on devices without lid.')
            return

        # Some platforms may not turn on with just lid open
        power_action = False
        if not self.faft_config.lid_wake_from_power_off:
            power_action = True

        if self.faft_config.mode_switcher_type not in (
                'keyboard_dev_switcher', 'tablet_detachable_switcher'):
            raise error.TestNAError("This test is only valid on devices with "
                                    "screens.")

        if self.faft_config.chrome_ec and not self.check_ec_capability(['lid'
                                                                        ]):
            raise error.TestNAError(
                    "TEST IT MANUALLY! ChromeEC can't control "
                    "lid on the device %s" % self.faft_config.platform)

        logging.info("Expected dev mode and reboot. "
                     "When the next DEVELOPER SCREEN shown, close lid "
                     "to make DUT shutdown.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '1',
                'mainfw_type': 'developer',
        }))
        self.switcher.simple_reboot()
        self.run_shutdown_process(
                self.wait_fw_screen_and_close_lid,
                pre_power_action=self.servo.lid_open,
                run_power_action=power_action,
                post_power_action=self.switcher.bypass_dev_mode)
        self.switcher.wait_for_client()

        logging.info("Reboot. When the developer screen shown, press "
                     "enter key to trigger either TO_NORM screen (new) or "
                     "RECOVERY INSERT screen (old). Then close lid to "
                     "make DUT shutdown.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '1',
                'mainfw_type': 'developer',
        }))
        self.switcher.simple_reboot()
        self.run_shutdown_process(
                self.wait_second_screen_and_close_lid,
                pre_power_action=self.servo.lid_open,
                run_power_action=power_action,
                post_power_action=self.switcher.bypass_dev_mode,
                shutdown_timeout=self.SHORT_SHUTDOWN_CONFIRMATION_PERIOD)
        self.switcher.wait_for_client()

        logging.info("Request recovery boot. When the RECOVERY INSERT "
                     "screen shows, close lid to make DUT shutdown.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '1',
                'mainfw_type': 'developer',
        }))
        self.faft_client.System.RequestRecoveryBoot()
        self.switcher.simple_reboot()
        self.run_shutdown_process(
                self.wait_longer_fw_screen_and_close_lid,
                pre_power_action=self.servo.lid_open,
                run_power_action=power_action,
                post_power_action=self.switcher.bypass_dev_mode,
                shutdown_timeout=self.SHORT_SHUTDOWN_CONFIRMATION_PERIOD)
        self.switcher.wait_for_client()

        logging.info("Request recovery boot again. When the recovery "
                     "insert screen shows, insert a corrupted USB and trigger "
                     "a YUCK SCREEN. Then close lid to make DUT shutdown.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '1',
                'mainfw_type': 'developer',
        }))
        self.faft_client.System.RequestRecoveryBoot()
        self.switcher.simple_reboot()
        self.run_shutdown_process(
                self.wait_yuck_screen_and_close_lid,
                pre_power_action=self.servo.lid_open,
                run_power_action=power_action,
                post_power_action=self.switcher.bypass_dev_mode,
                shutdown_timeout=self.SHORT_SHUTDOWN_CONFIRMATION_PERIOD)
        self.switcher.wait_for_client()

        logging.info("Switch back to normal mode.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '1',
                'mainfw_type': 'developer',
        }))
        self.switcher.reboot_to_mode(to_mode='normal')

        logging.info("Expected normal mode and request recovery boot. "
                     "Because an USB stick is inserted, a RECOVERY REMOVE "
                     "screen shows. Close lid to make DUT shutdown.")
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '0',
                'mainfw_type': 'normal',
        }))
        self.faft_client.System.RequestRecoveryBoot()
        self.switcher.simple_reboot()
        self.run_shutdown_process(
                self.wait_longer_fw_screen_and_close_lid,
                pre_power_action=self.servo.lid_open,
                run_power_action=power_action,
                shutdown_timeout=self.SHORT_SHUTDOWN_CONFIRMATION_PERIOD)
        self.switcher.wait_for_client()
        self.check_state((self.checkers.crossystem_checker, {
                'devsw_boot': '0',
                'mainfw_type': 'normal',
        }))