Best Strategies for Mobile Test Automation Framework Design

// Create a wrapper method for clicking an element
public void clickElement(By locator) {
  driver.findElement(locator).click();
}

// Create a library class for common actions
public class CommonActions {

  // Declare and initialize the driver object
  public static AppiumDriver driver = new AppiumDriver(new URL("http://127.0.0.1:4723/wd/hub"), new DesiredCapabilities("deviceName", "Pixel 4", "platformName", "Android", "platformVersion", "11", "appPackage", "com.example.loginapp", "appActivity", "com.example.loginapp.MainActivity", "noReset", true));

// Create a component class for a specific feature
public class ProfileComponent {

  // Declare the driver object
  private AppiumDriver driver;

  // Constructor to initialize the driver
  public ProfileComponent(AppiumDriver driver) {
    this.driver = driver;
  }

  // Method to update the profile information
  public void updateProfile(String name, String email, String phone) {

    // Use the wrapper method to click the profile link, clear and enter the name, email, and phone fields, and click the save button
    clickElement(By.linkText("Profile"));
    driver.findElement(By.id("name")).clear();
    driver.findElement(By.id("name")).sendKeys(name);
    driver.findElement(By.id("email")).clear();
    driver.findElement(By.id("email")).sendKeys(email);
    driver.findElement(By.id("phone")).clear();
    driver.findElement(By.id("phone")).sendKeys(phone);
    clickElement(By.id("save"));
  }
}

// Import the required libraries
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;
import org.testng.ITestResult;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeClass;

public class BaseTest {
  // Declare the driver and logger objects

  protected AppiumDriver driver;
  protected Logger logger;
  @BeforeClass
  public void setup() {

    // Initialize the logger object and load the log4j properties file
    logger = Logger.getLogger(BaseTest.class);
    PropertyConfigurator.configure("log4j.properties");
  }
  @AfterMethod
  public void tearDown(ITestResult result) {

    // Log the test result and take a screenshot if the test failed
    if (result.getStatus() == ITestResult.FAILURE) {
      logger.error("Test failed: " + result.getName());
      File srcFile = ((TakesScreenshot) driver).getScreenshotAs(OutputType.FILE);
      FileUtils.copyFile(srcFile, new File("screenshots/" + result.getName() + ".png"));
    } else {
      logger.info("Test passed: " + result.getName());
    }

    // Quit the driver
    driver.quit();
  }
}

Feature: Login to the mobile app
  As a user
  I want to login to the mobile app
  So that I can use the features
  Scenario: Successful login with valid credentials
    Given I launch the mobile app
    When I enter "testuser" as the username
    And I enter "testpass" as the password
    And I tap on the login button
    Then I should see the initial screen
    And I should see a welcome message


import io.cucumber.java.en.*;
import io.appium.java_client.*;
import org.openqa.selenium.*;
import java.net.*;
public class LoginSteps {
  // Declare and initialize the driver object
  public static AppiumDriver driver = new AppiumDriver(new URL("http://127.0.0.1:4723/wd/hub"), new DesiredCapabilities("deviceName", "Pixel 4", "platformName", "Android", "platformVersion", "11", "appPackage", "com.example.loginapp", "appActivity", "com.example.loginapp.MainActivity", "noReset", true));
@When("I enter {string} as the username")
public void i_enter_as_the_username(String username) {
  // Enter the username
  driver.findElement(By.id("com.example.loginapp:id/username")).sendKeys(username);
}
@When("I enter {string} as the password")
public void i_enter_as_the_password(String password) {
  // Enter the password
  driver.findElement(By.id("com.example.loginapp:id/password")).sendKeys(password);
}
@When("I tap on the login button")
public void i_tap_on_the_login_button() {
  // Tap on the login button
  driver.findElement(By.xpath("//android.widget.Button[@text='Login']"))
    .click();
}
@Then("I should see the home screen")
public void i_should_see_the_initial_screen() {
  // Verify the home screen
  assert(driver.findElement(By.id("com.example.loginapp:id/menu")).isDisplayed());
}
@Then("I should see a welcome message")
public void i_should_see_a_welcome_message() {
  // Verify the welcome message
  assert(driver.findElement(By.id("com.example.loginapp:id/welcome")).getText().equals("Welcome, testuser!"));
}
// Quit the driver
driver.quit();
}

pipeline {
  agent any
  tools {
    maven 'Maven 3.6.3'
    jdk 'Java 11'
  }
  stages {
    stage('Code Analysis') {
      steps {
        echo 'Running code analysis...'
        sh 'mvn sonar:sonar'
      }
    }
    stage('Build') {
      steps {
        echo 'Building the project...'
        sh 'mvn clean install -DskipTests'
      }
    }
    stage('Test') {
      steps {
        echo 'Running the tests...'
        sh 'mvn test -DsuiteXmlFile=testng.xml'
      }
    }
    stage('Report') {
      steps {
        echo 'Generating and publishing the test report...'
        allure includeProperties: false, jdk: '', results: [[path: 'target/allure-results']]
      }
    }
    stage('Deploy') {
      steps {
        echo 'Deploying the app to the target environment...'
        sh 'ansible-playbook deploy.yml'
      }
    }
  }
}

// Import the required libraries
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.MobileElement;
import org.openqa.selenium.remote.DesiredCapabilities;
import java.net.MalformedURLException;
import java.net.URL;

public class BrowserStackTest {

  // Declare the driver object
  public static AppiumDriver driver;
  public static void main(String[] args) throws MalformedURLException {

    // Set your BrowserStack credentials
    String userName = "YOUR_USERNAME";
    String accessKey = "YOUR_ACCESS_KEY";

    // Set the desired capabilities for the app and device
    DesiredCapabilities caps = new DesiredCapabilities();
    caps.setCapability("deviceName", "Samsung Galaxy S22 Ultra");
    caps.setCapability("platformName", "Android");
    caps.setCapability("platformVersion", "12.0");
    caps.setCapability("browserstack.local", true);
    caps.setCapability("buildName", "browserstack-build-1");
    caps.setCapability("projectName", "BrowserStack Sample");

    // Upload your app to BrowserStack using the REST API and get the app URL
    String appURL = BrowserStackUploader.uploadApp(userName, accessKey, "path/to/your/app.apk");

    // Set the app capability to the app URL
    caps.setCapability("app", appURL);

    // Initialize the driver with the BrowserStack server URL and the capabilities
    driver = new AppiumDriver(new URL("https://" + userName + ":" + accessKey + "@hub-cloud.browserstack.com/wd/hub"), caps);

    // Write your test cases using Appium commands
    // For example, login to the app and verify the result
    driver.findElement(By.id("com.example.loginapp:id/username")).sendKeys("testuser");
    driver.findElement(By.id("com.example.loginapp:id/password")).sendKeys("testpass");
    driver.findElement(By.id("com.example.loginapp:id/submit")).click();
    assert(driver.findElement(By.id("com.example.loginapp:id/welcome")).isDisplayed());
    System.out.println("Login successful");

    // Quit the driver
    driver.quit();
  }
}