[autotest] Drop RPC support for specifying a test kernel.
Our legacy Autotest code included support for specifying a specific
kernel to be tested when creating a job. That support wasn't
appropriate for Chrome OS, and didn't work.
All existing user level interfaces for specifying a kernel (CLI and
AFE) have been changed to drop this feature. This change removes
support for the feature in the RPC calls. Lower-level layers still
contain support that is unused, which will be removed in subsequent
CLs.
BUG=chromium:266704
TEST=Look at control file from AFE job creation page; run atest job create
Change-Id: Ifb0c6888f550f6cda98195b489ba8076cdf47e6b
Reviewed-on: https://chromium-review.googlesource.com/346570
Commit-Ready: Richard Barnette <jrbarnette@chromium.org>
Tested-by: Richard Barnette <jrbarnette@chromium.org>
Reviewed-by: Richard Barnette <jrbarnette@google.com>
diff --git a/frontend/afe/control_file.py b/frontend/afe/control_file.py
index a88a8b4..8971a88 100644
--- a/frontend/afe/control_file.py
+++ b/frontend/afe/control_file.py
@@ -16,152 +16,11 @@
EMPTY_TEMPLATE = 'def step_init():\n'
-CLIENT_KERNEL_TEMPLATE = """\
-kernel_list = %(client_kernel_list)s
-
-def step_init():
- for kernel_info in kernel_list:
- job.next_step(boot_kernel, kernel_info)
- job.next_step(step_test, kernel_info['version'])
- if len(kernel_list) > 1:
- job.use_sequence_number = True # include run numbers in directory names
-
-
-def boot_kernel(kernel_info):
- # remove kernels (and associated data) not referenced by the bootloader
- for host in job.hosts:
- host.cleanup_kernels()
-
- testkernel = job.kernel(kernel_info['version'])
- if kernel_info['config_file']:
- testkernel.config(kernel_info['config_file'])
- testkernel.build()
- testkernel.install()
-
- cmdline = ' '.join((kernel_info.get('cmdline', ''), '%(kernel_args)s'))
- testkernel.boot(args=cmdline)
-
-
-def step_test(kernel_version):
- global kernel
- kernel = kernel_version # Set the global in case anyone is using it.
- if len(kernel_list) > 1:
- # this is local to a machine, safe to assume there's only one host
- host, = job.hosts
- job.automatic_test_tag = host.get_kernel_ver()
-"""
-
-SERVER_KERNEL_TEMPLATE = """\
-kernel_list = %%(server_kernel_list)s
-kernel_install_control = \"""
-%s pass
-\"""
-
-from autotest_lib.client.common_lib import error
-
-at = autotest.Autotest()
-
-%%(upload_config_func)s
-def install_kernel(machine, kernel_info):
- host = hosts.create_host(machine)
- at.install(host=host)
- %%(call_upload_config)s
- at.run(kernel_install_control %%%%
- {'client_kernel_list': repr([kernel_info])}, host=host)
-
-
-num_machines_required = len(machines)
-if len(machines) > 4:
- # Allow a large multi-host tests to proceed despite a couple of hosts
- # failing to properly install the desired kernel (exclude those hosts).
- # TODO(gps): Figure out how to get and use SYNC_COUNT here. It is defined
- # within some control files and will end up inside of stepN functions below.
- num_machines_required = len(machines) - 2
-
-
-def step_init():
- # a host object we use solely for the purpose of finding out the booted
- # kernel version, we use machines[0] since we already check that the same
- # kernel has been booted on all machines
- if len(kernel_list) > 1:
- kernel_host = hosts.create_host(machines[0])
-
- for kernel_info in kernel_list:
- func = lambda machine: install_kernel(machine, kernel_info)
- good_machines = job.parallel_on_machines(func, machines)
- if len(good_machines) < num_machines_required:
- raise error.TestError(
- "kernel installed on only %%%%d of %%%%d machines."
- %%%% (len(good_machines), num_machines_required))
-
- # Replace the machines list that step_test() will use with the
- # ones that successfully installed the kernel.
- machines[:] = good_machines
-
- # have server_job.run_test() automatically add the kernel version as
- # a suffix to the test name otherwise we cannot run the same test on
- # different kernel versions
- if len(kernel_list) > 1:
- job.automatic_test_tag = kernel_host.get_kernel_ver()
- step_test()
-
-
-def step_test():
-""" % CLIENT_KERNEL_TEMPLATE
-
CLIENT_STEP_TEMPLATE = " job.next_step('step%d')\n"
SERVER_STEP_TEMPLATE = ' step%d()\n'
-UPLOAD_CONFIG_FUNC = """
-def upload_kernel_config(host, kernel_info):
- \"""
- If the kernel_info['config_file'] is a URL it will be downloaded
- locally and then uploaded to the client and a copy of the original
- dictionary with the new path to the config file will be returned.
- If the config file is not a URL the function returns the original
- dictionary.
- \"""
- import os
- from autotest_lib.client.common_lib import autotemp, utils
- config_orig = kernel_info.get('config_file')
-
- # if the file is not an URL then we assume it's a local client path
- if not config_orig or not utils.is_url(config_orig):
- return kernel_info
-
- # download it locally (on the server) and send it to the client
- config_tmp = autotemp.tempfile('kernel_config_upload', dir=job.tmpdir)
- try:
- utils.urlretrieve(config_orig, config_tmp.name)
- config_new = os.path.join(host.get_autodir(), 'tmp',
- os.path.basename(config_orig))
- host.send_file(config_tmp.name, config_new)
- finally:
- config_tmp.clean()
-
- return dict(kernel_info, config_file=config_new)
-
-"""
-
-CALL_UPLOAD_CONFIG = 'kernel_info = upload_kernel_config(host, kernel_info)'
-
-
-def kernel_config_file(kernel, platform):
- """Gets the kernel config.
-
- @param kernel The kernel rpm .
- @param platform The platform object.
-
- @return The kernel config string or None.
- """
- if (not kernel.endswith('.rpm') and platform and
- platform.kernel_config):
- return platform.kernel_config
- return None
-
-
-def read_control_file(test):
+def _read_control_file(test):
"""Reads the test control file from local disk.
@param test The test name.
@@ -174,43 +33,7 @@
return control_contents
-def get_kernel_stanza(kernel_list, platform=None, kernel_args='',
- is_server=False, upload_kernel_config=False):
-
- template_args = {'kernel_args' : kernel_args}
-
- # add 'config_file' keys to the kernel_info dictionaries
- new_kernel_list = []
- for kernel_info in kernel_list:
- if kernel_info.get('config_file'):
- # already got a config file from the user
- new_kernel_info = kernel_info
- else:
- config_file = kernel_config_file(kernel_info['version'], platform)
- new_kernel_info = dict(kernel_info, config_file=config_file)
-
- new_kernel_list.append(new_kernel_info)
-
- if is_server:
- template = SERVER_KERNEL_TEMPLATE
- # leave client_kernel_list as a placeholder
- template_args['client_kernel_list'] = '%(client_kernel_list)s'
- template_args['server_kernel_list'] = repr(new_kernel_list)
-
- if upload_kernel_config:
- template_args['call_upload_config'] = CALL_UPLOAD_CONFIG
- template_args['upload_config_func'] = UPLOAD_CONFIG_FUNC
- else:
- template_args['call_upload_config'] = ''
- template_args['upload_config_func'] = ''
- else:
- template = CLIENT_KERNEL_TEMPLATE
- template_args['client_kernel_list'] = repr(new_kernel_list)
-
- return template % template_args
-
-
-def add_boilerplate_to_nested_steps(lines):
+def _add_boilerplate_to_nested_steps(lines):
"""Adds boilerplate magic.
@param lines The string of lines.
@@ -227,19 +50,19 @@
return lines
-def format_step(item, lines):
+def _format_step(item, lines):
"""Format a line item.
@param item The item number.
@param lines The string of lines.
@returns The string lines.
"""
- lines = indent_text(lines, ' ')
+ lines = _indent_text(lines, ' ')
lines = 'def step%d():\n%s' % (item, lines)
return lines
-def get_tests_stanza(tests, is_server, prepend=None, append=None,
+def _get_tests_stanza(tests, is_server, prepend=None, append=None,
client_control_file='', test_source_build=None):
""" Constructs the control file test step code from a list of tests.
@@ -265,36 +88,14 @@
raw_control_files = site_rpc_interface.get_test_control_files_by_build(
tests, test_source_build)
else:
- raw_control_files = [read_control_file(test) for test in tests]
- return _get_tests_stanza(raw_control_files, is_server, prepend, append,
- client_control_file=client_control_file)
-
-
-def _get_tests_stanza(raw_control_files, is_server, prepend, append,
- client_control_file=''):
- """
- Implements the common parts of get_test_stanza.
-
- A site_control_file that wants to implement its own get_tests_stanza
- likely wants to call this in the end.
-
- @param raw_control_files A list of raw control file data to be combined
- into a single control file.
- @param is_server bool, Is this a server side test?
- @param prepend A list of steps to prepend to each client test.
- @param append A list of steps to append to each client test.
- @param client_control_file If specified, use this text as the body of a
- final client control file to append to raw_control_files after fixups.
-
- @returns The combined mega control file.
- """
+ raw_control_files = [_read_control_file(test) for test in tests]
if client_control_file:
- # 'return locals()' is always appended incase the user forgot, it
+ # 'return locals()' is always appended in case the user forgot, it
# is necessary to allow for nested step engine execution to work.
raw_control_files.append(client_control_file + '\nreturn locals()')
- raw_steps = prepend + [add_boilerplate_to_nested_steps(step)
+ raw_steps = prepend + [_add_boilerplate_to_nested_steps(step)
for step in raw_control_files] + append
- steps = [format_step(index, step)
+ steps = [_format_step(index, step)
for index, step in enumerate(raw_steps)]
if is_server:
step_template = SERVER_STEP_TEMPLATE
@@ -307,7 +108,7 @@
return header + '\n' + '\n\n'.join(steps) + footer
-def indent_text(text, indent):
+def _indent_text(text, indent):
"""Indent given lines of python code avoiding indenting multiline
quoted content (only for triple " and ' quoting for now).
@@ -354,8 +155,7 @@
return prepend, append
-def _sanity_check_generate_control(is_server, client_control_file, kernels,
- upload_kernel_config):
+def _sanity_check_generate_control(is_server, client_control_file):
"""
Sanity check some of the parameters to generate_control().
@@ -369,68 +169,30 @@
{'tests' : 'You cannot run server tests at the same time '
'as directly supplying a client-side control file.'})
- if kernels:
- # make sure that kernel is a list of dictionarions with at least
- # the 'version' key in them
- kernel_error = model_logic.ValidationError(
- {'kernel': 'The kernel parameter must be a sequence of '
- 'dictionaries containing at least the "version" key '
- '(got: %r)' % kernels})
- try:
- iter(kernels)
- except TypeError:
- raise kernel_error
- for kernel_info in kernels:
- if (not isinstance(kernel_info, dict) or
- 'version' not in kernel_info):
- raise kernel_error
- if upload_kernel_config and not is_server:
- raise model_logic.ValidationError(
- {'upload_kernel_config': 'Cannot use upload_kernel_config '
- 'with client side tests'})
-
-
-def generate_control(tests, kernels=None, platform=None, is_server=False,
- profilers=(), client_control_file='', profile_only=None,
- upload_kernel_config=False, test_source_build=None):
+def generate_control(tests, is_server=False, profilers=(),
+ client_control_file='', profile_only=None,
+ test_source_build=None):
"""
Generate a control file for a sequence of tests.
@param tests A sequence of test control files to run.
- @param kernels A sequence of kernel info dictionaries configuring which
- kernels to boot for this job and other options for them
- @param platform A platform object with a kernel_config attribute.
@param is_server bool, Is this a server control file rather than a client?
@param profilers A list of profiler objects to enable during the tests.
@param client_control_file Contents of a client control file to run as the
last test after everything in tests. Requires is_server=False.
@param profile_only bool, should this control file run all tests in
profile_only mode by default
- @param upload_kernel_config: if enabled it will generate server control
- file code that uploads the kernel config file to the client and
- tells the client of the new (local) path when compiling the kernel;
- the tests must be server side tests
@param test_source_build: Build to be used to retrieve test code. Default
to None.
@returns The control file text as a string.
"""
- _sanity_check_generate_control(is_server=is_server, kernels=kernels,
- client_control_file=client_control_file,
- upload_kernel_config=upload_kernel_config)
-
- control_file_text = ''
- if kernels:
- control_file_text = get_kernel_stanza(
- kernels, platform, is_server=is_server,
- upload_kernel_config=upload_kernel_config)
- else:
- control_file_text = EMPTY_TEMPLATE
-
+ _sanity_check_generate_control(is_server=is_server,
+ client_control_file=client_control_file)
+ control_file_text = EMPTY_TEMPLATE
prepend, append = _get_profiler_commands(profilers, is_server, profile_only)
-
- control_file_text += get_tests_stanza(tests, is_server, prepend, append,
- client_control_file,
- test_source_build)
+ control_file_text += _get_tests_stanza(tests, is_server, prepend, append,
+ client_control_file,
+ test_source_build)
return control_file_text