[ot] scripts/opentitan: run-bazel-tests.sh: Add test timeout option

When testing a specific execution environment, you can set a maximum
test timeout to use for that environment.

For environments where tests are expected to be quick this can be used
to decrease CI times (tests using unimplemented features may timeout, so
this provides a smaller upper bound on test execution). For environments
where tests may take a while when executed in parallel on a standard
GitHub runner (maybe longer than 60 seconds), this can be used to
increase the timeout for just executions in that environment.

Signed-off-by: Alex Jones <[email protected]>

Author: AlexJones0

.github/workflows/eg_regression.yml

@@ -14,6 +14,10 @@ on:
         required: true
         default: qemu  # Default tag, captures all QEMU exec envs in OpenTitan
         type: string
+      test_timeout:
+        description: The maximum timeout in seconds to use per executed test
+        required: false
+        type: string
       opentitan_repo:
         description: OpenTitan repository to be checked out
         required: true
@@ -62,6 +66,7 @@ jobs:
           set -o pipefail
           ./qemu/scripts/opentitan/run-bazel-tests.sh ./ qemu \
             ${{ inputs.exec_env }} \
+            ${{ inputs.test_timeout }} \
             | tee ${{ inputs.exec_env }}_test_results.txt
 
       - name: Upload Bazel test results

docs/opentitan/regressions.md

@@ -8,7 +8,7 @@ With a checkout of OpenTitan, the script can be run like this:
 
 ```sh
 ./scripts/opentitan/run-bazel-tests.sh path/to/opentitan path/to/qemu \
-    [execution_environment]
+    [execution_environment] [timeout]
 ```
 
 The script will execute all QEMU-compatible tests using QEMU as it was built
@@ -33,4 +33,6 @@ Specifying an execution environment when running the script will restrict to
 only running and comparing against tests for that execution environment.
 This can be used for more granular testing to break down large test workloads.
 If you do not specify an execution environment, _all_ available QEMU tests
-will be executed.
+will be executed. When specifying an execution environment, a maximum test
+timeout (in seconds) to use for that environment can also be provided as
+a subsequent argument to the script.

scripts/opentitan/run-bazel-tests.sh

@@ -7,7 +7,7 @@ set -e
 # comparing the results with a list of expected passes.
 #
 # USAGE: run-bazel-tests.sh path/to/opentitan/repo path/to/qemu/repo \
-#            [execution environment]
+#            [execution environment] [test_timeout]
 #
 # There is a companion file `tests/opentitan/data/earlgrey-tests.txt` that
 # is read by this script.
@@ -29,13 +29,14 @@ GITHUB_STEP_SUMMARY="${GITHUB_STEP_SUMMARY:-/dev/null}"
 opentitan_path="$1"
 qemu_path="$2"
 qemu_exec_env="$3"
+test_timeout="$4"
 if [ ! -d "$opentitan_path" ] || [ ! -d "$qemu_path" ]; then
-  echo "USAGE: ${0} <OPENTITAN REPO> <QEMU REPO> [<EXEC ENV>]"
+  echo "USAGE: ${0} <OPENTITAN REPO> <QEMU REPO> [<EXEC ENV>] [<TIMEOUT>]"
   exit 1
 fi
 opentitan_path="$(realpath "$opentitan_path")"
 qemu_path="$(realpath "$qemu_path")"
-if [ ! "$qemu_exec_env" ]; then
+if [ -z "$qemu_exec_env" ]; then
   # catch-all tag for all QEMU exec envs
   qemu_exec_env="qemu"
   echo "Using default 'qemu' tag to test all exec envs"
@@ -86,12 +87,18 @@ trap "cleanup" EXIT
 ## RUN BAZEL TESTS
 cd "$opentitan_path" >/dev/null
 
+test_args=""
+if [ -n "$test_timeout" ]; then
+  test_args="--test_timeout=$test_timeout"
+fi
+
 ./bazelisk.sh test //...                                    \
   --test_tag_filters="$qemu_exec_env"                       \
   --test_summary="short"                                    \
   --test_output=all                                         \
   --override_repository="+qemu+qemu_opentitan=${qemu_path}" \
   --build_tests_only                                        \
+  $test_args                                                \
   | tee "$results"
 
 ## COMPARE RESULTS