From 4965d6abddba9caa25080d761cbed914ed963cb1 Mon Sep 17 00:00:00 2001 From: Saksham Arora Date: Fri, 7 Nov 2025 16:41:03 +0530 Subject: [PATCH 1/3] Updated documentation --- docs/apis-for-app-testing.md | 14 ++-- docs/appium-firebase-app-upload.md | 4 +- docs/appium-flutter-integration.md | 2 +- docs/appium-install-uninstall-hook.md | 6 ++ docs/appium-lambdaHooks.md | 5 ++ docs/appium-uploading-retrieving-files.md | 3 + docs/application-setup-via-api.md | 79 +++++++++++++++++-- docs/application-setup-via-gui.md | 20 ++++- docs/desired-capabilities-in-appium.md | 3 + ...ed-with-flutter-dart-android-automation.md | 2 +- ...tarted-with-flutter-dart-ios-automation.md | 2 +- docs/supported-appium-plugins.md | 3 + docs/supported-appium-versions.md | 18 ++++- docs/supported-timezone.md | 5 +- 14 files changed, 144 insertions(+), 22 deletions(-) diff --git a/docs/apis-for-app-testing.md b/docs/apis-for-app-testing.md index 76fd73472..a99d2aec4 100644 --- a/docs/apis-for-app-testing.md +++ b/docs/apis-for-app-testing.md @@ -17,6 +17,8 @@ import CodeBlock from '@theme/CodeBlock'; import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys"; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import RealDeviceTag from '../src/component/realDevice'; +import VirtualDeviceTag from '../src/component/virtualDevice'; - -## Overview -*** - + In this documentation, we look at some APIs that will help you optimize your mobile app testing workflow. If you are performing live or automated app testing, you can use these APIs in your scripts to perform various actions. ## Fetching The Devices Available for Testing -*** - + To fetch the Devices that are available for running Tests.
@@ -237,8 +235,8 @@ 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.
diff --git a/docs/appium-firebase-app-upload.md b/docs/appium-firebase-app-upload.md index 4947980a4..c7c2164b7 100644 --- a/docs/appium-firebase-app-upload.md +++ b/docs/appium-firebase-app-upload.md @@ -17,7 +17,6 @@ url: https://www.lambdatest.com/support/docs/appium-firebase-app-upload/ site_name: Uploading app via Firebase slug: appium-firebase-app-upload/ --- - - + Flutter, an open-source UI toolkit created by Google, is a popular choice among developers to build natively compiled applications for mobile, web, and desktop from a single codebase. With Dart as its programming language, Flutter enables fast development of beautiful apps with a highly productive, extensible and open-source set of features. In this guide, we will explore how to run your first Flutter Dart test on an Android device using the LambdaTest Real Device Cloud. By combining the capabilities of Flutter Dart and LambdaTest, you can ensure the proper functioning of your app across different devices and make your app more reliable and robust. diff --git a/docs/getting-started-with-flutter-dart-ios-automation.md b/docs/getting-started-with-flutter-dart-ios-automation.md index de42ede25..2c5655867 100644 --- a/docs/getting-started-with-flutter-dart-ios-automation.md +++ b/docs/getting-started-with-flutter-dart-ios-automation.md @@ -45,7 +45,7 @@ import VirtualDeviceTag from '../src/component/virtualDevice'; }} > - + Flutter, an open-source UI toolkit created by Google, is a popular choice among developers to build natively compiled applications for mobile, web, and desktop from a single codebase. With Dart as its programming language, Flutter enables fast development of beautiful apps with a highly productive, extensible and open-source set of features. In this guide, we will explore how to run your first Flutter Dart test on an iOS device using the LambdaTest Real Device Cloud. By combining the capabilities of Flutter Dart and LambdaTest, you can ensure the proper functioning of your app across different devices and make your app more reliable and robust. diff --git a/docs/supported-appium-plugins.md b/docs/supported-appium-plugins.md index c3ab0cfe8..e5d96fa1b 100644 --- a/docs/supported-appium-plugins.md +++ b/docs/supported-appium-plugins.md @@ -24,6 +24,9 @@ slug: supported-appium-plugins/ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import NewTag from '../src/component/newTag'; +import RealDeviceTag from '../src/component/realDevice'; + + # Setting up timezone on Real Devices - + + In automated testing with Appium on LambdaTest, configuring the timezone accurately is crucial for precise testing scenarios. LambdaTest provides support for various timezones, allowing users to customize their testing environments to meet specific requirements. By default, the timezone for Appium testing on LambdaTest is selected based on the device's default settings. However, users have the flexibility to explicitly specify the timezone using the **timezone** capability in their desired capabilities. From 1a8a880f23df99027566f37f2bfd2450f74ce1ca Mon Sep 17 00:00:00 2001 From: Saksham Arora Date: Sat, 8 Nov 2025 17:25:09 +0530 Subject: [PATCH 2/3] Updated documentation --- docs/appium-firebase-app-upload.md | 4 +-- docs/appium-install-uninstall-hook.md | 3 ++- docs/application-setup-via-api.md | 26 +++++++++++++++++++- docs/supported-appium-versions.md | 35 +++++++++++++++------------ docs/supported-timezone.md | 2 +- 5 files changed, 50 insertions(+), 20 deletions(-) diff --git a/docs/appium-firebase-app-upload.md b/docs/appium-firebase-app-upload.md index c7c2164b7..040e00985 100644 --- a/docs/appium-firebase-app-upload.md +++ b/docs/appium-firebase-app-upload.md @@ -49,9 +49,9 @@ import TabItem from '@theme/TabItem'; import RealDeviceTag from '../src/component/realDevice'; --- - -## Tutorial to test an app uploaded on Firebase +## Tutorial to test an app uploaded on Firebase + **Firebase** is a platform developed by **Google** for creating mobile and web applications. **LambdaTest cloud platform** provides you various methods to upload your files on a real device like from playstore and appstore. Uploading an app through Firebase is one such method. ## How to Start with Firebase diff --git a/docs/appium-install-uninstall-hook.md b/docs/appium-install-uninstall-hook.md index 010ca1592..2682ab663 100644 --- a/docs/appium-install-uninstall-hook.md +++ b/docs/appium-install-uninstall-hook.md @@ -55,7 +55,8 @@ import VirtualDeviceTag from '../src/component/virtualDevice'; LambdaTest now allows you to install and uninstall apps in the middle of your automated tests. This means you don’t need to restart the session every time you want to switch apps, upgrade them, or clean up the device. -## Installing and Uninstalling Apps +## Installing and Uninstalling Apps + LambdaTest enables you to install and uninstall applications during automation test execution by using commands that can be run through WebDriver's script execution functionality. diff --git a/docs/application-setup-via-api.md b/docs/application-setup-via-api.md index 8eca38441..2bf737d9a 100644 --- a/docs/application-setup-via-api.md +++ b/docs/application-setup-via-api.md @@ -117,7 +117,7 @@ The maximum size for application should not exceed 1GB. The upload time of your application can range from a few seconds to a minute, depending on the size of your application. Therefore, do not interrupt the cURL command request until you receive the response. ::: -## Fetch your Applications +## Fetch your Applications for Real Devices @@ -161,6 +161,30 @@ Shown below is the response to the above cURL request. } ``` +## Fetch your Applications for Virtual Devices + + + + +
+ + {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=emulator&level=user"`} + +
+ + + + +
+ + {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=simulator&level=user"`} + +
+ + + + + ## Deleting your Application diff --git a/docs/supported-appium-versions.md b/docs/supported-appium-versions.md index d64084ce9..ac4f699a0 100644 --- a/docs/supported-appium-versions.md +++ b/docs/supported-appium-versions.md @@ -26,9 +26,6 @@ import NewTag from '../src/component/newTag'; import RealDeviceTag from '../src/component/realDevice'; import VirtualDeviceTag from '../src/component/virtualDevice'; - - - +# Supported Appium Versions + + Customize your testing experience on LambdaTest by selecting the appropriate Appium version for your tests on real devices. LambdaTest offers flexibility in choosing the Appium version to meet your testing requirements. By default, the suitable Appium version is selected based on the operating system (OS) when running tests. However, you can explicitly specify the version using the `appiumVersion` capability in your test scripts. -## Appium Version Configuration +## Appium Version Configuration for Real Devices To configure the Appium version for your tests on LambdaTest, use the `appiumVersion` capability in your test scripts. Below is a table of supported Appium versions for different platforms: | Platform Versions | Supported Versions | Default Version | Latest Version | @@ -65,16 +65,6 @@ To configure the Appium version for your tests on LambdaTest, use the `appiumVer | fireos | 1.21.0, 1.22.0, 1.22.3, 2.0.0, 2.1.3, 2.2.1, 2.3.0 | 2.2.1 | 2.3.0 | | tvos | 1.22.3, 2.2.1 | 1.22.3 | 1.22.3 | -:::info - -**For Virtual Devices:** -- LambdaTest currently supports the following Appium versions: - - **Android Devices:** `1.21.0`, `1.22.3`, `2.0.0`, `2.1.3`, `2.16.2` - - **iOS Devices:** `1.22.3`, `2.0.0`, `2.1.3`, `2.16.2` -- We also provide Support for Appium 3.0.2 - - **Android Devices:** `13`, `15`, `16` - - **iOS Devices:** `16`, `17`, `18`, `26` -::: **Java Example:** ```java // Java code for configuring Appium version in tests on LambdaTest @@ -111,4 +101,19 @@ capabilities.setCapability("platformName", "ios"); :::note - If a user passes any Appium version other than the mentioned versions, appropriate error will be thrown. - For devices running iOS 17 and newer, it is recommended to use Appium versions `2.2.1` and `above` to ensure the best compatibility and performance. -::: \ No newline at end of file +::: + + +## Appium Version Configuration for Virtual Devices + +| Platform Versions | Supported Versions | +|-------------------|--------------------| +| Android | 1.21.0, 1.22.3, 2.0.0, 2.1.3, 2.16.2 | +| iOS |1.22.3, 2.0.0, 2.1.3, 2.16.2 | + + +:::info +- We also provide Support for Appium 3.0.2 on following versions + - **Android Devices:** 13, 15, 16 + - **iOS Devices:** 16, 17, 18, 26 +::: diff --git a/docs/supported-timezone.md b/docs/supported-timezone.md index e74017f3f..03a0ba7a7 100644 --- a/docs/supported-timezone.md +++ b/docs/supported-timezone.md @@ -48,7 +48,7 @@ import VirtualDeviceTag from '../src/component/virtualDevice'; }} > -# Setting up timezone on Real Devices +# Setting up timezone In automated testing with Appium on LambdaTest, configuring the timezone accurately is crucial for precise testing scenarios. LambdaTest provides support for various timezones, allowing users to customize their testing environments to meet specific requirements. From 46a092c77f864727ff3af122b2ad823b78bc32e0 Mon Sep 17 00:00:00 2001 From: Saksham Arora Date: Sat, 8 Nov 2025 17:48:47 +0530 Subject: [PATCH 3/3] Updated documentation --- docs/supported-locales-xcui.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/supported-locales-xcui.md b/docs/supported-locales-xcui.md index b457a0e4d..9c92c1a2f 100644 --- a/docs/supported-locales-xcui.md +++ b/docs/supported-locales-xcui.md @@ -179,7 +179,13 @@ curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/x ``` :::note -- Ensure that both the **language** and **locale** parameters are passed simultaneously in the API request. -- App should support the language and locale mentioned in the API request to work. -- For XCUI sharding tests, you have to mention this in the `.yaml` file. +- When setting language or locale parameters, make sure your tests use the `ProcessInfo` object to pass these arguments correctly. This ensures the app launches with the specified language and locale settings. + ```swift + let app = XCUIApplication() + app.launchArguments += ProcessInfo().arguments + app.launch() +``` +- The language and locale settings are applied at the app level. +- To ensure your application under test displays the correct localized strings, dates, times, and calendar formats, include both language and locale in your desired capabilities. +- For XCUI sharding tests, you have to mention this in the `.yaml` file. ::: \ No newline at end of file