socialseed-e2e 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,333 @@
1
+ Metadata-Version: 2.4
2
+ Name: socialseed-e2e
3
+ Version: 0.1.0
4
+ Summary: Framework E2E para testing de APIs REST con Playwright
5
+ Author: Dairon Pérez
6
+ Author-email: Dairon Pérez Frías <dairon.perezfrias@gmail.com>
7
+ License: MIT
8
+ Project-URL: Homepage, https://github.com/daironpf/socialseed-e2e
9
+ Project-URL: Documentation, https://github.com/daironpf/socialseed-e2e/tree/main/docs
10
+ Project-URL: Repository, https://github.com/daironpf/socialseed-e2e
11
+ Project-URL: Issues, https://github.com/daironpf/socialseed-e2e/issues
12
+ Project-URL: Changelog, https://github.com/daironpf/socialseed-e2e/blob/main/CHANGELOG.md
13
+ Keywords: testing,e2e,api,playwright,rest,framework
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Topic :: Software Development :: Testing
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Classifier: License :: OSI Approved :: MIT License
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.9
21
+ Classifier: Programming Language :: Python :: 3.10
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Operating System :: OS Independent
25
+ Requires-Python: >=3.9
26
+ Description-Content-Type: text/markdown
27
+ License-File: LICENSE
28
+ Requires-Dist: playwright>=1.40.0
29
+ Requires-Dist: pydantic>=2.0.0
30
+ Requires-Dist: pyyaml>=6.0
31
+ Requires-Dist: requests>=2.31.0
32
+ Requires-Dist: typing-extensions>=4.8.0
33
+ Requires-Dist: click>=8.0.0
34
+ Requires-Dist: rich>=13.0.0
35
+ Provides-Extra: dev
36
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
37
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
38
+ Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
39
+ Requires-Dist: black>=23.0.0; extra == "dev"
40
+ Requires-Dist: isort>=5.12.0; extra == "dev"
41
+ Requires-Dist: flake8>=6.0.0; extra == "dev"
42
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
43
+ Requires-Dist: pre-commit>=3.0.0; extra == "dev"
44
+ Requires-Dist: twine>=4.0.0; extra == "dev"
45
+ Requires-Dist: build>=0.10.0; extra == "dev"
46
+ Requires-Dist: flask>=2.0.0; extra == "dev"
47
+ Provides-Extra: docs
48
+ Requires-Dist: sphinx>=7.0.0; extra == "docs"
49
+ Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "docs"
50
+ Requires-Dist: myst-parser>=2.0.0; extra == "docs"
51
+ Dynamic: license-file
52
+
53
+ # 🌱 socialseed-e2e
54
+
55
+ [![PyPI](https://img.shields.io/pypi/v/socialseed-e2e)](https://pypi.org/project/socialseed-e2e/)
56
+ [![Python](https://img.shields.io/pypi/pyversions/socialseed-e2e)](https://pypi.org/project/socialseed-e2e/)
57
+ [![CI](https://github.com/daironpf/socialseed-e2e/workflows/CI/badge.svg)](https://github.com/daironpf/socialseed-e2e/actions)
58
+ [![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://daironpf.github.io/socialseed-e2e/)
59
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
60
+ [![Downloads](https://img.shields.io/pypi/dm/socialseed-e2e)](https://pypi.org/project/socialseed-e2e/)
61
+
62
+ > **The ultimate E2E testing framework for REST APIs - Built for developers and AI agents**
63
+
64
+ **One-liner:** Test your REST APIs with 10x less code using intelligent scaffolding, automatic test discovery, and stateful test chaining. Perfect for both manual testing and AI-generated test suites.
65
+
66
+ 📚 **[Full Documentation](https://daironpf.github.io/socialseed-e2e/)** | 🚀 **[Quick Start](https://daironpf.github.io/socialseed-e2e/quickstart.html)** | 📖 **[Installation](https://daironpf.github.io/socialseed-e2e/installation.html)**
67
+
68
+ ---
69
+
70
+ ## 🎯 What is socialseed-e2e?
71
+
72
+ **socialseed-e2e** is a service-agnostic End-to-End (E2E) testing framework designed to make API testing effortless, scalable, and maintainable. Built with an hexagonal architecture that decouples the core engine from service logic, it enables both developers and AI agents to write reliable tests with minimal boilerplate.
73
+
74
+ ### Key Differentiators
75
+
76
+ - **🤖 AI-Native Architecture**: Structured protocols (`IServicePage`, `ITestModule`) designed for automated test generation
77
+ - **⚡ 10x Less Code**: Stateful test chaining and automatic discovery eliminate boilerplate
78
+ - **🧪 Built-in Mocking**: Flask-based mock API for testing without external dependencies
79
+ - **🔧 Zero Configuration**: Sensible defaults with YAML/JSON override support
80
+
81
+ ---
82
+
83
+ ## 🏗️ Architecture
84
+
85
+ ### Hexagonal Design
86
+
87
+ ```
88
+ socialseed-e2e/
89
+ ├── core/ # Service-agnostic engine (stable, tested)
90
+ │ ├── base_page.py # HTTP abstraction layer (Playwright)
91
+ │ ├── config_loader.py # Configuration management
92
+ │ ├── test_orchestrator.py # Test discovery & execution
93
+ │ ├── interfaces.py # Protocols for AI/codegen
94
+ │ └── loaders.py # Dynamic module loading
95
+ ├── services/ # Your service implementations
96
+ │ └── users-api/
97
+ │ ├── users_api_page.py
98
+ │ ├── data_schema.py
99
+ │ └── modules/
100
+ │ ├── 01_login_flow.py
101
+ │ ├── 02_register_flow.py
102
+ │ └── 03_profile_flow.py
103
+ └── templates/ # Scaffolding templates
104
+ ```
105
+
106
+ ### High-Level Flow
107
+
108
+ ```mermaid
109
+ graph TD;
110
+ subgraph "AI Agent Layer"
111
+ A[AI Agent / LLM] -- "Generates/Heals" --> B[Test Modules]
112
+ end
113
+
114
+ subgraph "SocialSeed E2E Framework"
115
+ B -- "Uses" --> C[Service Page Classes]
116
+ C -- "Extends" --> D[Core BasePage]
117
+ D -- "Orchestrates" --> E[Playwright Engine]
118
+ end
119
+
120
+ subgraph "Target Infrastructure"
121
+ E -- "REST / JSON" --> F[Microservices]
122
+ end
123
+
124
+ G[YAML/JSON Config] -.-> D
125
+ ```
126
+
127
+ ---
128
+
129
+ ## ✨ Key Features
130
+
131
+ - 🔥 **Service-Agnostic Core**: Test any REST API without framework modifications
132
+ - 🎯 **Playwright Integration**: Rock-solid HTTP testing with browser-like reliability
133
+ - 📝 **Smart Scaffolding**: `e2e new-service` and `e2e new-test` commands
134
+ - 🔍 **Auto-Discovery**: Tests automatically found and executed
135
+ - 🎨 **Rich CLI Output**: Beautiful terminal reports with tables and progress
136
+ - 🔧 **Environment Support**: Dev, staging, production configurations
137
+ - 📊 **Test Orchestration**: Run tests in logical order with state sharing
138
+ - 🏗️ **Hexagonal Architecture**: Clean separation of concerns
139
+ - 🤖 **AI-Ready**: Perfect for automated test generation workflows
140
+ - 🧪 **Built-in Mock API**: Flask-based mock server for testing without dependencies
141
+ - 📈 **Coverage Reports**: Automatic coverage tracking with codecov.io integration
142
+ - ⚡ **State Chaining**: Share state between tests naturally
143
+
144
+ ---
145
+
146
+ ## 🚀 Quick Start
147
+
148
+ ```bash
149
+ # Install
150
+ pip install socialseed-e2e
151
+ playwright install chromium
152
+
153
+ # Initialize project
154
+ e2e init my-api-tests
155
+ cd my-api-tests
156
+
157
+ # Create service and test
158
+ e2e new-service users-api
159
+ e2e new-test login --service users-api
160
+
161
+ # Run tests
162
+ e2e run
163
+ ```
164
+
165
+ 📚 **[Complete Quick Start Guide →](https://daironpf.github.io/socialseed-e2e/quickstart.html)**
166
+
167
+ ---
168
+
169
+ ## 📦 Installation
170
+
171
+ ```bash
172
+ pip install socialseed-e2e
173
+ playwright install chromium
174
+ ```
175
+
176
+ For development:
177
+ ```bash
178
+ git clone https://github.com/daironpf/socialseed-e2e.git
179
+ cd socialseed-e2e
180
+ pip install -e ".[dev]"
181
+ playwright install chromium
182
+ ```
183
+
184
+ 📖 **[Detailed Installation →](https://daironpf.github.io/socialseed-e2e/installation.html)**
185
+
186
+ ---
187
+
188
+ ## 🧪 Testing
189
+
190
+ The framework includes **420+ tests** organized for maintainability:
191
+
192
+ ```bash
193
+ # Run all tests
194
+ pytest
195
+
196
+ # Run by type
197
+ pytest -m unit # Unit tests
198
+ pytest -m integration # Integration tests
199
+ pytest -m cli # CLI tests
200
+
201
+ # With coverage
202
+ pytest --cov=socialseed_e2e --cov-report=html
203
+ ```
204
+
205
+ 📚 **[Testing Guide →](https://daironpf.github.io/socialseed-e2e/testing-guide.html)**
206
+
207
+ ---
208
+
209
+ ## 🚦 Project Status
210
+
211
+ ### Current (v0.1.0)
212
+ - ✅ **Core Framework**: Complete and tested (86.39% coverage)
213
+ - ✅ **CLI Commands**: init, new-service, new-test, run, doctor, config
214
+ - ✅ **Configuration**: YAML/JSON with environment variables
215
+ - ✅ **Mock API**: Flask-based server for integration testing
216
+ - ✅ **CI/CD**: GitHub Actions configured (CI, Release, Docs)
217
+ - ✅ **Documentation**: Complete guides hosted on GitHub Pages
218
+
219
+ ### In Progress
220
+ - 🚧 HTML reports with detailed metrics
221
+ - 🚧 Parallel test execution
222
+ - 🚧 Better authentication handling
223
+ - 🚧 WebSocket support
224
+
225
+ ### Planned
226
+ - 📋 Plugin system for custom extensions
227
+ - 📋 Docker integration
228
+ - 📋 Visual regression testing
229
+ - 📋 Performance testing metrics
230
+ - 📋 GraphQL and gRPC support
231
+
232
+ ---
233
+
234
+ ## 🤝 Contributing
235
+
236
+ We welcome contributions from developers and AI agents!
237
+
238
+ - 📋 **[Contributing Guidelines](CONTRIBUTING.md)** - How to contribute
239
+ - 🤖 **[AGENTS.md](AGENTS.md)** - Guide for AI agents
240
+ - 📜 **[AI_CONTRIBUTORS.md](AI_CONTRIBUTORS.md)** - Recognition for AI contributions
241
+
242
+ ### Quick Start for Contributors
243
+
244
+ ```bash
245
+ git clone https://github.com/daironpf/socialseed-e2e.git
246
+ cd socialseed-e2e
247
+ pip install -e ".[dev]"
248
+ pytest # Run tests
249
+ # Make changes
250
+ pytest # Verify
251
+ # Submit PR
252
+ ```
253
+
254
+ ---
255
+
256
+ ## 🤖 AI Contributors
257
+
258
+ This project recognizes AI agents as legitimate co-authors:
259
+
260
+ - **[OpenCode AI Agent](https://github.com/anomalyco)** - Framework architecture, core implementation, CLI, templates, documentation
261
+ - **Claude (Anthropic)** - Documentation, feature suggestions, bug fixes
262
+
263
+ See [AI_CONTRIBUTORS.md](AI_CONTRIBUTORS.md) for full details and contribution philosophy.
264
+
265
+ ---
266
+
267
+ ## 📚 Documentation
268
+
269
+ All documentation is hosted on **GitHub Pages** and automatically deployed on every push to main:
270
+
271
+ 🔗 **[https://daironpf.github.io/socialseed-e2e/](https://daironpf.github.io/socialseed-e2e/)**
272
+
273
+ ### Documentation Sections
274
+
275
+ - **[Installation Guide](https://daironpf.github.io/socialseed-e2e/installation.html)** - Detailed setup instructions
276
+ - **[Quick Start](https://daironpf.github.io/socialseed-e2e/quickstart.html)** - Get running in 15 minutes
277
+ - **[Configuration](https://daironpf.github.io/socialseed-e2e/configuration.html)** - Complete e2e.conf reference
278
+ - **[Writing Tests](https://daironpf.github.io/socialseed-e2e/writing-tests.html)** - Patterns and best practices
279
+ - **[CLI Reference](https://daironpf.github.io/socialseed-e2e/cli-reference.html)** - All commands and options
280
+ - **[API Reference](https://daironpf.github.io/socialseed-e2e/api-reference.html)** - Framework API documentation
281
+ - **[Testing Guide](https://daironpf.github.io/socialseed-e2e/testing-guide.html)** - Pytest configuration and execution
282
+ - **[Mock API](https://daironpf.github.io/socialseed-e2e/mock-api.html)** - Built-in Flask mock server guide
283
+
284
+ ### Local Documentation
285
+
286
+ ```bash
287
+ pip install ".[docs]"
288
+ cd docs && make html
289
+ open _build/html/index.html
290
+ ```
291
+
292
+ ---
293
+
294
+ ## 🗺️ Roadmap
295
+
296
+ ### v0.2.0 (Next)
297
+ - HTML reports with detailed metrics
298
+ - Parallel test execution
299
+ - Better authentication handling
300
+ - WebSocket support
301
+
302
+ ### v0.3.0 (Planned)
303
+ - Plugin system for custom extensions
304
+ - Docker integration
305
+ - Visual regression testing
306
+ - Performance testing metrics
307
+
308
+ ### v0.4.0 (Future)
309
+ - GraphQL support
310
+ - gRPC testing support
311
+ - AI-powered test healing
312
+ - Advanced visual testing
313
+
314
+ ---
315
+
316
+ ## 💬 Community
317
+
318
+ - **GitHub Discussions**: [Join the conversation](https://github.com/daironpf/socialseed-e2e/discussions)
319
+ - **Issues**: [Report bugs or request features](https://github.com/daironpf/socialseed-e2e/issues)
320
+ - **Documentation**: [https://daironpf.github.io/socialseed-e2e/](https://daironpf.github.io/socialseed-e2e/)
321
+
322
+ ---
323
+
324
+ ## 📜 License
325
+
326
+ MIT License - see [LICENSE](LICENSE) file for details.
327
+
328
+ ---
329
+
330
+ <p align="center">
331
+ <b>Built with ❤️ by Dairon Pérez Frías (@daironpf) and AI co-authors</b><br>
332
+ <sub>For developers and AI agents who believe in better testing</sub>
333
+ </p>
@@ -0,0 +1,29 @@
1
+ socialseed_e2e/__init__.py,sha256=EM8QR2Kxn9G8VVoY_1mSO8diajbEYtUIrKXZ8GOj2U0,1630
2
+ socialseed_e2e/__version__.py,sha256=Mb1crJu2pec03_HgXqXgnJ76a3ss0VUo9PNUdDGGj0g,670
3
+ socialseed_e2e/cli.py,sha256=C1epvpJHvoMax9fbiYSMaFVIrJ0sW3IziEswjV9oUlw,20682
4
+ socialseed_e2e/core/__init__.py,sha256=rIr_vOxTM6VT3tY-Mb0PbnbbjSa8LANTPUjxiCpdkpY,987
5
+ socialseed_e2e/core/base_page.py,sha256=MDuuhs7o6_p9dcOqtbWdDUXrE6eoY2SHZt8-hmD0eNA,29069
6
+ socialseed_e2e/core/check_deps.py,sha256=JWEt2Egu_vkGagkH-ulxV2z8jSlCExmZ-R35eY24p5s,1321
7
+ socialseed_e2e/core/config.py,sha256=ZjXSCCWOKFHqYqsxGaxmPzH0mtEHAD0QtQoIe61XrjE,4141
8
+ socialseed_e2e/core/config_loader.py,sha256=TpboGO8_jEpMB9e-CLFLyrEAZJl25LtuE7M59BptGSw,21218
9
+ socialseed_e2e/core/headers.py,sha256=c6dzxUopXqNQvtrb45iYl7R3bRC6RtKphR2MWsJA5E8,696
10
+ socialseed_e2e/core/interfaces.py,sha256=Fbl8pgrniqUt8MG6OmTdaw_4_KwMLXFD_8YIVEtTyFw,427
11
+ socialseed_e2e/core/loaders.py,sha256=AokTc1CmEkwYhu2BKBJnzj1uyCMX9d9Yvh3lb--tPUo,1854
12
+ socialseed_e2e/core/models.py,sha256=yRRcJwUFfdr6LYs-G1u2kCEE_8hF3kmDovDCOLfQzQE,702
13
+ socialseed_e2e/core/test_orchestrator.py,sha256=86re4CWQZqgCTxtemDWjL0pLMy48XT5unYVoQx6suM0,3115
14
+ socialseed_e2e/services/__init__.py,sha256=VXPqV9dKBBhrLAYZA4c_JZ__6zjKMucMLkjW3W0US0Q,323
15
+ socialseed_e2e/templates/__init__.py,sha256=ACNBxYE7h6GebXViyRR0GsBcqw3X71keEv8HiVERbXk,900
16
+ socialseed_e2e/templates/config.py.template,sha256=um9EoDXNJQIm6Hj7nuWBDQDBpUQeVOwUU7zB305PAbo,576
17
+ socialseed_e2e/templates/data_schema.py.template,sha256=jPGjE2SDOKFV00VMD6aYx70CFw1n7PjIY9NwYgJRopQ,3720
18
+ socialseed_e2e/templates/e2e.conf.template,sha256=hT3bN_6eXAgtw3QqAg1T-T6M6s0_-IZN1oVzIQrXROg,480
19
+ socialseed_e2e/templates/service_page.py.template,sha256=XgBMUPB9IjO92gyoUgKVQxora-X3bPpsMUj2TgpHLdo,2388
20
+ socialseed_e2e/templates/test_module.py.template,sha256=egnVBgMzGyuJkUYv5wlly7KsoelGA1MbueNEHRq9myc,1290
21
+ socialseed_e2e/utils/__init__.py,sha256=FUE9ffpqtzipXdEKNRYsJQ6iNFCa2864vxXDgPNfkgc,1007
22
+ socialseed_e2e/utils/template_engine.py,sha256=yIfKwk2EZ3g5LEfhDJQa1Yg1j9v0KUWai77qJd0UVUY,7527
23
+ socialseed_e2e/utils/validators.py,sha256=jeTZRfwlUsLUtIZs2cFirM_WyjUmG0mHeOno1Vm_eV0,17505
24
+ socialseed_e2e-0.1.0.dist-info/licenses/LICENSE,sha256=easdjHMFjCpMIVH-Ms-6-OjSc7XcBzR0G26tFEJUKmo,1077
25
+ socialseed_e2e-0.1.0.dist-info/METADATA,sha256=gqre6bFp5qTcPPDljr8LSuUKTNpFrZt_SA6qTjSNuvo,11632
26
+ socialseed_e2e-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
27
+ socialseed_e2e-0.1.0.dist-info/entry_points.txt,sha256=UyM3uA0ZDJJuOkF58ki2rgPxMz5Ksshb1R5bcO16U5I,89
28
+ socialseed_e2e-0.1.0.dist-info/top_level.txt,sha256=NbUeHcFE_5n-RLISvTI8-OVaZ_8RrLHjxoaDYGq-eFY,15
29
+ socialseed_e2e-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.10.2)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,3 @@
1
+ [console_scripts]
2
+ e2e = socialseed_e2e.cli:main
3
+ socialseed-e2e = socialseed_e2e.cli:main
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Dairon Pérez Frías
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1 @@
1
+ socialseed_e2e