feat: add tunnel-timeout flag (#8)

saucelabs · Apr 2, 2024 · 1d72225 · 1d72225
1 parent 0ea0a5a
commit 1d72225
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -8,32 +8,34 @@ It can be used as a command, or as a job.\
 Both are called `saucectl-run`.
 
 > You need to have set the following environment variables to be able to run saucectl:
+>
 > - SAUCE_USERNAME
 > - SAUCE_ACCESS_KEY
 
 Alternatively, you can use the `sauce-username` and `sauce-access-key` parameters of the orb.
 
 ## Parameters
 
-| Parameter name | Description | Default value |
-| --- | --- | --- |
-| sauce-username | Sauce Username to use for authentification | |
-| sauce-access-key | Sauce Access Key to use for authentification | |
-| saucectl-version | Version of saucectl to use. Example: v0.68.2 | `latest` |
-| config-file | Configuration file to use with saucectl | `.sauce/config.yml` |
-| working-directory | Working directory to use when running saucectl | `.` | 
-| region | Region to pass to saucectl | |
-| select-suite | Run a particular suite instead of all | |
-| show-console-log | Show console log when suite succeed | `false` |
-| env | Environment variable to pass to saucectl | |
-| sauceignore | Sauceignore file to be used | |
-| timeout | Test timeout in seconds | |
-| tunnel-name | Sets the sauce-connect tunnel name to be used for the run | |
-| tunnel-owner | Sets the sauce-connect tunnel owner to be used for the run | |
-| ccy | Sets the concurrency to be used for the run | |
-| retries | Sets the number of retries to do for the run | |
-| test-env-silent | Skips the test environment announcement | `false` |
-| async | Launches tests without awaiting outcomes; operates in a fire-and-forget manner | `false` |
+| Parameter name    | Description                                                                    | Default value       |
+| ----------------- | ------------------------------------------------------------------------------ | ------------------- |
+| sauce-username    | Sauce Username to use for authentification                                     |                     |
+| sauce-access-key  | Sauce Access Key to use for authentification                                   |                     |
+| saucectl-version  | Version of saucectl to use. Example: v0.68.2                                   | `latest`            |
+| config-file       | Configuration file to use with saucectl                                        | `.sauce/config.yml` |
+| working-directory | Working directory to use when running saucectl                                 | `.`                 |
+| region            | Region to pass to saucectl                                                     |                     |
+| select-suite      | Run a particular suite instead of all                                          |                     |
+| show-console-log  | Show console log when suite succeed                                            | `false`             |
+| env               | Environment variable to pass to saucectl                                       |                     |
+| sauceignore       | Sauceignore file to be used                                                    |                     |
+| timeout           | Test timeout in seconds                                                        |                     |
+| tunnel-name       | Sets the sauce-connect tunnel name to be used for the run                      |                     |
+| tunnel-owner      | Sets the sauce-connect tunnel owner to be used for the run                     |                     |
+| tunnel-timeout    | How long to wait for the specified tunnel to be ready                          |                     |
+| ccy               | Sets the concurrency to be used for the run                                    |                     |
+| retries           | Sets the number of retries to do for the run                                   |                     |
+| test-env-silent   | Skips the test environment announcement                                        | `false`             |
+| async             | Launches tests without awaiting outcomes; operates in a fire-and-forget manner | `false`             |
 
 ## Example
 

diff --git a/src/commands/saucectl-run.yml b/src/commands/saucectl-run.yml
@@ -40,7 +40,7 @@ parameters:
     default: false
   env:
     type: string
-    description:  Environment variables to pass to saucectl.
+    description: Environment variables to pass to saucectl.
     default: ""
   sauceignore:
     type: string
@@ -58,6 +58,10 @@ parameters:
     type: string
     description: Sets the sauce-connect tunnel parent to be used for the run.
     default: ""
+  tunnel-timeout:
+    type: string
+    description: How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc.
+    default: ""
   ccy:
     type: string
     description: Sets the concurrency to be used for the run.
@@ -91,6 +95,7 @@ steps:
         PARAM_TIMEOUT: <<parameters.timeout>>
         PARAM_TUNNEL_NAME: <<parameters.tunnel-name>>
         PARAM_TUNNEL_OWNER: <<parameters.tunnel-owner>>
+        PARAM_TUNNEL_TIMEOUT: <<parameters.tunnel-timeout>>
         PARAM_CCY: <<parameters.ccy>>
         PARAM_RETRIES: <<parameters.retries>>
         PARAM_TEST_ENV_SILENT: <<parameters.test-env-silent>>

diff --git a/src/scripts/saucectl-run.sh b/src/scripts/saucectl-run.sh
@@ -15,7 +15,7 @@ install() {
 
     platform=${platforms[$src_platform]}
     arch=${archs[$src_arch]}
-    
+
     # Check value
     if [ -z "${platform}" ] || [ -z "${arch}" ]; then
         echo "Unexpected platform (${src_platform} / ${platform}) or arch (${src_arch} / ${arch})"
@@ -102,6 +102,10 @@ parse_args() {
         ARGS+=("--tunnel-owner" "${PARAM_TUNNEL_OWNER}")
     fi
 
+    if [ -n "${PARAM_TUNNEL_TIMEOUT}" ];then
+        ARGS+=("--tunnel-timeout" "${PARAM_TUNNEL_TIMEOUT}")
+    fi
+
     if [ -n "${PARAM_CCY}" ];then
         ARGS+=("--ccy" "${PARAM_CCY}")
     fi