znsio / teswiz

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

Latest release status:

Latest successful build id:

NOTE

Use appium-device-farm v8.4.7-rc.8 or later

Use JDK v17 or higher

To Build

./gradlew clean build

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
• Electron

Applitools (https://applitools.com/) Visual AI, and Applitools Ultrafast Grid (https://applitools.com/product-ultrafast-test-cloud/) 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

Test can run on local browsers / devices, or against any cloud provider, such as HeadSpin, BrowserStack, SauceLabs, pCloudy.

Tech stack used

• JDK 17
• cucumber-jvm (https://cucumber.io)
• AppiumTestDistribution (https://github.com/AppiumTestDistribution/AppiumTestDistribution) -manages Android and iOS devices, and Appium
• Appium 2.x (https://appium.io)
  • https://javadoc.io/doc/io.appium/java-client/8.0.0-beta/deprecated-list.html
• Selenium WebDriver 4.x (https://selenium.dev)
  • https://www.selenium.dev/selenium/docs/api/java/deprecated-list.html
• reportportal.io (https://reportportal.io)
• Applitools (https://applitools.com)
• Build tool: gradle v8
• cucumber-reporting (https://github.com/damianszczepanik/cucumber-reporting)

Prerequisites

Getting started using teswiz

Configuring the test execution

Running the sample tests

Writing the first test

Setting up the Hard Gate

Additional configurations

Running Visual Tests using Applitools Visual AI

Functional/Feature Coverage

Configuration parameters

Add Auto Logging Using AspectJ

Setting up docker containers

Logging to ReportPortal

BREAKING CHANGES from v0.0.81

Troubleshooting / FAQs

Contact Anand Bagmar for help or if you face issues using teswiz

teswiz's Issues

[Electron] Not Getting logs in Console

While running the script getting logs in log file but not getting logs in console for projects importing teswiz as library

README.md contains wrong command for running iOS Tests

PLATFORM=windows ./gradlew run is mentioned for iOS

Github Actions: run tests on BrowserStack

On any code change in 'main' branch, run a web and app test on BrowserStack

Add a pre requisite step to download the electron application for Mac

• Currently, the electron application should be manually installed in the system to run the script.
• Implement the auto-download of the electron application and either install the application or extract the binary for the application.

Add support to run tests on LambdaTest

Add loggings for iOS

add reportportal logs to new iOS methods
add device logs and loggers for easy debugging

Run web tests on SauceLabs

Github Actions: run tests on LambdaTest

On any code change in 'main' branch, run a web and app test on LambdaTest

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency @appium/doctor to v2.1.8
• Update dependency com.browserstack:browserstack-local-java to v1.1.3
• Update dependency in.specmatic:specmatic-core to v1.3.31
• Update dependency appium to v2.11.1
• Update dependency appium-uiautomator2-driver to v3.7.0
• Update dependency appium-xcuitest-driver to v7.21.2
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency com.github.AppiumTestDistribution:AppiumTestDistribution to v14

Detected dependencies

docker-compose

docker-compose-v3-proxy.yml

docker-compose-v3.yml

github-actions

.github/workflows/BrowserStack_Android_Calculator_CI.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4
• android-actions/setup-android v3.2.1

.github/workflows/BrowserStack_Android_TheApp_CI.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4
• android-actions/setup-android v3.2.1

.github/workflows/BrowserStack_MultiUser_Android_Web_CI.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4
• android-actions/setup-android v3.2.1

.github/workflows/BrowserStack_Web_CI.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4

.github/workflows/Build_And_Run_Unit_Tests_CI.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4
• gradle/gradle-build-action 66535aaf56f831b35e3a8481c9c99b665b84dd45
• peter-evans/repository-dispatch v3

.github/workflows/HardGate_FailingBuild.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4

.github/workflows/HardGate_PassingBuild.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4

.github/workflows/codeql-analysis.yml

• actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332
• actions/setup-java v4
• github/codeql-action v3
• github/codeql-action v3
• github/codeql-action v3

gradle

gradle.properties

settings.gradle

build.gradle

• org.sonarqube 5.0.0.4638
• com.github.johnrengelman.shadow 8.1.1
• io.freefair.aspectj.post-compile-weaving 8.6
• com.fasterxml.jackson.dataformat:jackson-dataformat-yaml 2.17.1
• com.konghq:unirest-java 3.14.5
• org.assertj:assertj-core 3.26.0
• com.github.AppiumTestDistribution:AppiumTestDistribution b313941325
• org.apache.commons:commons-lang3 3.14.0
• org.apache.commons:commons-rng-simple 1.5
• com.github.vidstige:jadb 1.2.1
• org.jetbrains:annotations 24.1.0
• org.junit.jupiter:junit-jupiter 5.11.0-M2
• joda-time:joda-time 2.12.7
• com.browserstack:browserstack-local-java 1.1.1
• com.applitools:eyes-appium-java5 5.67.11
• net.masterthought:cucumber-reporting 5.8.1
• org.aspectj:aspectjrt 1.9.22.1
• in.specmatic:specmatic-core 1.3.30
• io.github.bonigarcia:webdrivermanager 5.9.1

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

• gradle 8.8

npm

package.json

• @appium/doctor 2.1.6
• @appium/relaxed-caps-plugin 1.0.6
• appium 2.10.3
• appium-device-farm 8.4.7-rc.46
• appium-uiautomator2-driver 3.6.1
• appium-xcuitest-driver 7.20.1
• braces 3.0.3
• fill-range 7.1.1
• ws 8.17.1

---

• Check this box to trigger a request for Renovate to run again on this repository

Report on report portal is in InProgress/Interrupted status while running from windows OS machine

when we run multiple scenarios in bulk from windows OS machine then the report on report portal is getting stuck with InProgress/Interrupted status

Update ScrollInDynamicLayer() to use the size of inner dropdown instead of entire mobile screen

ScrollInDynamicLayer() method in the driver class should get the size(height & width) of the pop-up/inner dropdown/dynamic layer screen instead of getting the size of the whole mobile screen for scrolling.

Need to change this:
public void scrollInDynamicLayer(Direction direction) {
Dimension dimension = driver.manage().window().getSize();
}

Fetch browser logs when running in Docker container

When we run web tests on local browser, we are able to generate, and store the browser logs in the logs directory, and also attach the same in reportportal.
We need to do the same when running the tests against browsers which are in docker containers.

Add capability to highlight elements that the test is interacting with

Implement jacoco in framework to know test coverage

Helpfull links
https://stackoverflow.com/questions/30851776/getting-jacoco-report-from-cucumber-tests-with-gradle
https://stackoverflow.com/questions/41643727/how-to-use-jacoco-gradle-plugin-with-testng-and-junit
https://github.com/h4ctar/cucumber_jacoco_junit_gradle/blob/master/build.gradle
https://docs.gradle.org/current/userguide/jacoco_plugin.html#default_values_of_the_jacoco_task_extension

Run web (browser) tests on BrowserStack

Description should be configurable for Report Portal for the consumers of teswiz

Currently, the description for ReportPortal is being set in Setup.java like this:

System.setProperty("rp.description", configs.get(
                APP_NAME) + " End-2-End scenarios on " + currentPlatform.name());

If the consumer, want to change this to something else or don't want "End-2-End scenarios" as they may be dealing with component, contract test, there's no way which currently exist. We need to make "rp.description" configurable so that consumers can set this property on their own. If they're not setting, then the same value defined above should be used.

Add sample tests for running on mobile-web (emulation mode)

Add capability to download APK/IPA based on the URL provided and use the same for executing test

Write a utlity which will take URL as an input, and

1. Download the APK/IPA from the provided URL
2. Store the APK/IPA in a temp location
3. Install the APK/IPA in the connected device/emulator

Add visual support for the electron platform

• Add visual testing with applitools for electron desktop application in teswiz

Add a pre requisite step to download the electron application for Windows

Currently, the electron application should be manually installed in the system to run the script.
Implement the auto-download of the electron application and either install the application or extract the binary for the application.

Auto logging at BL and Screen methods

Use AspectJ to automatically add log statements in the BLs and the Screen methods

Appium logs are not visible in target folder for Windows OS while running android scripts

Appium logs are not visible in target folder for Windows OS

Add visual validation for iOS

Applitools: applitool hasn't moved forward because of the issue Bug 52787

-verify the issue is still happening
-contact applitools team if still happening
-implement visual validation for iOS if issue has been resolved

Setup github actions for running tests on every push to main branch

Add support for running android / iOS native app tests in SauceLabs

Add sample tests for running on mobile-web on Android & iOS devices

HyperLink is missing for local reports instead we get plain text on terminal

When we run test cases locally , we have to navigate to the target/report folder and access the current generated report instead if we can have a hyperlink on terminal of the report it will be easier.

Run native app tests on Applitools Native Mobile Grid

Unreadable logs

While running the script getting logs in unreadable format
%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)-
%m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:
%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t]
(%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO [%t] (%F:%L)- %m%n INFO

Update README for electron application

• Add all the procedures how to run the automation script from teswiz for the electron application
• Describe all the parameters that were added to execute the script with electron application.

Upgrade to Se4 & Appium 2.0 (beta)

Migrate ATD to latest version

Hi Folks,

Thanks for using ATD. We have made quite a few changes to the ATD core which now depends on appium2.0. Upcoming release will be have breaking changes.

Steps to follow:

1. Update the dependency as below, currently in jitpack.

	<dependency>
	    <groupId>com.github.AppiumTestDistribution</groupId>
	    <artifactId>AppiumTestDistribution</artifactId>
	    <version>appium2.0-6de74eab6c-1</version>
	</dependency>

2. Make sure you have Appium2.0 server installed with respective drivers.
3. Install appium-device-farm plugin. Refer https://github.com/AppiumTestDistribution/appium-device-farm
4. Update your capabilties.json as https://github.com/AppiumTestDistribution/AppiumTestDistribution/blob/appium2.0/caps/iOScapabilities.json
5. If you want to run your test against BrowserStack Refer: https://github.com/AppiumTestDistribution/AppiumTestDistribution/blob/appium2.0/caps/browserstack.json
6. PCloudy Capabilties.json Refer: https://github.com/AppiumTestDistribution/AppiumTestDistribution/blob/appium2.0/caps/pcloudy_capabilities.json

cc: @anandbagmar

implement iOS support on other cloud platforms

browserstack -DONE
other platform where android is supported on teswiz include
pcloudy
headspin

implement all gestures for iOS

implement all the gestures that have been implemented for Android, for iOS
(would require ios app where these gestures can be performed)

Change the window size for headless mode for visual testing

• Currently, the window size is static for the headless mode
• We need to upgrade the window size accordingly to the size of the executing system screen size.