Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit 4d87d8e

Browse files
authored
Documentation for test timeouts. (#50687)
Support for test timeouts was added on the engine v2 recipes and this is documenting the new properties in build tests and global tests configurations. Bug: flutter/flutter#143021 [C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
1 parent e15947b commit 4d87d8e

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

ci/builders/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ configuration.
295295
"tests": [
296296
{
297297
"language": "python3",
298+
"test_timeout_secs": 600,
298299
"name": "Host Tests for host_debug_impeller_vulkan",
299300
"parameters": [
300301
"--variant",
@@ -316,6 +317,8 @@ In general any executable found in the path can be used as language. The
316317
default is empty which means no interpreter will be used to run the script
317318
and it is assumed the script is already an executable with the right
318319
permissions to run in the target platform.
320+
* **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the
321+
default 1 hour timeout. When debugging, or if a third-party program is known to misbehave, it is recommended to add timeouts to allow LUCI services to collect logs.
319322
* **name** - the name of the step running the script.
320323
* **parameters** - flags or parameters passed to the script. Parameters
321324
accept magic environment variables(placeholders replaced before executing
@@ -488,7 +491,8 @@ Engine test example:
488491
"--shard-variants=host_debug"
489492
],
490493
"max_attempts": 1,
491-
"script": "flutter/ci/clang_tidy.sh"
494+
"script": "flutter/ci/clang_tidy.sh",
495+
"test_timeout_secs": 600,
492496
}
493497
]
494498
}
@@ -535,6 +539,8 @@ The property's description is as follows:
535539
* **parameters** a list of parameters passed to the script execution.
536540
* **max_attempts** an integer with the maximum number of runs in case of failure.
537541
* **script** the path relative to checkout/src/ to run.
542+
* **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the
543+
default 1 hour timeout. When debugging, or if a third-party program is known to misbehave, it is recommended to add timeouts to allow LUCI services to collect logs.
538544

539545
### Global Generators
540546

0 commit comments

Comments
 (0)