BrowserStackCE · abdul-qadir92 · Sep 20, 2022 · Aug 16, 2023 · Aug 18, 2023 · Aug 18, 2023
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,15 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+src/test/resources/Reports/*
+target/
+build/
+.project
+.settings/
+.classpath
+.idea/
+.gradle/
+*.iml
+.DS_Store
+!gradle/wrapper/*
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright (c) 2021, BrowserStack Limited. https://www.browserstack.com
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -1 +1,265 @@
-# browserstack-examples-cucumber-testng
+![Logo](https://www.browserstack.com/images/static/header-logo.jpg)
+
+# BrowserStack Examples Cucumber TestNG Selenium 4 <a href="https://cucumber.io"><img src="https://avatars.githubusercontent.com/u/320565?s=200&v=4" alt="Cucumber" height="22" /></a> <a href="https://testng.org/"><img src="https://4.bp.blogspot.com/-yjCdQKv58cM/Wg9EsvVibuI/AAAAAAAAErc/0VeSAT2tp18JDUFNxD5lK87jKK6fT0UNACLcBGAs/s1600/1.png" alt="TestNG" height="22" /></a>
+
+## Introduction
+
+This BrowserStack Example repository demonstrates a Selenium 4 [Page Factory Model](https://www.browserstack.com/guide/page-object-model-in-selenium) wrapped under Cucumber and TestNG with parallel testing capabilities. The Selenium test scripts are written for the open source [BrowserStack Demo web application](https://bstackdemo.com) ([Github](https://github.com/browserstack/browserstack-demo-app)). This BrowserStack Demo App is an e-commerce web application which showcases multiple real-world user scenarios, written in Next and React. The app is bundled with offers data, orders data and products data that contains everything you need to start using the app and run tests out-of-the-box.
+
+The Selenium tests are run on different platforms like on-prem and BrowserStack using various run configurations and test capabilities.
+
+## :pushpin: Key Features
+
+:globe_with_meridians: Empowered to run on various platforms including **on-premise browsers**, browsers running on a remote selenium grid such as 
+ **[BrowserStack Automate](https://www.browserstack.com/automate)**
+
+:rocket: Enables concurrent execution of cucumber scenarios at scenario and feature level across different platforms.
+
+:bulb: Run the builds with max concurrency as per the parallel quota on your BrowserStack Account.
+
+:computer: Control concurrency of the tests by setting thread count from terminal.
+
+:white_check_mark: Three distinct layers of framework implementaion viz. Feature File, Step Definitions, Page Factory Classes to maintain the border between Business users and developers.
+
+:recycle: Can be ran on any installed browsers onprem without downloading the respective driver executables.
+
+:zap: Single Runner class required to configure all parameters and plugins.
+
+:bar_chart: HTML and PDF reports generation with screenshots.
+
+---
+
+## Repository setup
+
+- Clone the repository
+- Ensure you have the following dependencies installed on the machine
+  - Java >= 8
+  - Maven >= 3.1+
+
+
+  Maven:
+    ```sh
+    mvn install
+    ```
+---
+## About the tests in this repository
+
+This repository contains the following Cucumber Scenario tests:
+
+| Features | Tags | Test Name | Description |
+|--|--|--|--|
+| E2E | @e2e |End to End Scenario|This test scenario verifies successful product purchase lifecycle end-to-end with verifying that 9 Apple products are only shown if the Apple vendor filter option is applied and verifies that the product prices are in ascending order when the product sort “Lowest to Highest” is applied. It demonstrates the [Page Factory Model design pattern](https://www.browserstack.com/guide/page-object-model-in-selenium)|
+|User|@locked|Login as Locked User|This test verifies the login workflow error for a locked user.|
+|User|@noimage, @fail|Login as User with no image loaded| This test verifies that the product images load for user: “image_not_loading_user” on the e-commerce application. Since the images do not load, the test case assertion fails.|
+|User|@orders|Login as User with existing Orders| This test verifies that existing orders are shown for user: “existing_orders_user”|
+|Offers|@offers|Offers for Mumbai location|This test mocks the GPS location for Mumbai and verifies that the product offers applicable for the Mumbai location are shown. |
+
+ - `@test` will run all scenarios in **Offers** feature file.
+ -  `@users` will run all scenarios in **Users** feature file. 
+ - `@e2e` will run all scenarios in **E2E** feature file.
+ - `@regression` will run all scenarios in all the feature files.
+
+---
+
+## Test infrastructure environments
+
+- [On-premise/self-hosted](#On-Premise-or-Self-Hosted)
+- [BrowserStack](#browserstack)
+
+---
+## Configuring the maximum parallel test threads for this repository[SDK]
+
+For all the parallel run configuration profiles, tests will run with max parallels in your BrowserStack account, or you can configure the parallel test threads from the browserstack.yml file
+
+    parallelsPerPlatform
+
+|BrowserStack| onPrem |
+|--|--|
+| browserstack/conf/Run_Single_Test/single.testng.xml|testng.xml
+browserstack/conf/Run_Parallel_Test/parallel.testng.xml |
+
+
+
+---
+# Test Reporting
+
+- [Extent reports](https://ghchirp.tech/2098/)
+- Reports in HTML and PDF formats are generated in the [Reports](src/test/resources/Reports) with TimeStamp.
+---
+# On Premise or Self Hosted
+
+This infrastructure points to running the tests on your own machine using any browser (e.g. Chrome) using the browser's driver executables (e.g. ChromeDriver for Chrome). This driver dependency is resolved using the WebDriverManager and eliminates the need to download the webdriver on the local machine.
+
+## Running Your Tests
+
+### Run a specific test/entire suite on your own machine
+
+- How to run the test?
+
+  To run any test scenario (e.g. End to End Scenario) on your own machine, use the following command, you can specify any cucumber tag from the feature files to run the scenarios at feature/scenario outline level in this Maven Profile.
+
+	Eg. "@e2e", "@noimage", "@offers" or any of the other test scenario tags, as outlined in [About the tests in this repository](#About-the-tests-in-this-repository) section. 
+`"-Dcucumber.filter.tags=@e2e"`
+
+	User can also specify the choice of browser in the `<browser-type>` tags of the profile to run the suite/scenarios in that browser.
+	Eg. `<browser-type>firefox</browser-type>`
+
+  thread-count can be set for the tests from the terminal 
+  `"-DthreadCount=5"`
+
+  Maven:
+    ```sh
+  mvn test -P scenario-onprem
+  ```
+
+- Output
+
+  This run profile executes a specific test scenario/suite in single/parallel on the stated browser instance on your own machine.
+
+---
+# BrowserStack
+
+[BrowserStack](https://browserstack.com) provides instant access to 2,000+ real mobile devices and browsers on a highly reliable cloud infrastructure that effortlessly scales as testing needs grow.
+
+## Prerequisites
+
+- Create a new [BrowserStack account](https://www.browserstack.com/users/sign_up) or use an existing one.
+- Identify your BrowserStack username and access key from the [BrowserStack Automate Dashboard](https://automate.browserstack.com/) and export them as environment variables using the below commands.
+
+  - For \*nix based and Mac machines:
+
+  ```sh
+  export BROWSERSTACK_USERNAME=<browserstack-username> &&
+  export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  ```
+
+  - For Windows:
+
+  ```shell
+  set BROWSERSTACK_USERNAME=<browserstack-username>
+  set BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
+  ```
+
+  Alternatively, you can also hardcode username and access_key objects in the respective file:
+  - [browserstack.yml](browserstack.yml) file
+
+
+Note:
+- We have configured a list of test capabilities in the json files. You can certainly update them based on your device / browser test requirements.
+- The exact test capability values can be easily identified using the [Browserstack W3C Capability Generator](https://www.browserstack.com/automate/capabilities?tag=selenium-4)
+
+
+## Running Your Tests
+
+### Run a specific test/entire test suite in parallel on a single BrowserStack browser
+
+In this section, we will run the tests in parallel on a single browser on Browserstack. Refer to [browserstack.yml](browserstack.yml) file to change test capabilities for this configuration.
+
+- How to run the test?
+
+  To run the tests in parallel on a single BrowserStack browser, use the following command:
+
+  Maven:
+  ```sh
+  mvn test -P scenario-bs
+  ```
+
+	You can mention any scenario from the feature files using the `-Dcucumber.filter.tags`, tags defined at Feature level Eg. `@users` will run all the scenarios in the [Users Feature](src/test/resources/Features/Users.feature) file in parallel. Likewise `@regression` will run all the scenarios from all the Feature files in parallel.
+
+- Output
+
+  This run profile executes any scenario/entire test suite in parallel on a single BrowserStack browser. Please refer to your [BrowserStack dashboard](https://automate.browserstack.com/) for test results.
+
+  - Note: By default, this execution would run maximum test threads based on the parallel quota on your BrowserStack Account. Thread count can be configured as below based on your requirements.
+
+   ```sh
+  mvn test -P scenario-bs "-Dcucumber.filter.tags=@regresssion"
+  ```
+
+
+### Run the entire test suite in parallel on multiple BrowserStack browsers
+
+In this section, we will run the tests in parallel on multiple browsers on Browserstack. Refer to the [browserstack.yml](browserstack.yml) file to change test capabilities for this configuration.
+
+- How to run the test?
+
+  To run the entire test suite in parallel on multiple BrowserStack browsers/devices, use the following command:
+
+  Maven:
+  ```sh
+  mvn test -P scenario-bs
+  ```
+
+	You can mention any scenario from the feature files using the `-Dcucumber.filter.tags`, tags defined at Feature level Eg. `@users` will run all the scenarios in the [Users Feature](src/test/resources/Features/Users.feature) file in parallel. Likewise `@regression` will run all the scenarios from all the Feature files in parallel across multiple browsers/devices.
+---	
+### [Web application hosted on internal environment] Running your tests on BrowserStack using BrowserStackLocal
+
+#### Prerequisites
+
+- Clone the [BrowserStack demo application](https://github.com/browserstack/browserstack-demo-app) repository.
+  ```sh
+  git clone https://github.com/browserstack/browserstack-demo-app
+  ``` 
+- Please follow the README.md on the BrowserStack demo application repository to install and start the dev server on localhost.
+- In this section, we will run a single test case to test the BrowserStack Demo app hosted on your local machine i.e. localhost. Refer to the [browserstack.yml](browserstack.yml) file to change test capabilities for this configuration.
+- Note: You may need to provide additional BrowserStackLocal arguments to successfully connect your localhost environment with BrowserStack infrastructure. (e.g if you are behind firewalls, proxy or VPN).
+- Further details for successfully creating a BrowserStackLocal connection can be found here:
+
+  - [Local Testing with Automate](https://www.browserstack.com/local-testing/automate)
+  - [BrowserStackLocal Java GitHub](https://github.com/browserstack/browserstack-local-java)
+
+
+### [Web application hosted on internal environment] Run a specific test/entire test suite in parallel on a single BrowserStack browser/device using BrowserStackLocal
+
+- How to run the test?
+
+  - To run any test scenario (e.g. End to End Scenario) on a single BrowserStack browser using BrowserStackLocal, use the following command:
+
+  Maven:
+  ```sh
+  mvn test -P local-bs
+  ```
+
+You can mention any scenario from the feature files using the `-Dcucumber.filter.tags`, tags defined at Feature level Eg. `@users` will run all the scenarios in the [Users Feature](src/test/resources/Features/Users.feature) file in parallel. Likewise `@regression` will run all the scenarios from all the Feature files in parallel.
+
+- Output
+
+  This run profile executes a single test/entire suite on an internally hosted web application on a single browser on BrowserStack in parallel. Please refer to your [BrowserStack dashboard](https://automate.browserstack.com/) for test results.
+
+
+### [Web application hosted on internal environment] Run the entire test suite in parallel on multiple BrowserStack browser using BrowserStackLocal
+
+In this section, we will run the test cases to test the internally hosted website in parallel on multiple browsers/devices on Browserstack. Refer to the [browserstack.yml](browserstack.yml) file to change test capabilities for this configuration.
+
+- How to run the test?
+
+  To run the entire test suite in parallel on multiple devices and browsers using BrowserStackLocal, use the following command:
+
+  Maven:
+  ```sh
+  mvn test -P local-bs
+  ```
+
+- Output
+
+  This run profile executes the entire test suite on an internally hosted web application on multiple browsers on BrowserStack. Please refer to your [BrowserStack dashboard](https://automate.browserstack.com/) for test results.
+
+- Note: By default, this execution would run maximum test threads based on the parallel quota on your BrowserStack Account. Thread count can be configured as below based on your requirements.
+  ```sh
+  mvn test -P local-bs "-Dcucumber.filter.tags=@e2e"
+  ```
+
+
+## Additional Resources
+
+- View your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate)
+- Documentation for writing [Automate test scripts in Java](https://www.browserstack.com/automate/java)
+- Customising your tests capabilities for Selenium 4 on BrowserStack using our [test capability generator](https://www.browserstack.com/automate/capabilities?tag=selenium-4)
+- [List of Browsers & mobile devices](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate) for automation testing on BrowserStack
+- [Using Automate REST API](https://www.browserstack.com/automate/rest-api) to access information about your tests via the command-line interface
+- Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
+- For testing public web applications behind IP restriction, [Inbound IP Whitelisting](https://www.browserstack.com/local-testing/inbound-ip-whitelisting) can be enabled with the [BrowserStack Enterprise](https://www.browserstack.com/enterprise) offering
+
+
+## Open Issues
+- The PDF report breaks for the multiple scenarios executed in parallel on multiple devices/browsers.
diff --git a/browserstack.yml b/browserstack.yml
@@ -0,0 +1,97 @@
+# =============================
+# Set BrowserStack Credentials
+# =============================
+# Add your BrowserStack userName and accessKey here or set BROWSERSTACK_USERNAME and
+# BROWSERSTACK_ACCESS_KEY as env variables
+userName: YOUR_USERNAME
+accessKey: YOUR_ACCESS_KEY
+
+# ======================
+# BrowserStack Reporting
+# ======================
+# The following capabilities are used to set up reporting on BrowserStack:
+# Set 'projectName' to the name of your project. Example, Marketing Website
+projectName: BrowserStack Cucumber TestNG # Automate - Map SDK
+# Set `buildName` as the name of the job / testsuite being run
+buildName: browserstack build
+# `buildIdentifier` is a unique id to differentiate every execution that gets appended to
+# buildName. Choose your buildIdentifier format from the available expressions:
+# ${BUILD_NUMBER} (Default): Generates an incremental counter with every execution
+# ${DATE_TIME}: Generates a Timestamp with every execution. Eg. 05-Nov-19:30
+# Read more about buildIdentifiers here -> https://www.browserstack.com/docs/automate/selenium/organize-tests
+buildIdentifier: '#${BUILD_NUMBER}' # Supports strings along with either/both ${expression}
+buildTag: "regresson"
+selfHeal: true
+# =======================================
+# Platforms (Browsers / Devices to test)
+# =======================================
+# Platforms object contains all the browser / device combinations you want to test on.
+# Entire list available here -> (https://www.browserstack.com/list-of-browsers-and-platforms/automate)
+platforms:
+  - os: OS X
+    osVersion: Big Sur
+    browserName: Chrome
+    browserVersion: 131.0
+  - os: Windows
+    osVersion: 10
+    browserName: Edge
+    browserVersion: 131.0
+  - deviceName: Samsung Galaxy S2*
+    browserName: chrome # Try 'samsung' for Samsung browser
+    osVersion: [12131415]
+  - deviceName: iPhone 1* 
+    browserName: safari
+    osVersion: [15161718]
+# =======================
+# Parallels per Platform
+# =======================
+# The number of parallel threads to be used for each platform set.
+# BrowserStack's SDK runner will select the best strategy based on the configured value
+#
+# Example 1 - If you have configured 3 platforms and set `parallelsPerPlatform` as 2, a total of 6 (2 * 3) parallel threads will be used on BrowserStack
+#
+# Example 2 - If you have configured 1 platform and set `parallelsPerPlatform` as 5, a total of 5 (1 * 5) parallel threads will be used on BrowserStack
+parallelsPerPlatform: 2
+framework: cucumber-testng #junit,testng,java,cucumber-testng,serenity,cucumber-junit
+source: cucumber-testng:intellij:v1.1.2
+staticWebDriver: true
+browserstackAutomation: true
+# ==========================================
+# BrowserStack Local
+# (For localhost, staging/private websites)
+# ==========================================
+# Set browserStackLocal to true if your website under test is not accessible publicly over the internet
+# Learn more about how BrowserStack Local works here -> https://www.browserstack.com/docs/automate/selenium/local-testing-introduction
+browserstackLocal: false # <boolean> (Default false)
+
+# Options to be passed to BrowserStack local in-case of advanced configurations
+#browserStackLocalOptions:
+  # localIdentifier: # <string> (Default: null) Needed if you need to run multiple instances of local.
+  # forceLocal: false  # <boolean> (Default: false) Set to true if you need to resolve all your traffic via BrowserStack Local tunnel.
+  # Entire list of arguments available here -> https://www.browserstack.com/docs/automate/selenium/manage-incoming-connections
+
+# ===================
+# Debugging features
+# ===================
+debug: true # <boolean> # Set to true if you need screenshots for every selenium command ran
+networkLogs: true # <boolean> Set to true to enable HAR logs capturing
+consoleLogs: errors # <string> Remote browser's console debug levels to be printed (Default: errors)
+# Available options are `disable`, `errors`, `warnings`, `info`, `verbose` (Default: errors)
+
+# Test Observability is an intelligent test reporting & debugging product. It collects data using the SDK. Read more about what data is collected at https://www.browserstack.com/docs/test-observability/references/terms-and-conditions
+# Visit observability.browserstack.com to see your test reports and insights. To disable test observability, specify `testObservability: false` in the key below.
+testObservability: true
+accessibility: true
+accessibilityOptions:
+  wcagVersion: wcag21aaa # Default: wcag21aa
+  includeIssueType:
+    bestPractice: true # Default: false
+    needsReview: true # Default: true
+    experimental: true # Default: true
+  #includeTagsInTestingScope: [ '@users' ] # Tags for test cases to include
+  #excludeTagsInTestingScope: [ 'old', 'deprecated' ] # Tags for test cases to exclude
+
+performance: assert
+percy: true
+percyCaptureMode: auto
+#logLevel: debug