400 lines
14 KiB
Python
400 lines
14 KiB
Python
# Lint as: python2, python3
|
|
# Copyright (c) 2013 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 collections
|
|
import re
|
|
import sys
|
|
import warnings
|
|
|
|
import common
|
|
from autotest_lib.server.cros import provision_actionables as actionables
|
|
from autotest_lib.utils import labellib
|
|
from autotest_lib.utils.labellib import Key
|
|
|
|
|
|
### Constants for label prefixes
|
|
CROS_VERSION_PREFIX = Key.CROS_VERSION
|
|
CROS_ANDROID_VERSION_PREFIX = Key.CROS_ANDROID_VERSION
|
|
FW_RW_VERSION_PREFIX = Key.FIRMWARE_RW_VERSION
|
|
FW_RO_VERSION_PREFIX = Key.FIRMWARE_RO_VERSION
|
|
FW_CR50_RW_VERSION_PREFIX = Key.FIRMWARE_CR50_RW_VERSION
|
|
|
|
# So far the word cheets is only way to distinguish between ARC and Android
|
|
# build.
|
|
_CROS_ANDROID_BUILD_REGEX = r'.+/cheets.*/P?([0-9]+|LATEST)'
|
|
|
|
# Special label to skip provision and run reset instead.
|
|
SKIP_PROVISION = 'skip_provision'
|
|
|
|
# Postfix -cheetsth to distinguish ChromeOS build during Cheets provisioning.
|
|
CHEETS_SUFFIX = '-cheetsth'
|
|
|
|
# ChromeOS image archive server address
|
|
CROS_IMAGE_ARCHIVE = 'gs://chromeos-image-archive'
|
|
|
|
# ChromeOS firmware branch directory name. %s is for a (base)board name.
|
|
FW_BRANCH_GLOB = 'firmware-%s-[0-9]*.B-firmwarebranch'
|
|
|
|
_Action = collections.namedtuple('_Action', 'name, value')
|
|
|
|
|
|
def _get_label_action(str_label):
|
|
"""Get action represented by the label.
|
|
|
|
This is used for determine actions to perform based on labels, for
|
|
example for provisioning or repair.
|
|
|
|
@param str_label: label string
|
|
@returns: _Action instance
|
|
"""
|
|
try:
|
|
keyval_label = labellib.parse_keyval_label(str_label)
|
|
except ValueError:
|
|
return _Action(str_label, None)
|
|
else:
|
|
return _Action(keyval_label.key, keyval_label.value)
|
|
|
|
|
|
### Helpers to convert value to label
|
|
def get_version_label_prefix(image):
|
|
"""
|
|
Determine a version label prefix from a given image name.
|
|
|
|
Parses `image` to determine what kind of image it refers
|
|
to, and returns the corresponding version label prefix.
|
|
|
|
Known version label prefixes are:
|
|
* `CROS_VERSION_PREFIX` for Chrome OS version strings.
|
|
These images have names like `cave-release/R57-9030.0.0`.
|
|
* `CROS_ANDROID_VERSION_PREFIX` for Chrome OS Android version strings.
|
|
These images have names like `git_nyc-arc/cheets_x86-user/3512523`.
|
|
|
|
@param image: The image name to be parsed.
|
|
@returns: A string that is the prefix of version labels for the type
|
|
of image identified by `image`.
|
|
|
|
"""
|
|
if re.match(_CROS_ANDROID_BUILD_REGEX, image, re.I):
|
|
return CROS_ANDROID_VERSION_PREFIX
|
|
else:
|
|
return CROS_VERSION_PREFIX
|
|
|
|
|
|
def image_version_to_label(image):
|
|
"""
|
|
Return a version label appropriate to the given image name.
|
|
|
|
The type of version label is as determined described for
|
|
`get_version_label_prefix()`, meaning the label will identify a
|
|
CrOS or Android version.
|
|
|
|
@param image: The image name to be parsed.
|
|
@returns: A string that is the appropriate label name.
|
|
|
|
"""
|
|
return get_version_label_prefix(image) + ':' + image
|
|
|
|
|
|
def fwro_version_to_label(image):
|
|
"""
|
|
Returns the proper label name for a RO firmware build of |image|.
|
|
|
|
@param image: A string of the form 'lumpy-release/R28-3993.0.0'
|
|
@returns: A string that is the appropriate label name.
|
|
|
|
"""
|
|
warnings.warn('fwro_version_to_label is deprecated', stacklevel=2)
|
|
keyval_label = labellib.KeyvalLabel(Key.FIRMWARE_RO_VERSION, image)
|
|
return labellib.format_keyval_label(keyval_label)
|
|
|
|
|
|
def fwrw_version_to_label(image):
|
|
"""
|
|
Returns the proper label name for a RW firmware build of |image|.
|
|
|
|
@param image: A string of the form 'lumpy-release/R28-3993.0.0'
|
|
@returns: A string that is the appropriate label name.
|
|
|
|
"""
|
|
warnings.warn('fwrw_version_to_label is deprecated', stacklevel=2)
|
|
keyval_label = labellib.KeyvalLabel(Key.FIRMWARE_RW_VERSION, image)
|
|
return labellib.format_keyval_label(keyval_label)
|
|
|
|
|
|
class _SpecialTaskAction(object):
|
|
"""
|
|
Base class to give a template for mapping labels to tests.
|
|
"""
|
|
|
|
# A dictionary mapping labels to test names.
|
|
_actions = {}
|
|
|
|
# The name of this special task to be used in output.
|
|
name = None;
|
|
|
|
# Some special tasks require to run before others, e.g., ChromeOS image
|
|
# needs to be updated before firmware provision. List `_priorities` defines
|
|
# the order of each label prefix. An element with a smaller index has higher
|
|
# priority. Not listed ones have the lowest priority.
|
|
# This property should be overriden in subclass to define its own priorities
|
|
# across available label prefixes.
|
|
_priorities = []
|
|
|
|
|
|
@classmethod
|
|
def acts_on(cls, label):
|
|
"""
|
|
Returns True if the label is a label that we recognize as something we
|
|
know how to act on, given our _actions.
|
|
|
|
@param label: The label as a string.
|
|
@returns: True if there exists a test to run for this label.
|
|
"""
|
|
action = _get_label_action(label)
|
|
return action.name in cls._actions
|
|
|
|
|
|
@classmethod
|
|
def run_task_actions(cls, job, host, labels):
|
|
"""
|
|
Run task actions on host that correspond to the labels.
|
|
|
|
Emits status lines for each run test, and INFO lines for each
|
|
skipped label.
|
|
|
|
@param job: A job object from a control file.
|
|
@param host: The host to run actions on.
|
|
@param labels: The list of job labels to work on.
|
|
@raises: SpecialTaskActionException if a test fails.
|
|
"""
|
|
unactionable = cls._filter_unactionable_labels(labels)
|
|
for label in unactionable:
|
|
job.record('INFO', None, cls.name,
|
|
"Can't %s label '%s'." % (cls.name, label))
|
|
|
|
for action_item, value in cls._actions_and_values_iter(labels):
|
|
success = action_item.execute(job=job, host=host, value=value)
|
|
if not success:
|
|
raise SpecialTaskActionException()
|
|
|
|
|
|
@classmethod
|
|
def _actions_and_values_iter(cls, labels):
|
|
"""Return sorted action and value pairs to run for labels.
|
|
|
|
@params: An iterable of label strings.
|
|
@returns: A generator of Actionable and value pairs.
|
|
"""
|
|
actionable = cls._filter_actionable_labels(labels)
|
|
keyval_mapping = labellib.LabelsMapping(actionable)
|
|
sorted_names = sorted(keyval_mapping, key=cls._get_action_priority)
|
|
for name in sorted_names:
|
|
action_item = cls._actions[name]
|
|
value = keyval_mapping[name]
|
|
yield action_item, value
|
|
|
|
|
|
@classmethod
|
|
def _filter_unactionable_labels(cls, labels):
|
|
"""
|
|
Return labels that we cannot act on.
|
|
|
|
@param labels: A list of strings of labels.
|
|
@returns: A set of unactionable labels
|
|
"""
|
|
return {label for label in labels
|
|
if not (label == SKIP_PROVISION or cls.acts_on(label))}
|
|
|
|
|
|
@classmethod
|
|
def _filter_actionable_labels(cls, labels):
|
|
"""
|
|
Return labels that we can act on.
|
|
|
|
@param labels: A list of strings of labels.
|
|
@returns: A set of actionable labels
|
|
"""
|
|
return {label for label in labels if cls.acts_on(label)}
|
|
|
|
|
|
@classmethod
|
|
def partition(cls, labels):
|
|
"""
|
|
Filter a list of labels into two sets: those labels that we know how to
|
|
act on and those that we don't know how to act on.
|
|
|
|
@param labels: A list of strings of labels.
|
|
@returns: A tuple where the first element is a set of unactionable
|
|
labels, and the second element is a set of the actionable
|
|
labels.
|
|
"""
|
|
unactionable = set()
|
|
actionable = set()
|
|
|
|
for label in labels:
|
|
if label == SKIP_PROVISION:
|
|
# skip_provision is neither actionable or a capability label.
|
|
# It doesn't need any handling.
|
|
continue
|
|
elif cls.acts_on(label):
|
|
actionable.add(label)
|
|
else:
|
|
unactionable.add(label)
|
|
|
|
return unactionable, actionable
|
|
|
|
|
|
@classmethod
|
|
def _get_action_priority(cls, name):
|
|
"""Return priority for the action with the given name."""
|
|
if name in cls._priorities:
|
|
return cls._priorities.index(name)
|
|
else:
|
|
return sys.maxsize
|
|
|
|
|
|
class Verify(_SpecialTaskAction):
|
|
"""
|
|
Tests to verify that the DUT is in a sane, known good state that we can run
|
|
tests on. Failure to verify leads to running Repair.
|
|
"""
|
|
|
|
_actions = {
|
|
'modem_repair': actionables.TestActionable('cellular_StaleModemReboot'),
|
|
# TODO(crbug.com/404421): set rpm action to power_RPMTest after the RPM
|
|
# is stable in lab (destiny). The power_RPMTest failure led to reset job
|
|
# failure and that left dut in Repair Failed. Since the test will fail
|
|
# anyway due to the destiny lab issue, and test retry will retry the
|
|
# test in another DUT.
|
|
# This change temporarily disable the RPM check in reset job.
|
|
# Another way to do this is to remove rpm dependency from tests' control
|
|
# file. That will involve changes on multiple control files. This one
|
|
# line change here is a simple temporary fix.
|
|
'rpm': actionables.TestActionable('dummy_PassServer'),
|
|
}
|
|
|
|
name = 'verify'
|
|
|
|
|
|
class Provision(_SpecialTaskAction):
|
|
"""
|
|
Provisioning runs to change the configuration of the DUT from one state to
|
|
another. It will only be run on verified DUTs.
|
|
"""
|
|
|
|
# ChromeOS update must happen before firmware install, so the dut has the
|
|
# correct ChromeOS version label when firmware install occurs. The ChromeOS
|
|
# version label is used for firmware update to stage desired ChromeOS image
|
|
# on to the servo USB stick.
|
|
_priorities = [CROS_VERSION_PREFIX,
|
|
CROS_ANDROID_VERSION_PREFIX,
|
|
FW_RO_VERSION_PREFIX,
|
|
FW_RW_VERSION_PREFIX,
|
|
FW_CR50_RW_VERSION_PREFIX]
|
|
|
|
# TODO(milleral): http://crbug.com/249555
|
|
# Create some way to discover and register provisioning tests so that we
|
|
# don't need to hand-maintain a list of all of them.
|
|
_actions = {
|
|
CROS_VERSION_PREFIX:
|
|
actionables.TestActionable(
|
|
'provision_QuickProvision',
|
|
extra_kwargs={
|
|
'disable_sysinfo': False,
|
|
'disable_before_test_sysinfo': False,
|
|
'disable_before_iteration_sysinfo': True,
|
|
'disable_after_test_sysinfo': True,
|
|
'disable_after_iteration_sysinfo': True
|
|
}),
|
|
CROS_ANDROID_VERSION_PREFIX:
|
|
actionables.TestActionable('provision_CheetsUpdate'),
|
|
FW_RO_VERSION_PREFIX:
|
|
actionables.TestActionable('provision_FirmwareUpdate'),
|
|
FW_RW_VERSION_PREFIX:
|
|
actionables.TestActionable('provision_FirmwareUpdate',
|
|
extra_kwargs={
|
|
'rw_only': True,
|
|
'tag': 'rw_only'
|
|
}),
|
|
FW_CR50_RW_VERSION_PREFIX:
|
|
actionables.TestActionable('provision_Cr50TOT')
|
|
}
|
|
|
|
name = 'provision'
|
|
|
|
|
|
class Cleanup(_SpecialTaskAction):
|
|
"""
|
|
Cleanup runs after a test fails to try and remove artifacts of tests and
|
|
ensure the DUT will be in a sane state for the next test run.
|
|
"""
|
|
|
|
_actions = {
|
|
'cleanup-reboot': actionables.RebootActionable(),
|
|
}
|
|
|
|
name = 'cleanup'
|
|
|
|
|
|
# TODO(ayatane): This class doesn't do anything. It's safe to remove
|
|
# after all references to it are removed (after some buffer time to be
|
|
# safe, like a few release cycles).
|
|
class Repair(_SpecialTaskAction):
|
|
"""
|
|
Repair runs when one of the other special tasks fails. It should be able
|
|
to take a component of the DUT that's in an unknown state and restore it to
|
|
a good state.
|
|
"""
|
|
|
|
_actions = {
|
|
}
|
|
|
|
name = 'repair'
|
|
|
|
|
|
# TODO(milleral): crbug.com/364273
|
|
# Label doesn't really mean label in this context. We're putting things into
|
|
# DEPENDENCIES that really aren't DEPENDENCIES, and we should probably stop
|
|
# doing that.
|
|
def is_for_special_action(label):
|
|
"""
|
|
If any special task handles the label specially, then we're using the label
|
|
to communicate that we want an action, and not as an actual dependency that
|
|
the test has.
|
|
|
|
@param label: A string label name.
|
|
@return True if any special task handles this label specially,
|
|
False if no special task handles this label.
|
|
"""
|
|
return (Verify.acts_on(label) or
|
|
Provision.acts_on(label) or
|
|
Cleanup.acts_on(label) or
|
|
Repair.acts_on(label) or
|
|
label == SKIP_PROVISION)
|
|
|
|
|
|
def join(provision_type, provision_value):
|
|
"""
|
|
Combine the provision type and value into the label name.
|
|
|
|
@param provision_type: One of the constants that are the label prefixes.
|
|
@param provision_value: A string of the value for this provision type.
|
|
@returns: A string that is the label name for this (type, value) pair.
|
|
|
|
>>> join(CROS_VERSION_PREFIX, 'lumpy-release/R27-3773.0.0')
|
|
'cros-version:lumpy-release/R27-3773.0.0'
|
|
|
|
"""
|
|
return '%s:%s' % (provision_type, provision_value)
|
|
|
|
|
|
class SpecialTaskActionException(Exception):
|
|
"""
|
|
Exception raised when a special task fails to successfully run a test that
|
|
is required.
|
|
|
|
This is also a literally meaningless exception. It's always just discarded.
|
|
"""
|