socialseed-e2e Documentation

socialseed-e2e is a comprehensive End-to-End (E2E) testing framework for REST APIs built with Python and Playwright.

Getting Started

• Installation Guide
  • Table of Contents
  • System Requirements
  • Quick Install
  • Step-by-Step Installation
  • Virtual Environment Setup
  • Development Installation
  • Playwright Browser Installation
  • Verification
  • Platform-Specific Notes
  • Troubleshooting
  • Common Issues
  • Next Steps
• Quick Start Guide
  • Table of Contents
  • Overview
  • What You’ll Build
  • Step 1: Project Initialization
  • Step 2: Understanding the Project Structure
  • Step 3: Configure Your API
  • Step 4: Create Your First Service
  • Step 5: Create Your First Test
  • Step 6: Run Your Tests
  • Step 7: Add More Tests
  • Next Steps
  • Troubleshooting
  • Summary

User Guide

• Configuration Reference
  • Overview
  • Configuration File Location
  • Configuration Structure
  • General Section
  • Services Configuration
  • Environment Variables
  • API Gateway Setup
  • Database Configuration
  • Test Data Configuration
  • Security Configuration
  • Reporting Configuration
  • Configuration Examples
  • Advanced Features
  • Troubleshooting
  • Configuration Reference Summary
  • See Also
• Writing Test Modules
  • Overview
  • Test Module Structure
  • The run() Function
  • ServicePage Usage
  • Assertions and Error Handling
  • Sharing State Between Tests
  • Best Practices
  • Complete Examples
  • Common Patterns
  • Testing with Mock API
  • See Also
• CLI Reference
  • Overview
  • Global Options
  • Commands Reference
  • Error Messages and Solutions
  • Environment Variables
  • Command Cheat Sheet
  • Advanced Usage
  • Tips and Best Practices
  • See Also

API Reference

• API Reference - Core Module
  • BasePage
  • Configuration
  • Models
  • Test Orchestrator
  • Module Loader
  • Interfaces
• API Reference - CLI Module
  • Main CLI
  • Commands
• API Reference - Models
  • Service Configuration
  • Test Context
  • Retry Configuration
  • Rate Limit Configuration
  • Request Log
  • Exceptions
• API Reference - Utilities
  • Template Engine
  • String Utilities
  • Validators
  • Headers

Development

• Pytest Configuration and Testing Guide
• Mock API for Integration Testing

Additional Resources

• Changelog
• License

Indices and tables

• Index

• Module Index

• Search Page

Features

• Hexagonal Architecture: Clean separation between core framework and service-specific code

• Playwright Integration: Modern HTTP client with automatic retries and rate limiting

• YAML Configuration: Centralized configuration management

• Dynamic Test Discovery: Automatic test module loading and execution

• Rich CLI: Beautiful command-line interface with helpful feedback

• Type Safety: Full type hints support with Pydantic models

Quick Links

• Source Code: https://github.com/daironpf/socialseed-e2e

• Issue Tracker: https://github.com/daironpf/socialseed-e2e/issues

• PyPI: https://pypi.org/project/socialseed-e2e/

License

This project is licensed under the MIT License - see the License page for details.