InTheForest/chromium_depot_tools
1
0
Fork 0
mirror of https://chromium.googlesource.com/chromium/tools/depot_tools.git synced 2026-01-11 10:41:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update typing/documentation for bot_update's test API output_json method

Browse Source 
This change adds some additional type annotations to remove typing
errors surfaced in the output_json method of the bot_update test API and
adds documentation for the parameters.

Change-Id: I4aa3edae665016cd1d1394e9294f20a15b8f7e1c
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/tools/depot_tools/+/7142477
Auto-Submit: Garrett Beaty <gbeaty@google.com>
Reviewed-by: Yiwei Zhang <yiwzhang@google.com>
Commit-Queue: Yiwei Zhang <yiwzhang@google.com>
This commit is contained in:
Garrett Beaty
2025-11-11 21:20:43 -08:00
committed by LUCI CQ
parent 4f279935d6
commit 372c58b852
1 changed files with 39 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
recipes/recipe_modules/bot_update/test_api.py
View File

@@ -2,6 +2,7 @@
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import collections.abc
import hashlib
import struct
import typing
@@ -26,24 +27,50 @@ class BotUpdateTestApi(recipe_test_api.RecipeTestApi):
def commit_positions(val: bool):
return val
def output_json(self,
first_sln,
revision_mapping,
*,
patch_root=None,
fixed_revisions=None,
fail_checkout: bool = False,
fail_patch: bool | typing.Literal['download'] = False,
commit_positions: bool = True):
"""Deterministically synthesize json.output test data for gclient's
--output-json option.
def output_json(
self,
first_sln: str,
revision_mapping: collections.abc.Mapping[str, str],
*,
patch_root: str | None = None,
fixed_revisions: collections.abc.Mapping[str, str] | None = None,
fail_checkout: bool = False,
fail_patch: bool | typing.Literal['download'] = False,
commit_positions: bool = True,
):
"""Synthesized json output for bot_update.py.
Args:
first_sln: The name of the first solution in the gclient config.
revision_mapping: A mapping from property name to project
name/checkout-relative repo path. The resultant json will have
the given property set to the revision of that project.
patch_root: The relative path within the checkout to where the
patch should be applied.
fixed_revisions: A mapping from project name/checkout-relative
repo path to the revisions to be used for the project. The
revisions can be either refs or commit hashes. The manifests in
the resultant json will have refs replaced with generated
revision values. The provided revisions will be reported as-is
in the fixed_revisions of the resultant json.
fail_checkout: Whether or not the simulated checkout should fail.
fail_patch: Whether or not the checkout should fail to apply the
patch. A value of 'download' can be provided to indicate a
failure to download the patch.
commit_positions: Whether or not to generate commit position
properties when generating revision properties. If true, any
project that has a revision property generated will have another
property generated with the same name with _cp appended with a
commit position as the value.
"""
t = recipe_test_api.StepTestData()
output = {
output: dict[str, typing.Any] = {
'did_run': True,
}
fixed_revisions = fixed_revisions or {}
if fail_checkout:
t.retcode = 1
else: