First step in writing tests using coteafs-appium framework is defining a Yaml config file in the src/test/resources folder.

(For more details, check the link above.)

Sample file is shown below.

servers:
  android:
    host: 127.0.0.1
    port: 4723
    external: true
    arguments:
      log_level: DEBUG
      log_time_stamp: true
      local_time_zone: true
      session_override: true
      android:
        suppress_adb_kill_server: true
devices:
  test:
    platform_type: ANDROID
    device_name: MI Redmi Note 4
    device_version: 7.0
    app_type: HYBRID
    device_type: REAL
    automation_name: APPIUM
    app_location: apps/android/VodQA.apk
    session_timeout: 120000
    playback:
      delay_before_swipe: 200
      delay_after_swipe: 100
      delay_before_tap: 0
      delay_after_tap: 0

By using Action classes for each Activity, the flow specific for that activity can be modularized and tests looks much clean and readable. See the sample test below.

import org.testng.annotations.AfterClass;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;

import com.github.wasiqb.coteafs.appium.android.vodqa.actions.LoginActivityAction;
import com.github.wasiqb.coteafs.appium.service.AppiumServer;

public class SampleTest {
    protected AndroidDevice androidDevice;
    private   AppiumServer  androidServer;

    @BeforeClass
    public void setupTestSuite () {
        // Here the parameter refers to the key in server block in config file.
        this.androidServer = new AppiumServer ("android");
        this.androidServer.start ();

        // Here the param refers to the key in devices block in config file.
        this.androidDevice = new AndroidDevice (this.androidServer, "test");
        this.androidDevice.start ();
    }

    @AfterClass (alwaysRun = true)
    public void tearDownTestSuite () {
        this.androidDevice.stop ();
        this.androidServer.stop ();
    }

    @Test
    public void login () {
        final LoginActivityAction login = new LoginActivityAction (this.androidDevice);
        login.addInputValue ("UserName", "admin")
            .addInputValue ("Password", "admin")
            .perform ();
    }
}

New class needs to be created for each Activity. There's an abstract activity class for each type of device. Here prepare method needs to be implemented with all the elements available on that Activity.

See the below sample for an Android activity with comments for better understanding.

import org.openqa.selenium.By;

import com.github.wasiqb.coteafs.appium.android.AndroidDevice;
import com.github.wasiqb.coteafs.appium.device.DeviceElement;

public class LoginActivity extends AndroidActivity {
    public LoginActivity (final AndroidDevice device) {
        super (device);
    }

    @Override
    protected DeviceElement prepare () {
        final DeviceElement main = DeviceElement.create ("Main")
            .forAndroid (By.id ("android:id/content"));
        DeviceElement.create ("Back")
            .parent (main)
            .forAndroid (By.xpath ("//android.widget.TextView[@text=\"Back\"]"))
            // We can set multiple locators for different Automation names.
            .forAndroid (AutomationType.UIAUTOMATOR2,
                MobileBy.AndroidUIAutomator ("new UiSelector ().text (\"Back\");"));
        DeviceElement.create ("UserName")
            .forAndroid (MobileBy.AccessibilityId ("username"))
            .parent (main);
        DeviceElement.create ("Password")
            .forAndroid (MobileBy.AccessibilityId ("password"))
            .parent (main);
        DeviceElement.create ("Login")
            .index (1)    // Index of element when multiple elements for same locator exists.
            .waitStrategy (WaitStrategy.VISIBLE)  // Wait strategy to be used while finding the element.
            .forAndroid (MobileBy.AccessibilityId ("login"))     // Locator used to find the element.
            .parent (main);    // Parent of current element.
        return main;
    }
}

There is abstract action class provided by the framework where Activity specific flow is implemented in perform method. See the sample Activity action class below.

import com.github.wasiqb.coteafs.appium.android.AndroidActivityActions;
import com.github.wasiqb.coteafs.appium.android.AndroidDevice;
import com.github.wasiqb.coteafs.appium.android.vodqa.activities.LoginActivity;

public class LoginActivityAction extends AndroidActivityActions {
    public LoginActivityAction (final AndroidDevice device) {
        super (device);
    }

    @Override
    public void perform () {
        final LoginActivity login = new LoginActivity (getDevice ());
        login.onElement ("UserName")
            .enterText (value ("UserName"));
        login.onElement ("Password")
            .enterText (value ("Password"));
        login.onDevice ()
            .hideKeyboard ();
        login.onElement ("Login")
            .tap ();
    }
}