Project Setup Guide

This comprehensive guide will assist you in setting up your development environment on a fresh PC, including Maven, Java 8, Appium, and the Android SDK for mobile app testing.

Prerequisites

Before you begin, ensure that you have the following prerequisites installed on your machine:

1. Java 8: Maven and Appium are compatible with Java 8. Download and install it from the official Oracle website.

2. Maven: Download the latest version from the official Apache Maven website and follow the installation instructions.

3. Node.js: Appium is a Node.js server. Download and install Node.js from the official Node.js website.

4. Appium: After installing Node.js, open a terminal and run the following command to install Appium globally:

   npm install -g appium

5. Android SDK: Download and install the Android SDK. You can obtain it as part of Android Studio or separately. Follow the instructions on the official Android developer website to install the SDK.

Environment Variables

Set the necessary environment variables after installing Java, Maven, and Android SDK:

1. JAVA_HOME: Set this variable to the installation path of your Java JDK. For example:

   export JAVA_HOME=/path/to/your/java/installation

2. M2_HOME: Set this variable to the installation path of Maven. For example:

   export M2_HOME=/path/to/your/maven/installation

3. ANDROID_HOME: Set this variable to the installation path of your Android SDK. For example:

   export ANDROID_HOME=/path/to/your/android/sdk

4. PATH: Add the following to your PATH environment variable:

   export PATH=$PATH:$JAVA_HOME/bin:$M2_HOME/bin:$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools

Verify Installations

To ensure that Java, Maven, Appium, and the Android SDK are installed correctly, open a terminal and run the following commands:

1. Java:

   java -version

2. Maven:

   mvn -version

3. Appium:

   appium -v

4. Android SDK:

   sdkmanager --version

Android Emulator Setup (if nedeed)

1. Install Required SDK Components

Open a terminal and run the following commands to install the necessary SDK components:

sdkmanager "platform-tools" "platforms;android-<version>" "emulator" "system-images;android-<version>;google_apis;<version>"

Replace <version> with the Android & Google APIs version you want to emulate.

2. Create AVD (Android Virtual Device)

Use the following command to create an AVD with desired specifications:

avdmanager create avd -n <emulator_name> -k "system-images;android-<version>;google_apis;<version>"

Replace <emulator_name> with the desired name for your emulator, and <version> with the Android & Google APIs version you want to emulate.

3. Start Android Emulator

Launch your Android Emulator using the following command:

emulator -avd <emulator_name>

Replace <emulator_name> with the name of your configured AVD.

Now you have set up the Android Emulator and are ready to use it for testing with Appium.

Running Tests from Terminal

1. To run tests locally, open a terminal in project root folder and run:

   mvn clean test -DdeviceId={device_or_simulator_id} -DappPath={app_path} -Denv=local
   

2. To run tests on cloud, open a terminal in project root folder and run:

   mvn clean test -Denv=cloud
   

   Note: app & device are specified in browserstack.yml