Skip to content

Commit bb4e9e6

Browse files
authored
Revise README for framework name and features update
Updated README to reflect framework name change and improved clarity on features and services offered.
1 parent cf8806e commit bb4e9e6

File tree

1 file changed

+69
-51
lines changed

1 file changed

+69
-51
lines changed

README.md

Lines changed: 69 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,60 @@
1-
# 🛡️ Selenium + Pytest SauceDemo E2E Framework with Allure
2-
3-
[![Python](https://img.shields.io/badge/Python-3.9+-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
4-
[![Selenium](https://img.shields.io/badge/Selenium-4.0+-43B02A?style=for-the-badge&logo=selenium&logoColor=white)](https://www.selenium.dev/)
5-
[![Pytest](https://img.shields.io/badge/pytest-7.0+-0A9EDC?style=for-the-badge&logo=pytest&logoColor=white)](https://pytest.org/)
6-
[![Allure](https://img.shields.io/badge/Allure-2.0+-FF0000?style=for-the-badge&logo=allure&logoColor=white)](https://allurereport.org/)
7-
[![CI](https://img.shields.io/badge/CI-Passing-brightgreen?style=for-the-badge&logo=github)](https://github.com/jerryfinol17/Automated-testing-project/actions)
8-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)](LICENSE)
9-
10-
**Enterprise-ready End-to-End automation framework** for SauceDemo using **Selenium WebDriver**, **pytest**, **Page Object Model** and **Allure reporting** — with rich interactive dashboards, screenshots, timelines and CI/CD artifacts.
11-
12-
Demonstrates key skills companies seek: stable Selenium automation, beautiful stakeholder reports (Allure), maintainable POM, data-driven tests, cross-browser, and automated pipelines.
13-
14-
### ✨ Key Highlights
15-
- ✅ Full **Page Object Model** (dedicated pages + config modules)
16-
- ✅ Cross-browser (Chrome & Firefox via WebDriver Manager)
17-
- ✅ All SauceDemo users & edge cases (locked-out, invalid creds, empty fields)
18-
- ✅ Comprehensive flows: login, inventory (add/multi/sort/price validation), cart (consistency/remove), full parametrized checkout E2E
19-
-**Allure reporting** — steps, attachments, timelines, screenshots, failure details
20-
- ✅ Pytest-HTML fallback + auto artifacts in CI
21-
- ✅ GitHub Actions CI (runs on push/PR, green status, reports downloadable)
22-
- ✅ Data-driven with `@pytest.mark.parametrize`
23-
24-
### 📁 Project Structure
25-
26-
```bash
27-
Automated-testing-project/
28-
├── config/ # Credentials & locators per page
29-
├── pages/ # POM core (login, inventory, cart, checkout)
30-
├── test/ # Test suites (login, inventory, cart/E2E)
31-
├── reports/ # Pytest-HTML reports
32-
├── allure-results/ # Raw Allure data
33-
├── allure-report/ # Generated Allure dashboard
34-
├── docs/ # Screenshots & extras
35-
├── .github/workflows/ # CI pipeline (main.yml)
36-
└── requirements.txt
1+
# Selenium + Python + POM Framework
2+
**Production-Ready E2E Automation Framework with Allure | SauceDemo**
3+
4+
[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://python.org)
5+
[![Selenium](https://img.shields.io/badge/Selenium-43B02A?style=for-the-badge&logo=selenium&logoColor=white)](https://www.selenium.dev)
6+
[![Pytest](https://img.shields.io/badge/Pytest-0A9EDC?style=for-the-badge&logo=pytest&logoColor=white)](https://pytest.org)
7+
[![Allure](https://img.shields.io/badge/Allure-FF0000?style=for-the-badge&logo=allure&logoColor=white)](https://allure.report)
8+
[![GitHub Actions](https://github.com/jerryfinol17/selenium-python-saucedemo-pom-framework/actions/workflows/main.yml/badge.svg)](https://github.com/jerryfinol17/selenium-python-saucedemo-pom-framework/actions)
9+
[![Coverage](https://img.shields.io/badge/Coverage-76.5%25-yellow?style=for-the-badge)](https://github.com/jerryfinol17/selenium-python-saucedemo-pom-framework)
10+
11+
A clean, maintainable **End-to-End automation framework** built with **Selenium + Python + Page Object Model (POM)** and **Allure Reporting**.
12+
13+
Designed with production standards in mind: reusable components, centralized configuration, beautiful reporting, and CI/CD ready.
14+
15+
---
16+
17+
### ✨ Key Features
18+
19+
- **Page Object Model** with reusable `BasePage` class
20+
- Centralized locators and configuration
21+
- Cross-browser testing (Firefox + Edge)
22+
- **Allure Reporting** with automatic screenshots on failure
23+
- Data-driven tests (positive + negative scenarios)
24+
- CI/CD pipeline with GitHub Actions
25+
26+
---
27+
28+
### 🏗️ Project Structure
29+
30+
```bash
31+
selenium-python-saucedemo-pom-framework/
32+
├── pages/ # Page Objects (BasePage, LoginPage, InventoryPage...)
33+
├── test/ # Test suites
34+
├── config/ # Locators and configuration
35+
├── screenshots/ # Automatic failure screenshots
36+
├── allure-results/ # Allure raw data
37+
├── .github/workflows/ # CI/CD pipeline
38+
├── requirements.txt
39+
└── conftest.py
3740
```
3841

3942
### 🚀 Quick Start
4043
```bash
41-
git clone https://github.com/jerryfinol17/Automated-testing-project.git
42-
cd Automated-testing-project
44+
git clone https://github.com/jerryfinol17/selenium-python-saucedemo-pom-framework.git
45+
cd selenium-python-saucedemo-pom-framework
46+
47+
# Virtual environment
48+
python -m venv .venv
49+
source .venv/bin/activate # Windows: .venv\Scripts\activate
50+
4351
pip install -r requirements.txt
52+
53+
# Run tests
54+
pytest -q
55+
56+
# Generate and open Allure report
57+
allure serve allure-results
4458
```
4559

4660
### Run Tests:
@@ -50,23 +64,27 @@ pytest --alluredir=allure-results -v # With Allure
5064
allure serve allure-results/ # Open interactive report
5165
```
5266

53-
### CI Reports:
54-
Download Allure/HTML artifacts from Actions tab after runs.
55-
### Reporting Demo
56-
Allure dashboard: steps, screenshots, failure reasons — perfect for sharing with PMs/devs.
57-
(Agrega screenshot de Allure si podés: sube uno a docs/ y enlaza: Allure Sample)
67+
### Reporting
68+
**Allure Report**: Rich interactive dashboards with steps, timelines and screenshots
69+
**Screenshots**: Automatically captured on test failure
70+
**Coverage**: 76.5%
71+
72+
### Why This Framework?
73+
This repository showcases my ability to build structured and maintainable Selenium frameworks using modern practices (POM, Allure reporting, and clean architecture).It complements my **Playwright** frameworks (Python & TypeScript) and demonstrates versatility across the two most used automation tools.
5874

59-
![img.png](docs/img.png)
75+
### Services I Offer:
76+
**QA Automation Enginee**r specialized in building production-ready frameworks.
77+
Available services:Playwright frameworks (Python & TypeScript)
78+
Selenium + Python frameworks
79+
Migration from Selenium to Playwright
80+
CI/CD integration + Allure reporting
6081

61-
### Why this Framework stands out
62-
Classic Selenium (enterprise staple) + modern Allure reporting = combo que muchas compañías pagan bien. Listo para escalar a tu proyecto real.Open for freelance/contract QA roles (Selenium/Playwright/Python/API/CI).
82+
Looking for a custom automation framework for your project?
83+
Contact me → **jerrytareas17@gmail.com (mailto:jerrytareas17@gmail.com)**
6384

64-
**Open for freelance/contract QA Automation roles** (Selenium • Playwright • Python • API • CI/CD).
85+
Star the repository if you find it useful!
6586

66-
→ DM me on X [@GordoRelig3d](https://x.com/GordoRelig3d)
67-
→ Email: jerrytareas17@gmail.com
87+
Made with for the QA Automation community.
6888

69-
¡Tests green, reports stunning! 🏆
7089

7190

72-
Built by Jerry Finol | Last Updated: March 20, 2026

0 commit comments

Comments
 (0)