From 0b266b327311745be07db7864c2a40001fca16a2 Mon Sep 17 00:00:00 2001 From: Godofredo Contreras Date: Thu, 15 Feb 2024 07:53:12 -0800 Subject: [PATCH 1/2] Documentation for test timeouts. 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: https://github.com/flutter/flutter/issues/143021 --- ci/builders/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/ci/builders/README.md b/ci/builders/README.md index 335271ce77150..b7a2b5a4a8ed0 100644 --- a/ci/builders/README.md +++ b/ci/builders/README.md @@ -295,6 +295,7 @@ configuration. "tests": [ { "language": "python3", + "test_timeout_secs": 600, "name": "Host Tests for host_debug_impeller_vulkan", "parameters": [ "--variant", @@ -316,6 +317,8 @@ In general any executable found in the path can be used as language. The default is empty which means no interpreter will be used to run the script and it is assumed the script is already an executable with the right permissions to run in the target platform. +* **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the +default 1 hour timeout. It is recommended to add timeouts to tests leaking processes to allow LUCI services to collect logs. * **name** - the name of the step running the script. * **parameters** - flags or parameters passed to the script. Parameters accept magic environment variables(placeholders replaced before executing @@ -488,7 +491,8 @@ Engine test example: "--shard-variants=host_debug" ], "max_attempts": 1, - "script": "flutter/ci/clang_tidy.sh" + "script": "flutter/ci/clang_tidy.sh", + "test_timeout_secs": 600, } ] } @@ -535,6 +539,8 @@ The property's description is as follows: * **parameters** a list of parameters passed to the script execution. * **max_attempts** an integer with the maximum number of runs in case of failure. * **script** the path relative to checkout/src/ to run. +* **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the +default 1 hour timeout. It is recommended to add timeouts to tests leaking processes to allow LUCI services to collect logs. ### Global Generators From 211d39ddd9c5b777f4d12bfba396be657e51f151 Mon Sep 17 00:00:00 2001 From: Godofredo Contreras Date: Thu, 15 Feb 2024 10:27:46 -0800 Subject: [PATCH 2/2] Update docs. --- ci/builders/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ci/builders/README.md b/ci/builders/README.md index b7a2b5a4a8ed0..a1c532f427872 100644 --- a/ci/builders/README.md +++ b/ci/builders/README.md @@ -318,7 +318,7 @@ default is empty which means no interpreter will be used to run the script and it is assumed the script is already an executable with the right permissions to run in the target platform. * **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the -default 1 hour timeout. It is recommended to add timeouts to tests leaking processes to allow LUCI services to collect logs. +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. * **name** - the name of the step running the script. * **parameters** - flags or parameters passed to the script. Parameters accept magic environment variables(placeholders replaced before executing @@ -540,7 +540,7 @@ The property's description is as follows: * **max_attempts** an integer with the maximum number of runs in case of failure. * **script** the path relative to checkout/src/ to run. * **test_timeout_secs** - the timeout in seconds for the step running the test. This value overrides the -default 1 hour timeout. It is recommended to add timeouts to tests leaking processes to allow LUCI services to collect logs. +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. ### Global Generators