This project has been created to demonstrate how a QA Engineer can perform Mobile Testing using Appium + WebDriver.IO More commands and insights about the integration at WebDriverIO Appium docs
We need node js to download Appium beta version & drivers easily.
- Download Node Js depending on your operating system.
I Tested the following steps on MAC OS Monterrey:
- Installed Adopted Open JDK with Homebrew
- To return where was the SDK installed I used the command:
/usr/libexec/java_home- If you want to check the java version:
/usr/libexec/java_home -V- Open the zshenv file to insert the JAVA_HOME variable (i):
vim ~/.zshenv- Enter the environment variable and save the vim session (:wq!):
export JAVA_HOME=$(/usr/libexec/java_home)- Source and apply the changes in the system:
source ~/.zshenv- You can check if it was set correctly running the command:
echo $JAVA_HOME- It should return something like:
/Library/Java/JavaVirtualMachines/adoptopenjdk-16.jdk/Contents/HomeTested the following steps on MAC OS Monterrey:
- Android studio on Mac can be located at:
* cd /Users/[USER]/Library/Android/sdk- We need to add a reference to a couple of folders inside of that SDK
- Tools & Platform Tools
- Open the zshenv file to insert the ANDROID_HOME variable (i):
vim ~/.zshenv- Enter the environment variables and save the vim session (:wq!):
export ANDROID_HOME="/Users/[USER]/Library/Android/sdk"
export PATH=$ANDROID_HOME/platform-tools:$PATH
export PATH=$ANDROID_HOME/tools:$PATH- Source and apply the changes in the system:
source ~/.zshenv- You can check if it was set correctly running the command:
echo $ANDROID_HOME- It should return something like:
/Users/[USER]/Library/Android/sdk- With this configured you can access the command Android Debug Bridge
adb- Install XCode from the MacOs App Store
- Install XCode Command line tools
xcode-select --install- Make sure it is installed correctly using the following command:
xcode-select -p- It should return something like(may defer from your OS version):
/Applications/Xcode.app/Contents/Developer- Install Carthage(It is a simple dependency manager for macOS and iOS, created by a group of developers from GitHub).
brew install carthageIn order to find the correct locators to map elements, you will need to have this tool installed in your computer.
For this project you can use the following configuration:
| Server Key | Server Value |
|---|---|
| Remote Host | 0.0.0.0 |
| Remote Port | 4724 |
| Remote Path | / |
Android Desired Capabilities(Example)
| Desired Capability Key | Desired Capability Value |
|---|---|
| platformName | Android |
| platformVersion | [OS VERSION / IMAGE] |
| deviceName | [EMULATED_DEVICE_NAME] |
| app | /[PROJECT_PATH]/[APP_NAME].apk |
| appium:automationName | UIAutomator2 |
IOS Desired Capabilities(Emulator - App)
| Desired Capability Key | Desired Capability Value |
|---|---|
| platformName | IOS |
| platformVersion | [OS VERSION / IMAGE] |
| deviceName | [EMULATED_DEVICE_NAME] |
| app | /[PROJECT_PATH]/[APP_NAME].app |
| appium:automationName | XCUItest |
Appium is an open source test automation framework for use with native, hybrid and mobile web apps. It drives iOS, Android, and Windows apps using the WebDriver protocol.
npm install -g appium@nextCheck the appium version using
appium -vTo check if your OS meets the appium requirements, install this node package.
- Appium Doctor Package Install it using the command
npm install appium-doctor -gAnd then use the library:
appium-doctorIf you want Appium to work correctly, you need to download and have the android/ios driver in your system. Run the commands:
appium driver install xcuitest
appium driver install uiautomator2Check the installed drivers using
appium driver listSample Application that you can use:
SauceDemo Hybrid App - React Native) - (Framework is configured to use this one)
Sauce Labs Native Sample Application
WebdriverIO Demo App for iOS and Android
Important Note: For IOS you are going to need an app build to run it in simulators, but an .IPA file to run it in real devices. It required additonal desired capabilities, and you can see which ones in the next article: Appium XCUITest Driver Real Device Setup
1- Run the command to create the package.json & continue with the installation process
npm init wdio .2- Using the WDIO Configuration Helper select the options you want to select. In my case I decided to use:
- On my local machine
- Mocha
- No compiler
- Spect Location: Default
- Do you want WebDriverIO to generate some test files?: No
- Reporter: Spec
- No Plugin
- Service: Appium
- Base URL: Default
- NPM Install: Yes
3- Add your tests at
'./[yourProject]/specs/**/*.js'4- Configure the app route at wdio.conf.js
- Declare where it is going to be located
const projectPath = require('path')
const androidAppPath = projectPath.join(process.cwd(), "app/android/Android-MyDemoAppRN.1.3.0.build-244.apk")
const iosAppPath = projectPath.join(process.cwd(),"app/ios/MyRNDemoApp.app");- Set up the capabilities for Android(Emulator sample)
capabilities: [{
platformName: 'Android',
"appium:device-name": 'Pixel 4 API 30(R)',
"appium:platformVersion": "11.0",
"appium:automationName": "UIAutomator2",
"appium:app": androidAppPath,
// "appium:appWaitActivity": "com.swaglabsmobileapp.MainActivity"(For OLD swaglabs app)
}]- Set up the capabilities for Android(Emulator sample)
capabilities: [{
platformName: 'IOS',
"appium:device-name": 'iPhone 13 Pro Max',
"appium:platformVersion": "16.0",
"appium:automationName": "XCUItest",
"appium:app": iosAppPath,
}]- Install Appium in your project
npm install --save-dev appium@next- Check if the drivers are still available, if not install them again:
appium driver listappium driver install xcuitest
appium driver install uiautomator2- Run your scripts using
npx wdioif you want to run this project:
1- Install all the system requirements
2- Clone the project
3- Run: npm i
4- Download the android app and place it under app/android or app/IOS
5- npm run wdioIOS/wdioAndroid
- To manage node versions you can install "n" using the command "npm install -g n". Then you can install the version you may need, for instance "n 16.15.1"(LTS version where this project is working fine.)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent