Selenium Test Automation Boilerplate

Ready-to-use UI Test Automation Architecture using Java and Selenium WebDriver.

Installation Steps

In order to use the framework:

1. Fork the repository.
2. Clone, i.e, download your copy of the repository to your local machine using

git clone https://github.com/[your_username]/selenium-test-automation-boilerplate.git

3. Import the project in IntelliJ IDEA.
4. Make your desired changes.
5. Use IntelliJ IDEA to run your desired tests. Alternatively, you can use the terminal to run the tests, for example ./gradlew test -Dbrowser=firefox -Dheadless=false to run all the tests using the firefox browser in headed mode.

Languages and Frameworks

The project uses the following:

• Java 11 as the programming language.
• Selenium WebDriver as the web browser automation framework using the Java binding.
• WebDriverManager as the browser driver management library.
• Univocity Parsers to parse and handle CSV files.
• TestNG as the testing framework.
• AssertJ as the assertion library.
• Lombok to generate getters.
• Owner to minimize the code to handle properties file.
• Extent Reports as the test reporting strategy.
• Selenium Shutterbug for capturing screenshots.
• Gradle as the Java build tool.
• IntelliJ IDEA as the IDE.

Project Structure

The project is structured as follows:

📦 selenium-test-automation-boilerplate
├─ .github
│  └─ workflows
│     └─ test-execution.yml
├─ .gitignore
├─ README.md
├─ build.gradle
├─ gradle
│  └─ wrapper
│     ├─ gradle-wrapper.jar
│     └─ gradle-wrapper.properties
├─ gradlew
├─ gradlew.bat
├─ script
│  └─ install_chrome.sh
├─ settings.gradle
└─ src
   ├─ main
   │  ├─ java
   │  │  └─ io
   │  │     └─ github
   │  │        └─ tahanima
   │  │           ├─ config
   │  │           │  ├─ Configuration.java
   │  │           │  ├─ ConfigurationManager.java
   │  │           │  └─ package-info.java
   │  │           ├─ data
   │  │           │  ├─ BaseData.java
   │  │           │  ├─ login
   │  │           │  │  └─ LoginData.java
   │  │           │  └─ package-info.java
   │  │           ├─ driver
   │  │           │  ├─ BrowserFactory.java
   │  │           │  ├─ DriverManager.java
   │  │           │  └─ package-info.java
   │  │           ├─ page
   │  │           │  ├─ BasePage.java
   │  │           │  ├─ BasePageFactory.java
   │  │           │  ├─ login
   │  │           │  │  └─ LoginPage.java
   │  │           │  ├─ package-info.java
   │  │           │  └─ product
   │  │           │     └─ ProductsPage.java
   │  │           └─ report
   │  │              ├─ ExtentReportManager.java
   │  │              └─ package-info.java
   │  └─ resources
   │     └─ general.properties
   └─ test
      ├─ java
      │  └─ io
      │     └─ github
      │        └─ tahanima
      │           ├─ BaseTest.java
      │           ├─ login
      │           │  └─ LoginTest.java
      │           └─ util
      │              ├─ DataProviderUtil.java
      │              └─ TestListener.java
      └─ resources
         └─ testData
            └─ login
               └─ login.csv

Project Components

• Config
• Data
• Driver
• Page
• Report
• Test
• Workflow

Config

The project has some global properties, for example, browser and base url. The config package holds all the relevant classes to handle these global properties.

Data

The project reads test data from csv files. The test data properties are modeled in terms of entities and the data package handles this. For convenience, there is an example class - LoginData.java to demonstrate the usage.

Driver

The project uses Selenium WebDriver to automate user workflows for web-based applications as part of automated testing. The driver package contains all the necessary initialization logic for WebDriver.

Page

The project uses Page Object Model to capture all the relevant UI components and functionalities of a web page. The page package provides all the classes to achieve this. For convenience, there is an example class - LoginPage.java to demonstrate the usage.

Report

The project uses Extent Reports to provide test reporting functionalities. The report package contains the relevant class.

Test

LoginTest.java demonstrates an example test script.

Workflow

The project uses GitHub Actions to run the selenium tests when an update is made to the main branch of the repo in GitHub.