Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Test Capabilities to be in Correct Section and Updated Typos #3047

Merged
merged 3 commits into from
Dec 16, 2024
Merged

Updating Test Capabilities to be in Correct Section and Updated Typos #3047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba2a8ca
Update real-devices.md (#3042)
lee-133 Dec 13, 2024
3c9f8bb
Update test-configuration-options.md (#3044)
lee-133 Dec 13, 2024
9e62561
Update test-configuration-options.md (#3038)
lee-133 Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 33 additions & 34 deletions docs/dev/test-configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,8 +880,7 @@

Defines the custom time zone override for the application under test.
You can use `UTC`, `PST`, `EST`, as well as place-based timezone names such as `America/Los_Angeles`.
See [the list of available time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) f
or more details. The same behavior could be achieved by providing a custom
See [the list of available time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for more details. The same behavior could be achieved by providing a custom
value to the `TZ` environment variable via the `appium:processArguments` capability.

:::note
Expand Down Expand Up @@ -2006,38 +2005,6 @@

---

### `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 @@ -2139,6 +2106,22 @@

---

### `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 2113 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/dev/test-configuration-options.md#L2113 

[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": 2113, "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 @@ -2186,6 +2169,22 @@

---

### `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
2 changes: 1 addition & 1 deletion docs/mobile-apps/automated-testing/appium/real-devices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ To optimize device availability, consistency, and efficiency for multiple tests,
To skip the uninstallation and reinstallation of your app from the device, you can set `noReset` to `true` in conjunction with using a `cacheId`. This setting adds efficiency, but may not be suitable for test setups that require the app's state to be reset between tests.

```js
"appium: noReset" : "true",
"appium:noReset" : "true",
"sauce:options" : {
"cacheId" : "jnc0x1256",
}
Expand Down
Loading