SauceDemo Test Automation Framework

A BDD test automation framework for the SauceDemo e-commerce application. Built with Selenium WebDriver, Cucumber, and TestNG. Includes a full CI/CD pipeline via GitHub Actions with live Allure reporting published to GitHub Pages.

📊 View Live Allure Report

Project Structure

Test-Automation-Framework-Internal/
│
├── .github/
│   └── workflows/
│       └── ci.yml                      # GitHub Actions CI/CD pipeline
│
├── src/test/
│   ├── java/com/automation/
│   │   ├── base/
│   │   │   └── TestBase.java           # Browser setup, teardown, and reusable wrappers
│   │   ├── models/
│   │   │   └── SauceData.java          # POJO for JSON test data deserialization
│   │   ├── pages/                      # Page Object Model (POM)
│   │   │   ├── LoginPage.java
│   │   │   ├── ProductListPage.java
│   │   │   ├── CartPage.java
│   │   │   ├── CheckoutInfoPage.java
│   │   │   ├── CheckoutOverviewPage.java
│   │   │   └── CheckoutCompletePage.java
│   │   ├── runners/
│   │   │   └── TestRunner.java         # TestNG + Cucumber entry point
│   │   ├── stepdef/
│   │   │   ├── StepDef.java            # Cucumber step definitions
│   │   │   └── ApplicationHooks.java   # Before/After hooks, screenshot on failure
│   │   └── utils/
│   │       └── JsonUtils.java          # JSON test data reader (Jackson)
│   │
│   └── resources/
│       ├── features/
│       │   └── Saucedemo.feature       # Gherkin BDD scenarios
│       ├── testdata/
│       │   └── data.json               # Externalized test data
│       ├── config.properties           # Browser, URL, timeout, and execution config
│       ├── testng.xml                  # TestNG suite definition
│       └── log4j2.xml                  # Log4j2 logging configuration
│
├── pom.xml                             # Maven dependencies and plugin config
└── README.md

Tech Stack

Component	Technology
Language	Java 11
Browser Automation	Selenium WebDriver 4.27
Test Framework	TestNG 7.8
BDD Layer	Cucumber 7.14
Build Tool	Maven
Reporting	Allure 2.24 + Cucumber HTML
Logging	Log4j2
Test Data	JSON via Jackson
Design Pattern	Page Object Model (POM)
CI/CD	GitHub Actions

Framework Design

TestBase — Centralized Browser Control

All page classes extend TestBase, which provides:

initialization() — launches the configured browser with popups disabled. Automatically runs headless when executed in CI (detected via the CI environment variable set by GitHub Actions). Supports local and Selenium Grid execution via executionMode.
clickOn(WebElement) — click with retry logic and StaleElementReferenceException handling
sendText(WebElement, String) — clears and types into inputs with retry logic
waitForVisibility(WebElement) — explicit wait until element is visible
waitForClickability(WebElement) — explicit wait until element is interactable
invisibilityOfElement(WebElement) — waits for element to disappear

Page Object Model

Each page of the application has a dedicated class. Page classes use @FindBy annotations and PageFactory for element location, and return the next relevant page object from action methods to support fluent chaining.

ApplicationHooks — Lifecycle and Screenshot Capture

@Before launches the browser before each scenario. @After is split into two ordered hooks:

order = 1 runs first — captures a screenshot on failure and attaches it to both the Allure report and the Cucumber HTML report
order = 0 runs last — safely closes the browser after the screenshot is already taken

Test Data

All credentials, personal info, product lists, and expected error messages are stored externally in data.json. Tests reference data by index, keeping step definitions free of hard-coded values. JsonUtils deserializes the JSON into SauceData POJOs using Jackson.

Test Scenarios

Defined in src/test/resources/features/Saucedemo.feature:

Tag	Scenario	Description
`@smoke @regression`	Complete E2E purchase flow	Login → add products → cart → checkout → confirm order
`@regression @negative`	Login fails with locked out user	Verifies correct error message for locked accounts
`@smoke`	Quick smoke — add single product	Login → add product → verify cart badge count

Prerequisites

Java JDK 11+ — configured in system PATH
Maven 3.6+ — configured in system PATH
Google Chrome — latest stable version
Git
IDE — IntelliJ IDEA or Eclipse (optional for local runs)

Getting Started

1. Clone the repository

git clone https://github.com/ElementZ76/Test-Automation-Framework-Internal.git
cd Test-Automation-Framework-Internal

2. Install dependencies

mvn clean install -DskipTests

3. Verify setup

mvn clean test -Dtags="@smoke"

Chrome should open, run the smoke test, and close. Results appear in target/allure-results/.

Running Tests

All parameters are passed with the -D flag and override their corresponding default in config.properties.

Supported Parameters

Parameter	Default	Accepted Values	Description
`browser`	`chrome`	`chrome`, `firefox`, `edge`	Browser to launch
`threads`	`1`	Any positive integer	Number of parallel test threads
`tags`	(all scenarios)	Any Cucumber tag expression	Filter which scenarios to run
`executionMode`	`local`	`local`, `grid`	Run locally or against a Selenium Grid hub
`gridUrl`	`http://localhost:4444`	Any valid hub URL	Selenium Grid hub address (used when `executionMode=grid`)

Run all tests

mvn clean test

Filter by tag

# Smoke tests only
mvn clean test -Dtags="@smoke"

# Full regression suite
mvn clean test -Dtags="@regression"

# Negative test cases
mvn clean test -Dtags="@negative"

# Multiple tags (AND)
mvn clean test -Dtags="@smoke and @regression"

# Exclude a tag
mvn clean test -Dtags="not @wip"

Select a browser

mvn clean test -Dbrowser=firefox
mvn clean test -Dbrowser=edge

Parallel execution

# Run with 3 parallel threads
mvn clean test -Dthreads=3

# Parallel smoke suite on Firefox
mvn clean test -Dbrowser=firefox -Dthreads=4 -Dtags="@smoke"

Via IDE

Open the project as a Maven project
Navigate to src/test/java/com/automation/runners/TestRunner.java
Right-click → Run As → TestNG Test

Selenium Grid

Selenium Grid lets the framework send browser sessions to a hub rather than opening a browser directly on your machine. TestNG, Cucumber, Allure, and all reports work exactly the same — only where the browser process runs changes.

Prerequisites

Java must be installed and available in PATH on the machine running the hub and node
The Selenium Server jar (selenium-server-<version>.jar) must be present
Chrome (or whichever browser you intend to use) must be installed on the node machine

Step 1 — Start the Hub

Open a terminal in the folder containing the Selenium Server jar and run:

java -jar selenium-server-<version>.jar hub

The hub starts and listens on port 4444 by default. You will see a line like:

INFO [Standalone.execute] - Started Selenium standalone

Leave this terminal open for the duration of your test run.

Step 2 — Register a Node

Open a second terminal in the same folder and run:

java -jar selenium-server-<version>.jar node --hub http://localhost:4444

The node registers itself with the hub and advertises whichever browsers are installed on the machine. You will see a confirmation like:

INFO [Node.register] - Node registered with hub

Leave this terminal open as well.

Step 3 — Verify the Grid is running

Open http://localhost:4444/ui in a browser. The Grid console will show the registered node and its available browser slots. Both the hub and node must appear healthy before running tests.

Step 4 — Run tests against the Grid

With both terminals still running, execute from your project directory:

# Default — Chrome on localhost:4444
mvn clean test -DexecutionMode=grid

# Specific Grid URL
mvn clean test -DexecutionMode=grid -DgridUrl=http://localhost:4444

# Grid + browser + tag filter
mvn clean test -DexecutionMode=grid -DgridUrl=http://localhost:4444 -Dbrowser=chrome -Dtags="@regression"

# Grid + parallel threads
mvn clean test -DexecutionMode=grid -Dthreads=3

How it works

When executionMode=grid, TestBase.initialization() creates a RemoteWebDriver pointed at the hub URL instead of launching a local ChromeDriver. The hub receives the request and delegates it to an available node, which opens the browser on its own machine. From the framework's perspective everything else — hooks, steps, waits, screenshots, reports — is identical to a local run.

Reports

Allure (recommended)

# Run tests first, then open the live report:
mvn allure:serve

# Generate static HTML only (no auto-open):
mvn allure:report

Opens a live Allure report in your browser with step-by-step execution details, timing, tags, and screenshots embedded directly inside any failed scenario.

Cucumber HTML

Available at target/cucumber-reports/cucumber.html after any test run. Open directly in a browser.

Report output locations

Path	Contents
`target/allure-results/`	Raw Allure JSON results
`target/site/allure-maven-plugin/`	Generated static Allure HTML report
`target/cucumber-reports/cucumber.html`	Cucumber HTML report
`logs/automation.log`	Full Log4j2 execution log

Live report (CI)

Every push to main triggers the pipeline and publishes results automatically:

📊 https://elementz76.github.io/Test-Automation-Framework-Internal/

CI/CD Pipeline

The GitHub Actions workflow (.github/workflows/ci.yml) runs on every push and pull request to main.

Pipeline stages

Push to main
     ↓
Checkout code
     ↓
Set up JDK 11 (with Maven cache)
     ↓
Run tests (headless Chrome, all scenarios)
     ↓
Upload artifacts: allure-results, cucumber-report, logs
     ↓
Generate Allure HTML report
     ↓
Deploy to GitHub Pages (gh-pages branch)

Key behaviours

Tests run in headless Chrome automatically on CI — no configuration needed
Tests run in headed Chrome locally — browser opens visibly as expected
The pipeline continues even if tests fail (continue-on-error: true) so reports are always generated and uploaded
Artifacts (results, reports, logs) are retained for 7 days per run
The Allure report keeps a history of the last 20 runs for trend analysis

Manual trigger

The pipeline can also be triggered manually from the Actions tab in GitHub using the workflow_dispatch event — no push required.

Configuration

All default settings are in src/test/resources/config.properties. Any value can be overridden at runtime using -D flags without modifying any code.

url           = https://www.saucedemo.com/
browser       = chrome
implicitwait  = 10
threads       = 1
executionMode = local
gridUrl       = http://localhost:4444

Property	Description	Accepted Values
`url`	Base URL of the application under test	Any valid URL
`browser`	Browser to launch	`chrome`, `firefox`, `edge`
`implicitwait`	Implicit wait timeout in seconds	Integer
`threads`	Number of parallel execution threads	Positive integer
`executionMode`	Where to run — locally or on a Selenium Grid	`local`, `grid`
`gridUrl`	Selenium Grid hub URL (used when `executionMode=grid`)	Any valid hub URL

Troubleshooting

Chrome does not open locally

Confirm --headless is not hardcoded in TestBase.java. The framework detects CI automatically via System.getenv("CI"). Locally this is null, so headed mode is used. On GitHub Actions it is "true", so headless mode activates.

Maven dependencies not downloading

mvn clean install -U

In Eclipse: right-click project → Maven → Update Project → check Force Update → OK.

TestNG plugin missing in Eclipse

Go to Help → Eclipse Marketplace → search TestNG for Eclipse → install → restart Eclipse.

Allure report is blank after CI run

Check the Actions run log for compilation errors. The most common cause is a filename case mismatch — Java class names must exactly match their filenames (case-sensitive on Linux). For example, CartPage.java not cartPage.java.

Tests compile locally but fail on CI

Ensure all source files are committed and tracked by Git:

git ls-files src/

Every .java file should appear. If any are missing, stage and commit them explicitly:

git add src/
git commit -m "fix: ensure all source files are tracked"
git push origin main

Name		Name	Last commit message	Last commit date
Latest commit History 62 Commits
.allure/allure-2.24.0		.allure/allure-2.24.0
.github/workflows		.github/workflows
.metadata		.metadata
allure-report		allure-report
src/test		src/test
test-output		test-output
.gitignore		.gitignore
README.md		README.md
pom.xml		pom.xml

Folders and files

Latest commit

History

Repository files navigation

SauceDemo Test Automation Framework

Table of Contents

Project Structure

Tech Stack

Framework Design

TestBase — Centralized Browser Control

Page Object Model

ApplicationHooks — Lifecycle and Screenshot Capture

Test Data

Test Scenarios

Prerequisites

Getting Started

1. Clone the repository

2. Install dependencies

3. Verify setup

Running Tests

Supported Parameters

Run all tests

Filter by tag

Select a browser

Parallel execution

Via IDE

Selenium Grid

Prerequisites

Step 1 — Start the Hub

Step 2 — Register a Node

Step 3 — Verify the Grid is running

Step 4 — Run tests against the Grid

How it works

Reports

Allure (recommended)

Cucumber HTML

Report output locations

Live report (CI)

CI/CD Pipeline

Pipeline stages

Key behaviours

Manual trigger

Configuration

Troubleshooting

Chrome does not open locally

Maven dependencies not downloading

TestNG plugin missing in Eclipse

Allure report is blank after CI run

Tests compile locally but fail on CI

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages