# Copyright 2022 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

from autotest_lib.client.common_lib import error
from autotest_lib.client.common_lib.cros import kernel_utils
from autotest_lib.client.common_lib.cros import dev_server
from autotest_lib.server.cros.minios import minios_test


class nbr_EndToEndTest(minios_test.MiniOsTest):
    """Test network based recovery of a DUT."""
    version = 1

    def run_once(self,
                 job_repo_url=None,
                 n2m=True,
                 corrupt_partitions=False,
                 network_name='Ethernet',
                 network_password=None,
                 running_at_desk=False):
        """
        Validates the network based recovery flow.

        @param job_repo_url: A url pointing to the devserver where the autotest
            package for this build should be staged.
        @param n2m: Perform recovery from ToT to current stable version.
        @param corrupt_partitions: Corrupt the kernel and rootfs partition before
            attempting recovery.
        @param network_name: The name of the network to connect to for recovery.
        @param network_password: Optional password for the network.
        @param running_at_desk: indicates test is run locally from a workstation.

        """
        update_url = job_repo_url
        if n2m:
            build_name = self._get_latest_serving_stable_build()
            logging.debug('stable build name is %s', build_name)

            # Determine the URL for the stable build.
            autotest_devserver = dev_server.ImageServer.resolve(
                    build_name, self._host.hostname)
            update_url = autotest_devserver.get_update_url(build_name)

        logging.info('Performing recovery with update url: %s', update_url)
        payload_url = self.get_payload_for_nebraska(
                update_url, full_payload=True, public_bucket=running_at_desk)

        logging.info("Booting into MiniOS")
        self._boot_minios()

        # Install testing dependencies into MiniOS.
        logging.info("Successfully booted into MiniOS.")
        self._install_test_dependencies(public_bucket=running_at_desk)

        old_boot_id = self._host.get_boot_id()
        self._start_nebraska(payload_url=payload_url)
        cmd = [
                self._MINIOS_CLIENT_CMD, '--start_recovery',
                f'--network_name={network_name}', '--watch'
        ]
        if network_password:
            cmd += [f'--network_password={network_password}']
        logging.info(f'Performing network based recovery with cmd: {cmd}.')
        self._run(cmd)
        logging.info('Recovery complete. Grabbing logs.')

        # Generate host log.
        minios_hostlog = self._create_minios_hostlog()
        self._verify_reboot(old_boot_id)

        # NBR always recovers into partition A.
        kernel_utils.verify_boot_expectations(kernel_utils._KERNEL_A,
                                              host=self._host)
        # Verify the update engine events that happened during the recovery.
        self.verify_update_events(self._RECOVERY_VERSION, minios_hostlog)

        # Restore the stateful partition.
        logging.info('Verification complete. Restoring stateful.')
        self._restore_stateful(public_bucket=running_at_desk)