| # Copyright (c) 2012 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 httplib |
| import logging |
| import multiprocessing |
| import os |
| import re |
| import urlparse |
| |
| from autotest_lib.client.common_lib import error, global_config |
| |
| # Local stateful update path is relative to the CrOS source directory. |
| LOCAL_STATEFUL_UPDATE_PATH = 'src/platform/dev/stateful_update' |
| LOCAL_CHROOT_STATEFUL_UPDATE_PATH = '/usr/bin/stateful_update' |
| REMOTE_STATEUL_UPDATE_PATH = '/usr/local/bin/stateful_update' |
| STATEFUL_UPDATE = '/tmp/stateful_update' |
| UPDATER_BIN = '/usr/bin/update_engine_client' |
| UPDATER_IDLE = 'UPDATE_STATUS_IDLE' |
| UPDATER_NEED_REBOOT = 'UPDATE_STATUS_UPDATED_NEED_REBOOT' |
| UPDATED_MARKER = '/var/run/update_engine_autoupdate_completed' |
| UPDATER_LOGS = '/var/log/messages /var/log/update_engine' |
| |
| |
| class ChromiumOSError(error.InstallError): |
| """Generic error for ChromiumOS-specific exceptions.""" |
| pass |
| |
| |
| class RootFSUpdateError(ChromiumOSError): |
| """Raised when the RootFS fails to update.""" |
| pass |
| |
| |
| class StatefulUpdateError(ChromiumOSError): |
| """Raised when the stateful partition fails to update.""" |
| pass |
| |
| |
| def url_to_version(update_url): |
| """Return the version based on update_url. |
| |
| @param update_url: url to the image to update to. |
| |
| """ |
| # The Chrome OS version is generally the last element in the URL. The only |
| # exception is delta update URLs, which are rooted under the version; e.g., |
| # http://.../update/.../0.14.755.0/au/0.14.754.0. In this case we want to |
| # strip off the au section of the path before reading the version. |
| return re.sub( |
| '/au/.*', '', urlparse.urlparse(update_url).path).split('/')[-1] |
| |
| |
| def url_to_image_name(update_url): |
| """Return the image name based on update_url. |
| |
| From a URL like: |
| http://172.22.50.205:8082/update/lumpy-release/R27-3837.0.0 |
| return lumpy-release/R27-3837.0.0 |
| |
| @param update_url: url to the image to update to. |
| @returns a string representing the image name in the update_url. |
| |
| """ |
| return '/'.join(urlparse.urlparse(update_url).path.split('/')[-2:]) |
| |
| |
| class ChromiumOSUpdater(): |
| """Helper class used to update DUT with image of desired version.""" |
| KERNEL_A = {'name': 'KERN-A', 'kernel': 2, 'root': 3} |
| KERNEL_B = {'name': 'KERN-B', 'kernel': 4, 'root': 5} |
| |
| |
| def __init__(self, update_url, host=None, local_devserver=False): |
| self.host = host |
| self.update_url = update_url |
| self._update_error_queue = multiprocessing.Queue(2) |
| self.local_devserver = local_devserver |
| if not local_devserver: |
| self.update_version = url_to_version(update_url) |
| else: |
| self.update_version = None |
| |
| def check_update_status(self): |
| """Return current status from update-engine.""" |
| update_status = self._run( |
| '%s -status 2>&1 | grep CURRENT_OP' % UPDATER_BIN) |
| return update_status.stdout.strip().split('=')[-1] |
| |
| |
| def reset_update_engine(self): |
| """Restarts the update-engine service.""" |
| self._run('rm -f %s' % UPDATED_MARKER) |
| try: |
| self._run('initctl stop update-engine') |
| except error.AutoservRunError: |
| logging.warn('Stopping update-engine service failed. Already dead?') |
| self._run('initctl start update-engine') |
| |
| if self.check_update_status() != UPDATER_IDLE: |
| raise ChromiumOSError('%s is not in an installable state' % |
| self.host.hostname) |
| |
| |
| def _run(self, cmd, *args, **kwargs): |
| """Abbreviated form of self.host.run(...)""" |
| return self.host.run(cmd, *args, **kwargs) |
| |
| |
| def rootdev(self, options=''): |
| """Returns the stripped output of rootdev <options>. |
| |
| @param options: options to run rootdev. |
| |
| """ |
| return self._run('rootdev %s' % options).stdout.strip() |
| |
| |
| def get_kernel_state(self): |
| """Returns the (<active>, <inactive>) kernel state as a pair.""" |
| active_root = int(re.findall('\d+\Z', self.rootdev('-s'))[0]) |
| if active_root == self.KERNEL_A['root']: |
| return self.KERNEL_A, self.KERNEL_B |
| elif active_root == self.KERNEL_B['root']: |
| return self.KERNEL_B, self.KERNEL_A |
| else: |
| raise ChromiumOSError('Encountered unknown root partition: %s' % |
| active_root) |
| |
| |
| def _cgpt(self, flag, kernel, dev='$(rootdev -s -d)'): |
| """Return numeric cgpt value for the specified flag, kernel, device. """ |
| return int(self._run('cgpt show -n -i %d %s %s' % ( |
| kernel['kernel'], flag, dev)).stdout.strip()) |
| |
| |
| def get_kernel_priority(self, kernel): |
| """Return numeric priority for the specified kernel. |
| |
| @param kernel: information of the given kernel, KERNEL_A or KERNEL_B. |
| |
| """ |
| return self._cgpt('-P', kernel) |
| |
| |
| def get_kernel_success(self, kernel): |
| """Return boolean success flag for the specified kernel. |
| |
| @param kernel: information of the given kernel, KERNEL_A or KERNEL_B. |
| |
| """ |
| return self._cgpt('-S', kernel) != 0 |
| |
| |
| def get_kernel_tries(self, kernel): |
| """Return tries count for the specified kernel. |
| |
| @param kernel: information of the given kernel, KERNEL_A or KERNEL_B. |
| |
| """ |
| return self._cgpt('-T', kernel) |
| |
| |
| def get_stateful_update_script(self): |
| """Returns the path to the stateful update script on the target.""" |
| # We attempt to load the local stateful update path in 3 different |
| # ways. First we use the location specified in the autotest global |
| # config. If this doesn't exist, we attempt to use the Chromium OS |
| # Chroot path to the installed script. If all else fails, we use the |
| # stateful update script on the host. |
| stateful_update_path = os.path.join( |
| global_config.global_config.get_config_value( |
| 'CROS', 'source_tree', default=''), |
| LOCAL_STATEFUL_UPDATE_PATH) |
| |
| if not os.path.exists(stateful_update_path): |
| logging.warn('Could not find Chrome OS source location for ' |
| 'stateful_update script at %s, falling back to chroot ' |
| 'copy.', stateful_update_path) |
| stateful_update_path = LOCAL_CHROOT_STATEFUL_UPDATE_PATH |
| |
| if not os.path.exists(stateful_update_path): |
| logging.warn('Could not chroot stateful_update script, falling ' |
| 'back on client copy.') |
| statefuldev_script = REMOTE_STATEUL_UPDATE_PATH |
| else: |
| self.host.send_file( |
| stateful_update_path, STATEFUL_UPDATE, delete_dest=True) |
| statefuldev_script = STATEFUL_UPDATE |
| |
| return statefuldev_script |
| |
| |
| def reset_stateful_partition(self): |
| """Clear any pending stateful update request.""" |
| statefuldev_cmd = [self.get_stateful_update_script()] |
| statefuldev_cmd += ['--stateful_change=reset', '2>&1'] |
| # This shouldn't take any time at all. |
| self._run(' '.join(statefuldev_cmd), timeout=10) |
| |
| |
| def revert_boot_partition(self): |
| """Revert the boot partition.""" |
| part = self.rootdev('-s') |
| logging.warn('Reverting update; Boot partition will be %s', part) |
| return self._run('/postinst %s 2>&1' % part) |
| |
| |
| def trigger_update(self): |
| """Triggers a background update on a test image. |
| |
| @raise RootFSUpdateError if anything went wrong. |
| |
| """ |
| autoupdate_cmd = '%s --check_for_update --omaha_url=%s' % ( |
| UPDATER_BIN, self.update_url) |
| logging.info('triggering update via: %s', autoupdate_cmd) |
| try: |
| # This should return immediately, hence the short timeout. |
| self._run(autoupdate_cmd, timeout=10) |
| except error.AutoservRunError, e: |
| raise RootFSUpdateError('update triggering failed on %s: %s' % |
| (self.host.hostname, str(e))) |
| |
| |
| def _update_root(self): |
| logging.info('Updating root partition...') |
| |
| # Run update_engine using the specified URL. |
| try: |
| autoupdate_cmd = '%s --update --omaha_url=%s 2>&1' % ( |
| UPDATER_BIN, self.update_url) |
| self._run(autoupdate_cmd, timeout=900) |
| except error.AutoservRunError: |
| update_error = RootFSUpdateError('update-engine failed on %s' % |
| self.host.hostname) |
| self._update_error_queue.put(update_error) |
| raise update_error |
| |
| # Check that the installer completed as expected. |
| status = self.check_update_status() |
| if status != UPDATER_NEED_REBOOT: |
| update_error = RootFSUpdateError('update-engine error on %s: %s' % |
| (self.host.hostname, status)) |
| self._update_error_queue.put(update_error) |
| raise update_error |
| |
| |
| def _update_stateful(self): |
| logging.info('Updating stateful partition...') |
| # For production devservers we create a static tree of payloads rooted |
| # at archive. |
| if not self.local_devserver: |
| statefuldev_url = self.update_url.replace('update', |
| 'static/archive') |
| else: |
| statefuldev_url = self.update_url.replace('update', |
| 'static') |
| |
| # Attempt stateful partition update; this must succeed so that the newly |
| # installed host is testable after update. |
| statefuldev_cmd = [self.get_stateful_update_script()] |
| statefuldev_cmd += [statefuldev_url, '--stateful_change=clean', '2>&1'] |
| try: |
| self._run(' '.join(statefuldev_cmd), timeout=600) |
| except error.AutoservRunError: |
| update_error = StatefulUpdateError('stateful_update failed on %s' % |
| self.host.hostname) |
| self._update_error_queue.put(update_error) |
| raise update_error |
| |
| |
| def run_update(self, force_update, update_root=True): |
| """Update the DUT with image of specific version. |
| |
| @param force_update: True to update DUT even if it's running the same |
| version already. |
| @param update_root: True to force a kernel update. If it's False and |
| force_update is True, stateful update will be used to clean up |
| the DUT. |
| |
| """ |
| booted_version = self.get_build_id() |
| if (self.check_version() and not force_update): |
| logging.info('System is already up to date. Skipping update.') |
| return False |
| |
| if self.update_version: |
| logging.info('Updating from version %s to %s.', |
| booted_version, self.update_version) |
| |
| # Check that Dev Server is accepting connections (from autoserv's host). |
| # If we can't talk to it, the machine host probably can't either. |
| auserver_host = urlparse.urlparse(self.update_url)[1] |
| try: |
| httplib.HTTPConnection(auserver_host).connect() |
| except IOError: |
| raise ChromiumOSError( |
| 'Update server at %s not available' % auserver_host) |
| |
| logging.info('Installing from %s to %s', self.update_url, |
| self.host.hostname) |
| |
| # Reset update state. |
| self.reset_update_engine() |
| self.reset_stateful_partition() |
| |
| try: |
| updaters = [ |
| multiprocessing.process.Process(target=self._update_root), |
| multiprocessing.process.Process(target=self._update_stateful) |
| ] |
| if not update_root: |
| logging.info('Root update is skipped.') |
| updaters = updaters[1:] |
| |
| # Run the updaters in parallel. |
| for updater in updaters: updater.start() |
| for updater in updaters: updater.join() |
| |
| # Re-raise the first error that occurred. |
| if not self._update_error_queue.empty(): |
| update_error = self._update_error_queue.get() |
| self.revert_boot_partition() |
| self.reset_stateful_partition() |
| raise update_error |
| |
| logging.info('Update complete.') |
| return True |
| except: |
| # Collect update engine logs in the event of failure. |
| if self.host.job: |
| logging.info('Collecting update engine logs...') |
| self.host.get_file( |
| UPDATER_LOGS, self.host.job.sysinfo.sysinfodir, |
| preserve_perm=False) |
| raise |
| |
| |
| def check_version(self): |
| """Check the image running in DUT has the desired version. |
| |
| @returns: True if the DUT's image version matches the version that |
| the autoupdater tries to update to. |
| |
| """ |
| booted_version = self.get_build_id() |
| return (self.update_version and |
| self.update_version.endswith(booted_version)) |
| |
| |
| def check_version_to_confirm_install(self): |
| """Check image running in DUT has the desired version to be installed. |
| |
| The method should not be used to check if DUT needs to have a full |
| reimage. Only use it to confirm a image is installed. |
| |
| For build from trybot, version retrieved from lsb-release looks like |
| 3888.0.2013_03_21_1340. However, for trybot build, self.update_version |
| looks like 'R27-3888.0.0-b711', which does not have the date string and |
| it is complicated to get the date string from update url. |
| Therefore, to make the version verification easiser, the date string is |
| ignored in version retrieved from lsb-release. |
| |
| When we are checking if a DUT needs to do a full install, we should NOT |
| use this method to check if the DUT is running the same version, since |
| it may return false positive. For example, if the DUT is running a |
| trybot build with version |3888.0.2013_03_21_1340| and the version to |
| be installed is an official build with version of 3888.0.0, |
| check_version method returns False which is expected. However, |
| check_version_to_confirm_install returns True, which will lead to |
| reimage job fails to install correct image in the DUT. |
| |
| On the other hand, when we try to confirm if a build is successfully |
| installed, we should ignore the date string, so a trybot build can be |
| installed successfully when the reimage job calls |
| check_version_to_confirm_install to verify the image version at the end |
| of the job. |
| |
| This logic has a bug if a trybot build failed to be installed in a |
| DUT running an older trybot build with same platform number, but |
| different build number (-b###). So to conclusively determine if a |
| tryjob build is imaged successfully, we do need to find out the date |
| string from update url. |
| |
| @returns: True if the DUT's image version (without the date string if |
| the image is a trybot build), matches the version that the |
| autoupdater is trying to update to. |
| |
| """ |
| # Always try the default check_version method first, this prevents |
| # any backward compatibility issue. |
| if self.check_version(): |
| return True |
| |
| booted_version = self.get_build_id() |
| booted_version_no_date = re.sub(r'\d{4}_\d{2}_\d{2}_\d+', '', |
| booted_version) |
| # For a DUT running a build from trybot, only matching the version |
| # number is enough to consider versions are matched. |
| if booted_version != booted_version_no_date: |
| return (self.update_version and |
| booted_version_no_date in self.update_version) |
| else: |
| return (self.update_version and |
| self.update_version.endswith(booted_version_no_date)) |
| |
| |
| def get_build_id(self): |
| """Pulls the CHROMEOS_RELEASE_VERSION string from /etc/lsb-release.""" |
| return self._run('grep CHROMEOS_RELEASE_VERSION' |
| ' /etc/lsb-release').stdout.split('=')[1].strip() |