diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index ddd5765483..54dccbdbaa 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1419,9 +1419,11 @@ Controls Sauce Labs default resigning (iOS) or instrumentation (Android) of mobi When set to `true`, Sauce Labs will resign the app under test with its own signature. This is required for iOS apps to be installed on our devices, but also to support features like: +- [Vitals](#vitals) - [Network Capture](#networkcapture) -- [Image Injection](#saucelabsimageinjectionenabled) -- [Biometrics interception](#allowtouchidenroll) +- [Image Injection](#imageinjection) +- [Biometrics interception](#biometricsinterception) +- [Crash Reporting](#crashreporting) And many more. This value can be set to `false` to allow testing of specific behaviors that are not permitted under the Sauce Labs provisioning. See [Resigning Enablements](/mobile-apps/automated-testing/ipa-files/#sauce-labs-resigning-enablements) for more information. This capability can only be set to `false` for iOS private devices. @@ -1429,9 +1431,11 @@ And many more. This value can be set to `false` to allow testing of specific beh When set to `true`, Sauce Labs will instrument the app under test with its own signature. This is required for Android apps if you want to use features like: +- [Vitals](#vitals) - [Network Capture](#networkcapture) -- [Image Injection](#saucelabsimageinjectionenabled) -- [Biometrics interception](#allowtouchidenroll) +- [Image Injection](#imageinjection) +- [Biometrics interception](#biometricsinterception) +- [Crash Reporting](#crashreporting) and many more. This value can be set to `false` and can be used for private and public devices. @@ -1449,7 +1453,23 @@ capabilities.setCapability("sauce:options", sauceOptions); --- -### `sauceLabsImageInjectionEnabled` +### `vitals` + +

| OPTIONAL | BOOLEAN | Real Devices Only |

+ +Vitals enables memory, cpu, performance stats alongside UI interactions during the session. + +```java +MutableCapabilities capabilities = new MutableCapabilities(); +//... +MutableCapabilities sauceOptions = new MutableCapabilities(); +sauceOptions.setCapability("vitals", true); +capabilities.setCapability("sauce:options", sauceOptions); +``` + +--- + +### `imageInjection`

| OPTIONAL | BOOLEAN | Real Devices Only |

@@ -1459,13 +1479,13 @@ Enables the [camera image injection](/mobile-apps/features/camera-image-injectio MutableCapabilities capabilities = new MutableCapabilities(); //... MutableCapabilities sauceOptions = new MutableCapabilities(); -sauceOptions.setCapability("sauceLabsImageInjectionEnabled", true); +sauceOptions.setCapability("imageInjection", true); capabilities.setCapability("sauce:options", sauceOptions); ``` --- -### `sauceLabsBypassScreenshotRestriction` +### `bypassScreenshotRestriction`

| OPTIONAL | BOOLEAN | Real Devices Only | Android Only |

@@ -1475,13 +1495,13 @@ Bypasses the restriction on taking screenshots for secure screens (i.e., secure MutableCapabilities capabilities = new MutableCapabilities(); //... MutableCapabilities sauceOptions = new MutableCapabilities(); -sauceOptions.setCapability("sauceLabsBypassScreenshotRestriction", true); +sauceOptions.setCapability("bypassScreenshotRestriction", true); capabilities.setCapability("sauce:options", sauceOptions); ``` --- -### `allowTouchIdEnroll` +### `biometricsInterception`

| OPTIONAL | BOOLEAN | Real Devices Only |

@@ -1491,7 +1511,23 @@ Enables the interception of biometric input, allowing the test to simulate Touch MutableCapabilities capabilities = new MutableCapabilities(); //... MutableCapabilities sauceOptions = new MutableCapabilities(); -sauceOptions.setCapability("allowTouchIdEnroll", true); +sauceOptions.setCapability("biometricsInterception", true); +capabilities.setCapability("sauce:options", sauceOptions); +``` + +--- + +### `crashReporting` + +

| OPTIONAL | BOOLEAN | Real Devices Only |

+ +Enables capturing and inclusion of detailed stack traces in the test results, providing insights into any application crashes that occur during testing. + +```java +MutableCapabilities capabilities = new MutableCapabilities(); +//... +MutableCapabilities sauceOptions = new MutableCapabilities(); +sauceOptions.setCapability("crashReporting", true); capabilities.setCapability("sauce:options", sauceOptions); ``` diff --git a/docs/mobile-apps/features/biometric-authentication.md b/docs/mobile-apps/features/biometric-authentication.md index 0dec7cca05..5a20ba9217 100644 --- a/docs/mobile-apps/features/biometric-authentication.md +++ b/docs/mobile-apps/features/biometric-authentication.md @@ -104,12 +104,12 @@ To use biometric interception in a live mobile app test, you must ensure that th To enable fingerprint and facial recognition on iOS and Android real devices: -1. Add the `allowTouchIdEnroll` capability to your test configuration and set it to `true`. +1. Add the `biometricsInterception` capability to your test configuration and set it to `true`. :::note - Setting `allowTouchIdEnroll` does not update your app's biometric interception setting in Sauce Labs. It only sets the capability for the test in the event that the app setting in Sauce Labs is _different_ from the test script capability. + Setting `biometricsInterception` does not update your app's biometric interception setting in Sauce Labs. It only sets the capability for the test in the event that the app setting in Sauce Labs is _different_ from the test script capability. - - If biometric interception is ENABLED for the app in Sauce Labs, setting `allowTouchIdEnroll=true` or omitting it will have no effect, but setting `allowTouchIdEnroll=false` will disable the enrollment for the test, overriding the app setting. + - If biometric interception is ENABLED for the app in Sauce Labs, setting `biometricsInterception=true` or omitting it will have no effect, but setting `biometricsInterception=false` will disable the enrollment for the test, overriding the app setting. - The opposite is true if biometric interception is DISABLED for the app in Sauce Labs. ::: @@ -135,8 +135,8 @@ Testing biometric interception on Sauce Labs iOS Simulators or on your local mac ```js reference title="WebdriverIO Biometrics Check Sample" https://github.com/saucelabs-training/demo-js/blob/docs-1.1/webdriverio/appium-app/examples/biometric-login/test/specs/biometrics.emusim.spec.ts#L10-L31 ``` - :::note Setting allowTouchIdEnroll capability is optional - You can set the desired capability `allowTouchIdEnroll` to `true` to enable enrollment by default for your app, but if you are checking the enrollment in your script anyway, this is not required. + :::note Setting biometricsInterception capability is optional + You can set the desired capability `biometricsInterception` to `true` to enable enrollment by default for your app, but if you are checking the enrollment in your script anyway, this is not required. ::: 2. If biometrics is disabled, call the `driver.toggleEnrollTouchId(true)` method to enable it. ```js reference title="WebdriverIO Toggle Biometrics Sample" diff --git a/docs/mobile-apps/features/camera-image-injection.md b/docs/mobile-apps/features/camera-image-injection.md index 59fa91f4d9..7c556a4f25 100644 --- a/docs/mobile-apps/features/camera-image-injection.md +++ b/docs/mobile-apps/features/camera-image-injection.md @@ -144,7 +144,7 @@ During an automated test, you'll pass an image to the image injection endpoint. In your test script, you'll need to input the desired capabilities specific to Camera Image Injection (see below code snippets). The code will execute your image upload and opening of the device camera. -1. First, add the camera instrumentation desired capability command, `sauceLabsImageInjectionEnabled`, to your test script. This capability enables image injection functionality. +1. First, add the camera instrumentation desired capability command, `imageInjection`, to your test script. This capability enables image injection functionality.