blob: d0b99192f5f40f451af5501236cb132a6c980703 [file] [log] [blame]
# -*- coding: utf-8 -*-
# Copyright 2019 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.
"""Autotest utilities."""
from __future__ import print_function
import fnmatch
import os
from chromite.lib import constants
from chromite.lib import cros_build_lib
from chromite.lib import path_util
class AutotestTarballBuilder(object):
"""Builds autotest tarballs for testing."""
# Archive file names.
_CONTROL_FILES_ARCHIVE = 'control_files.tar'
_PACKAGES_ARCHIVE = 'autotest_packages.tar'
_TEST_SUITES_ARCHIVE = 'test_suites.tar.bz2'
_SERVER_PACKAGE_ARCHIVE = 'autotest_server_package.tar.bz2'
# Directory within _SERVER_PACKAGE_ARCHIVE where Tast files needed to run
# with Server-Side Packaging are stored.
# Tast files and directories to include in AUTOTEST_SERVER_PACKAGE relative to
# the build root.
'/usr/bin/tast', # Main Tast executable.
'/usr/bin/remote_test_runner', # Runs remote tests.
'/usr/libexec/tast/bundles', # Dir containing test bundles.
'/usr/share/tast/data', # Dir containing test data.
# Tast files and directories stored in the source code.
'src/platform/tast/tools/', # Helper script to run SSP tast.
def __init__(self, archive_basedir, output_directory):
"""Init function.
archive_basedir (str): The base directory from which the archives will be
created. This path should contain the `autotest` directory.
output_directory (str): The directory where the archives will be written.
self.archive_basedir = archive_basedir
self.output_directory = output_directory
def BuildAutotestControlFilesTarball(self):
"""Tar up the autotest control files.
str - Path of the partial autotest control files tarball.
# Find the control files in autotest/.
input_list = _FindFilesWithPattern('control*', target='autotest',
tarball = os.path.join(self.output_directory, self._CONTROL_FILES_ARCHIVE)
self._BuildTarball(input_list, tarball, compressed=False)
return tarball
def BuildAutotestPackagesTarball(self):
"""Tar up the autotest packages.
str - Path of the partial autotest packages tarball.
input_list = ['autotest/packages']
tarball = os.path.join(self.output_directory, self._PACKAGES_ARCHIVE)
self._BuildTarball(input_list, tarball, compressed=False)
return tarball
def BuildAutotestTestSuitesTarball(self):
"""Tar up the autotest test suite control files.
str - Path of the autotest test suites tarball.
input_list = ['autotest/test_suites']
tarball = os.path.join(self.output_directory, self._TEST_SUITES_ARCHIVE)
self._BuildTarball(input_list, tarball)
return tarball
def BuildAutotestServerPackageTarball(self):
"""Tar up the autotest files required by the server package.
str - The path of the autotest server package tarball.
# Find all files in autotest excluding certain directories.
tast_files, transforms = self._GetTastServerFilesAndTarTransforms()
autotest_files = _FindFilesWithPattern(
'*', target='autotest', cwd=self.archive_basedir,
exclude_dirs=('autotest/packages', 'autotest/client/deps/',
'autotest/client/tests', 'autotest/client/site_tests'))
tarball = os.path.join(self.output_directory, self._SERVER_PACKAGE_ARCHIVE)
self._BuildTarball(autotest_files + tast_files, tarball,
extra_args=transforms, error_code_ok=True)
return tarball
def _BuildTarball(self, input_list, tarball_output, compressed=True,
"""Tars and zips files and directories from input_list to tarball_output.
input_list: A list of files and directories to be archived.
tarball_output: Path of output tar archive file.
compressed: Whether or not the tarball should be compressed with pbzip2.
**kwargs: Keyword arguments to pass to CreateTarball.
Return value of cros_build_lib.CreateTarball.
compressor = cros_build_lib.COMP_NONE
chroot = None
if compressed:
compressor = cros_build_lib.COMP_BZIP2
if not cros_build_lib.IsInsideChroot():
chroot = path_util.FromChrootPath('/')
return cros_build_lib.CreateTarball(
tarball_output, self.archive_basedir, compression=compressor,
chroot=chroot, inputs=input_list, **kwargs)
def _GetTastServerFilesAndTarTransforms(self):
"""Returns Tast server files and corresponding tar transform flags.
The returned paths should be included in AUTOTEST_SERVER_PACKAGE. The
--transform arguments should be passed to GNU tar to convert the paths to
appropriate destinations in the tarball.
(files, transforms), where files is a list of absolute paths to Tast
server files/directories and transforms is a list of --transform
arguments to pass to GNU tar when archiving those files.
files = []
transforms = []
for path in self._GetTastSspFiles():
if not os.path.exists(path):
dest = os.path.join(self._TAST_SSP_SUBDIR, os.path.basename(path))
transforms.append('--transform=s|^%s|%s|' %
(os.path.relpath(path, '/'), dest))
return files, transforms
def _GetTastSspFiles(self):
"""Build out the paths to the tast SSP files.
list[str] - The paths to the files.
files = []
if cros_build_lib.IsInsideChroot():
files.extend(map(path_util.FromChrootPath, self._TAST_SSP_CHROOT_FILES))
for filename in self._TAST_SSP_SOURCE_FILES:
files.append(os.path.join(constants.SOURCE_ROOT, filename))
return files
def _FindFilesWithPattern(pattern, target='./', cwd=os.curdir, exclude_dirs=()):
"""Search the root directory recursively for matching filenames.
The |target| and |cwd| args allow manipulating how the found paths are
returned as well as specifying where the search needs to be executed.
If our filesystem only has /path/to/example.txt, and our pattern is '*.txt':
|target|='./', |cwd|='/path' => ./to/example.txt
|target|='to', |cwd|='/path' => to/example.txt
|target|='./', |cwd|='/path/to' => ./example.txt
|target|='/path' => /path/to/example.txt
|target|='/path/to' => /path/to/example.txt
pattern: the pattern used to match the filenames.
target: the target directory to search.
cwd: current working directory.
exclude_dirs: Directories to not include when searching.
A list of paths of the matched files.
# Backup the current working directory before changing it
old_cwd = os.getcwd()
matches = []
for directory, _, filenames in os.walk(target):
if any(directory.startswith(e) for e in exclude_dirs):
# Skip files in excluded directories.
for filename in fnmatch.filter(filenames, pattern):
matches.append(os.path.join(directory, filename))
# Restore the working directory
return matches