[buildbucket] Add exe_cipd_version param
Add exe_cipd_version parameter to api.buildbucket.schedule_request
R=iannucci@chromium.org
Bug: 942767
Change-Id: I013807976af5d0cf1dbc9ab08ac5665412e41e8a
Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/1688470
Commit-Queue: Nodir Turakulov <nodir@chromium.org>
Reviewed-by: Robbie Iannucci <iannucci@chromium.org>
Reviewed-by: Michael Moss <mmoss@chromium.org>
Auto-Submit: Nodir Turakulov <nodir@chromium.org>
(cherry picked from commit e2f09162f4902d4ce8cc02cbb54e1deec1511e7d)
Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/1756214
Reviewed-by: Nodir Turakulov <nodir@chromium.org>
diff --git a/README.recipes.md b/README.recipes.md
index 402becc..f55c6c6 100644
--- a/README.recipes.md
+++ b/README.recipes.md
@@ -249,7 +249,7 @@
A module for interacting with buildbucket.
-  **@property**<br>— **def [bucket\_v1](/recipe_modules/buildbucket/api.py#833)(self):**
+  **@property**<br>— **def [bucket\_v1](/recipe_modules/buildbucket/api.py#838)(self):**
Returns bucket name in v1 format.
@@ -272,11 +272,11 @@
the rules described in the .proto files.
If the current build is not a buildbucket build, returned `build.id` is 0.
-  **@property**<br>— **def [build\_id](/recipe_modules/buildbucket/api.py#849)(self):**
+  **@property**<br>— **def [build\_id](/recipe_modules/buildbucket/api.py#854)(self):**
DEPRECATED, use build.id instead.
-  **@property**<br>— **def [build\_input](/recipe_modules/buildbucket/api.py#854)(self):**
+  **@property**<br>— **def [build\_input](/recipe_modules/buildbucket/api.py#859)(self):**
DEPRECATED, use build.input instead.
@@ -293,7 +293,7 @@
See "Builder cache" in
https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/project_config.proto
-  **@property**<br>— **def [builder\_id](/recipe_modules/buildbucket/api.py#859)(self):**
+  **@property**<br>— **def [builder\_id](/recipe_modules/buildbucket/api.py#864)(self):**
Deprecated. Use build.builder instead.
@@ -301,9 +301,9 @@
Returns builder name. Shortcut for `.build.builder.builder`.
-— **def [cancel\_build](/recipe_modules/buildbucket/api.py#601)(self, build_id, \*\*kwargs):**
+— **def [cancel\_build](/recipe_modules/buildbucket/api.py#606)(self, build_id, \*\*kwargs):**
-— **def [collect\_build](/recipe_modules/buildbucket/api.py#660)(self, build_id, mirror_status=False, \*\*kwargs):**
+— **def [collect\_build](/recipe_modules/buildbucket/api.py#665)(self, build_id, mirror_status=False, \*\*kwargs):**
Shorthand for `collect_builds` below, but for a single build only.
@@ -315,7 +315,7 @@
[Build](https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto).
for the ended build.
-— **def [collect\_builds](/recipe_modules/buildbucket/api.py#680)(self, build_ids, interval=None, timeout=None, step_name=None, raise_if_unsuccessful=False):**
+— **def [collect\_builds](/recipe_modules/buildbucket/api.py#685)(self, build_ids, interval=None, timeout=None, step_name=None, raise_if_unsuccessful=False):**
Waits for a set of builds to end and returns their details.
@@ -333,7 +333,7 @@
[Build](https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto)
for all specified builds.
-— **def [get](/recipe_modules/buildbucket/api.py#639)(self, build_id, url_title_fn=None, step_name=None):**
+— **def [get](/recipe_modules/buildbucket/api.py#644)(self, build_id, url_title_fn=None, step_name=None):**
Gets a build.
@@ -345,11 +345,11 @@
Returns:
A build_pb2.Build.
-— **def [get\_build](/recipe_modules/buildbucket/api.py#656)(self, build_id, \*\*kwargs):**
+— **def [get\_build](/recipe_modules/buildbucket/api.py#661)(self, build_id, \*\*kwargs):**
DEPRECATED. Use get().
-— **def [get\_multi](/recipe_modules/buildbucket/api.py#604)(self, build_ids, url_title_fn=None, step_name=None):**
+— **def [get\_multi](/recipe_modules/buildbucket/api.py#609)(self, build_ids, url_title_fn=None, step_name=None):**
Gets multiple builds.
@@ -377,11 +377,11 @@
Returns True if the build is critical. Build defaults to the current one.
-  **@property**<br>— **def [properties](/recipe_modules/buildbucket/api.py#844)(self):**
+  **@property**<br>— **def [properties](/recipe_modules/buildbucket/api.py#849)(self):**
DEPRECATED, use build attribute instead.
-— **def [put](/recipe_modules/buildbucket/api.py#505)(self, builds, \*\*kwargs):**
+— **def [put](/recipe_modules/buildbucket/api.py#510)(self, builds, \*\*kwargs):**
Puts a batch of builds.
@@ -417,7 +417,7 @@
[Builds](https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto)
in the same order as schedule_build_requests.
-— **def [schedule](/recipe_modules/buildbucket/api.py#429)(self, schedule_build_requests, url_title_fn=None, step_name=None):**
+— **def [schedule](/recipe_modules/buildbucket/api.py#434)(self, schedule_build_requests, url_title_fn=None, step_name=None):**
Schedules a batch of builds.
@@ -446,7 +446,7 @@
Raises:
`InfraFailure` if any of the requests fail.
-— **def [schedule\_request](/recipe_modules/buildbucket/api.py#298)(self, builder, project=None, bucket=None, properties=None, experimental=None, gitiles_commit=None, gerrit_changes=None, tags=None, inherit_buildsets=True, dimensions=None, priority=None, critical=None):**
+— **def [schedule\_request](/recipe_modules/buildbucket/api.py#298)(self, builder, project=None, bucket=None, properties=None, experimental=None, gitiles_commit=None, gerrit_changes=None, tags=None, inherit_buildsets=True, dimensions=None, priority=None, critical=None, exe_cipd_version=None):**
Creates a new `ScheduleBuildRequest` message with reasonable defaults.
@@ -495,8 +495,10 @@
Defaults to .build.critical.
See also Build.critical in
https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto
+* exe_cipd_version: CIPD version of the LUCI Executable (e.g. recipe) to use
+ instead of the server-configured one.
-— **def [search](/recipe_modules/buildbucket/api.py#540)(self, predicate, limit=None, url_title_fn=None, step_name=None):**
+— **def [search](/recipe_modules/buildbucket/api.py#545)(self, predicate, limit=None, url_title_fn=None, step_name=None):**
Searches for builds.
diff --git a/recipe_modules/buildbucket/api.py b/recipe_modules/buildbucket/api.py
index 7928ac2..8b135f4 100644
--- a/recipe_modules/buildbucket/api.py
+++ b/recipe_modules/buildbucket/api.py
@@ -309,6 +309,7 @@
dimensions=None,
priority=None,
critical=None,
+ exe_cipd_version=None,
):
"""Creates a new `ScheduleBuildRequest` message with reasonable defaults.
@@ -357,6 +358,8 @@
Defaults to .build.critical.
See also Build.critical in
https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto
+ * exe_cipd_version: CIPD version of the LUCI Executable (e.g. recipe) to use
+ instead of the server-configured one.
"""
@@ -387,6 +390,8 @@
experimental=b.input.experimental,
critical=b.critical,
)
+ if exe_cipd_version:
+ req.exe.cipd_version = exe_cipd_version
req.properties.update(properties or {})
if experimental is not None:
diff --git a/recipe_modules/buildbucket/tests/schedule.expected/exe_cipd_version.json b/recipe_modules/buildbucket/tests/schedule.expected/exe_cipd_version.json
new file mode 100644
index 0000000..834cce7
--- /dev/null
+++ b/recipe_modules/buildbucket/tests/schedule.expected/exe_cipd_version.json
@@ -0,0 +1,181 @@
+[
+ {
+ "cmd": [
+ "bb",
+ "batch",
+ "-host",
+ "cr-buildbucket.appspot.com"
+ ],
+ "infra_step": true,
+ "name": "buildbucket.schedule",
+ "stdin": "{\"requests\": [{\"scheduleBuild\": {\"builder\": {\"bucket\": \"try\", \"builder\": \"linux\", \"project\": \"chromium\"}, \"exe\": {\"cipdVersion\": \"some_ver\"}, \"gerritChanges\": [{\"change\": \"123456\", \"host\": \"chromium-review.googlesource.com\", \"patchset\": \"7\", \"project\": \"chromium/src\"}], \"gitilesCommit\": {\"host\": \"chromium.googlesource.com\", \"id\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"project\": \"chromium/src\"}, \"requestId\": \"8945511751514863184-00000000-0000-0000-0000-000000001337\", \"tags\": [{\"key\": \"buildset\", \"value\": \"bs\"}, {\"key\": \"user_agent\", \"value\": \"recipe\"}]}}]}",
+ "~followup_annotations": [
+ "@@@STEP_LOG_LINE@json.output@{@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"responses\": [@@@",
+ "@@@STEP_LOG_LINE@json.output@ {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"scheduleBuild\": {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"builder\": {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"bucket\": \"try\", @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"builder\": \"linux\", @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"project\": \"chromium\"@@@",
+ "@@@STEP_LOG_LINE@json.output@ }, @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"id\": \"8922054662172514000\"@@@",
+ "@@@STEP_LOG_LINE@json.output@ }@@@",
+ "@@@STEP_LOG_LINE@json.output@ }@@@",
+ "@@@STEP_LOG_LINE@json.output@ ]@@@",
+ "@@@STEP_LOG_LINE@json.output@}@@@",
+ "@@@STEP_LOG_END@json.output@@@",
+ "@@@STEP_LOG_LINE@request@{@@@",
+ "@@@STEP_LOG_LINE@request@ \"requests\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"scheduleBuild\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"builder\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"bucket\": \"try\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"builder\": \"linux\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"exe\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"cipdVersion\": \"some_ver\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"gerritChanges\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"change\": \"123456\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"host\": \"chromium-review.googlesource.com\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"patchset\": \"7\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium/src\"@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ], @@@",
+ "@@@STEP_LOG_LINE@request@ \"gitilesCommit\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"host\": \"chromium.googlesource.com\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"id\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium/src\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"requestId\": \"8945511751514863184-00000000-0000-0000-0000-000000001337\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"tags\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"key\": \"buildset\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"value\": \"bs\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"key\": \"user_agent\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"value\": \"recipe\"@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ]@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ]@@@",
+ "@@@STEP_LOG_LINE@request@}@@@",
+ "@@@STEP_LOG_END@request@@@",
+ "@@@STEP_LINK@8922054662172514000@https://cr-buildbucket.appspot.com/build/8922054662172514000@@@"
+ ]
+ },
+ {
+ "cmd": [],
+ "name": "buildbucket.run"
+ },
+ {
+ "cmd": [
+ "bb",
+ "batch",
+ "-host",
+ "cr-buildbucket.appspot.com"
+ ],
+ "infra_step": true,
+ "name": "buildbucket.run.schedule",
+ "stdin": "{\"requests\": [{\"scheduleBuild\": {\"builder\": {\"bucket\": \"try\", \"builder\": \"linux\", \"project\": \"chromium\"}, \"exe\": {\"cipdVersion\": \"some_ver\"}, \"gerritChanges\": [{\"change\": \"123456\", \"host\": \"chromium-review.googlesource.com\", \"patchset\": \"7\", \"project\": \"chromium/src\"}], \"gitilesCommit\": {\"host\": \"chromium.googlesource.com\", \"id\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", \"project\": \"chromium/src\"}, \"requestId\": \"8945511751514863184-00000000-0000-0000-0000-000000001337\", \"tags\": [{\"key\": \"buildset\", \"value\": \"bs\"}, {\"key\": \"user_agent\", \"value\": \"recipe\"}]}}]}",
+ "~followup_annotations": [
+ "@@@STEP_NEST_LEVEL@1@@@",
+ "@@@STEP_LOG_LINE@json.output@{@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"responses\": [@@@",
+ "@@@STEP_LOG_LINE@json.output@ {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"scheduleBuild\": {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"builder\": {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"bucket\": \"try\", @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"builder\": \"linux\", @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"project\": \"chromium\"@@@",
+ "@@@STEP_LOG_LINE@json.output@ }, @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"id\": \"8922054662172514001\"@@@",
+ "@@@STEP_LOG_LINE@json.output@ }@@@",
+ "@@@STEP_LOG_LINE@json.output@ }@@@",
+ "@@@STEP_LOG_LINE@json.output@ ]@@@",
+ "@@@STEP_LOG_LINE@json.output@}@@@",
+ "@@@STEP_LOG_END@json.output@@@",
+ "@@@STEP_LOG_LINE@request@{@@@",
+ "@@@STEP_LOG_LINE@request@ \"requests\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"scheduleBuild\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"builder\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"bucket\": \"try\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"builder\": \"linux\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"exe\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"cipdVersion\": \"some_ver\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"gerritChanges\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"change\": \"123456\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"host\": \"chromium-review.googlesource.com\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"patchset\": \"7\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium/src\"@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ], @@@",
+ "@@@STEP_LOG_LINE@request@ \"gitilesCommit\": {@@@",
+ "@@@STEP_LOG_LINE@request@ \"host\": \"chromium.googlesource.com\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"id\": \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"project\": \"chromium/src\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ \"requestId\": \"8945511751514863184-00000000-0000-0000-0000-000000001337\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"tags\": [@@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"key\": \"buildset\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"value\": \"bs\"@@@",
+ "@@@STEP_LOG_LINE@request@ }, @@@",
+ "@@@STEP_LOG_LINE@request@ {@@@",
+ "@@@STEP_LOG_LINE@request@ \"key\": \"user_agent\", @@@",
+ "@@@STEP_LOG_LINE@request@ \"value\": \"recipe\"@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ]@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ }@@@",
+ "@@@STEP_LOG_LINE@request@ ]@@@",
+ "@@@STEP_LOG_LINE@request@}@@@",
+ "@@@STEP_LOG_END@request@@@",
+ "@@@STEP_LINK@8922054662172514001@https://cr-buildbucket.appspot.com/build/8922054662172514001@@@"
+ ]
+ },
+ {
+ "cmd": [
+ "buildbucket",
+ "collect",
+ "-host",
+ "cr-buildbucket.appspot.com",
+ "-json-output",
+ "/path/to/tmp/json",
+ "-interval",
+ "60s",
+ "8922054662172514001"
+ ],
+ "infra_step": true,
+ "name": "buildbucket.run.collect",
+ "timeout": 3600,
+ "~followup_annotations": [
+ "@@@STEP_NEST_LEVEL@1@@@",
+ "@@@STEP_LOG_LINE@json.output@[@@@",
+ "@@@STEP_LOG_LINE@json.output@ {@@@",
+ "@@@STEP_LOG_LINE@json.output@ \"id\": \"8922054662172514001\", @@@",
+ "@@@STEP_LOG_LINE@json.output@ \"status\": \"SUCCESS\"@@@",
+ "@@@STEP_LOG_LINE@json.output@ }@@@",
+ "@@@STEP_LOG_LINE@json.output@]@@@",
+ "@@@STEP_LOG_END@json.output@@@"
+ ]
+ },
+ {
+ "cmd": [],
+ "name": "run nothing"
+ },
+ {
+ "jsonResult": null,
+ "name": "$result"
+ }
+]
\ No newline at end of file
diff --git a/recipe_modules/buildbucket/tests/schedule.py b/recipe_modules/buildbucket/tests/schedule.py
index 9344957..59abb3c 100644
--- a/recipe_modules/buildbucket/tests/schedule.py
+++ b/recipe_modules/buildbucket/tests/schedule.py
@@ -48,6 +48,8 @@
yield test('basic')
+ yield test('exe_cipd_version', exe_cipd_version='some_ver')
+
yield test(
test_name='tags',
tags={'a': 'b'}
