🚀 Automation & API Testing Project

A complete end-to-end software testing framework that combines UI automation 🖥️ and REST API testing ⚡ into a single, maintainable Java project. Built around the public demo site AutomationExercise.com, it mirrors that site's own published test-case catalogue (TC01–TC36) with real Selenium/TestNG and REST Assured coverage, complete Allure traceability, and Jira/Zephyr-style test-case linking — making it a solid reference for QA engineers building production-grade automation suites.

▶️ Watch the Full Project Demo — see the framework, UI test execution, API testing, and generated reports in action.

✨ Key Features

• 35+ UI Test Cases Mapped to Real Scenarios 🧪 — Every test method (TC01…TC36) corresponds 1:1 to a published test case on AutomationExercise.com's own test-case page, annotated with @Link/@TmsLink back to the source scenario.
• 14 REST Assured API Test Cases 📡 — Covers productsList, brandsList, searchProduct, verifyLogin, createAccount, updateAccount, deleteAccount, and getUserDetailByEmail, including disallowed-method checks (405), missing-parameter checks (400), and a full create → fetch → update → delete account lifecycle.
• Page Object Model (POM) 🏗️ — Nine page classes (HomePage, LoginPage, SignupPage, ProductsPage, SingleProductPage, CartPage, CheckoutPage, PaymentPage, ConatctusPage) share a common Framework base with 30+ reusable Selenium wrappers (waits, dropdowns, alerts, drag-and-drop, window switching, screenshots).
• Data-Driven Testing 📊 — User credentials, page URLs, checkout/payment details, and contact-form data are all externalized as JSON (SignupData.JSON, CreateAccount.JSON, PagesUrl.JSON, Payment.JSON, Contactus.JSON, ReviewData.JSON) and parsed with Gson into POJOs.
• Configurable Test Environments ⚙️ — A single config.properties, read through ConfigReader, controls the browser, base URL, wait timings, and headless mode without touching test code.
• Multi-Browser Support 🌐 — WebDriverHandle supports Chrome, Edge, and Brave (with a bundled ad-blocker .crx extension and anti-detection Chrome flags baked in).
• Optimized WebDriver Lifecycle (55% Faster Execution) ⚡ — Tests share one WebDriver instance per test class (initialized in BaseTest's @BeforeClass) instead of spinning up a new browser per test method. In a real full-suite run this cut total execution time from 7 min 29 sec → 4 min 6 sec for the same 36 tests.
• Allure Reporting with Full Traceability 📈 — @Epic / @Feature / @Story / @Severity / @Owner annotations on every test, automatic failure screenshots via a custom AllureListener, and REST Assured request/response logging attached to API test reports.
• Built-in Flaky Test Handling 🔄 — A custom RetryAnalyzer automatically retries a failing test up to 2 times, logging each retry attempt separately from the final verified result, before marking it failed for real.
• Test Case Management Alignment 🎯 — @TmsLink/@Link annotations map automated tests back to Jira/Zephyr Scale test case IDs for traceability between manual and automated coverage.

🛠️ Tech Stack

Category	Technology
Language	Java 25 ☕
Build Tool	Apache Maven 📦
UI Automation	Selenium WebDriver 4.41.0 🌐
Test Runner	TestNG 7.11.0 🧪
API Testing	REST Assured 6.0.0 ⚡
Reporting	Allure (allure-testng, allure-java-commons, allure-rest-assured 2.31.0) 📊
JSON Handling	Gson 2.13.2, Jackson Databind 2.17.0 📄
Boilerplate Reduction	Lombok 1.18.42 🛠️
Assertions/Unit	JUnit Jupiter ✅
Test Execution	Maven Surefire Plugin 3.1.2 🚀

🚀 Getting Started

Prerequisites 📋

• JDK 25 (or lower the maven.compiler.source/target values in pom.xml to match your installed JDK)
• Apache Maven 3.8+
• Chrome, Edge, or Brave installed locally — browser in config.properties controls which one WebDriverHandle launches (Brave is hardcoded to the default Windows install path; adjust WebDriverHandle.java if you're on macOS/Linux or a different install location)
• An IDE such as IntelliJ IDEA (the repo ships with an .idea folder) or Eclipse/VS Code

Installation 💻

1. Clone the repository

git clone https://github.com/SeifZiad/Automation-API-Testing-Project.git
cd Automation-API-Testing-Project

2. Install dependencies

mvn clean install -DskipTests

3. Configure your test environment Edit src/main/resources/config.properties:

browser=chrome
baseUrl=https://automationexercise.com/
implicitWait=10
explicitWait=15
headless=true

💡 Usage

Run the full UI suite 🖥️

mvn clean test

Tests.xml wires up four test classes in this order: HomePageTests → AuthenticationTests → ProductsCartTests → UserStories. A clean full-suite run completes all 36 tests in around 4 minutes:

Run a single test class 🎯

mvn test -Dtest=AuthenticationTests

Run the API tests ⚡

ApiTests isn't currently wired into Tests.xml, so run it directly:

mvn test -Dtest=ApiTests

Generate and view the Allure report 📊

allure serve target/allure-results

or generate a static report:

allure generate target/allure-results --clean -o target/allure-report
allure open target/allure-report

Example: a real API test from this project 📡

Response res = given()
        .baseUri("https://automationexercise.com")
        .when()
        .get("/api/productsList")
        .then()
        .extract().response();

ProductsResponse body = new Gson().fromJson(res.asString(), ProductsResponse.class);

Assert.assertEquals(res.statusCode(), 200);
Assert.assertNotNull(body.getProducts());

Example: a real UI test from this project 🖥️

@Test(dataProvider = "singleUserData")
@TmsLink("TC-02")
public void TC02_PositiveLoginTest(User user) {
    homePage = new LoginPage(driver);
    ((LoginPage) homePage).perfromLogin(user.email, user.password);

    String actual = ((LoginPage) homePage).ReadvalidloginMessage();
    Assert.assertEquals(actual, user.firstName + " " + user.lastName);
}

⏱️ Test Execution & Performance

The framework was deliberately refactored to control WebDriver scope, since that's the single biggest lever on suite runtime for a Selenium project of this size.

Approach	WebDriver Lifecycle	Total Time (36 tests)
Legacy (Alltests.java, @BeforeMethod)	New browser launched for every test method	7 min 29 sec
Current (BaseTest.java, @BeforeClass)	One browser shared across all tests in a class	4 min 6 sec

That's a ~55% reduction in execution time for identical coverage, simply by moving driver initialization from @BeforeMethod to @BeforeClass and reusing the session across a test class's methods.

📊 Reporting & Stability

Allure Reports 📈

Every run produces a full Allure dashboard: pass/fail rate, execution duration, and tests grouped by @Feature/@Story (e.g., Navigation, Shopping Cart, Checkout Workflows), so a non-technical stakeholder can see coverage at a glance without reading code.

Retry Analysis 🔄

RetryAnalyzer (wired in via @Test(retryAnalyzer = RetryAnalyzer.class)) automatically retries a test up to 2 times before it's reported as a genuine failure. The console output — and the Allure report — clearly separate intermediate retry attempts from the final verified result, so a transient failure (e.g., a slow page load) never gets confused with a real regression:

📂 Project Structure

Automation-API-Testing-Project/
├── .idea/                              # IDE project settings
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── Pages/                  # Page Object Model classes
│   │   │   │   ├── HomePage.java           # Navigation, subscribe, category checks
│   │   │   │   ├── LoginPage.java          # extends HomePage — login/signup entry points
│   │   │   │   ├── SignupPage.java         # Full registration form flow
│   │   │   │   ├── ProductsPage.java       # Product listing, search
│   │   │   │   ├── SingleProductPage.java  # Product detail, add-to-cart, reviews
│   │   │   │   ├── CartPage.java           # Cart contents, quantity, removal
│   │   │   │   ├── CheckoutPage.java       # Checkout / order review
│   │   │   │   ├── PaymentPage.java        # Payment form submission
│   │   │   │   └── ConatctusPage.java      # Contact Us form
│   │   │   └── Utils/
│   │   │       ├── ApiResponsePOJOs/       # Gson/Jackson response models (Product, Brand, ApiResponse, ...)
│   │   │       ├── POJOClasses/User.java   # UI test-data POJO
│   │   │       ├── ConfigReader.java       # Reads config.properties
│   │   │       ├── Framework.java          # Reusable Selenium action wrappers (30+ methods)
│   │   │       └── WebDriverHandle.java    # Chrome/Edge/Brave driver lifecycle (singleton)
│   │   └── resources/
│   │       └── config.properties           # Environment configuration
│   └── test/
│       ├── java/
│       │   ├── AllTests/
│       │   │   ├── BaseTest.java           # Shared setup/teardown (@BeforeClass driver init) + TestNG data providers
│       │   │   ├── HomePageTests.java      # TC10, TC25, TC26, TC29–TC36: navigation & home page tests
│       │   │   ├── AuthenticationTests.java# TC01–TC06, TC27–TC28: signup/login/logout/delete
│       │   │   ├── ProductsCartTests.java  # TC08, TC09, TC11–TC13, TC16–TC19, TC21: products, cart, brands, categories, reviews
│       │   │   ├── UserStories.java        # TC14–TC16, TC20, TC23–TC24: end-to-end checkout/order journeys
│       │   │   ├── ApiTests.java           # 14 REST Assured API test cases
│       │   │   └── Alltests.java           # Legacy monolithic suite (superseded by the classes above)
│       │   ├── Listeners/
│       │   │   └── AllureListener.java     # Auto-attaches screenshots to Allure on failure
│       │   └── Utils/
│       │       └── RetryAnalyzer.java      # Retries failed tests up to 2x, logging each attempt
│       └── resources/
│           ├── TestingData/                # JSON test data
│           │   ├── SignupData.JSON
│           │   ├── CreateAccount.JSON
│           │   ├── PagesUrl.JSON
│           │   ├── Payment.JSON
│           │   ├── Contactus.JSON
│           │   └── ReviewData.JSON
│           └── extensions/
│               └── adblocker.crx           # Bundled ad-blocker extension for stable UI runs
├── Tests.xml                            # TestNG suite (HomePageTests, AuthenticationTests, ProductsCartTests, UserStories)
├── pom.xml                              # Maven build & dependency configuration
├── .gitignore
└── README.md

Note: Alltests.java predates the split into HomePageTests / AuthenticationTests / ProductsCartTests / UserStories and duplicates much of their coverage in one 800+ line class, using a @BeforeMethod driver — the slower, pre-optimization approach described above. It isn't referenced by Tests.xml and is kept in the repo as an earlier iteration rather than the maintained entry point.

⚙️ Configuration / Environment Variables

The framework is configured through src/main/resources/config.properties, loaded at runtime by ConfigReader:

Key	Description	Example
browser	Browser used for Selenium execution — chrome, edge, or brave	brave
baseUrl	Base URL of the application under test	[https://automationexercise.com/](https://automationexercise.com/)
implicitWait	Implicit wait timeout in seconds	10
explicitWait	Explicit/WebDriverWait timeout in seconds	15
headless	Run the browser headless (--headless=new)	true

If you set browser=brave, WebDriverHandle.java currently points to a hardcoded Windows path (C:\Program Files\BraveSoftware\Brave-Browser\Application\brave.exe). Update this path directly in the source if you're on macOS/Linux or have Brave installed elsewhere.

🤝 Contributing

Contributions, suggestions, and bug reports are welcome:

1. Fork the repository.
2. Create a feature branch: git checkout -b feature/your-feature-name.
3. Commit your changes with clear messages.
4. Push the branch and open a Pull Request describing the change and its motivation.
5. For bugs or ideas, feel free to open an Issue first to discuss the approach.

Please keep new UI tests aligned with the existing Page Object Model (extend Framework/HomePage as appropriate), initialize the WebDriver at the class level (not per-method) to preserve the current execution-time gains, add corresponding JSON test data under TestingData/, and wire new test classes into Tests.xml.

📄 License

This project is intended for educational and portfolio purposes. No formal license file is currently published in the repository — if you plan to reuse or redistribute this code, please reach out to the repository owner (SeifZiad) for clarification.