Repo documentation for depot_tools

Table of Contents

Recipe Modules

  • bot_update — Recipe module to ensure a checkout is consistent on a bot.
  • cipd — API for interacting with CIPD.
  • depot_tools — The depot_tools module provides safe functions to access paths within the depot_tools repo.
  • gclient
  • gerrit
  • git
  • git_cl
  • gitiles
  • gsutil
  • osx_sdk — The osx_sdk module provides safe functions to access a semi-hermetic XCode installation.
  • presubmit
  • tryserver
  • windows_sdk — The windows_sdk module provides safe functions to access a hermetic Microsoft Visual Studio installation.

Recipes

Recipe Modules

recipe_modules / bot_update

DEPS: depot_tools, gclient, gerrit, gitiles, tryserver, recipe_engine/buildbucket, recipe_engine/commit_position, recipe_engine/context, recipe_engine/cq, recipe_engine/json, recipe_engine/milo, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/runtime, recipe_engine/step

Recipe module to ensure a checkout is consistent on a bot.

class BotUpdateApi(RecipeApi):

def __call__(self, name, cmd, **kwargs):

Wrapper for easy calling of bot_update.

def deapply_patch(self, bot_update_step):

Deapplies a patch, taking care of DEPS and solution revisions properly.

def ensure_checkout(self, gclient_config=None, suffix=None, patch=True, update_presentation=True, patch_root=None, with_branch_heads=False, with_tags=False, no_fetch_tags=False, refs=None, patch_oauth2=None, oauth2_json=None, use_site_config_creds=None, clobber=False, root_solution_revision=None, rietveld=None, issue=None, patchset=None, gerrit_no_reset=False, gerrit_no_rebase_patch_ref=False, assert_one_gerrit_change=True, disable_syntax_validation=False, patch_refs=None, ignore_input_commit=False, add_blamelists=False, set_output_commit=False, step_test_data=None, enforce_fetch=False, **kwargs):

Args:

  • gclient_config: The gclient configuration to use when running bot_update. If omitted, the current gclient configuration is used.
  • no_fetch_tags: When true, the root git repo being checked out will not fetch any tags referenced from the references being fetched. When a repo has many references, it can become a performance bottleneck, so avoid tags if the checkout will not need them present.
  • disable_syntax_validation: (legacy) Disables syntax validation for DEPS. Needed as migration paths for recipes dealing with older revisions, such as bisect.
  • ignore_input_commit: if True, ignore api.buildbucket.gitiles_commit. Exists for historical reasons. Please do not use.
  • add_blamelists: if True, add blamelist pins for all of the repos that had revisions specified in the gclient config.
  • set_output_commit: if True, mark the checked out commit as the primary output commit of this build, i.e. call api.buildbucket.set_output_gitiles_commit. In case of multiple repos, the repo is the one specified in api.buildbucket.gitiles_commit or the first configured solution. When sorting builds by commit position, this commit will be used. Requires falsy ignore_input_commit.
  • step_test_data: a null function that returns test bot_update.py output. Use test_api.output_json to generate test data.
  • enforce_fetch: Enforce a new fetch to refresh the git cache, even if the solution revision passed in already exists in the current git cache.
  • assert_one_gerrit_change: if True, assert that there is at most one change in self.m.buildbucket.build.input.gerrit_changes, because bot_update module ONLY supports one change. Users may specify a change via tryserver.set_change() and explicitly set this flag False.

def get_project_revision_properties(self, project_name, gclient_config=None):

Returns all property names used for storing the checked-out revision of a given project.

Args:

  • project_name (str): The name of a checked-out project as deps path, e.g. src or src/v8.
  • gclient_config: The gclient configuration to use. If omitted, the current gclient configuration is used.

Returns (list of str): All properties that'll hold the checked-out revision of the given project. An empty list if no such properties exist.

@property
def last_returned_properties(self):

def resolve_fixed_revision(self, bot_update_json, name):

Sets a fixed revision for a single dependency using project revision properties.

recipe_modules / cipd

DEPS: recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step

API for interacting with CIPD.

Depends on ‘cipd’ binary available in PATH: https://godoc.org/go.chromium.org/luci/cipd/client/cmd/cipd

WARNING: There is an alternative cipd recipe_module in recipes-py.git: https://codesearch.chromium.org/chromium/infra/recipes-py/recipe_modules/cipd/

Consider using that one instead. TODO(crbug.com/875523): Delete this module.

class CIPDApi(RecipeApi):

CIPDApi provides basic support for CIPD.

This assumes that cipd (or cipd.exe or cipd.bat on windows) has been installed somewhere in $PATH. This will be true if you use depot_tools, or if your recipe is running inside of chrome-infrastructure's systems (buildbot, swarming).

def build(self, input_dir, output_package, package_name, install_mode=None):

Builds, but does not upload, a cipd package from a directory.

Args: input_dir (Path) - the directory to build the package from. output_package (Path) - the file to write the package to. package_name (str) - the name of the cipd package as it would appear when uploaded to the cipd package server. install_mode (None|‘copy’|‘symlink’) - the mechanism that the cipd client should use when installing this package. If None, defaults to the platform default (‘copy’ on windows, ‘symlink’ on everything else).

def create_from_pkg(self, pkg_def, refs=None, tags=None):

Builds and uploads a package based on a PackageDefinition object.

This builds and uploads the package in one step.

Args: pkg_def (PackageDefinition) - The description of the package we want to create. refs (list(str)) - A list of ref names to set for the package instance. tags (dict(str, str)) - A map of tag name -> value to set for the package instance.

Returns the JSON ‘result’ section, e.g.: { “package”: “infra/tools/cipd/android-amd64”, “instance_id”: “433bfdf86c0bb82d1eee2d1a0473d3709c25d2c4” }

def create_from_yaml(self, pkg_def, refs=None, tags=None, verification_timeout=None):

Builds and uploads a package based on on-disk YAML package definition file.

This builds and uploads the package in one step.

Args: pkg_def (Path) - The path to the yaml file. refs (list(str)) - A list of ref names to set for the package instance. tags (dict(str, str)) - A map of tag name -> value to set for the package instance. verification_timeout (str) - Duration string that controls the time to wait for backend-side package hash verification. Valid time units are “ns”, “us”, “ms”, “s”, “m”, “h”.

Returns the JSON ‘result’ section, e.g.: { “package”: “infra/tools/cipd/android-amd64”, “instance_id”: “433bfdf86c0bb82d1eee2d1a0473d3709c25d2c4” }

@property
def default_bot_service_account_credentials(self):

def describe(self, package_name, version, test_data_refs=None, test_data_tags=None):

def ensure(self, root, packages):

Ensures that packages are installed in a given root dir.

packages must be a mapping from package name to its version, where

  • name must be for right platform (see also platform_suffix),
  • version could be either instance_id, or ref, or unique tag.

If installing a package requires credentials, call set_service_account_credentials before calling this function.

@property
def executable(self):

def initialize(self):

def platform_suffix(self, name=None, arch=None, bits=None):

Use to get full package name that is platform indepdent.

Example:

‘my/package/%s’ % api.cipd.platform_suffix() ‘my/package/linux-amd64’

Optional platform bits and architecture may be supplied to generate CIPD suffixes for other platforms. If any are omitted, the current platform parameters will be used.

def register(self, package_name, package_path, refs=None, tags=None):

def search(self, package_name, tag):

def set_ref(self, package_name, version, refs):

def set_service_account_credentials(self, path):

def set_tag(self, package_name, version, tags):

recipe_modules / depot_tools

DEPS: recipe_engine/context, recipe_engine/platform, recipe_engine/runtime

The depot_tools module provides safe functions to access paths within the depot_tools repo.

class DepotToolsApi(RecipeApi):

@property
def autoninja_path(self):

@property
def cros_path(self):

@property
def download_from_google_storage_path(self):

@property
def gn_py_path(self):

@property
def gsutil_py_path(self):

@property
def ninja_path(self):

@contextlib.contextmanager
def on_path(self):

Use this context manager to put depot_tools on $PATH.

Example:

with api.depot_tools.on_path():
  # run some steps

@property
def presubmit_support_py_path(self):

@property
def root(self):

Returns (Path): The “depot_tools” root directory.

@property
def upload_to_google_storage_path(self):

recipe_modules / gclient

DEPS: git, gitiles, tryserver, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step

class GclientApi(RecipeApi):

@property
def DepsDiffException(self):

def __call__(self, name, cmd, infra_step=True, **kwargs):

Wrapper for easy calling of gclient steps.

def break_locks(self):

Remove all index.lock files. If a previous run of git crashed, bot was reset, etc... we might end up with leftover index.lock files.

def checkout(self, gclient_config=None, revert=RevertOnTryserver, inject_parent_got_revision=True, extra_sync_flags=None, **kwargs):

Return a step generator function for gclient checkouts.

@staticmethod
def config_to_pythonish(cfg):

def diff_deps(self, cwd):

def get_config_defaults(self):

def get_gerrit_patch_root(self, gclient_config=None):

Returns local path to the repo where gerrit patch will be applied.

If there is no patch, returns None. If patch is specified, but such repo is not found among configured solutions or repo_path_map, returns name of the first solution. This is done solely for backward compatibility with existing tests. Please do not rely on this logic in new code. Instead, properly map a repository to a local path using repo_path_map. TODO(nodir): remove this. Update all recipe tests to specify a git_repo matching the recipe.

def get_repo_path(self, repo_url, gclient_config=None):

Returns local path to the repo checkout given its url.

Consults cfg.repo_path_map and fallbacks to urls in configured solutions.

Returns None if not found.

@staticmethod
def got_revision_reverse_mapping(cfg):

Returns the merged got_revision_reverse_mapping.

Returns (dict): A mapping from property name -> project name. It merges the values of the deprecated got_revision_mapping and the new got_revision_reverse_mapping.

def inject_parent_got_revision(self, gclient_config=None, override=False):

Match gclient config to build revisions obtained from build_properties.

Args: gclient_config (gclient config object) - The config to manipulate. A value of None manipulates the module's built-in config (self.c). override (bool) - If True, will forcibly set revision and custom_vars even if the config already contains values for them.

def resolve_revision(self, revision):

def runhooks(self, args=None, name=‘runhooks’, **kwargs):

def set_patch_repo_revision(self, gclient_config=None):

Updates config revision corresponding to patched project.

Useful for bot_update only, as this is the only consumer of gclient‘s config revision map. This doesn’t overwrite the revision if it was already set.

@spec_alias.deleter
def spec_alias(self):

def sync(self, cfg, extra_sync_flags=None, **kwargs):

@use_mirror.setter
def use_mirror(self, val):

recipe_modules / gerrit

DEPS: recipe_engine/context, recipe_engine/json, recipe_engine/path, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step

class GerritApi(RecipeApi):

Module for interact with Gerrit endpoints

def __call__(self, name, cmd, infra_step=True, **kwargs):

Wrapper for easy calling of gerrit_utils steps.

def abandon_change(self, host, change, message=None, name=None, step_test_data=None):

def create_gerrit_branch(self, host, project, branch, commit, **kwargs):

Creates a new branch from given project and commit

Returns: The ref of the branch created

def get_change_description(self, host, change, patchset, timeout=None, step_test_data=None):

Gets the description for a given CL and patchset.

Args: host: URL of Gerrit host to query. change: The change number. patchset: The patchset number.

Returns: The description corresponding to given CL and patchset.

def get_changes(self, host, query_params, start=None, limit=None, o_params=None, step_test_data=None, **kwargs):

Queries changes for the given host.

Args:

Returns: A list of change dicts as documented here: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#list-changes

def get_gerrit_branch(self, host, project, branch, **kwargs):

Gets a branch from given project and commit

Returns: The revision of the branch

def get_related_changes(self, host, change, revision=‘current’, step_test_data=None):

Queries related changes for a given host, change, and revision.

Args:

Returns: A related changes dictionary as documented here: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#related-changes-info

def get_revision_info(self, host, change, patchset, timeout=None, step_test_data=None):

Returns the info for a given patchset of a given change.

Args: host: Gerrit host to query. change: The change number. patchset: The patchset number.

Returns: A dict for the target revision as documented here: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#list-changes

def move_changes(self, host, project, from_branch, to_branch, step_test_data=None):

recipe_modules / git

DEPS: recipe_engine/buildbucket, recipe_engine/context, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/runtime, recipe_engine/step

class GitApi(RecipeApi):

def __call__(self, *args, **kwargs):

Returns a git command step.

def bundle_create(self, bundle_path, rev_list_args=None, **kwargs):

Runs ‘git bundle create’ on a Git repository.

Args:

  • bundle_path (Path): The path of the output bundle.
  • refs (list): The list of refs to include in the bundle. If None, all refs in the Git checkout will be bundled.
  • kwargs: Forwarded to ‘call’.

def cat_file_at_commit(self, file_path, commit_hash, remote_name=None, **kwargs):

Outputs the contents of a file at a given revision.

def checkout(self, url, ref=None, dir_path=None, recursive=False, submodules=True, submodule_update_force=False, keep_paths=None, step_suffix=None, curl_trace_file=None, can_fail_build=True, set_got_revision=False, remote_name=None, display_fetch_size=None, file_name=None, submodule_update_recursive=True, use_git_cache=False, progress=True, tags=False):

Performs a full git checkout and returns sha1 of checked out revision.

Args:

  • url (str): url of remote repo to use as upstream
  • ref (str): ref to fetch and check out
  • dir_path (Path): optional directory to clone into
  • recursive (bool): whether to recursively fetch submodules or not
  • submodules (bool): whether to sync and update submodules or not
  • submodule_update_force (bool): whether to update submodules with --force
  • keep_paths (iterable of strings): paths to ignore during git-clean; paths are gitignore-style patterns relative to checkout_path.
  • step_suffix (str): suffix to add to a each step name
  • curl_trace_file (Path): if not None, dump GIT_CURL_VERBOSE=1 trace to that file. Useful for debugging git issue reproducible only on bots. It has a side effect of all stderr output of ‘git fetch’ going to that file.
  • can_fail_build (bool): if False, ignore errors during fetch or checkout.
  • set_got_revision (bool): if True, resolves HEAD and sets got_revision property.
  • remote_name (str): name of the git remote to use
  • display_fetch_size (bool): if True, run git count-objects before and after fetch and display delta. Adds two more steps. Defaults to False.
  • file_name (str): optional path to a single file to checkout.
  • submodule_update_recursive (bool): if True, updates submodules recursively.
  • use_git_cache (bool): if True, git cache will be used for this checkout. WARNING, this is EXPERIMENTAL!!! This wasn't tested with:
    • submodules
    • since origin url is modified to a local path, may cause problem with scripts that do “git fetch origin” or “git push origin”.
    • arbitrary refs such refs/whatever/not-fetched-by-default-to-cache progress (bool): whether to show progress for fetch or not
  • tags (bool): Also fetch tags.

Returns: If the checkout was successful, this returns the commit hash of the checked-out-repo. Otherwise this returns None.

def config_get(self, prop_name, **kwargs):

Returns git config output.

Args:

  • prop_name: (str) The name of the config property to query.
  • kwargs: Forwarded to ‘call’.

Returns: (str) The Git config output, or None if no output was generated.

def count_objects(self, previous_result=None, can_fail_build=False, **kwargs):

Returns git count-objects result as a dict.

Args:

  • previous_result (dict): the result of previous count_objects call. If passed, delta is reported in the log and step text.
  • can_fail_build (bool): if True, may fail the build and/or raise an exception. Defaults to False.

Returns: A dict of count-object values, or None if count-object run failed.

def fetch_tags(self, remote_name=None, **kwargs):

Fetches all tags from the remote.

def get_remote_url(self, remote_name=None, **kwargs):

Returns the remote Git repository URL, or None.

Args:

  • remote_name: (str) The name of the remote to query, defaults to ‘origin’.
  • kwargs: Forwarded to ‘call’.

Returns: (str) The URL of the remote Git repository, or None.

def get_timestamp(self, commit=‘HEAD’, test_data=None, **kwargs):

Find and return the timestamp of the given commit.

def new_branch(self, branch, name=None, upstream=None, **kwargs):

Runs git new-branch on a Git repository, to be used before git cl upload.

Args:

  • branch (str): new branch name, which must not yet exist.
  • name (str): step name.
  • upstream (str): to origin/master.
  • kwargs: Forwarded to ‘call’.

def rebase(self, name_prefix, branch, dir_path, remote_name=None, **kwargs):

Runs rebase HEAD onto branch

Args:

  • name_prefix (str): a prefix used for the step names
  • branch (str): a branch name or a hash to rebase onto
  • dir_path (Path): directory to clone into
  • remote_name (str): the remote name to rebase from if not origin

recipe_modules / git_cl

DEPS: recipe_engine/context, recipe_engine/python, recipe_engine/raw_io

class GitClApi(RecipeApi):

def get_description(self, patch_url=None, **kwargs):

DEPRECATED. Consider using gerrit.get_change_description instead.

def issue(self, **kwargs):

def set_description(self, description, patch_url=None, **kwargs):

def upload(self, message, upload_args=None, **kwargs):

recipe_modules / gitiles

DEPS: recipe_engine/json, recipe_engine/path, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step, recipe_engine/url

class Gitiles(RecipeApi):

Module for polling a git repository using the Gitiles web interface.

def canonicalize_repo_url(self, repo_url):

Returns a canonical form of repo_url. If not recognized, returns as is.

def commit_log(self, url, commit, step_name=None, attempts=None):

Returns: (dict) the Gitiles commit log structure for a given commit.

Args:

  • url (str): The base repository URL.
  • commit (str): The commit hash.
  • step_name (str): If not None, override the step name.
  • attempts (int): Number of times to try the request before failing.

def download_archive(self, repository_url, destination, revision=‘refs/heads/master’):

Downloads an archive of the repo and extracts it to destination.

If the gitiles server attempts to provide a tarball with paths which escape destination, this function will extract all valid files and then raise StepFailure with an attribute StepFailure.gitiles_skipped_files containing the names of the files that were skipped.

Args:

  • repository_url (str): Full URL to the repository
  • destination (Path): Local path to extract the archive to. Must not exist prior to this call.
  • revision (str): The ref or revision in the repo to download. Defaults to ‘refs/heads/master’.

def download_file(self, repository_url, file_path, branch=‘master’, step_name=None, attempts=None, **kwargs):

Downloads raw file content from a Gitiles repository.

Args:

  • repository_url (str): Full URL to the repository.
  • branch (str): Branch of the repository.
  • file_path (str): Relative path to the file from the repository root.
  • step_name (str): Custom name for this step (optional).
  • attempts (int): Number of times to try the request before failing.

Returns: Raw file content.

def log(self, url, ref, limit=0, cursor=None, step_name=None, attempts=None, **kwargs):

Returns the most recent commits under the given ref with properties.

Args:

  • url (str): URL of the remote repository.
  • ref (str): Name of the desired ref (see Gitiles.refs).
  • limit (int): Number of commits to limit the fetching to. Gitiles does not return all commits in one call; instead paging is used. 0 implies to return whatever first gerrit responds with. Otherwise, paging will be used to fetch at least this many commits, but all fetched commits will be returned.
  • cursor (str or None): The paging cursor used to fetch the next page.
  • step_name (str): Custom name for this step (optional).

Returns: A tuple of (commits, cursor). Commits are a list of commits (as Gitiles dict structure) in reverse chronological order. The number of commits may be higher than limit argument. Cursor can be used for subsequent calls to log for paging. If None, signals that there are no more commits to fetch.

def parse_repo_url(self, repo_url):

Returns (host, project) pair.

Returns (None, None) if repo_url is not recognized.

def refs(self, url, step_name=‘refs’, attempts=None):

Returns a list of refs in the remote repository.

def unparse_repo_url(self, host, project):

Generates a Gitiles repo URL. See also parse_repo_url.

recipe_modules / gsutil

DEPS: recipe_engine/path, recipe_engine/python

class GSUtilApi(RecipeApi):

def __call__(self, cmd, name=None, use_retry_wrapper=True, version=None, parallel_upload=False, multithreaded=False, infra_step=True, **kwargs):

A step to run arbitrary gsutil commands.

On LUCI this should automatically use the ambient task account credentials. On Buildbot, this assumes that gsutil authentication environment variables (AWS_CREDENTIAL_FILE and BOTO_CONFIG) are already set, though if you want to set them to something else you can always do so using the env={} kwarg.

Note also that gsutil does its own wildcard processing, so wildcards are valid in file-like portions of the cmd. See ‘gsutil help wildcards’.

Args:

  • cmd (List[str|Path]) - Arguments to pass to gsutil. Include gsutil-level options first (see ‘gsutil help options’).
  • name (str) - Name of the step to use. Defaults to the first non-flag token in the cmd.

def cat(self, url, args=None, **kwargs):

def copy(self, source_bucket, source, dest_bucket, dest, args=None, link_name=‘gsutil.copy’, metadata=None, unauthenticated_url=False, **kwargs):

def download(self, bucket, source, dest, args=None, **kwargs):

def download_url(self, url, dest, args=None, **kwargs):

@property
def gsutil_py_path(self):

def list(self, url, args=None, **kwargs):

def remove_url(self, url, args=None, **kwargs):

def signurl(self, private_key_file, bucket, dest, args=None, **kwargs):

def stat(self, url, args=None, **kwargs):

def upload(self, source, bucket, dest, args=None, link_name=‘gsutil.upload’, metadata=None, unauthenticated_url=False, **kwargs):

recipe_modules / osx_sdk

DEPS: recipe_engine/cipd, recipe_engine/context, recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/step, recipe_engine/version

The osx_sdk module provides safe functions to access a semi-hermetic XCode installation.

Available only to Google-run bots.

class OSXSDKApi(RecipeApi):

API for using OS X SDK distributed via CIPD.

@contextmanager
def __call__(self, kind):

Sets up the XCode SDK environment.

Is a no-op on non-mac platforms.

This will deploy the helper tool and the XCode.app bundle at [START_DIR]/cache/osx_sdk.

To avoid machines rebuilding these on every run, set up a named cache in your cr-buildbucket.cfg file like:

caches: {
  # Cache for mac_toolchain tool and XCode.app
  name: "osx_sdk"
  path: "osx_sdk"
}

If you have builders which e.g. use a non-current SDK, you can give them a uniqely named cache:

caches: {
  # Cache for N-1 version mac_toolchain tool and XCode.app
  name: "osx_sdk_old"
  path: "osx_sdk"
}

Similarly, if you have mac and iOS builders you may want to distinguish the cache name by adding ‘_ios’ to it. However, if you're sharing the same bots for both mac and iOS, consider having a single cache and just always fetching the iOS version. This will lead to lower overall disk utilization and should help to reduce cache thrashing.

Usage: with api.osx_sdk(‘mac’): # sdk with mac build bits

with api.osx_sdk(‘ios’): # sdk with mac+iOS build bits

Args: kind (‘mac’|‘ios’): How the SDK should be configured. iOS includes the base XCode distribution, as well as the iOS simulators (which can be quite large).

Raises: StepFailure or InfraFailure.

def initialize(self):

recipe_modules / presubmit

DEPS: bot_update, depot_tools, gclient, git, tryserver, recipe_engine/context, recipe_engine/cq, recipe_engine/json, recipe_engine/path, recipe_engine/properties, recipe_engine/python, recipe_engine/resultdb, recipe_engine/step

class PresubmitApi(RecipeApi):

def __call__(self, *args, **kwargs):

Returns a presubmit step.

def execute(self, bot_update_step, skip_owners=False):

Runs presubmit and sets summary markdown if applicable.

Args:

  • bot_update_step: the StepResult from a previously executed bot_update step.
  • skip_owners: a boolean indicating whether Owners checks should be skipped.

Returns: a RawResult object, suitable for being returned from RunSteps.

def prepare(self):

Sets up a presubmit run.

This includes:

  • setting up the checkout w/ bot_update
  • locally committing the applied patch
  • running hooks, if requested

This expects the gclient configuration to already have been set.

Returns: the StepResult from the bot_update step.

@property
def presubmit_support_path(self):

recipe_modules / tryserver

DEPS: gerrit, git, git_cl, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step

class TryserverApi(RecipeApi):

@property
def constants(self):

@property
def gerrit_change(self):

Returns current gerrit change, if there is exactly one.

Returns a self.m.buildbucket.common_pb2.GerritChange or None.

@property
def gerrit_change_fetch_ref(self):

Returns gerrit patch ref, e.g. "refs/heads/45/12345/6, or None.

Populated iff gerrit_change is populated.

@property
def gerrit_change_number(self):

Returns gerrit change patchset, e.g. 12345 for a patch ref of “refs/heads/45/12345/6”.

Populated iff gerrit_change is populated. Returns None if not populated.

@property
def gerrit_change_owner(self):

Returns owner of the current Gerrit CL.

Populated iff gerrit_change is populated. Is a dictionary with keys like “name”.

@property
def gerrit_change_repo_url(self):

Returns canonical URL of the gitiles repo of the current Gerrit CL.

Populated iff gerrit_change is populated.

@property
def gerrit_change_target_ref(self):

Returns gerrit change destination ref, e.g. “refs/heads/master”.

Populated iff gerrit_change is populated.

@property
def gerrit_patchset_number(self):

Returns gerrit change patchset, e.g. 6 for a patch ref of “refs/heads/45/12345/6”.

Populated iff gerrit_change is populated Returns None if not populated..

def get_files_affected_by_patch(self, patch_root, report_files_via_property=None, **kwargs):

Returns list of paths to files affected by the patch.

Args:

  • patch_root: path relative to api.path[‘root’], usually obtained from api.gclient.get_gerrit_patch_root().
  • report_files_via_property: name of the output property to report the list of the files. If None (default), do not report.

Returned paths will be relative to to patch_root.

def get_footer(self, tag, patch_text=None):

Gets a specific tag from a CL description

def get_footers(self, patch_text=None):

Retrieves footers from the patch description.

footers are machine readable tags embedded in commit messages. See git-footers documentation for more information.

def initialize(self):

@property
def is_gerrit_issue(self):

Returns true iff the properties exist to match a Gerrit issue.

@property
def is_patch_in_git(self):

@property
def is_tryserver(self):

Returns true iff we have a change to check out.

def normalize_footer_name(self, footer):

def set_change(self, change):

Set the gerrit change for this module.

Args:

  • change: a self.m.buildbucket.common_pb2.GerritChange.

def set_compile_failure_tryjob_result(self):

Mark the tryjob result as a compile failure.

def set_invalid_test_results_tryjob_result(self):

Mark the tryjob result as having invalid test results.

This means we run some tests, but the results were not valid (e.g. no list of specific test cases that failed, or too many tests failing, etc).

def set_patch_failure_tryjob_result(self):

Mark the tryjob result as failure to apply the patch.

def set_subproject_tag(self, subproject_tag):

Adds a subproject tag to the build.

This can be used to distinguish between builds that execute different steps depending on what was patched, e.g. blink vs. pure chromium patches.

def set_test_expired_tryjob_result(self):

Mark the tryjob result as a test expiration.

This means a test task expired and was never scheduled, most likely due to lack of capacity.

def set_test_failure_tryjob_result(self):

Mark the tryjob result as a test failure.

This means we started running actual tests (not prerequisite steps like checkout or compile), and some of these tests have failed.

def set_test_timeout_tryjob_result(self):

Mark the tryjob result as a test timeout.

This means tests were scheduled but didn't finish executing within the timeout.

@property
def valid_footers(self):

recipe_modules / windows_sdk

DEPS: recipe_engine/cipd, recipe_engine/context, recipe_engine/json, recipe_engine/path, recipe_engine/step

The windows_sdk module provides safe functions to access a hermetic Microsoft Visual Studio installation.

Available only to Google-run bots.

class WindowsSDKApi(RecipeApi):

API for using Windows SDK distributed via CIPD.

@contextmanager
def __call__(self, path=None, version=None, enabled=True, target_arch=‘x64’):

Sets up the SDK environment when enabled.

Args:

  • path (path): Path to a directory where to install the SDK (default is ‘[CACHE]/windows_sdk’)
  • version (str): CIPD version of the SDK (default is set via $infra/windows_sdk.version property)
  • enabled (bool): Whether the SDK should be used or not.
  • target_arch (str): ‘x86’ or ‘x64’.

Yields: If enabled, yields SDKPaths object with paths to well-known roots within the deployed bundle: * win_sdk - a Path to the root of the extracted Windows SDK. * dia_sdk - a Path to the root of the extracted Debug Interface Access SDK.

Raises: StepFailure or InfraFailure.

Recipes

recipes / bot_update:examples/full

DEPS: bot_update, gclient, gerrit, tryserver, recipe_engine/buildbucket, recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/runtime

def RunSteps(api):

recipes / bot_update:tests/do_not_retry_patch_failures_in_cq

DEPS: bot_update, gclient, recipe_engine/buildbucket, recipe_engine/cq, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / bot_update:tests/ensure_checkout

DEPS: bot_update, gclient, recipe_engine/json

def RunSteps(api):

recipes / cipd:examples/full

DEPS: cipd, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/step

def RunSteps(api, use_pkg, pkg_files, pkg_dirs, ver_files, install_mode):

recipes / cipd:examples/platform_suffix

DEPS: cipd, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/step

def RunSteps(api, arch_override, bits_override, expect_error):

recipes / depot_tools:examples/full

DEPS: depot_tools, recipe_engine/path, recipe_engine/platform, recipe_engine/runtime, recipe_engine/step

def RunSteps(api):

recipes / fetch_end_to_end_test

DEPS: bot_update, gclient, recipe_engine/context, recipe_engine/file, recipe_engine/path, recipe_engine/python, recipe_engine/step

def RunSteps(api):

recipes / gclient:examples/full

DEPS: gclient, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/path, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / gclient:tests/diff_deps

DEPS: gclient, recipe_engine/assertions, recipe_engine/buildbucket, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/raw_io

def RunSteps(api):

recipes / gclient:tests/patch_project

DEPS: gclient, recipe_engine/buildbucket, recipe_engine/path, recipe_engine/properties

def RunSteps(api):

recipes / gclient:tests/sync_failure

DEPS: gclient, recipe_engine/path

def RunSteps(api):

recipes / gerrit:examples/full

DEPS: gerrit, recipe_engine/step

def RunSteps(api):

recipes / git:examples/full

DEPS: git, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/raw_io, recipe_engine/step

def RunSteps(api):

recipes / git_cl:examples/full

DEPS: git_cl, recipe_engine/path, recipe_engine/raw_io, recipe_engine/step

def RunSteps(api):

recipes / gitiles:examples/full

DEPS: gitiles, recipe_engine/json, recipe_engine/path, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / gitiles:tests/parse_repo_url

DEPS: gitiles, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / gsutil:examples/full

DEPS: gsutil, recipe_engine/path

def RunSteps(api):

Move things around in a loop!

recipes / osx_sdk:examples/full

DEPS: osx_sdk, recipe_engine/platform, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / presubmit:examples/full

DEPS: presubmit, recipe_engine/json

def RunSteps(api):

recipes / presubmit:tests/execute

DEPS: gclient, presubmit, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/cq, recipe_engine/json, recipe_engine/path, recipe_engine/properties, recipe_engine/runtime

def RunSteps(api):

recipes / presubmit:tests/prepare

DEPS: gclient, presubmit, recipe_engine/buildbucket, recipe_engine/context, recipe_engine/path, recipe_engine/properties, recipe_engine/runtime

def RunSteps(api, patch_project, patch_repository_url):

recipes / tryserver:examples/full

DEPS: gerrit, tryserver, recipe_engine/buildbucket, recipe_engine/json, recipe_engine/path, recipe_engine/platform, recipe_engine/properties, recipe_engine/python, recipe_engine/raw_io, recipe_engine/step

def RunSteps(api):

recipes / tryserver:tests/gerrit_change_fetch_ref_timeout

DEPS: gerrit, tryserver, recipe_engine/buildbucket, recipe_engine/properties

def RunSteps(api):

recipes / tryserver:tests/gerrit_change_owner

DEPS: gerrit, tryserver, recipe_engine/buildbucket

def RunSteps(api):

recipes / tryserver:tests/gerrit_change_target_ref

DEPS: gerrit, tryserver, recipe_engine/buildbucket, recipe_engine/properties, recipe_engine/step

def RunSteps(api):

recipes / windows_sdk:examples/full

DEPS: windows_sdk, recipe_engine/platform, recipe_engine/properties, recipe_engine/step

def RunSteps(api):