Merge branch 'stage' into smartui-xcui-updates

Author: amanchopra1905

assets/images/kane-ai/features/dynamic-url-replacement/1.png

@@ -87,28 +87,28 @@ Shown below is the response to the above cURL request.
 
 ## Generate publicly shareable build and test links
 
-To generate public shareable build link, run the below cURL command. 
+To generate public **shareable build link**, run the below cURL command. 
 
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
-{`curl -X POST 'https://api.lambdatest.com/lshs/api/v1.0/share-item/generate-sharable-link' \
--H 'Content-Type: application/json' \
---user 'username:password' \
--d '{
-    "entityIds": ["123456"],
-    "entityType": "App Automation Build",
-    "expiresAt": 7
-}'`}
+{`curl 'https://api.lambdatest.com/lshs/api/v1.0/share-item/generate-sharable-link' \
+  -H 'Content-Type: application/json' \
+  -u "${YOUR_LAMBDATEST_USERNAME()}:${YOUR_LAMBDATEST_ACCESS_KEY()}" \
+  --data-raw '{"entityIds":["buildID"],"entityType":"App Automation Build","expiresAt":7}'`}
 </CodeBlock>
 </div>
 
-To generate public shareable test link, run the below cURL command. 
+
+To generate public **shareable test link**, run the below cURL command. 
 
 <div className="lambdatest__codeblock">
 <CodeBlock className="language-bash">
 {`curl 'https://api.lambdatest.com/lshs/api/v1.0/share-item/generate-sharable-link' \
-  -H 'authorization: Bearer <Bearer Token>' \
-  --data-raw '{"entityIds":["APPTESaBCDefGHI5JlMnOPQ"],"entityType":"App Automation Test","expiresAt":7}'`}
+  -H 'Content-Type: application/json' \
+  -u "${YOUR_LAMBDATEST_USERNAME()}:${YOUR_LAMBDATEST_ACCESS_KEY()}" \
+  --data-raw '{"entityIds":["testID"],"entityType":"App Automation Test","expiresAt":7}'
+`}
+
 </CodeBlock>
 </div> 
 
@@ -117,6 +117,11 @@ To generate public shareable test link, run the below cURL command.
 | Test | `entityIds` <br/>  <br/> `entityType` <br/>   <br/> `expiresAt`  | For tests, pass `entityIds` as the test id and pass `entityType` as "App Automation Test" <br/> `expiresAt` is the number of days after which the shareable test link will expire '|
 | Build | `entityIds` <br/>  <br/> `entityType` <br/> <br/> `expiresAt`  | For builds, pass `entityIds` as the build id and pass `entityType` as "App Automation Build" <br/> `expiresAt` is the number of days after which the shareable build link will expire '|
 
+:::note
+The shareable links are valid for a period of 7, 15, or 30 days, after which they will expire.
+
+:::
+
 >That’s all! In case you have any questions or need any additional information, you could reach out at our <span className="doc__lt" onClick={() => window.openLTChatWidget()}>**24X7 Chat Support**</span> or mail us directly at [email protected].
 
 <nav aria-label="breadcrumbs">

assets/images/kane-ai/features/dynamic-url-replacement/2.png

@@ -11,6 +11,9 @@ site_name: LambdaTest
 slug: app-settings/
 ---
 
+import AndroidDeviceTag from '../src/component/androidDevice';
+import IOSDeviceTag from '../src/component/iosDevice';
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -35,33 +38,49 @@ slug: app-settings/
     }}
 ></script>
 
-# App Settings in Real Device Cloud
+# App Settings in Real Device Cloud 
 
 App settings play a crucial role in testing the environment for mobile applications. These settings, provided by LambdaTest, offer developers a range of capabilities to enhance testing procedures and ensure comprehensive validation of their apps functionality.
 
 <img loading="lazy" src={require('../assets/images/mobile-app-testing/app-settings.webp').default} alt="Real "  className="doc_img" width="1366" height="629"/>
 
-## Image Injection
+## Disable app resinging <AndroidDeviceTag value="Android Device" /> <IOSDeviceTag value="iOS Device" />
+
+Enable the Disable App Resigning feature to use biometrics and image injection without needing to re-sign the app after updates. This simplifies development and testing by bypassing the app resigning process.
+
+## Biometric Authentication <AndroidDeviceTag value="Android Device" /> <IOSDeviceTag value="iOS Device" />
+
+Enable the Biometric Authentication feature to effortlessly test your biometric authentication-reliant applications on designated remote Lambdatest devices. This functionality enables the emulation of diverse biometric authentication techniques such as fingerprint scanning, facial recognition and others. Leveraging this feature ensures thorough validation of your applications' security and functionality across a spectrum of realistic usage scenarios.
+
+Check out our detailed [support documentation](https://www.lambdatest.com/support/docs/biometric-authentication/) to learn in detail about the Biometric supported APIs and much more.
+
+## Image Injection <AndroidDeviceTag value="Android Device" /> <IOSDeviceTag value="iOS Device" />
 
 Enable the Image Injection feature to capture images, QR codes, and barcode scans seamlessly within your app using LambdaTest devices. Our approach utilizes Sensor Instrumentation to seamlessly integrate your app with various mobile sensors, such as the camera. By enabling Image Injection for a specific session, LambdaTest seamlessly injects camera code modules into your app, effectively mocking or overriding the Android or iOS SDK used in your app.
 
 Check out our detailed [support documentation](https://www.lambdatest.com/support/docs/camera-image-injection/) to learn in detail about the image injection feature.
 
-## Biometric Authentication
+## Default Network Logs <AndroidDeviceTag value="Android Device" /> <IOSDeviceTag value="iOS Device" />
 
-Enable this setting to effortlessly test your biometric authentication-reliant applications on designated remote Lambdatest devices. This functionality enables the emulation of diverse biometric authentication techniques such as fingerprint scanning, facial recognition and others. Leveraging this feature ensures thorough validation of your applications' security and functionality across a spectrum of realistic usage scenarios.
+Enable the Default Network Logs feature to seamlessly initiate network log capturing at the beginning of each session within your application. By enabling this setting at the app level, you prioritize the logging of network activities over device logs, ensuring comprehensive monitoring of network interactions right from the start. 
 
-Check out our detailed [support documentation](https://www.lambdatest.com/support/docs/biometric-authentication/) to learn in detail about the Biometric supported APIs and much more.
+## Language and Local <AndroidDeviceTag value="Android Device" /> <IOSDeviceTag value="iOS Device" />
+Enable the Language & Locale feature to first select the language for the application, and then choose the locale. Once enabled, the language cannot be changed during the session.
 
-## Disable Screenshot Block (only Android)
+## Disable Screenshot Block <AndroidDeviceTag value="Android Device" />
 
-Enable this setting to conduct uninterrupted testing of your application's performance, even when screenshot capture is restricted within your app. This tool facilitates testing in both app-live and app automation scenarios, ensuring seamless evaluation of your applications.
+Enable the Disable Screenshot Block feature to conduct uninterrupted testing of your application's performance, even when screenshot capture is restricted within your app. This tool facilitates testing in both app-live and app automation scenarios, ensuring seamless evaluation of your applications.
 
 Check out our detailed [support documentation](https://www.lambdatest.com/support/docs/disable-screenshot-block/) to learn in detail about disable screenshot block feature.
 
-## Default Network Logs
+## App Arguments <IOSDeviceTag value="iOS Device" />
+Enable the App Arguments feature to provide custom arguments before launching the app, allowing you to configure specific settings or behaviors. These arguments are passed to the app at startup, enabling you to control app modes, enable debugging, or customize other options based on your needs.
+
+
+
+
+
 
-Enable this feature to seamlessly initiate network log capturing at the beginning of each session within your application. By enabling this setting at the app level, you prioritize the logging of network activities over device logs, ensuring comprehensive monitoring of network interactions right from the start. 
 
 
 <nav aria-label="breadcrumbs">

docs/apis-for-app-testing.md

@@ -1,7 +1,7 @@
 ---
 id: appium-visual-regression
 title: Getting Started With Visual Regression Testing Using Appium On SmartUI Real Devices (NodeJS)
-sidebar_label: Appium
+sidebar_label: Appium Hooks
 description: Explore our Appium Visual Regression support documentation for step-by-step guidance! Conduct visual testing, manage apps, and ensure your mobile apps are flawless before launch.
 keywords:
   - Visual Regression

docs/app-settings.md

@@ -108,6 +108,10 @@ To enable biometric authentication feature in your automation script, set the ca
 DesiredCapabilities capabilities = new DesiredCapabilities();
 capabilities.setcapability("enableBiometricsAuthentication",true)
 ```
+:::note
+Explicitly set the `autoAcceptAlerts` capability to false in order to run biometric tests on iOS devices.
+::: 
+
 
 ### Using Lambda-Hook
 

docs/appium-visual-regression.md

@@ -622,29 +622,48 @@ The uploadArtefact flag is not currently supported for tests running with the **
 ***
 
 ### `globalPre`
-> Currently, only **Linux OS** is supported
-
 The `globalPre` flag allows you to define a pre-execution step that runs once before any of your tasks starts. This flag ensures that all necessary setup tasks, such as installing dependencies, configuring environments, or initializing resources, are completed before test execution begins.
 
 #### Functionality
 - Runs before any test execution starts, ensuring the environment is properly configured.
 - Executes on a separate machine (VM) or the local machine, based on the [test discovery mode](/support/docs/deep-dive-into-hyperexecute-yaml/#mode) selected.
 - Useful for setup tasks, such as fetching credentials, initializing databases, or downloading required files.
 
+#### Limitations
+- This feature is supported in YAML version 0.1 and 0.2 only.
+- `remote` mode is not supported for **XCUI** and **Espresso** framework jobs. Default mode for these frameworks is `local`.
+
 ```yaml title="hyperexecute.yaml"
 globalPre:
   mode: remote #local or remote
   commands:
     - "echo 'Setting up environment'"
     - "apt-get update && apt-get install -y curl"
     - "curl -X POST https://api.example.com/init"
+  runson: win
+  cache: true
+```
+
+:::info
+You can also use `beforeAll` as an alias for the `globalPre` command:
+
+```yaml
+beforeAll:
+  commands:
+    - "apt-get update && apt-get install -y curl"
+  mode: remote
+  runson: win
+  cache: true
 ```
+:::
 
 #### Parameters
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| mode | string | Defines where the pre-step commands will be executed. <br /> Options: [local or remote](/support/docs/deep-dive-into-hyperexecute-yaml/#mode). |
+| mode | string | Defines where the pre-step commands will be executed. <br /> Options: [local or remote](/support/docs/deep-dive-into-hyperexecute-yaml/#mode). Default `mode` is `remote`.|
 | commands | list | List of shell commands to execute before test execution begins. |
+| runson | string | It specifies the operating system on which all the task would run in case of `remote mode`. By default, it is set to `linux`. |
+| cache | boolean | It is used to cache the payload after all commands have executed. It is useful in cases like: <br /> &nbsp;&nbsp;&nbsp; - If you want to made some modification in the payload at runtime by executing some set of commands. <br /> &nbsp;&nbsp;&nbsp; - If the payload is fetched from git source. By caching the payload, git rate limiting can be avoided as the payload will only be fetched once per job with `cache: true`. |
 
 #### Difference between `globalPre` and `pre` flags
 | Scenario | globalPre | pre |
@@ -657,29 +676,45 @@ globalPre:
 ***
 
 ### `globalPost`
-> Currently, only **Linux OS** is supported
-
 The `globalPost` flag defines a post-execution step that runs once after all tasks have completed. This step ensures that cleanup tasks, such as removing temporary files, logging results, or notifying external systems, are performed after test execution.
 
 #### Functionality
 - Runs after all test execution is completed, ensuring final cleanup and reporting.
 - Executes on a separate machine (VM) or the local machine, based on the mode selected.
 - Useful for cleanup tasks, such as deleting test artifacts, summarizing reports, or deallocating cloud resources.
 
+#### Limitations
+- This feature is supported in YAML version 0.1 and 0.2 only.
+- `remote` mode is not supported for **XCUI** and **Espresso** framework jobs. Default mode for these frameworks is `local`.
+
 ```yaml title="hyperexecute.yaml"
 globalPost:
   mode: remote #local or remote
   commands:
     - "echo 'Cleaning up test environment'"
     - "rm -rf /tmp/test-results"
     - "curl -X POST https://api.example.com/cleanup"
+  runson: linux
 ```
 
+:::info
+You can also use `afterAll` as an alias for the `globalPost` command:
+
+```yaml
+afterAll:
+  commands:
+    - "curl -X POST https://api.example.com/cleanup"
+  mode: local
+  runson: linux
+```
+:::
+
 #### Parameters
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| mode | string | Defines where the post-step commands will be executed. <br /> Options: [local or remote](/support/docs/deep-dive-into-hyperexecute-yaml/#mode). |
+| mode | string | Defines where the post-step commands will be executed. <br /> Options: [local or remote](/support/docs/deep-dive-into-hyperexecute-yaml/#mode). Default `mode` is `remote`. |
 | commands | list | List of shell commands to execute after test execution completes. |
+| runson | string | It specifies the operating system on which all the task would run in case of `remote mode`. By default, it is set to `linux`. |
 
 #### Difference between `globalPost` and `post` flags
 | Scenario | globalPost |	post |
@@ -1346,9 +1381,10 @@ if your test loads jquery static library multiple times and for some reason it i
 
 > **Note**: These cached resources are not yet shared across VMs. So, each VM has its own copy of cache.
 
+<!--
 ***
 
-### `afterAll`
+ ### `afterAll`
 It is used to run commands after the job has finished. Currently only local directive is allowed, means that all the commands would be run on the same host on which HyperExecute CLI was run. Running commands in `afterAll` on HyperExecute VMs(remote commands) is not yet supported. Users will have access to all the artifacts when these commands would be run.
 ```yaml
 afterAll:
@@ -1359,7 +1395,7 @@ afterAll:
 
 For instance you want to further process the artifacts and create a custom PDF. You can use `afterAll` for this purpose wherein custom commands can be invoked. Other use cases can be in case you :
 - Want to run some commands after the job is finished.
-- Want to run these commands from the same host from which hyperexecute-cli is run.
+- Want to run these commands from the same host from which hyperexecute-cli is run. -->
 
 <!-- ***
 ## `beforeAll`

docs/biometric-authentication.md

@@ -162,7 +162,7 @@ The **HyperExecute YAML** file serves as the foundational component for test exe
 | [postDirectives](/support/docs/deep-dive-into-hyperexecute-yaml/#postdirectives) | Map |Similar to post with option to retry. |
 | [alwaysRunPostSteps](/support/docs/deep-dive-into-hyperexecute-yaml/#alwaysrunpoststeps) | Boolean | Execute the Post Steps in every scenario case |
 | [cacheTestURL](/support/docs/deep-dive-into-hyperexecute-yaml/#cachetesturl) | Boolean |It enables users to cache static test files. |
-| [afterAll](/support/docs/deep-dive-into-hyperexecute-yaml/#afterall) | Map |It is used to run commands after the job has finished. |
+<!-- | [afterAll](/support/docs/deep-dive-into-hyperexecute-yaml/#afterall) | Map |It is used to run commands after the job has finished. | -->
 | [project](/support/docs/deep-dive-into-hyperexecute-yaml/#project) | String | Segregate data at a project/repo level |
 | [slackChannel](/support/docs/deep-dive-into-hyperexecute-yaml/#slackchannel) | String | Allows you to receive notifications of your Job updates directly in your preferred Slack channel. |
 | [afterEachScenario](/support/docs/deep-dive-into-hyperexecute-yaml/#aftereachscenario) | List of Strings | Allows you to trigger your define tasks after each test scenario. |

docs/deep-dive-into-hyperexecute-yaml.md

@@ -2,7 +2,7 @@
 id: install-apps-from-app-center
 title: How to Test Apps Installed via App Center?
 hide_title: true
-sidebar_label: App Center
+sidebar_label: App Center (Deprecating)
 description: Learn how to test apps installed from App Center on LambdaTest for optimal performance on real Android and iOS devices.
 keywords:
 - install apps from app center
@@ -36,7 +36,11 @@ slug: install-apps-from-app-center/
     }}
 ></script>
 
-# How to Test Apps Installed via App Center?
+# How to Test Apps Installed via App Center? 
+
+:::warning note
+This method of uploading applications will be deprecated on [31st March 2025](https://learn.microsoft.com/en-us/appcenter/retirement). 
+:::
 
 LambdaTest enables developers to test their mobile applications and websites across a range of real devices and browsers. It allows you to install apps directly from the App Center to test them on real android or iOS devices, ensuring that they perform well in actual user environments.
 

docs/hyperexecute-yaml-parameters.md

@@ -68,6 +68,17 @@ Open the test run to view its URL. Copy the Test Run ID from the URL. This ID wi
 A list of test instances with various configurations will be displayed for each test run.
 :::
 
+
+### Step 3: Configure the API Call
+Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:
+
+- **concurrency :** Defaults to 1 if not specified.
+- **title :** Assign a unique job title; a random one will be generated if omitted.
+- **region :** Choose a region such as eastus or centralindia.
+- **tunnel :** Add the parameter and tunnel name if you want to run using LambdaTest Tunnel.
+- **accessibility :** Set as true if you want to run accessibility test on all your tests in the test run. (Could potentially slow the execution down if set as true)
+- **replaced_url :** To be used to dynamically replace any pattern URL in test cases with the replacement URL for entire test run.
+
 #### Example API Call:
 
 ```yaml
@@ -78,11 +89,26 @@ curl --location 'https://test-manager-api.lambdatest.com/api/atm/v1/hyperexecute
     "test_run_id": "YOUR_TEST_RUN_ID", #enter test run id
     "concurrency": 1, # Optional, Default 1
     "title": "UNIQUE_BUILD_NAME", #Optional
-    "region": "YOUR_DESIRED_REGION" #eastus, centralindia
+    "region": "YOUR_DESIRED_REGION", #eastus, centralindia
+    "tunnel": "tunnel-name", #Optional to be used if running via tunnel
+    "accessibility": false, #Optional
+    "replaced_url": [
+      {
+          "pattern_url": "TEST_URL_1",
+          "replacement_url": "REPLACED_TEST_URL_1"
+      },
+      {
+          "pattern_url": "TEST_URL_2",
+          "replacement_url": "REPLACED_TEST_URL_2"
+      },
+      {
+          "pattern_url": "TEST_URL_3",
+          "replacement_url": "REPLACED_TEST_URL_3"
+      }
+    ] #Optional to be used to dynamically replace any pattern URL in test cases with the replacement URL
 }'
 ```
 
-
 #### Sample API Response:
 
 The API response contains the job ID for both jobs created for desktop web tests as well as mobile tests on real devices. Here is a sample response for a test run which contains both app and web test cases:
@@ -97,15 +123,6 @@ The API response contains the job ID for both jobs created for desktop web tests
 }
 ```
 
-### Step 3: Configure the API Call
-Replace `<TestRunID>` with the actual ID from the URL and set additional optional parameters:
-
-- **Concurrency :** Defaults to 1 if not specified.
-- **Title :** Assign a unique job title; a random one will be generated if omitted.
-- **Region :** Choose a region such as eastus or centralindia.
-
-Confirm that the job title is unique to avoid conflicts. Select a region if you require a specific allocation for your devices.
-
 
 ### Step 4: Authenticate and Trigger the Job
 - Provide your LambdaTest username and access key for Basic Authentication.