🧪 PyUnit (unittest) + Selenium Framework

Professional Test Automation Framework using Python's unittest (PyUnit) and Selenium WebDriver.

✨ Features

• 🎯 PyUnit (unittest) - Python's built-in testing framework
• 🌐 Selenium WebDriver - Multi-browser automation
• 📊 HTML Reports - Beautiful test execution reports
• 📝 Loguru Logging - Professional logging system
• 🔄 CI/CD Ready - Jenkins & GitHub Actions support
• 📸 Screenshots - Auto-capture on failures
• 🎨 Page Object Model - Clean, maintainable architecture
• ✅ 10 Test Cases - Comprehensive coverage

📦 Installation

Prerequisites

• Python 3.8 or higher
• pip (Python package manager)

Setup

# Clone or extract the framework
cd pyunit-selenium-framework

# Create virtual environment (recommended)
python3 -m venv venv

# Activate virtual environment
# On macOS/Linux:
source venv/bin/activate
# On Windows:
venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

🚀 Quick Start

1. Configure Environment

# Copy example environment file
cp .env.example .env

# Edit .env with your settings (optional)
nano .env

2. Run Tests

# Run all tests with HTML report
python3 run_tests.py

# Or use the bash script
./run_tests.sh

# Run specific browser
./run_tests.sh chrome
./run_tests.sh firefox
./run_tests.sh edge

# Run in headed mode (see browser)
./run_tests.sh headed

# Run in headless mode (no UI)
./run_tests.sh headless

3. View Reports

# HTML report will be in reports/ directory
open reports/PyUnit_Selenium_Test_Report.html

📁 Project Structure

pyunit-selenium-framework/
├── config/
│   ├── __init__.py
│   ├── config.py              # Configuration management
│   └── logger.py              # Logging configuration
├── helpers/
│   ├── __init__.py
│   └── api_helper.py          # API integration helper
├── pages/
│   ├── __init__.py
│   ├── base_page.py           # Base page object
│   └── login_page.py          # Login page object
├── tests/
│   ├── __init__.py
│   ├── base_test.py           # Base test class
│   └── test_login.py          # Login test cases
├── screenshots/               # Test screenshots
├── logs/                     # Execution logs
├── reports/                  # HTML test reports
├── requirements.txt          # Python dependencies
├── run_tests.py             # Test runner script
├── run_tests.sh             # Bash test runner
├── .env.example             # Environment variables template
├── .gitignore              # Git ignore file
└── README.md               # This file

🧪 Test Cases

All test cases are based on https://the-internet.herokuapp.com/login

Login Tests (10 test cases)

1. ✅ test_01_successful_login - Verify successful login with valid credentials
2. ✅ test_02_invalid_username - Verify login fails with invalid username
3. ✅ test_03_invalid_password - Verify login fails with invalid password
4. ✅ test_04_empty_credentials - Verify login fails with empty credentials
5. ✅ test_05_successful_logout - Verify successful logout after login
6. ✅ test_06_login_page_elements - Verify login page elements validation
7. ✅ test_07_special_characters - Verify login with special characters
8. ✅ test_08_case_sensitivity - Verify username case sensitivity
9. ✅ test_09_clear_form - Verify clear login form functionality
10. ✅ test_10_page_title - Verify page title

🎯 Running Specific Tests

# Run specific test file
python3 -m unittest tests.test_login

# Run specific test class
python3 -m unittest tests.test_login.LoginTests

# Run specific test method
python3 -m unittest tests.test_login.LoginTests.test_01_successful_login

# Run with verbose output
python3 -m unittest tests.test_login -v

🔧 Configuration

Environment Variables (.env)

# Browser Configuration
BROWSER=chrome                    # chrome, firefox, edge
HEADLESS=true                     # true or false

# Base URL
BASE_URL=https://the-internet.herokuapp.com

# Timeouts (seconds)
IMPLICIT_WAIT=10
EXPLICIT_WAIT=30
PAGE_LOAD_TIMEOUT=30

# Screenshots
SCREENSHOT_ON_FAILURE=true

# Test Data
VALID_USERNAME=tomsmith
VALID_PASSWORD=SuperSecretPassword!

Runtime Configuration

# Set browser
export BROWSER=firefox
python3 run_tests.py

# Set headless mode
export HEADLESS=false
python3 run_tests.py

# Set base URL
export BASE_URL=https://your-app.com
python3 run_tests.py

📊 Reports & Logging

HTML Reports

• Location: reports/
• Auto-generated after each test run
• Includes test results, screenshots, and execution time
• Open in browser: open reports/PyUnit_Selenium_Test_Report.html

Logs

• Location: logs/test_execution.log
• Rotating logs (max 10MB)
• 30-day retention
• Automatic compression

Screenshots

• Location: screenshots/
• Auto-captured on test failures
• Named with test name and timestamp
• Example: test_01_successful_login_20231215_143022.png

🎨 Page Object Model

Base Page

from pages.base_page import BasePage

class MyPage(BasePage):
    # Locators
    ELEMENT = (By.ID, 'element-id')
    
    def __init__(self, driver):
        super().__init__(driver)
    
    def click_element(self):
        self.click(self.ELEMENT)

Page Methods Available

# Navigation
navigate_to(url)

# Element Interaction
click(locator)
type(locator, text)
get_text(locator)

# Waits
wait_for_element(locator)
wait_for_element_clickable(locator)

# Visibility
is_visible(locator)
is_element_present(locator)

# Utilities
take_screenshot(name)
get_current_url()
get_title()
execute_script(script)

🧪 Writing Tests

Test Template

import unittest
from tests.base_test import BaseTest
from pages.your_page import YourPage
from config.logger import test_start, test_end

class YourTests(BaseTest):
    
    def setUp(self):
        super().setUp()
        self.page = YourPage(self.driver)
    
    def test_something(self):
        test_start("TC-001: Test description")
        
        # Test steps
        self.page.do_something()
        
        # Assertions
        self.assertTrue(condition, "Error message")
        
        test_end("TC-001", "PASSED")

if __name__ == '__main__':
    unittest.main()

Assertions

PyUnit provides rich assertion methods:

# Equality
self.assertEqual(a, b)
self.assertNotEqual(a, b)

# Boolean
self.assertTrue(condition)
self.assertFalse(condition)

# Containment
self.assertIn(item, container)
self.assertNotIn(item, container)

# Null checks
self.assertIsNone(value)
self.assertIsNotNone(value)

# Exceptions
self.assertRaises(Exception, callable)

🔄 CI/CD Integration

Jenkins

pipeline {
    agent any
    
    stages {
        stage('Setup') {
            steps {
                sh 'python3 -m venv venv'
                sh 'source venv/bin/activate && pip install -r requirements.txt'
            }
        }
        
        stage('Test') {
            steps {
                sh 'source venv/bin/activate && python3 run_tests.py'
            }
        }
        
        stage('Report') {
            steps {
                publishHTML([
                    reportDir: 'reports',
                    reportFiles: 'PyUnit_Selenium_Test_Report.html',
                    reportName: 'Test Report'
                ])
            }
        }
    }
}

GitHub Actions

name: PyUnit Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v2
    
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.9'
    
    - name: Install dependencies
      run: |
        pip install -r requirements.txt
    
    - name: Run tests
      run: |
        python3 run_tests.py
    
    - name: Upload report
      uses: actions/upload-artifact@v2
      with:
        name: test-report
        path: reports/

🐛 Troubleshooting

Issue 1: WebDriver not found

# The framework uses webdriver-manager which auto-downloads drivers
# If issues persist, update webdriver-manager:
pip install --upgrade webdriver-manager

Issue 2: Import errors

# Ensure you're in the project root
cd pyunit-selenium-framework

# Verify Python path
export PYTHONPATH="${PYTHONPATH}:$(pwd)"

Issue 3: Browser not launching

# Check browser is installed
google-chrome --version  # Chrome
firefox --version        # Firefox
msedge --version        # Edge

# Try headed mode to see errors
export HEADLESS=false
python3 run_tests.py

Issue 4: Tests hanging

# Increase timeouts in .env
EXPLICIT_WAIT=60
PAGE_LOAD_TIMEOUT=60

📚 Dependencies

Key dependencies and their purposes:

Package	Version	Purpose
selenium	4.15.2	Browser automation
webdriver-manager	4.0.1	Auto driver management
loguru	0.7.2	Professional logging
html-testRunner	1.2.1	HTML report generation
requests	2.31.0	API integration
python-dotenv	1.0.0	Environment variables

💡 Best Practices

✅ Use Page Object Model - Keep tests clean and maintainable
✅ Explicit Waits - Wait for elements, don't use sleep
✅ Descriptive Test Names - Use test_01_description format
✅ Independent Tests - Each test should run standalone
✅ Logging - Use logger for important actions
✅ Screenshots - Capture on failures for debugging
✅ Configuration - Use .env for environment-specific settings
✅ Assertions - Use meaningful assertion messages

🎓 Learning Resources

• Python unittest Documentation
• Selenium Python Documentation
• Page Object Model Pattern
• Loguru Documentation

👨‍💻 Author

Pravin Gamit

• Senior QA Automation Engineer
• 5+ years experience in test automation

📄 License

ISC License - Free to use and modify

---

🚀 Quick Commands Reference

# Setup
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

# Run all tests
python3 run_tests.py

# Run specific browser
./run_tests.sh chrome

# Run in headed mode
./run_tests.sh headed

# Run specific test
python3 -m unittest tests.test_login.LoginTests.test_01_successful_login

# View report
open reports/PyUnit_Selenium_Test_Report.html

# View logs
tail -f logs/test_execution.log

---

⭐ Happy Testing with PyUnit + Selenium! 🚀