SauceDemo Test Automation Framework

A comprehensive test automation framework for SauceDemo e-commerce application using Python and Playwright.

Overview

This project implements automated regression tests for SauceDemo, covering critical user flows including authentication, shopping cart operations, and checkout processes.

Technology Stack

• Language: Python 3.9+
• Test Framework: Playwright for Python
• Test Runner: pytest
• Reporting: pytest-html
• CI/CD: GitHub Actions

Project Structure

assessment-swag-labs/
├── tests/                    # Test suites
│   ├── test_login.py         # Authentication tests
│   ├── test_cart.py          # Shopping cart tests
│   ├── test_checkout.py      # Checkout flow tests
│   └── conftest.py           # Pytest fixtures and configuration
├── pages/                    # Page Object Model classes
│   ├── login_page.py         # Login page interactions
│   ├── inventory_page.py     # Product listing page
│   ├── cart_page.py          # Shopping cart page
│   └── checkout_page.py      # Checkout pages
├── utils/                     # Utility functions
│   ├── config.py             # Configuration management
│   └── helpers.py            # Helper functions
├── data/                      # Test data
│   └── test_data.json        # Test data in JSON format
├── reports/                   # Test reports (generated)
├── .github/
│   └── workflows/
│       └── tests.yml         # GitHub Actions CI workflow
├── pytest.ini                # Pytest configuration
├── requirements.txt          # Python dependencies
└── README.md                 # This file

Setup Instructions

Prerequisites

• Python 3.9 or higher
• pip (Python package manager)
• Git

Installation Steps

1. Clone the repository (if applicable):

   git clone <repository-url>
   cd assessment-swag-labs

2. Create a virtual environment:

   python -m venv .venv

3. Activate the virtual environment:

   • On Linux/Mac:

     source .venv/bin/activate

   • On Windows:

     .venv\Scripts\activate

4. Install dependencies:

   pip install -r requirements.txt

5. Install Playwright browsers:

   playwright install

6. Set up environment variables (optional):

   cp .env.example .env
   # Edit .env file with your configuration if needed

Running Tests

Run All Tests

pytest

Run Specific Test Suites

# Run only login tests
pytest -m login

# Run only cart tests
pytest -m cart

# Run only checkout tests
pytest -m checkout

Run Specific Test File

pytest tests/test_login.py

Run with Verbose Output

pytest -v

Run in Headed Mode (see browser)

pytest --headed

Run with Screenshots on Failure

Screenshots are automatically captured on test failures and saved in test-results/ directory.

Cross-browser runs

Run the full suite on all supported browsers (Chromium, Firefox, WebKit). Each test runs once per browser:

pytest --browser chromium --browser firefox --browser webkit

Run on a single browser only (e.g. for faster local feedback):

pytest --browser firefox

Test Coverage

Authentication Tests (test_login.py)

• ✅ Valid login with correct credentials
• ✅ Invalid username
• ✅ Invalid password
• ✅ Locked out user handling
• ✅ Empty username validation
• ✅ Empty password validation
• ✅ Empty credentials validation
• ✅ Login page elements visibility

Shopping Cart Tests (test_cart.py)

• ✅ Add single item to cart
• ✅ Add multiple items to cart
• ✅ Remove item from inventory page
• ✅ Remove item from cart page
• ✅ Cart persistence across navigation
• ✅ Cart persists after cart page refresh
• ✅ Cart badge preserved after inventory refresh
• ✅ Cart badge count updates
• ✅ Cart items display correctly
• ✅ Inventory loads with all products
• ✅ Inventory sorting by name and price
• ✅ Proceed to checkout from cart
• ✅ Inventory access in a new tab after login

Checkout Tests (test_checkout.py)

• ✅ Complete end-to-end checkout flow
• ✅ Checkout form validation (missing first name)
• ✅ Checkout form validation (missing last name)
• ✅ Checkout form validation (missing postal code)
• ✅ Cancel checkout functionality
• ✅ Logout after checkout
• ✅ Checkout with multiple items
• ✅ Error message clears after fixing checkout info
• ✅ Back/forward navigation during checkout
• ✅ Overview items match cart items
• ✅ Totals and tax calculation on overview

Page Object Model (POM)

The framework uses the Page Object Model pattern to improve maintainability and reduce code duplication:

• LoginPage: Handles all login page interactions
• InventoryPage: Manages product listing, sorting, and cart operations
• CartPage: Handles shopping cart operations
• CheckoutPage: Manages checkout information and completion

Test Data Management

Test data is stored in data/test_data.json and includes:

• User credentials (standard, locked_out, problem, etc.)
• Customer information for checkout
• Product names

Configuration

Configuration is managed through:

• utils/config.py: Base URLs, credentials, timeouts
• .env file: Environment-specific variables (optional)
• pytest.ini: Pytest configuration and markers

Reporting

After test execution, HTML reports are generated in the reports/ directory:

• reports/report.html: Comprehensive test report with results

Screenshots are saved in test-results/ directory on failures.

CI/CD Integration

The project includes a GitHub Actions workflow (.github/workflows/tests.yml) that:

• Runs tests on push/PR to main/master/develop branches
• Uses a cross-browser matrix: the suite runs on Chromium, Firefox, and WebKit (one job per browser)
• Installs only the browser for each matrix job and runs pytest --browser <browser>
• Generates test reports and uploads artifacts per browser: test-results-chromium, test-results-firefox, test-results-webkit (each contains reports/ and test-results/)

Best Practices Implemented

1. Page Object Model: Separates page interactions from test logic
2. Fixtures: Reusable test setup using pytest fixtures
3. Data-Driven Testing: Test data externalized in JSON files
4. Robust Locators: Using data-test attributes and role-based selectors
5. Auto-waiting: Leveraging Playwright's built-in waiting mechanisms
6. Error Handling: Comprehensive error messages and assertions
7. Documentation: Clear docstrings and README

Design Decisions

• Playwright + pytest:
  • Playwright provides modern, reliable browser automation with built-in auto-waiting and powerful debugging tools.
  • pytest offers a simple, expressive test syntax and rich plugin ecosystem (fixtures, markers, HTML reports).
• Page Object Model (POM):
  • Pages encapsulate selectors and actions so tests focus on business flows.
  • Mapping:
    • LoginPage → tests/test_login.py
    • InventoryPage → tests/test_cart.py, tests/test_checkout.py
    • CartPage → tests/test_cart.py, tests/test_checkout.py
    • CheckoutPage → tests/test_checkout.py
• Suite layering via markers:
  • @pytest.mark.login for authentication coverage.
  • @pytest.mark.cart for cart and inventory/cart interactions.
  • @pytest.mark.checkout for checkout flows.
  • A subset of high-value end-to-end tests can be additionally marked as smoke for faster CI runs.

Flakiness Strategy

• Rely on Playwright auto-waiting instead of arbitrary sleeps.
• Use explicit readiness checks such as:
  • InventoryPage.is_loaded() after login or refresh.
  • CartPage.is_loaded() after navigating to the cart.
  • CheckoutPage.is_step_one_loaded() and CheckoutPage.is_overview_loaded() around checkout transitions.
• For absence checks (e.g., empty cart badge), use low/zero timeouts so tests fail fast instead of waiting for the full default timeout.
• Keep tests stateless and isolated by using fresh pages/contexts via pytest fixtures.

Navigation & Edge Coverage

Navigation-related scenarios covered by the suite include:

• Direct navigation to inventory.html without login redirects back to the login page.
• After logout, attempts to access inventory.html are redirected to login.
• Cart state persists across:
  • Navigation between inventory and cart.
  • Refreshing the cart page.
  • Refreshing the inventory page (cart badge count preserved).
• Checkout back/forward behavior:
  • From checkout step two, using browser Back returns to step one with data cleared.
  • Using browser Forward returns to step two with overview still loaded.
• Logged-in users can open inventory.html in a new tab and remain authenticated.

Future Enhancements

Potential improvements for the framework:

• API testing integration
• Performance testing
• Visual regression testing
• Cross-browser testing matrix
• Test data generation utilities
• Allure reporting integration
• Docker containerization

Author

Created as part of QA Engineer assessment for QTeam Solutions.

License

This project is for assessment purposes.