From 0ea2270330d102eeadd0b175fe3de00b7f5a80cd Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Thu, 5 Dec 2024 16:57:44 +0100 Subject: [PATCH 1/8] Update sauceLabsImageInjectionEnabled in camera-image-injection.md --- docs/mobile-apps/features/camera-image-injection.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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. From c0f7eb714a63b83aeecf1265256a7c8e31cd34b4 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Thu, 5 Dec 2024 17:03:05 +0100 Subject: [PATCH 2/8] Update sauceLabsImageInjectionEnabled in test-configuration-options.md --- docs/dev/test-configuration-options.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index ddd5765483..426bf4ad5d 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1420,7 +1420,7 @@ 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: - [Network Capture](#networkcapture) -- [Image Injection](#saucelabsimageinjectionenabled) +- [Image Injection](#imageInjection) - [Biometrics interception](#allowtouchidenroll) 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. @@ -1430,7 +1430,7 @@ 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: - [Network Capture](#networkcapture) -- [Image Injection](#saucelabsimageinjectionenabled) +- [Image Injection](#imageInjection) - [Biometrics interception](#allowtouchidenroll) and many more. This value can be set to `false` and can be used for private and public devices. @@ -1449,7 +1449,7 @@ capabilities.setCapability("sauce:options", sauceOptions); --- -### `sauceLabsImageInjectionEnabled` +### `imageInjection`

| OPTIONAL | BOOLEAN | Real Devices Only |

@@ -1459,7 +1459,7 @@ 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); ``` From e0240ed6d5d0c76b6e16608c5bdb936ff0e78455 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Thu, 5 Dec 2024 17:03:53 +0100 Subject: [PATCH 3/8] Update sauceLabsBypassScreenshotRestriction in test-configuration-options.md --- docs/dev/test-configuration-options.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index 426bf4ad5d..12e499506f 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1465,7 +1465,7 @@ capabilities.setCapability("sauce:options", sauceOptions); --- -### `sauceLabsBypassScreenshotRestriction` +### `bypassScreenshotRestriction`

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

@@ -1475,7 +1475,7 @@ 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); ``` From 61e329ea0fbf355f8aa154443de4231786d4a744 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Thu, 5 Dec 2024 17:05:07 +0100 Subject: [PATCH 4/8] Update allowTouchIdEnroll in test-configuration-options.md --- docs/dev/test-configuration-options.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index 12e499506f..80f46fcba4 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1421,7 +1421,7 @@ When set to `true`, Sauce Labs will resign the app under test with its own signa - [Network Capture](#networkcapture) - [Image Injection](#imageInjection) -- [Biometrics interception](#allowtouchidenroll) +- [Biometrics interception](#biometricsInterception) 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. @@ -1431,7 +1431,7 @@ When set to `true`, Sauce Labs will instrument the app under test with its own s - [Network Capture](#networkcapture) - [Image Injection](#imageInjection) -- [Biometrics interception](#allowtouchidenroll) +- [Biometrics interception](#biometricsInterception) and many more. This value can be set to `false` and can be used for private and public devices. @@ -1481,7 +1481,7 @@ capabilities.setCapability("sauce:options", sauceOptions); --- -### `allowTouchIdEnroll` +### `biometricsInterception`

| OPTIONAL | BOOLEAN | Real Devices Only |

@@ -1491,7 +1491,7 @@ 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); ``` From e59c56ee82e6e7780106bac1710af168fab9cc88 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Thu, 5 Dec 2024 17:06:28 +0100 Subject: [PATCH 5/8] Update allowTouchIdEnroll in biometric-authentication.md --- docs/mobile-apps/features/biometric-authentication.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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" From 58c8d80051e37bfe90eeb91b16ac1d22f6f0e91a Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Wed, 11 Dec 2024 13:17:20 +0100 Subject: [PATCH 6/8] Fixed broken anchor --- docs/dev/test-configuration-options.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index 80f46fcba4..1d7232fe07 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1420,8 +1420,8 @@ 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: - [Network Capture](#networkcapture) -- [Image Injection](#imageInjection) -- [Biometrics interception](#biometricsInterception) +- [Image Injection](#imageinjection) +- [Biometrics interception](#biometricsinterception) 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. @@ -1430,8 +1430,8 @@ 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: - [Network Capture](#networkcapture) -- [Image Injection](#imageInjection) -- [Biometrics interception](#biometricsInterception) +- [Image Injection](#imageinjection) +- [Biometrics interception](#biometricsinterception) and many more. This value can be set to `false` and can be used for private and public devices. From a7f5a940fa562f3163a940195641eed76b188549 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Wed, 11 Dec 2024 14:53:58 +0100 Subject: [PATCH 7/8] Added ceash reporting --- docs/dev/test-configuration-options.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index 1d7232fe07..c9fd8704c5 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1422,6 +1422,7 @@ When set to `true`, Sauce Labs will resign the app under test with its own signa - [Network Capture](#networkcapture) - [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. @@ -1432,6 +1433,7 @@ When set to `true`, Sauce Labs will instrument the app under test with its own s - [Network Capture](#networkcapture) - [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. @@ -1497,6 +1499,22 @@ 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); +``` + +--- + ### `audioCapture`

| OPTIONAL | BOOLEAN |

From 2fa2b4eaf1b6298c7ca1b7f37b741e3f19a977c1 Mon Sep 17 00:00:00 2001 From: ShahRukh Date: Wed, 11 Dec 2024 15:02:18 +0100 Subject: [PATCH 8/8] Added vitals --- docs/dev/test-configuration-options.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/dev/test-configuration-options.md b/docs/dev/test-configuration-options.md index c9fd8704c5..54dccbdbaa 100644 --- a/docs/dev/test-configuration-options.md +++ b/docs/dev/test-configuration-options.md @@ -1419,6 +1419,7 @@ 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](#imageinjection) - [Biometrics interception](#biometricsinterception) @@ -1430,6 +1431,7 @@ 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](#imageinjection) - [Biometrics interception](#biometricsinterception) @@ -1451,6 +1453,22 @@ capabilities.setCapability("sauce:options", sauceOptions); --- +### `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 |