Skip to content

Commit 55107f3

Browse files
yuyi-slyuyi-sl
authored
Merge branch 'main' into update-network-throttling
2 parents 441f323 + 386a679 commit 55107f3

File tree

4 files changed

+280
-11
lines changed

4 files changed

+280
-11
lines changed

‎docs/mobile-apps/automated-testing/appium/appium-flutter-integration-driver.md

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
---
2+
id: appium-flutter-integration-driver
3+
title: Appium Flutter Integration Driver Testing on Sauce Labs
4+
sidebar_label: Appium Flutter Integration Testing
5+
description: Learn how to test Flutter apps with the Appium Flutter Integration Driver.
6+
---
7+
8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
import Tabs from '@theme/Tabs';
10+
import TabItem from '@theme/TabItem';
11+
12+
Sauce Labs supports testing Flutter apps on Android and iOS real devices with Appium by utilizing the [appium-flutter-integration-driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver).
13+
The process to test Flutter apps with Appium involves an additional and crucial step: [Prepare the app with Flutter Integration Server](#prepare-the-app-with-flutter-integration-server).
14+
This step includes instructions on how to prepare and build your app for both Android and iOS platforms. After preparing your app,
15+
you can [upload](#uploading-your-flutter-app-to-sauce-labs) it to Sauce Labs, [Configure your Appium capabilities](#configuring-your-appium-capabilities), and run your tests.
16+
17+
18+
## Native Flutter Integration Driver vs Appium Flutter Integration Driver
19+
20+
| Use Cases | Native Flutter Driver | Appium Flutter Integration Driver |
21+
| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------- | --------------------------------- |
22+
| Writing tests in languages other than Dart | ❌ | ✔️ |
23+
| Running integration tests for Flutter apps with embedded webview or native view, or existing native apps with embedded Flutter view | ❌ | ✔️ |
24+
| Running tests on multiple devices simultaneously | ❌ | ✔️ |
25+
| Running integration tests on device farms that offer Appium support | ❌ | ✔️ |
26+
| App interactions beyond Flutter’s contextuality (e.g., sending an OTP from a message application) | ❌ | ✔️ |
27+
28+
## Differences from Appium Flutter Driver
29+
30+
The current Appium Flutter Driver is built on top of the `flutter_test` SDK, which is deprecated.
31+
The potential deprecation ([Expand deprecation policy to package:flutter_driver](https://github.com/flutter/flutter/issues/139249))
32+
means this driver may not work with future Flutter updates. It also does not handle all cases, such as permission dialog handling.
33+
34+
## Why Use Appium Flutter Integration Driver?
35+
36+
This driver is built using [Flutter Integration Test](https://docs.flutter.dev/cookbook/testing/integration/introduction).
37+
38+
***Strong Typing & Fluent APIs:*** Ensures robust and easy-to-use interfaces.
39+
40+
***Element Handling***: Automatically waits for elements to attach to the DOM before interacting.
41+
42+
***Seamless Context Switching***: No need to switch between contexts, such as Flutter and native; the driver handles it effortlessly.
43+
44+
***Auto Wait for Render Cycles***: Automatically waits for frame render cycles, including animations and screen transitions.
45+
46+
***Simplified Powerful Gestures***: Supports powerful yet simplified gestures like LongPress, ScrollToElement, DragAndDrop, and DoubleClick.
47+
48+
***Element Chaining***: Allows chaining of elements, enabling you to find child elements under a specific parent easily.
49+
50+
51+
## What You'll Need
52+
53+
- Familiarity with creating, signing and building [Flutter apps](https://docs.flutter.dev/).
54+
- Familiarity writing and running [Appium tests](/mobile-apps/automated-testing/appium/).
55+
56+
## Use Sauce Labs `My Demo App Flutter`
57+
58+
[*My Demo App Flutter*](https://github.com/saucelabs/my-demo-app-flutter) is a mobile application developed using Flutter based
59+
on [Flutter Counter example application](https://github.com/felangel/bloc/tree/master/examples/flutter_counter).
60+
Modified by the Sauce Labs team, this app is designed to demonstrate the robust capabilities of Sauce Labs
61+
mobile devices cloud, with a particular focus on our integration with the [Appium Flutter Integration Driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver).
62+
63+
The apps can be found [here](https://github.com/saucelabs/my-demo-app-flutter/releases/tag/v1.0.0).
64+
- To download the demo app for Android please click [here](https://github.com/saucelabs/my-demo-app-flutter/releases/download/v1.0.0/sl_my_demo_flutter_app.apk).
65+
- To download the demo app for iOs please click [here](https://github.com/saucelabs/my-demo-app-flutter/releases/download/v1.0.0/sl_my_demo_flutter_app.ipa).
66+
67+
68+
## Prepare the app with Flutter Integration Server
69+
70+
1. Open your Flutter project in your favorite IDE.
71+
2. In your Flutter app's `pubspec.yaml`, add the following dependencies:
72+
73+
Get the latest version from `https://pub.dev/packages/appium_flutter_server/install`
74+
75+
```yaml
76+
dev_dependencies:
77+
appium_flutter_server: 0.0.14
78+
```
79+
80+
3. Create a directory called `integration_test` in the root of your Flutter project.
81+
4. Create a file called `appium_test.dart` in the `integration_test` directory.
82+
5. Add the following code to the `appium_test.dart` file:
83+
84+
```dart
85+
import 'package:appium_flutter_server/appium_flutter_server.dart';
86+
import 'package:appium_testing_app/main.dart';
87+
88+
void main() {
89+
initializeTest(app: const MyApp());
90+
}
91+
```
92+
If you are in need to configure certain prerequists before the testing app is loaded, you can try the following code:
93+
```dart
94+
import 'package:appium_testing_app/main.dart'; as app;
95+
void main() {
96+
initializeTest(
97+
callback: (WidgetTester tester) async {
98+
// Perform any prerequisite steps or intialise any dependencies required by the app
99+
// and make sure to pump the app widget using below statement.
100+
await tester.pumpWidget(const app.MyApp());
101+
},
102+
);
103+
}
104+
```
105+
106+
6. Build the Android app:
107+
108+
```bash
109+
./gradlew app:assembleDebug -Ptarget=`pwd`/../integration_test/appium_test.dart
110+
```
111+
112+
The APK file will be located in `{project-root}/build/app/outputs/flutter-apk/`
113+
114+
7. Build the iOS app:
115+
For Simulator - Debug mode
116+
```bash
117+
flutter build ios integration_test/appium_test.dart --simulator
118+
```
119+
120+
The app will be located in `{project-root}/build/ios/iphonesimulator/`
121+
122+
For Real Device - Release mode
123+
```bash
124+
flutter build ipa --release integration_test/appium_test.dart
125+
```
126+
127+
The IPA file will be located in `{project-root}/build/ios/ipa/`
128+
129+
Bingo! You are ready to run your tests using Appium Flutter Integration Driver.
130+
131+
## Uploading your Flutter App to Sauce Labs
132+
133+
You can now upload the built apps with our [REST API](/dev/api/storage/#upload-file-to-app-storage), or manually upload them to the preferred Data Center. See [Manually Uploading an App](/mobile-apps/live-testing/live-mobile-app-testing/#uploading-an-app) for more information.
134+
135+
## Configuring your Appium Capabilities
136+
137+
More information on how to write Appium tests for Flutter apps can be found in the [appium-flutter-integration-driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver) repository. You can also find a sample Flutter app and tests in the [Demo JS - Appium Flutter Integration](https://github.com/saucelabs-training/demo-js/tree/docs-1.3/webdriverio/appium-app/examples/appium-flutter-integration)-repository.
138+
139+
:::info APPIUM FLUTTER INTEGRATION DRIVER SUPPORT :
140+
[appium-flutter-integration-driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver). This driver will now be included by default with Appium version latest and all subsequent versions released after July 1st.
141+
142+
More information regarding the available [appium versions](/mobile-apps/automated-testing/appium/appium-versions/#Real-Devices) we support at Sauce Sabs.
143+
:::
144+
145+
### Real Devices
146+
147+
<Tabs
148+
groupId="capability-ex"
149+
defaultValue="java"
150+
values={[
151+
{label: 'Java', value: 'java'},
152+
{label: 'WDIO', value: 'ts'},
153+
]}>
154+
155+
<TabItem value="java">
156+
<Tabs groupId="capability-java"
157+
defaultValue="android"
158+
values={[
159+
{label: 'Android', value: 'android'},
160+
{label: 'iOS', value: 'ios'},
161+
]}>
162+
<TabItem value="android">
163+
164+
<!-- prettier-ignore -->
165+
```java
166+
MutableCapabilities capabilities = new MutableCapabilities();
167+
168+
capabilities.setCapability("platformName", "android");
169+
// W3C Protocol is mandatory for Appium 2
170+
capabilities.setCapability("appium:platformVersion", "12");
171+
capabilities.setCapability("appium:deviceName", "Google Pixel 6");
172+
// Mandatory for Appium 2
173+
capabilities.setCapability("appium:automationName", "FlutterIntegration");
174+
capabilities.setCapability("appium:app", "storage:filename=sl_my_demo_flutter_app.apk");
175+
176+
HashMap<String, Object> sauceOptions = new HashMap<String, Object>();
177+
// appiumVersion is mandatory to use Appium 2 on Sauce Labs
178+
sauceOptions.put("appiumVersion", "appium-20240701");
179+
sauceOptions.put("username", System.getenv("SAUCE_USERNAME"));
180+
sauceOptions.put("accessKey", System.getenv("SAUCE_ACCESS_KEY"));
181+
capabilities.setCapability("sauce:options", sauceOptions);
182+
```
183+
184+
</TabItem>
185+
<TabItem value="ios">
186+
187+
<!-- prettier-ignore -->
188+
```java
189+
MutableCapabilities capabilities = new MutableCapabilities();
190+
191+
capabilities.setCapability("platformName", "ios");
192+
// W3C Protocol is mandatory for Appium 2
193+
capabilities.setCapability("appium:platformVersion", "16");
194+
capabilities.setCapability("appium:deviceName", "iPhone 14");
195+
// Mandatory for Appium 2
196+
capabilities.setCapability("appium:automationName", "FlutterIntegration");
197+
capabilities.setCapability("appium:app", "storage:filename=sl_my_demo_flutter_app.ipa");
198+
199+
HashMap<String, Object> sauceOptions = new HashMap<String, Object>();
200+
// appiumVersion is mandatory to use Appium 2 on Sauce Labs
201+
sauceOptions.put("appiumVersion", "appium-20240701");
202+
sauceOptions.put("username", System.getenv("SAUCE_USERNAME"));
203+
sauceOptions.put("accessKey", System.getenv("SAUCE_ACCESS_KEY"));
204+
capabilities.setCapability("sauce:options", sauceOptions);
205+
```
206+
207+
</TabItem>
208+
</Tabs>
209+
</TabItem>
210+
<TabItem value="ts">
211+
212+
<Tabs
213+
groupId="capability-js"
214+
defaultValue="android"
215+
values={[
216+
{label: 'Android', value: 'android'},
217+
{label: 'iOS', value: 'ios'},
218+
]}>
219+
<TabItem value="android">
220+
221+
<!-- prettier-ignore -->
222+
```ts
223+
const capabilities = {
224+
platformName: 'android',
225+
// W3C Protocol is mandatory for Appium 2
226+
'appium:platformVersion': '12',
227+
'appium:deviceName': 'Google Pixel 6',
228+
// Mandatory for Appium 2
229+
'appium:automationName': 'FlutterIntegration',
230+
'appium:app': 'storage:filename=sl_my_demo_flutter_app.apk',
231+
'sauce:options': {
232+
// appiumVersion is mandatory to use Appium 2 on Sauce Labs
233+
appiumVersion: 'appium-20240701'
234+
}
235+
}
236+
```
237+
238+
</TabItem>
239+
<TabItem value="ios">
240+
241+
<!-- prettier-ignore -->
242+
```ts
243+
const capabilities = {
244+
platformName: 'ios',
245+
// W3C Protocol is mandatory for Appium 2
246+
'appium:platformVersion': '16',
247+
'appium:deviceName': 'iPhone 14',
248+
// Mandatory for Appium 2
249+
'appium:automationName': 'FlutterIntegration',
250+
'appium:app': 'storage:filename=sl_my_demo_flutter_app.ipa',
251+
'sauce:options': {
252+
// appiumVersion is mandatory to use Appium 2 on Sauce Labs
253+
appiumVersion: 'appium-20240701'
254+
}
255+
}
256+
```
257+
258+
</TabItem>
259+
</Tabs>
260+
</TabItem>
261+
</Tabs>

‎docs/mobile-apps/automated-testing/appium/appium-flutter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99
import Tabs from '@theme/Tabs';
1010
import TabItem from '@theme/TabItem';
1111

12+
:::warning Appium Flutter Driver
13+
The [`appium-flutter-driver`](https://github.com/appium-userland/appium-flutter-driver/). is now considered a legacy driver by Appium,
14+
meaning no bug fixes or updates will be released. However, it can still be used when running tests on Sauce Labs.
15+
We advise transitioning to the [appium-flutter-integration-driver](https://github.com/AppiumTestDistribution/appium-flutter-integration-driver).
16+
A guide on how to run tests on Sauce Labs using the new driver can be found [here](/mobile-apps/automated-testing/appium/appium-flutter-integration-driver).
17+
:::
18+
1219
Sauce Labs supports testing Flutter apps on Android and iOS virtual and real devices with Appium by supporting the [`appium-flutter-driver`](https://github.com/appium-userland/appium-flutter-driver/). The process to test Flutter apps with Appium involves an extra and important step, which is [preprocessing your app](#preprocessing-your-flutter-app). After that you can [build](#building-your-flutter-app) it, [upload](#uploading-your-flutter-app-to-sauce-labs) it to Sauce Labs, [configure your Appium capabilities](#configuring-your-appium-capabilities) and run your tests.
1320

1421
## What You'll Need

‎docs/testfairy/testfairy.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,26 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
Welcome to TestFairy, the App Center distribution alternative! Use our enterprise-grade app distribution capabilities to migrate from App Center before March 31, 2025!
1010

11-
## Distribute App to Testers
12-
13-
TestFairy offers enterprise-grade app distribution capabilities, allowing companies to easily and securely distribute the right apps to the right users. The platform allows admins to enforce corporate security policies during testing, and has the capability to automatically update apps to new versions or revoke access to installed apps or users.
11+
## Store and Manage Apps
1412

15-
For more information, see [Managing Testers](/testfairy/testers/managing-testers/).
13+
TestFairy offers robust, enterprise-grade app storage capabilities, enabling companies to securely upload, download, and manage their apps with ease. With TestFairy, you can efficiently organize and deliver the right apps to the right users while maintaining high security standards.
1614

17-
## Analyze User Behavior
15+
For more information, see [Managing Apps through API](/testfairy/api-reference/rest-api/).
1816

19-
TestFairy provides mobile teams with videos showing exactly what happened during a mobile device test, before a crash, or before something went wrong, which ensures that bugs are fixed quickly.
17+
## Distribute App to Testers
2018

21-
For more information, see [Adding the TestFairy SDK](/testfairy/sdk/adding-tf-sdk/).
19+
TestFairy offers enterprise-grade app distribution capabilities, allowing companies to easily and securely distribute the right apps to users like internal or external beta testers. The platform allows admins to enforce corporate security policies during testing, and has the capability to automatically update apps to new versions or revoke access to installed apps or users.
2220

23-
## Collect Feedback
21+
For more information, see [Managing Testers](/testfairy/testers/managing-testers/).
2422

25-
TestFairy's feedback features help users provide feedback by shaking their device or taking a screenshot. A report can automatically be posted to Jira along with the session video recording, logs, metrics, and crash reports.
23+
## Manage everything through API and Integrations
2624

27-
For more information, see [Getting Feedback](/testfairy/sdk/user-feedback/).
25+
TestFairy provides comprehensive API and integration capabilities, allowing companies to automate app management, user management, beta testers and seamlessly integrate with existing workflows. Use our APIs to manage app/user distribution or enforce security policies programmatically.
26+
Integrate TestFairy with your CI/CD pipelines, project management tools, and other enterprise systems to streamline your app development and distribution process.
27+
For more information, see [API Reference guide](/testfairy/api-reference/rest-api/)
2828

2929
## Security
3030

3131
TestFairy is available as a private cloud or an on-premise installation and can integrate with any SAML single sign-on service. TestFairy is the only platform that provides end-to-end data encryption using your private/public keys, so your data remains private.
3232

33-
For more information, see [End to End Data Encryption](/testfairy/sdk/security/data-encryption/).
33+
For more information, see [SSO](/testfairy/security/sso/sso-intro/), or [Private Cloud](/testfairy/security/sso/sso-intro/).

‎sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1403,6 +1403,7 @@ module.exports = {
14031403
'mobile-apps/automated-testing/appium/virtual-devices',
14041404
'mobile-apps/automated-testing/appium/test-app-upgrades',
14051405
'mobile-apps/automated-testing/appium/appium-flutter',
1406+
'mobile-apps/automated-testing/appium/appium-flutter-integration-driver',
14061407
],
14071408
},
14081409
{

0 commit comments

Comments
 (0)