To verify the emulator setup, run:

    adb devices

Install Appium

• Install it via npm:

  npm install -g appium
  

Install appium-doctor to Verify System Setup

• Install appium-doctor to ensure your environment is set up properly:

  npm install -g appium-doctor
  

• Run appium-doctor:

  appium-doctor --android
  

• Ensure that all checks pass.

BrowserStack Setup

To run the tests on BrowserStack:

1. Create a BrowserStack account.
2. Obtain your BrowserStack credentials: BS_USER (username) and BS_KEY (access key).
3. Upload Android APK to BrowserStack and get the app_url (e.g., bs://<app-id>).

• APK file is located at /resources/app/android/ColorNote.apk

4. Create a .env file at the root of this repository with the following content:

   BS_USER=<your_browserstack_username>
   BS_KEY=<your_browserstack_access_key>
   

Installation

1. Clone the repository:

   git clone <repository-url>
   cd <repository-directory>
   

2. Install the dependencies:

   npm install
   

Running the Tests

Running on Local Machine

1. Ensure that your Android Virtual Device (AVD) is running.

• Verify below value in /config/wdio.android.conf.ts and modify if your Device is different

  'appium:deviceName': 'Pixel 8',
  'appium:platformVersion': '10.0',
  

2. Execute the tests:

   npm run test:local
   

Running on BrowserStack

1. Add your .env file with your BrowserStack credentials.

2. Ensure you’ve uploaded the APK to BrowserStack and updated the appium:app capability in the wdio.browserstack.android.conf.ts to point to the BrowserStack app_url.

   example : 'appium:app': 'bs://yourapkpath',
   

• Verify below value in /config/wdio.browserstack.android.conf.ts and modify if your Device is different.

  'appium:deviceName': 'Google Pixel 8',
  'appium:platformVersion': '14.0',
  

3. Execute the tests:

   npm run test:browserstack
   

Folder Structure

• tests/: Contains the test directory and files.
• pageobjects/: Implements the Page Object Model for the app screens.
• helpers/: Utility functions and custom commands.
• config/: WebdriverIO configuration files.
• reports/: Test reports.
• resources/: Contains the APK file and other
• package.json: Defines project dependencies, scripts, and configurations for the project.
• tsconfig.json: Configures TypeScript compilation settings
• .github/workflows/ci.yaml : This file defines github ci actions. It requires existing env variable inside github secrets.

Reporting

The test reports are generated using Allure Reports.

• To generate and view the report:

  npm run test-local:with-report
  npm run test-browserstack:with-report
  

The reports will open in your browser, displaying the results of the test runs.

Note :

• Currently this framework contains test cases for smoke inside tests/smoke/ , this framework can be further extended for different test types such as e2e and regression.