Add wait_for_boot option

Refs #449
futureware-tech · Oct 23, 2024 · fc6e8be · fc6e8be
1 parent 9f1c121
commit fc6e8be
Show file tree

Hide file tree

Showing 8 changed files with 124 additions and 853 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## unreleased
+
+- Add a `wait_for_boot` option (default false, preserving current behavior) to
+  wait for Simulator to finish booting the requested image before continuing.
+
 ## v3
 
 - Breaking: change the default simulator from "model = iPhone 8" to "os = iOS",

diff --git a/README.md b/README.md
@@ -42,7 +42,8 @@ a device with Apple Developer account, because a Simulator UDID
 | `os`                 | `iOS`, `tvOS`, `watchOS` | OS type of the device                                                                                                              |
 | `os_version`         | `>=14.0`                 | OS version specification in semver format                                                                                          |
 | `udid`               | `ABCD-EFGH`              | Specific UDID you'd like to launch                                                                                                 |
-| `erase_before_boot`  | `true`                   | Whether the data should be erased from device before boot. Starting for a clean state helps getting a stable environment for tests |
+| `erase_before_boot`  | `true`                   | Whether the data should be erased from device before boot. Starting from a clean state helps getting a stable environment for tests |
+| `wait_for_boot`      | `false`                  | Whether the action must wait for the Simulator to finish booting requested image                                                  |
 | `shutdown_after_job` | `true`                   | Whether to shutdown the launched Simulator after the workflow job has been finished                                                |
 
 ## Outputs

diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts
@@ -14,6 +14,11 @@ test('boots a device', () => {
     cp.execFileSync(nodeProcess, [actionMain], options).toString()
   ).toContain('Booting device')
 
+  process.env['INPUT_WAIT_FOR_BOOT'] = 'true'
+  expect(
+    cp.execFileSync(nodeProcess, [actionMain], options).toString()
+  ).toContain('Waiting for device to finish booting')
+
   process.env['INPUT_MODEL'] = 'Pixel 4'
   expect(() => cp.execFileSync(nodeProcess, [actionMain], options)).toThrow()
 })
diff --git a/action.yml b/action.yml
@@ -23,6 +23,12 @@ inputs:
     description: Whether the Simulator data should be erased before booting
     required: true
     default: 'true'
+  wait_for_boot:
+    description: >
+      Whether the action must wait for the Simulator to finish booting requested
+      image
+    required: false
+    default: 'false'
   shutdown_after_job:
     description: >
       Whether the Simulator should be shut down after the job has finished. This