Skip to content

A Java-based API test automation framework using Rest Assured, TestNG, and Maven, integrated with Jenkins CI/CD pipelines. This setup enables seamless API test execution, reporting, and continuous integration, making it ideal for automating backend validations in agile environments.

Notifications You must be signed in to change notification settings

pranjaldayama/restassured-jenkins-cicd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

RestAssured Jenkins CI/CD Framework πŸš€

A clean Java + REST Assured test framework built with Maven/TestNG and integrated with Jenkins for full CI/CD automation.


🧠 What It Does

  • Implements REST API tests using REST Assured and TestNG
  • Uses Maven to manage dependencies & run tests
  • Integrates with Jenkins to trigger tests on code changes or schedules
  • Produces reports (e.g., TestNG, HTML) after each Jenkins build

πŸš€ Quick Start

  1. Clone the repo

    git clone https://github.com/pranjaldayama/restassured-jenkins-cicd.git
    cd restassured-jenkins-cicd
    
  2. Build & run tests locally

    mvn clean test

  3. Hook into Jenkins

Create a Maven job in Jenkins Point it to this repo Configure the build step as clean test Optionally add Allure or TestNG HTML report plugins for post-build reporting

Project Structure

 β”œβ”€β”€ src/ β”‚ β”œβ”€β”€ main/java/ ← Request payloads, helper utilities β”‚ └── test/java/ ← REST Assured test classes and TestNG suites β”œβ”€β”€ pom.xml ← Build, dependencies & plugins └── Jenkinsfile (optional) ← Pipeline config for Jenkins Pipeline jobs 

πŸ› οΈ Features & Best Practices

βœ… Modular API tests with REST Assured + TestNG βœ… Maven-automated lifecycle: compile β†’ test β†’ report βœ… Optional Jenkinsfile for declarative pipeline CI βœ… Generates build artifacts & test reports for traceability

🧩 Jenkins Integration Tips

Use Jenkins Maven integration plugin (or Pipeline syntax) Define build step: mvn clean test Enable post-build report archiving (TestNG HTML or Allure) Automate via triggers: SCM polling, webhooks, or cron schedule

About

A Java-based API test automation framework using Rest Assured, TestNG, and Maven, integrated with Jenkins CI/CD pipelines. This setup enables seamless API test execution, reporting, and continuous integration, making it ideal for automating backend validations in agile environments.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages