socialseed-e2e 0.1.0__tar.gz

socialseed_e2e-0.1.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive CLI reference documentation
+- Sphinx documentation setup with autodoc
+- ReadTheDocs configuration
+
+## [0.1.0] - 2026-02-01
+
+### Added
+- Initial release of socialseed-e2e
+- Core framework with BasePage, ApiConfigLoader, TestOrchestrator
+- CLI with commands: init, new-service, new-test, run, doctor, config
+- Playwright integration for HTTP testing
+- YAML/JSON configuration support
+- Template system for scaffolding
+- Mock API server for integration testing
+- Rich CLI output with tables and progress bars
+- Pytest integration with markers and coverage
+- GitHub Actions CI/CD workflow
+- Complete documentation suite
+
+### Features
+- Service-agnostic hexagonal architecture
+- Automatic test discovery and execution
+- Stateful test chaining with shared context
+- Rate limiting and retry mechanisms
+- Type-safe Pydantic models
+- Environment variable support in configuration
+
+[Unreleased]: https://github.com/daironpf/socialseed-e2e/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/daironpf/socialseed-e2e/releases/tag/v0.1.0

socialseed_e2e-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+dairon.perezfrias@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

socialseed_e2e-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,460 @@
+# Contributing to socialseed-e2e
+
+First off, thank you for considering contributing to socialseed-e2e! It's people like you that make this framework a great tool for the community.
+
+This document provides guidelines and instructions for contributing to the project. We welcome contributions from both human developers and AI agents.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How Can I Contribute?](#how-can-i-contribute)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Features](#suggesting-features)
+  - [Contributing Code](#contributing-code)
+- [Development Setup](#development-setup)
+- [Code Style Guide](#code-style-guide)
+- [Pull Request Process](#pull-request-process)
+- [Commit Message Conventions](#commit-message-conventions)
+- [AI Contributors](#ai-contributors)
+- [Questions?](#questions)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating a bug report, please:
+
+1. **Check existing issues** to see if the problem has already been reported
+2. **Use the latest version** to verify the bug still exists
+3. **Isolate the problem** to the smallest reproducible example
+
+#### How to Submit a Good Bug Report
+
+Bugs are tracked as [GitHub issues](https://github.com/daironpf/socialseed-e2e/issues). When creating a bug report, please include:
+
+- **Use a clear and descriptive title** (e.g., "BasePage retry fails on 429 status code")
+- **Describe the exact steps to reproduce the problem**
+- **Provide specific examples** demonstrating the steps
+- **Describe the behavior you observed** and what behavior you expected
+- **Include code samples** and/or terminal output
+- **Specify your environment**:
+  - Python version: `python --version`
+  - socialseed-e2e version: `pip show socialseed-e2e`
+  - Operating system and version
+  - Playwright version: `pip show playwright`
+
+**Bug Report Template:**
+
+```markdown
+**Description:**
+A clear description of the bug.
+
+**Steps to Reproduce:**
+1. Initialize project with 'e2e init'
+2. Create service with 'e2e new-service test-api'
+3. Run 'e2e run'
+4. See error
+
+**Expected Behavior:**
+What you expected to happen.
+
+**Actual Behavior:**
+What actually happened, including full error messages.
+
+**Environment:**
+- Python: 3.11.4
+- socialseed-e2e: 0.1.0
+- OS: Ubuntu 22.04
+- Playwright: 1.40.0
+
+**Additional Context:**
+Add any other context about the problem here.
+```
+
+### Suggesting Features
+
+Feature requests are welcome! When suggesting a feature:
+
+1. **Check existing issues** to see if the feature has already been suggested
+2. **Provide a clear use case** - explain why this feature would be useful
+3. **Describe the solution** you'd like to see
+4. **Consider alternatives** you've thought of
+
+#### How to Submit a Feature Request
+
+- **Use a clear and descriptive title** for the issue
+- **Provide a detailed description** of the suggested feature
+- **Explain why this feature would be useful** to most users
+- **List some examples** of how the feature would be used
+- **Note if you are willing to work on this feature** yourself
+
+**Feature Request Template:**
+
+```markdown
+**Feature Description:**
+A clear description of the feature you'd like to see.
+
+**Use Case:**
+Explain the scenario where this feature would be helpful.
+
+**Proposed Solution:**
+Describe how you think this should work.
+
+**Alternatives Considered:**
+Describe any alternative solutions you've considered.
+
+**Additional Context:**
+Add any other context or screenshots about the feature request.
+```
+
+### Contributing Code
+
+#### Before You Start
+
+1. **Check existing issues** or create a new one to discuss your proposed changes
+2. **Fork the repository** and create a new branch for your changes
+3. **Ensure your changes align** with the project's goals and architecture
+
+#### Types of Contributions We Welcome
+
+- 🐛 **Bug fixes** - Fix reported issues
+- ✨ **New features** - Add functionality following our architecture
+- 📝 **Documentation** - Improve docs, add examples, fix typos
+- 🧪 **Tests** - Add test coverage for existing code
+- 🔧 **Refactoring** - Improve code quality without changing behavior
+- 🎨 **UI/UX improvements** - Enhance CLI output or user experience
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.9 or higher
+- Git
+- pip or pipenv
+
+### Setting Up Your Development Environment
+
+1. **Fork and clone the repository:**
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/socialseed-e2e.git
+   cd socialseed-e2e
+   ```
+
+2. **Create a virtual environment:**
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. **Install development dependencies:**
+   ```bash
+   pip install -e ".[dev]"
+   playwright install chromium
+   ```
+
+4. **Install pre-commit hooks:**
+   ```bash
+   pre-commit install
+   ```
+   This will automatically run code quality checks on each commit.
+
+5. **Verify your setup:**
+   ```bash
+   e2e doctor
+   pytest
+   ```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run only unit tests
+pytest -m unit
+
+# Run only integration tests
+pytest -m integration
+
+# Run with coverage
+pytest --cov=socialseed_e2e --cov-report=html
+
+# Run specific test file
+pytest tests/unit/test_base_page.py
+```
+
+### Code Quality Tools
+
+We use several tools to maintain code quality. These are automatically run as **pre-commit hooks** on every commit, ensuring code quality before changes are submitted.
+
+#### Pre-commit Hooks (Automatic)
+
+Once you run `pre-commit install`, the following checks run automatically on each commit:
+
+- **trailing-whitespace**: Removes trailing whitespace
+- **end-of-file-fixer**: Ensures files end with a newline
+- **check-yaml**: Validates YAML syntax
+- **check-json**: Validates JSON syntax
+- **check-toml**: Validates TOML syntax
+- **check-merge-conflict**: Prevents merge conflict markers from being committed
+- **check-added-large-files**: Prevents large files from being committed
+- **black**: Formats Python code
+- **isort**: Sorts Python imports
+- **flake8**: Checks Python style and syntax
+- **mypy**: Performs static type checking
+
+#### Manual Quality Checks
+
+You can also run these tools manually:
+
+```bash
+# Format code with black
+black src/ tests/
+
+# Sort imports
+isort src/ tests/
+
+# Check style with flake8
+flake8 src/ tests/
+
+# Type checking
+mypy src/socialseed_e2e
+
+# Run all quality checks on all files
+pre-commit run --all-files
+
+# Run specific hook
+pre-commit run black --all-files
+```
+
+## Code Style Guide
+
+### Python Code Style
+
+We follow [PEP 8](https://pep8.org/) with the following specifics:
+
+- **Line length**: 100 characters maximum
+- **Quotes**: Use double quotes for strings, single quotes for single characters
+- **Imports**: Grouped as standard library, third-party, local (sorted alphabetically within groups)
+- **Type hints**: Required for all function parameters and return values
+- **Docstrings**: Use Google-style docstrings for all public modules, classes, and functions
+
+### Example:
+
+```python
+"""Module for user service testing.
+
+This module provides functionality for testing user-related
+API endpoints.
+"""
+
+from typing import Dict, Any, Optional
+from playwright.sync_api import APIResponse
+
+from socialseed_e2e.core.base_page import BasePage
+
+
+class UserServicePage(BasePage):
+    """Page object for user service API.
+
+    Provides methods for interacting with user endpoints
+    including CRUD operations and authentication.
+
+    Attributes:
+        base_url: The base URL for the user service
+        auth_token: Authentication token for protected endpoints
+    """
+
+    def __init__(self, base_url: str) -> None:
+        """Initialize the UserServicePage.
+
+        Args:
+            base_url: The base URL for the user service API
+        """
+        super().__init__(base_url)
+        self.auth_token: Optional[str] = None
+
+    def login(self, email: str, password: str) -> APIResponse:
+        """Authenticate user and store token.
+
+        Args:
+            email: User's email address
+            password: User's password
+
+        Returns:
+            APIResponse: The login response containing auth token
+
+        Raises:
+            AssertionError: If login fails (non-2xx status)
+        """
+        response = self.post(
+            "/auth/login",
+            json={"email": email, "password": password}
+        )
+
+        if response.ok:
+            data = response.json()
+            self.auth_token = data.get("token")
+
+        return response
+```
+
+### Testing Guidelines
+
+- **Test names**: Descriptive, prefixed with `test_`
+- **Test organization**: Mirror the source structure in `tests/`
+- **Use fixtures**: Leverage pytest fixtures for setup/teardown
+- **Mock external services**: Use the built-in mock API or mocking libraries
+- **Coverage**: Aim for >80% coverage on new code
+
+### Documentation Guidelines
+
+- **Update README.md** if adding new features
+- **Update CHANGELOG.md** following Keep a Changelog format
+- **Add docstrings** to all public APIs
+- **Update relevant docs** in the `docs/` directory
+- **Include examples** for new features
+
+## Pull Request Process
+
+### Before Submitting
+
+1. **Ensure tests pass:**
+   ```bash
+   pytest
+   ```
+
+2. **Check code quality:**
+   ```bash
+   black src/ tests/
+   flake8 src/ tests/
+   mypy src/socialseed_e2e
+   ```
+
+3. **Verify pre-commit hooks are passing:**
+   ```bash
+   pre-commit run --all-files
+   ```
+
+4. **Update documentation** as needed
+
+5. **Add/update tests** for your changes
+
+6. **Update CHANGELOG.md** with your changes under [Unreleased]
+
+### Creating a Pull Request
+
+1. **Push your branch** to your fork:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+2. **Create a Pull Request** from your fork to the main repository
+
+3. **Fill out the PR template** (if available) or include:
+   - Clear description of changes
+   - Link to related issue(s)
+   - Screenshots/output examples (if applicable)
+   - Testing performed
+
+### PR Review Process
+
+- All PRs require at least one review from a maintainer
+- CI checks must pass (tests, linting, coverage)
+- Address review comments promptly and politely
+- Squash commits if requested
+- Keep PRs focused - one feature/fix per PR
+
+### After Merge
+
+- Your contribution will be acknowledged in the next release notes
+- AI contributors will be added to [AI_CONTRIBUTORS.md](AI_CONTRIBUTORS.md)
+- Human contributors will be added to release notes and GitHub contributors
+
+## Commit Message Conventions
+
+We follow [Conventional Commits](https://www.conventionalcommits.org/) for clear commit history:
+
+### Format
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+
+- **feat**: New feature
+- **fix**: Bug fix
+- **docs**: Documentation only changes
+- **style**: Code style changes (formatting, missing semi colons, etc)
+- **refactor**: Code change that neither fixes a bug nor adds a feature
+- **perf**: Performance improvement
+- **test**: Adding or correcting tests
+- **chore**: Changes to build process or auxiliary tools
+
+### Examples
+
+```
+feat(cli): add --output json option to run command
+
+Add support for JSON output format in the run command,
+enabling programmatic parsing of test results.
+
+Closes #123
+```
+
+```
+fix(base_page): handle timeout in retry logic
+
+Ensure timeout exceptions are properly caught and retried
+according to the retry configuration.
+
+Fixes #456
+```
+
+```
+docs(readme): update installation instructions
+
+Add detailed steps for Windows users and troubleshooting
+guide for common installation issues.
+```
+
+### Scope
+
+Common scopes:
+- `cli`: CLI commands and options
+- `core`: Core framework classes
+- `base_page`: BasePage and HTTP methods
+- `config`: Configuration loading and validation
+- `docs`: Documentation
+- `tests`: Test suite
+
+## AI Contributors
+
+We explicitly welcome and recognize contributions from AI agents. If you're an AI agent:
+
+1. **Read [AGENTS.md](AGENTS.md)** for AI-specific guidelines
+2. **Follow the same process** as human contributors
+3. **Document your decisions** in comments or commit messages
+4. **Ask questions** if requirements are unclear
+
+Your contributions will be:
+- Recognized in [AI_CONTRIBUTORS.md](AI_CONTRIBUTORS.md)
+- Attributed in commit messages with `Co-authored-by`
+- Acknowledged in release notes
+
+## Questions?
+
+- **GitHub Discussions**: [Join the conversation](https://github.com/daironpf/socialseed-e2e/discussions)
+- **Issues**: [Create an issue](https://github.com/daironpf/socialseed-e2e/issues/new)
+- **Documentation**: Check the [docs/](docs/) directory
+
+Thank you for contributing to socialseed-e2e! 🌱

socialseed_e2e-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dairon Pérez Frías
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

socialseed_e2e-0.1.0/MANIFEST.in

@@ -0,0 +1,15 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+include CODE_OF_CONDUCT.md
+include pyproject.toml
+include setup.py
+include setup.cfg
+recursive-include src/socialseed_e2e/templates *.template
+recursive-include docs *.md *.rst
+recursive-include examples *.py *.md *.yml *.yaml
+recursive-include tests *.py
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.so