Skip to content

Commit

Permalink
Update test-configuration-options.md
Browse files Browse the repository at this point in the history
Moved the following 2 capabilities:
recordVideo
videoUploadOnPass
FROM section: Desktop and Mobile Capabilities: Sauce-Specific – Optional
TO section: Desktop and Virtual Device Capabilities: Sauce-Specific – Optional
As they are not supported on Real Devices.
  • Loading branch information
lee-133 authored Dec 11, 2024
1 parent 5b27082 commit 416dae3
Showing 1 changed file with 32 additions and 32 deletions.
64 changes: 32 additions & 32 deletions docs/dev/test-configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1970,38 +1970,6 @@ Appium tests for the Real Device Cloud using the W3C protocol MUST use `tunnelNa

---

### `recordVideo`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Use this to disable video recording. By default, Sauce Labs records a video of every test you run. Disabling video recording can be useful for debugging failing tests as well as having a visual confirmation that a certain feature works (or still works). However, there is an added wait time for screen recording during a test run.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("recordVideo", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `videoUploadOnPass`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Disables video upload for passing tests. `videoUploadOnPass` is an alternative to `recordVideo`; it lets you discard videos for tests you've marked as passing. It disables video post-processing and uploading that may otherwise consume some extra time after your test is complete.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("videoUploadOnPass", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `recordScreenshots`

<p><small>| OPTIONAL | BOOLEAN |</small></p>
Expand Down Expand Up @@ -2103,6 +2071,22 @@ capabilities.setCapability("sauce:options", sauceOptions);

---

### `recordVideo`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Use this to disable video recording. By default, Sauce Labs records a video of every test you run. Disabling video recording can be useful for debugging failing tests as well as having a visual confirmation that a certain feature works (or still works). However, there is an added wait time for screen recording during a test run.

Check warning on line 2078 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [sauce.Simplicity] Remove 'useful'. Be precise instead of subjective. Raw Output: {"message": "[sauce.Simplicity] Remove 'useful'. Be precise instead of subjective.", "location": {"path": "docs/dev/test-configuration-options.md", "range": {"start": {"line": 2078, "column": 133}}}, "severity": "WARNING"}

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("recordVideo", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `timeZone`

<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Desktop and Virtual Devices Only</span> |</small></p>
Expand Down Expand Up @@ -2150,6 +2134,22 @@ The same behavior could be achieved by providing a custom value to the

---

### `videoUploadOnPass`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Disables video upload for passing tests. `videoUploadOnPass` is an alternative to `recordVideo`; it lets you discard videos for tests you've marked as passing. It disables video post-processing and uploading that may otherwise consume some extra time after your test is complete.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("videoUploadOnPass", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### Pre-Run Executables

<p><small>| OPTIONAL | <span className="sauceGreen">Desktop and Virtual Devices Only</span> |</small></p>
Expand Down

0 comments on commit 416dae3

Please sign in to comment.