8000 GitHub - coolpydev/teswiz: End-2-End framework for Native & Web Automation using Cucumber-jvm, Appium, Selenium WebDriver, Applitools & ReportPortal · GitHub
[go: up one dir, main page]

Skip to content
coolpydevPublic
forked from znsio/teswiz

About

End-2-End framework for Native & Web Automation using Cucumber-jvm, Appium, Selenium WebDriver, Applitools & ReportPortal

Resources

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

0.0.3 0.0.3 CI CodeQL

What is this repository about?

This repository implements automated tests for Android & iOS apps, specified using cucumber-jvm and intelligently run them against

  • Android
  • iOS
  • Windows Apps
  • Web

Applitools is integrated with this framework, to provide Visual AI testing as part of functional automation.

Reports will be uploaded to reportportal.io, that you would need to setup separately, and provide the server details in src/test/resources/reportportal.properties file or provide the path to the file using this environment variable: REPORT_PORTAL_FILE

Tech stack used

Getting Started, or how can you use teswiz?

It is very easy to use teswiz in your framework. Follow these steps:

  1. Setup the prerequisites mentioned below [https://github.com/znsio/teswiz#prerequisites]
  2. Using your favorite IDE (I use IntelliJ Idea Community Edition), create a new Java-Gradle project
  3. Copy build.gradle.sample file to your newly created project's root folder and rename it to build.gradle
  4. Create capabilities.json in some folder - ex: ./capabilities - refer to src/test/resources/com/znsio/e2e/features/android/caps/capabilities.json
  5. Create config.properties in some folder - ex: ./configurations and provide default values - refer to src/test/resources/com/znsio/e2e/features/android/configs/config.properties
  6. Update the run task in build.gradle with appropriate values for config.properties, pathToStepDef, pathToFeaturesDir, pathToLogProperties
  7. Refer to the Running the tests section

Prerequisites

Running the tests

Run on Android

To run all the tests against the Android platform, run the following command:

PLATFORM=android ./gradlew run

Run on Local devices:

The framework, by default, automatically figures out if there are multiple devices connected to the machine, and if so, will run the tests in parallel

Run on pCloudy's Device Farm:

To enable running the tests on pCloudy's Device Farm, the following additional environment variables need to be provided:

  • RUN_IN_CI=true - Default is false
  • CLOUD_USER - pCloudy username
  • CLOUD_KEY - pCloudy password

Sample command:

PLATFORM=android RUN_IN_CI=true CLOUD_USER=myusername CLOUD_KEY=abcd1234abcd ./gradlew run

For other cloud configurations, refer here: https://github.com/AppiumTestDistribution/AppiumTestDistribution

Run on iOS

PLATFORM=iOS ./gradlew run

Run on Windows

PLATFORM=windows ./gradlew run

Run on Web

PLATFORM=web ./gradlew run

Running Multi-User simulations

The framework now supports running multiuser scenarios. This means 1 cucumber scenario can orchestrate the interaction between multiple instances of the application-under-test in multiple platforms - ex: Android and Web

Example:

multi-user-example-annotated.png

In the above example You can run these tests as below:

To run tests on android & web platforms

TAG=@multiuser-android-web

Current restriction - 1 android device & max 2 web browsers

To run tests on web platforms

TAG=@multiuser-web-web 

Current restriction - max 2 web browsers

Additional configurations

Running the tests with Applitools Visual AI

To enable Applitools Visual Testing in your test execution, the following additional environment variables need to be provided:

  • IS_VISUAL=true - to enable Visual Testing using Applitools
  • APPLITOOLS_API_KEY=<API_KEY> - Sets the API key as provided by Applitools

Running a subset of tests:

To run a subset of tests, for a given platform, the following additional environment variables need to be provided:

  • TAG=@schedule - This will run all tests tagged with the platform name provided, except tests tagged as "@wip"
  • TAG="@schedule and @signup" - This will run all tests tagged with the name schedule AND signup for the platform name provided, except tests tagged as "@wip"
  • TAG="@schedule or @signup" - This will run all tests tagged with the name schedule OR signup for the platform name provided, except tests tagged as "@wip"

Sample commands:

PLATFORM=android TAG=@schedule ./gradlew run`

PLATFORM=android TAG="@schedule and @signup" ./gradlew run`

PLATFORM=android TAG="@schedule or @signup" ./gradlew run`

Using a different apk for execution (Android):

To run tests using a specific apk (instead of the one specified in caps/capabilities.json, OR, caps/pcloudy_capabilties.json, the following additional environment variable need to be provided:

  • APP_PATH='<path to apk>'

Sample command:

APP_PATH=~/Downloads/MyLatestApp.apk PLATFORM=android ./gradlew run

Configuration parameters

The config.properties file has the following properties. Highlighting the defaults, and options for each here.

These can be overridden by providing the same either as environment variables or system properties.

# ATD properties
RUNNER=distribute -> ATD property. We will always use distributed
FRAMEWORK=cucumber -> ATD property. We will always use cucumber
RUNNER_LEVEL=methods -> ATD property. We will always use methods
CAPS=./caps/capabilities.json -> Path to capabilties.json file

# teswiz configuration properties. Can be overridden using environment variables or system properties

APP_NAME=teswiz -> Name of your application
APP_PACKAGE_NAME=io.cloudgrey.the_app -> android app package name
APPLITOOLS_CONFIGURATION=./configs/applitools_config.json -> Applitools configuration 
BASE_URL_FOR_WEB=BASE_URL -> Key name of the property in TEST_DATA_FILE for environment specific base url
BROWSER=chrome -> Which browser to use for Web execution? Supported: chrome || firefox
                  Browsers should to be installed. Corresponding WebDriver for the browser will be downloaded automatically
BROWSER_HEADLESS=false -> Should browser be started in headless mode? If yes, set to true
BROWSER_MAXIMIZE=true -> Should browser be maximised when started? If yes, set to true
BROWSER_VERBOSE_LOGGING=true -> Should browser logs be verbose? If yes, set to true
ENVIRONMENT_CONFIG_FILE=./src/test/resources/environments.json -> Environment specific configuration file
IS_VISUAL=false -> Should enable Applitools Visual Testing? If yes, set to true
LOG_DIR=target -> Where should logs be created?
LOG_PROPERTIES_FILE=./src/test/resources/log4j.properties -> log4j configuration file
PARALLEL=1 -> How many tests should be run in parallel? 
PLATFORM=android -> Run tests against? Supported: android | iOS | windows | web
PROXY_KEY=HTTP_PROXY -> If proxy should be set, what is the environment variable specifying the proxy?
REPORT_PORTAL_FILE=src/test/resources/reportportal.properties -> ReportPortal.io configuration
RUN_IN_CI=false -> Are tests running in CI?
TARGET_ENVIRONMENT=prod -> Which environment are the tests running against? Should map to envrionments specified in ENVIRONMENT_CONFIG_FILE 
TEST_DATA_FILE=./src/test/resources/testData.json -> Environment specific static test data
CLEANUP_DEVICE_BEFORE_STARTING_EXECUTION=true -> uninstall apk from each device before the test starts

Troubleshooting / FAQs

Setting Environment Variables:

You can set environment variables

From Mac OSX or Linux:

export PLATFORM=android

From Windows:

set PLATFORM=android

About

End-2-End framework for Native & Web Automation using Cucumber-jvm, Appium, Selenium WebDriver, Applitools & ReportPortal

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0