How to Setup and Automate iOS mobile application using Appium in Mac?

 

Work Flow of Appium

As discussed in the “How to Automate Android Mobile Application using Appium?” posting, Appium test script written in IDE will interact with the Appium Server which is nothing but the node server with the specified IP address and port number. Node server again passes the request to mobile devices or emulator using the uiautomation in Mac. All the UI elements associated with the mobile application can be controlled by using the appium client which is nothing but the derived one of selenium.

The following information is going to explain about the iOS application automation using Appium + TestNG + Core Java in Mac. Please note, this posting going to explain the iOS automation using the .APP file generated from the xcode project and all the automation testing happened using iPhone simulator.

How to setup Appium in Mac?

The following pre-requisites make it available at your end before start setting up Appium in Mac;

1. Latest JDK (Pre-installed in most of the Mac)
2. Appium.dmg for Mac
3. Latest Eclipse IDE for Mac
4. Source code of iOS app (xcode project)

Once the above pre-requisite is ready, start writing the test scripts in the newly created class file under java project by mapping the external dependencies of JAR files (Selenium & Appium client)

Now, we can see the above pre-requisite information in an elaborate way;

Pre-requisite 1:

Ensure the Java installation in the command prompt by entering java -version based on the below screenshot;

Pre-requisite 2:

Download the Appium Installer from https://bitbucket.org/appium/appium.app/downloads/ and install the dmg file in your Mac;

Ensure Appium is successfully installed and running based on the below screenshot;

Ensure the below settings in the Appium server;

Pre-requisite 3:

Download and install the Eclipse IDE from http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/marsr

TestNG should be downloaded from Eclipse market place and integrate with Eclipse IDE based on the below screenshot;

Go to help menu in Eclipse IDE and install the TestNG from Available software option;

Pre-requisite 4:

Get the source code(sample project) from the github using the URL https://github.com/appium/ios-uicatalog and download the zip file;

• Unzip the file and click the .xcodeproj file associated with the folder
• Select the build deployment target based on the available SDK mapped in the xcode

• Select the appropriate simulator in XCODE IDE to run the test application based on the below screenshot;

Go to the terminal window available in the ‘Applications’ to build the source code without any errors and it will generate the .APP file for automating the same using Appium;

Go to the source code location in the terminal windows and build based on the following command as mentioned in the screenshot;

You will be getting the below succeeded message if there is no compilation or run time errors associated with the source code.

Ensure .APP file has been generated under the Downloads -> ios-uicatalog-master -> build -> Release-iphonesimulator

All the pre-requisites are ready at our end and now coming to the script preparation for automating an iOS mobile application.

1. Create a java project in Eclipse IDE as AppiumDemo

2. Create a new package as appium.test(your own name) and class as AppiumTest(your own name) based on the below screenshot;

3. Now add the script in the AppiumTest.java file in Eclipse IDE;

Before entering in to the script preparation, I would like to highlight the importance of Inspector option available in the Appium server;

It will help us to trace the mobile elements, which is used for triggering the user actions like click, enter text etc.

Go to Eclipse IDE –> Project –> Properties –> Select ‘Java Build Path’ in left pane and select the ‘Libraries’ tab and select the ‘Add External Jars…’ to map all the dependencies jar as mentioned below;

Selenium supporting jars from http://www.seleniumhq.org/download/ (Java)

Appium client libraries jars from http://appium.io/downloads.html (Java)

Add the selenium-java-2.47.1.jar and all jar files available in the libs folder and enable the same based on the below screenshot.

Everything is ready and we need to map the generated .APP file in the Appium server to trigger the user actions in the iOS app installed in the simulator.

Launch the Appium server and it will start to run by invoking the iPhone simulator and the .APP file will be showing based on the below screenshot. Please quit the simulator in which while running script in Eclipse IDE, it will automatically invoke the simulator using Appium.

Add the below script and run the test script in the Eclipse IDE;

package appium.test;

import io.appium.java_client.ios.IOSDriver;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;

import org.apache.commons.io.FileUtils;
import org.openqa.selenium.By;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.Augmenter;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

public class AppiumTest {
 
 
 @SuppressWarnings("rawtypes")
 private IOSDriver driver;
 
 @SuppressWarnings("rawtypes")
 @BeforeMethod
 public void setUp() throws MalformedURLException {
 DesiredCapabilities caps = new DesiredCapabilities();
 caps.setCapability("platformName", "iOS");
 caps.setCapability("platformVersion", "7.1"); 
 caps.setCapability("deviceName", "iPhone Simulator"); 
// caps.setCapability("bundleid", "com.example.apple-samplecode.UICatalog");
 caps.setCapability("app", "/Users/gopikannan/Downloads/ios-uicatalog-master/build/Release-iphonesimulator/UICatalog.app"); 
 driver = new IOSDriver(new URL("http://127.0.0.1:4725/wd/hub"), caps);
 }
 
 @Test
 public void testiOS() throws InterruptedException, IOException {
 driver.findElement(By.xpath("//UIAApplication[1]/UIAWindow[1]/UIATableView[1]/UIATableCell[1]/UIAStaticText[1]")).click();
 driver.findElement(By.xpath("//UIAApplication[1]/UIAWindow[1]/UIATableView[1]/UIATableCell[1]/UIAStaticText[1]")).click();
 driver.findElement(By.name("OK")).click();
 Thread.sleep(2000);
 File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);
 FileUtils.copyFile(scrFile, new File("/Users/gopikannan/Downloads/g2.jpg"));
 
 }
 
 @AfterMethod
 public void tearDown() {
 driver.quit();
 }
 
}

Go to Eclipse IDE and right click the mouse button in script window by selecting the ‘Run as’ option and again select the TestNG Test’ as mentioned in the below screenshot;

That’s it!!! You script will be executed in the mobile application installed in the iPhone Simulator.

Please check the below Post/URL to start automating the latest iOS 10 and above including xcode 8 and above;

https://gopekannan.wordpress.com/2017/08/26/how-to-setup-appium-in-mac-for-automating-ios-10-and-above/