Got a question? Email us or reach out on LinkedIn

Introduction

Starter project for new automated testing initiative. This is a project to simply clone and start building your automated testing solution immediately with a few simple configurations detailed below.

Questions and issues

The github issue tracker is only for bug reports and feature requests. Anything else, such as questions for help in using the library, should be emailed to our team.

Prerequisites

1. Java 21
2. Maven 3.x
3. Chrome (latest)

Quick Start

Once the prerequisites are installed and configured follow these 3 simple instructions to get your test solution up and running:

1. Clone this Starter Project
2. Perform mvn clean install -U
3. Perform mvn clean install -Psingle -Dtest.name=BasicTest -Dtest.env=prod

To Run in IntelliJ

1. Open IntelliJ
2. Open pom.xml file
3. Right click on pom.xml file > select Maven > select Reload project option
4. Add default runtime configuration for TestNG VM option of -Dtest.env=prod
5. Right click and run test

Code Formatter

The mvn clean install Maven command runs a common code formatter plugin. This plugin ensures all code is formatted with consistent industry standards. If your code is not formatted correctly simply open a terminal and execute the following Maven command:

mvn formatter:format

Customize To Your Application

1. Open the automation.properties file, change the web.url property to point to your AUT
2. In a browser, open your AUT login or entry page. Note a common element on this entry page.
3. Open Constants.java; Create an interface entry such as String LOGIN_BUTTON = "Login";
4. Open the MyApplicationTestCase.java class; Replace line 26 with your addition from previous Step
5. In IntelliJ, verify you have a default TestNG VM option of -Dtest.env=prod
6. Run test in Debug mode.

Encrypting Username(s) and Password(s)

By default, this microservice leverages the JDK 1.8 Java Cryptographic Extension library. Simply encrypt, your username and password and add these values to your Data.DEFAULT_USER_CREDENTIALS Credentials object. Once encrypted, these values can be used to log into your SUT.

Configuration

Assertion Handling

• By default, all tests are run in Soft Assertions mode (test will continue executing if failure occurs)
• You can override this setting in the automation.properties file by setting the enable.hard.assert=false

Dynamic Properties

-Dtest.user=YOUR_USERNAME

-Dtest.password=YOUR_PASSWORD

-Dtest.env=YOUR ENVIRONMENT_CONFIGURATION

-Dbrowser=YOUR_BROWSER

-Dbrowser.version=YOUR_BROWSER_VERSION

-Dbrowser.resolution=YOUR_BROWSER_RESOLUTION

-Dplatform=YOUR_OPERATING_SYSTEM

-Dtest.group=YOUR_TESTNG_GROUP

Test Execution

Executing any test requires defining the -Dtest.env=dev,test,etc... runtime property. This is necessary to support executing any and all scripts against any environment desired.

IDE

In order to execute tests in your Integrated Development Environment you must simply add a TestNG variable to tell the automated tests which environment to run against.

In your IDE's Runtime Configuration for TestNG, simply add **-Dtest.env=ENVIRONMENT

Run Using SauceLabs

If you have a SauceLabs account, define the grid.hub.url in your grid.properties file according to the settings defined in the setup instructions provided by SauceLabs.

Be sure to download and run the Sauce Connect plugin in your local environment to execute your tests in SauceLabs.

Add the following section to your settings.xml in order to connect your local Maven profile to SauceLabs:

<profile>
    <id>saucelabs</id>
    <properties>
        <sauce.username>YOUR_SAUCELABS_USER</sauce.username>
        <sauce.key>YOUR_SAUCELABS_KEY</sauce.key>
    </properties>
</profile>

Maven

Run Using SauceLabs

$ mvn clean install -Psaucelabs -PGROUP_NAME -Dtest.env=ENVIRONMENT

mvn clean install -Psaucelabs -Pacceptance -Dtest.env=prod

Run Single Test

$ mvn clean install -Psingle -Dtest.name=TEST_CLASS_NAME -Dtest.env=ENVIRONMENT

mvn clean install -Psingle -Dtest.name=BasicTest -Dtest.env=prod

Run a Maven Profile of Tests

$ mvn clean install -PGROUP_NAME -Dtest.env=ENVIRONMENT

mvn clean install -Pacceptance -Dtest.env=prod

Run ANY Group of Test(s)

$ mvn clean install -Pgroup -Dtest.group=GROUP_NAME -Dtest.env=ENVIRONMENT

mvn clean install -Pgroup -Dtest.group=webServiceTest -Dtest.env=prod

Run ANY Test(s)

$ mvn clean install -Pgroup -Dtest.group=GROUP_NAME -Dtest.env=ENVIRONMENT -Dtest.package=PACKAGE_NAME -Dtest.threadCount=NUMBER_OF_THREADS

mvn clean install -Pgroup -Dtest.group=webServiceTest -Dtest.env=prod -Dtest.package=* -Dtest.threadCount=1

Run Manual Tests

Executes all manual tests stubbed out ready to be automated. The artifact of executing these tests is the Gherkin logging for the test scenario that can then be used as instructions to performing your manual tests.

$ mvn clean install -Pmanual -Dtest.env=ENVIRONMENT

mvn clean install -Pmanual -Dtest.env=prod

Test Samples

REST Web Service Test Sample

A headless web service test leveraging a public REST endpoint at Dog CEO is used as a JSON service sample.
Simply, run the test named BasicRestTest.java

Basic Browser Test Sample

A web-based browser sample test is provided that opens a browser and tests Oracle. Simply, run the test named BasicTest.java

Deep Dive Browser Test Sample

A web-based browser sample test tests the Console and Network traffic during the browser test being executed. Simply, run the test named BrowserDiagnosticsTest.java

Non-Deterministic (AI based) Test Sample

This web-based browser test makes decisions on what to test based on the probability defined in the static map included in the test. Ideal if you wanted to mimic a user's random behaviours for a given amount of time in your application. Simply, run the test named PowerUserTest.java

Data Provider using Excel

A Excel-based data provider sample is provided to keep your data extracted from your tests. The dataProvider is easily used by taking 3 arguments:

1. File name from an Excel file in your resources directory
2. Sheet name from your Excel file where your data resides
3. Total number of columns to read

@Test(dataProvider = "exampleExcelData", dataProviderClass = ExcelDataProvider.class)
public void testExcelDataProvider(String firstName, String lastName, String nickName) {
    Test info here