Appium: Creating Automation Source Code Based on Test Specifications
Introduction
Hi, my name is Pann Nu Wai, and I am part of the QA Group at KINTO Technologies. As a Test Automation Specialist for the App team in the QA Group, I am responsible for building and maintaining the test automation environment for the KINTO Kantan Moushikomi App, as well as writing test specifications and test scripts.
Previously, I wrote a technical article about DarkMode automation testing using Appium.
I have been working with automated testing using Appium for three years. In my team, we follow a process where test specifications are defined first before writing the automated test source code. So, in this post, I’d like to share an approach to creating test specifications that has proven highly useful when writing Java source code for Appium.
Before diving into the details, I’ll first explain why this method of creating test specifications is essential.
Benefits of Creating Test Specifications
- Saves time when writing automated test source code.
- Easy to understand even for non-automation testers.
- Improves readability by organizing specifications by screen, source code class, and operation function.
In this article, we will use the login scenario specification for the KINTO Kantan Moushikomi App as a sample test specification.
Login steps
Here, we will explain each step of logging in to the KINTO Kantan Moushikomi App.
Step 1
Step 2
Step 3
Collecting Test Data for Login
As the first step in creating a login test specification, it is essential to gather test data, including the test environment, test account, password, report name (automatically generated after test execution), and test execution file. Now, let’s begin with the iOS login scenario specification.
| Data Name | Data Information |
|---|---|
| Environment | Stg4 |
| Test Account | ******@gmail.com |
| Password | ******** |
| Report Name | For iOS iOS.poc.login For Android android.poc.login |
| Executable Source File | For iOS iOS.poc.login.xml For Android android.poc.login.xml |
Login Scenario Specification for iOS
| Confirmation Function | Screen | Operation | Points to Check | Executable File (xml) | Source File | Method |
|---|---|---|---|---|---|---|
| Log in | Main Screen | Click on the My Page logo | The login button can be pressed | iOS.poc.login.xml | iOS.MainPage | clickMyPagingLogo |
| My Page Screen | Click on "Application Details" Press "Log in here!" |
iOS.MyPagingPage | clickApplyTab clickLoginHereButton |
|||
| Login Screen | Enter the above test account in the "Email address (KINTO ID)" field. Enter the above password in the "Login Password" field. Click "Log in to My KINTO" |
iOS.LoginPage | fillMailAddress fillPassword clickToMyKintoLoginButton |
Now let’s create a Java class for each screen in the scenario specification. First, click the My Page logo on the main screen (MainPage.java).
MainPage.java
public class MainPage extends Base {
public static final String MY_PAGING_LOGO =
"//XCUIElementTypeButton[@name="My Page"]";
/**
* Test method for clicking the "My Page" logo on the main screen
*
* This method uses XPath to locate the "My Page" logo on the main page
* and performs a click action.
*
*/
@Test(groups = "MainPage")
public void clickMyPagingLogo() {
driver.findElementByXPath(MY_PAGING_LOGO).click();
}
}
Step 2: Click "Application Details" on the My Page screen, then click "Log in here."
MyPagingPage.java
public class MyPagingPage extends Base {
public static final String APPLY_TAB =
"//XCUIElementTypeButton[@name="Application Details"]";
public static final String LOGIN_HERE_BUTTON =
"//XCUIElementTypeButton[@name="Log in to My KINTO"]";
/**
* Test method to click "Application Details" on the My Page screen
*
* This method uses XPath to identify the "Application Details" on the My Page screen,
* and performs a click action.
*
*/
@Test(groups = "MyPagingPage", dependsOnGroups = "MainPage")
public void clickApplyTab() {
driver.findElementByXPath(APPLY_TAB).click();
}
/**
* A test method to click "Log in here" on the My Page screen
*
* This method uses XPath to identify "Log in here" on the My Page screen,
* and performs a click action.
*
*/
@Test(groups = "MyPagingPage", dependsOnMethods = "clickApplyTab")
public void clickLoginHereButton() {
driver.findElementByXPath(LOGIN_HERE_BUTTON).click();
}
}
Next, in step 3, enter your email address and password on the Login Screen, then press the Login button.
LoginPage.java
public class LoginPage extends Base {
public static final String EMAIL_TEXT_FIELD =
"//XCUIElementTypeApplication[@name="KINTO Easy Application"]/XCUIElementTypeOther[2]/XCUIElementTypeTextField";
public static final String PASSWORD_TEXT_FIELD =
"//XCUIElementTypeApplication[@name="KINTO Easy Application"]/XCUIElementTypeOther[3]/XCUIElementTypeSecureTextField";
public static final String ENTER_KEY =
"//XCUIElementTypeButton[@name="Return"]";
public static final String TO_MY_KINTO_LOGIN_BUTTON =
"//XCUIElementTypeButton[@name="Log in to My KINTO"]";
/**
* A test method to enter a test account in the "Email address (KINTO ID)" field on the login screen
*
* This method uses XPath to search for the "email address" on the login screen
* and enter the test account (Parameter) in the xml file.
*
*/
@Parameters("email")
@Test(groups= "LoginPage", dependsOnGroups = "MyPagingPage")
public void fillMailAddress(String email) {
driver.findElementByXPath(EMAIL_TEXT_FIELD).click();
driver.getKeyboard().sendKeys(email);
}
/**
* A test method to enter a password in the "Login Password" field on the login screen.
*
* This method uses XPath to get the login password from the login screen.
* and enter the password (Parameter) for the xml file.
*
*/
@Parameters("password")
@Test(groups= "LoginPage", dependsOnGroups = "MyPagingPage")
public void fillPassword(String password) {
driver.findElementByXPath(PASSWORD_TEXT_FIELD).click();
driver.getKeyboard().sendKeys(password);
driver.findElementByXPath(ENTER_KEY).click();
}
/**
* A test method to click "Log in to My KINTO" on the login screen
*
* This method uses XPath to identify "Log in to My KINTO" on the login screen,
* and performs a click action.
*
*/
@Test(groups= "LoginPage", dependsOnGroups = "MyPagingPage")
public void clickToMyKintoLoginButton() {
driver.findElementByXPath(TO_MY_KINTO_LOGIN_BUTTON).click();
}
}
The xml file below is the test execution file for automated testing. Each function is written in sequence based on the test specification.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE suite SYSTEM "http://testng.org/testng-1.0.dtd">
<suite name="iOS.poc.login">
<test verbose="2" name="iOS.poc.login">
<classes>
<class name="iOS.MainPage">
<methods>
<include name="clickMyPagingLogo"/>
</methods>
</class>
<class name="iOS.MyPagingPage">
<methods>
<include name="clickApplyTab"/>
<include name="clickLoginHereButton"/>
</methods>
</class>
<class name="iOS.LoginPage">
<methods>
<parameter name="email" value="******.gmail.com"/>
<parameter name="password" value="*********"/>
<include name="fillMailAddress"/>
<include name="fillPassword"/>
<include name="clickToMyKintoLoginButton"/>
</methods>
</class>
</classes>
</test>
</suite>
Summary
In this article, we've outlined how to create test specifications for Appium Java source code. However, we believe this approach will be valuable not only for those working with Appium but also for developing automated test source code across different frameworks.
関連記事 | Related Posts
イベント情報
