Prerequisite

For Android - Configuring your Windows/Mac/Linux and Android device for Android Native Test Execution

For iOS - Configuring your Mac and iOS device for iOS Native Test Execution


If you would like to avoid the above configuration, you may follow the below guide for inspecting the Application on Cloud devices preconfigured for Automation.

Configuring Appium Desktop Inspector to inspect Android/iOS Apps from TestObject


Note: You need a TestObject/SauceLabs Account for inspecting Apps on TestObject. We can provide you a complementary TestObject Account on demand if you have subscribed for Pro Plan with Testsigma.


Appium Desktop  - Local Configuration

Appium Desktop is an open source app for Mac, Windows, and Linux which allows you to use Appium Server in a intuitive and powerful GUI as compared to the command line Appium tool.

You can install it from here - Appium Desktop


Appium Inspector is a component of the Appium Desktop application that allows us to inspect mobile Apps.


On opening the Appium Desktop Client, it will look as shown below:



1. First, click on the Start Server button to start the Server. Your Appium Server will start running and it will look as shown below:

Note: It is highly recommended to keep the Port number unchanged unless you are a System Administrator since other port numbers might be used by another Application.



Appium Server has started now.


2. Click on the Start Inspector Session button(first icon on top right corner with the lens icon) to open the Inspector Session Configuration page. 

Since we have already started Appium Server, the default option is to attach the new Inspector session to the already running Appium Server i.e the Automatic Server tab.


Please check the following article for more details on configuring the session to inspect apps from TestObject

Configuring Appium Desktop Inspector to inspect Android/iOS Apps from TestObject


Desired Capabilities

Below given are a set of minimum Desired Capabilities we need to add in order to inspect an Android/iOS App using the Inspector in a local Appium Session.


Desired Capabilities for Android

  • platformName: We need to provide the value 'Android'.
  • platformVersion: As per the version of your Android Device/Simulator.
  • deviceName: Providing a deviceName is optional.
  • appPackage: Package name of the app to be automated.
  • appActivity: Name of the Activity of the App we need to start with.


Here's a sample set:

{
  "platformName": "Android",
  "platformVersion": "8.1",
  "deviceName": "Redmi 5 Pro",
  "appPackage": "org.wikipedia",
  "appActivity": ".main.MainActivity"
}


Desired Capabilities for iOS

  • platformName: We need to provide the value 'iOS'.
  • platformVersion: As per the version of your iOS Device/Simulator.
  • deviceName: Providing a deviceName is optional.
  • app: Path to the app to be automated.
  • udid: UDID of the device.
  • bundleID: Bundle ID of the app to be automated.


Here's a sample set:

{
  platformName: "iOS",
  platformVersion: "12.0",
  deviceName: "iPhone X",
  app: "~/Documents/TestApp.ipa",
  udid: "12345678-ABCD-DEFG-AVBFJDSKFL"
}



Enter the above given Desired Capabilities in the Appium Inspector Session Configuration window as shown below:


Finally, click on Start Session to start the session and inspect the Apps using Appium Inspector.


Thus, we have successfully started a local Appium Server and Appium Inspector session for inspecting your Mobile App.

Please check the below article for a detailed video on inspecting Android/iOS Apps using Appium - How to inspect UI Identifiers for Android/iOS Apps using Appium Desktop Inspector?


Happy Automation!