devdox-ai-locust 0.1.1__tar.gz

devdox_ai_locust-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

devdox_ai_locust-0.1.1/PKG-INFO

@@ -0,0 +1,424 @@
+Metadata-Version: 2.4
+Name: devdox_ai_locust
+Version: 0.1.1
+Summary: AI-powered Locust load test generator from API documentation
+Author-email: Hayat Bourji <hayat.bourgi@montyholding.com>
+Maintainer-email: Hayat Bourji <hayat.bourgi@montyholding.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/montymobile1/devdox-ai-locust
+Project-URL: Repository, https://github.com/montymobile1/devdox-ai-locust
+Keywords: locust,load-testing,api,testing,performance,ai,openapi,swagger
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: System :: Networking :: Monitoring
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: locust>=2.0.0
+Requires-Dist: faker>=15.0.0
+Requires-Dist: colorama>=0.4.0
+Requires-Dist: rich>=12.0.0
+Requires-Dist: pydantic>=1.10.0
+Requires-Dist: langchain-together==0.3.0
+Requires-Dist: together==1.5.17
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: black==25.1.0
+Requires-Dist: pydantic-settings==2.10.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=22.0; extra == "dev"
+Requires-Dist: flake8>=5.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: pre-commit>=2.20; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Requires-Dist: build>=0.8; extra == "dev"
+Requires-Dist: ruff==0.13.1; extra == "dev"
+Requires-Dist: types-Pygments==2.19.0.20250809; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0; extra == "docs"
+Requires-Dist: myst-parser>=0.18; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: pytest-mock>=3.8; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21; extra == "test"
+Requires-Dist: httpx>=0.23; extra == "test"
+Requires-Dist: aiofiles>=23.0; extra == "test"
+Requires-Dist: coverage>=7.0; extra == "test"
+Provides-Extra: ai
+Requires-Dist: openai>=0.27.0; extra == "ai"
+Requires-Dist: anthropic>=0.3.0; extra == "ai"
+Dynamic: license-file
+
+# DevDox AI Locust
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+> **AI-powered Locust load test generator from API documentation**
+
+DevDox AI Locust automatically generates comprehensive Locust load testing scripts from your API documentation (OpenAPI/Swagger specs). Using advanced AI capabilities, it creates realistic test scenarios, handles complex authentication flows, and generates production-ready performance tests.
+
+## ✨ Features
+
+- 🤖 **AI-Enhanced Generation**: Uses Together AI to create intelligent, realistic load test scenarios
+- 📚 **OpenAPI/Swagger Support**: Automatically parses OpenAPI 3.0 and Swagger 2.0 specifications  
+- 🔧 **Production-Ready Code**: Generates clean, maintainable Locust test files
+- 🎯 **Smart Test Scenarios**: Creates CRUD workflows, authentication flows, and error handling
+- 📊 **Realistic Data**: Generates appropriate test data using Faker
+- 🛠️ **Template-Based**: Highly customizable Jinja2 templates for different testing needs
+- 🔄 **Hybrid Approach**: Combines rule-based generation with AI enhancement
+- 📈 **Comprehensive Coverage**: Handles various HTTP methods, content types, and response scenarios
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+# Install from PyPI (when published)
+pip install devdox-ai-locust
+
+# Or install from source
+git clone https://github.com/montymobile1/devdox-ai-locust.git
+cd devdox-ai-locust
+pip install -e .
+```
+
+### Prerequisites
+
+1. **Python 3.12+** - Required for modern async/await syntax and type hints
+2. **Together AI API Key** - For AI-enhanced generation capabilities
+
+### Configuration
+
+1. Get your Together AI API key from [Together AI](https://api.together.xyz/)
+2. Set up your environment:
+
+```bash
+# Copy example environment file
+cp .env.example .env
+
+# Edit .env and add your API key
+echo "API_KEY=your_together_ai_api_key_here" > .env
+```
+
+### Basic Usage
+
+```bash
+# Generate from OpenAPI URL
+devdox_ai_locust generate --openapi-url https://api.example.com/openapi.json --output ./tests
+
+# Generate from local file
+dal generate --openapi-file ./api-spec.yaml --output ./load-tests
+
+# Generate with custom configuration
+devdox_ai_locust generate \
+   https://petstore.swagger.io/v2/swagger.json \
+  --output ./petstore-tests \
+  --together-api-key your_api_key \
+  
+```
+
+
+
+## 📖 Documentation
+
+### Command Line Interface
+
+```bash
+devdox_ai_locust generate [OPTIONS] SWAGGER_URL
+```
+
+| Option | Short | Type | Description | Default |
+|--------|--------|------|-------------|---------|
+| `--output` | `-o` | Path | Output directory for generated tests | `output` |
+| `--users` | `-u` | Integer | Number of simulated users | `10` |
+| `--spawn-rate` | `-r` | Float | User spawn rate (users/second) | `2` |
+| `--run-time` | `-t` | String | Test duration (e.g., 5m, 1h) | `5m` |
+| `--host` | `-H` | String | Target host URL | None |
+| `--auth/--no-auth` | | Boolean | Include authentication | `True` |
+| `--dry-run` | | Flag | Generate without running | `False` |
+| `--custom-requirement` | | String | Custom AI instructions | None |
+| `--together-api-key` | | String | Together AI API key | From env |
+
+
+
+
+### Generated Test Structure
+
+```
+locust_tests/
+├── locust.py              # Main Locust test file
+├── config.py              # Test configuration
+├── test_data.py           # Test data generators
+├── utils.py               # Utility functions
+├── requirements.txt       # Python dependencies
+├── .env.example          # Environment variables template
+├── README.md             # Test documentation
+├── workflows/
+│   ├── user_workflow.py   # User-related test scenarios
+│   ├── auth_workflow.py   # Authentication workflows
+│   └── crud_workflow.py   # CRUD operation workflows
+└── data/
+    ├── users.json         # Sample user data
+    └── test_cases.json    # Predefined test cases
+```
+
+## 🔧 Advanced Usage
+
+### Custom Templates
+
+Create custom Jinja2 templates for specialized test generation:
+
+```python
+# custom_template.py.j2
+from locust import HttpUser, task, between
+
+class {{ class_name }}User(HttpUser):
+    wait_time = between(1, 3)
+    
+    def on_start(self):
+        """Setup method called before tasks"""
+        self.token = self.login()
+    
+    {% for endpoint in endpoints %}
+    @task({{ endpoint.weight | default(1) }})
+    def {{ endpoint.method_name }}(self):
+        """{{ endpoint.description }}"""
+        # Custom task implementation
+        {{ endpoint.ai_generated_code | indent(8) }}
+    {% endfor %}
+```
+
+### Programmatic Usage
+
+```python
+from devdox_ai_locust import HybridLocustGenerator
+from devdox_ai_locust.config import Settings
+
+# Initialize generator
+config = Settings()
+generator = HybridLocustGenerator(config)
+
+# Generate from OpenAPI spec
+async def generate_tests():
+    files, workflows = await generator.generate_from_url(
+        "https://api.example.com/openapi.json",
+        output_dir="./tests",
+        ai_enhanced=True
+    )
+    
+    print(f"Generated {len(files)} test files")
+    print(f"Created {len(workflows)} workflows")
+
+# Run generation
+import asyncio
+asyncio.run(generate_tests())
+```
+
+
+## 🧪 Development
+
+### Setup Development Environment
+
+```bash
+# Clone repository
+git clone https://github.com/montymobile1/devdox-ai-locust.git
+cd devdox-ai-locust
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e ".[dev,test,ai]"
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Running Tests
+
+```bash
+
+# Use the test runner script
+coverage run -m pytest tests/
+```
+
+
+
+### Project Structure
+
+```
+src/devdox_ai_locust/
+├── __init__.py
+├── cli.py                      # Command line interface
+├── config.py                   # Configuration management
+├── locust_generator.py         # Basic test generation
+├── hybrid_loctus_generator.py  # AI-enhanced generation
+├── templates/                  # Jinja2 templates
+│   ├── locust.py.j2
+│   ├── config.py.j2
+│   └── workflow.py.j2
+├── schemas/                    # Data models and validation
+│   ├── processing_result.py
+│   └── endpoint_schema.py
+├── utils/                      # Utility modules
+│   ├── swagger_utils.py
+│   ├── open_ai_parser.py
+│   └── file_creation.py
+└── prompt/                     # AI prompt templates
+    ├── system_prompts.py
+    └── enhancement_prompts.py
+```
+
+### Development Workflow
+
+1. **Fork** the repository
+2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)
+3. **Make** your changes
+4. **Add** tests for new functionality
+5. **Run** the test suite (`make test`)
+6. **Commit** your changes (`git commit -m 'Add amazing feature'`)
+7. **Push** to the branch (`git push origin feature/amazing-feature`)
+8. **Open** a Pull Request
+
+### Code Standards
+
+- **Python 3.12+** with type hints
+- **Black** for code formatting
+- **isort** for import sorting
+- **pytest** for testing
+- **mypy** for type checking
+- **Pre-commit hooks** for quality gates
+
+## 📋 Requirements
+
+### System Requirements
+
+- **Python**: 3.12 or higher
+- **Memory**: 512MB RAM minimum, 1GB recommended
+- **Storage**: 100MB for installation, additional space for generated tests
+
+### Dependencies
+
+#### Core Dependencies
+- `locust` - Load testing framework
+- `click` - CLI framework
+- `pyyaml` - YAML parsing
+- `requests` - HTTP client
+- `pydantic` - Data validation
+- `jinja2` - Template engine
+- `rich` - Rich text output
+- `faker` - Test data generation
+
+#### AI Dependencies
+- `langchain-together` - Together AI integration
+- `together` - Together AI Python client
+
+#### Development Dependencies
+- `pytest` - Testing framework
+- `black` - Code formatter
+- `mypy` - Type checker
+- `pre-commit` - Git hooks
+
+## 🔍 Examples
+
+### Example 1: E-commerce API
+
+```bash
+# Generate tests for an e-commerce API
+devdox_ai_locust generate \
+   https://api.shop.example.com/v1/openapi.json \
+  --output ./ecommerce-tests 
+
+# The generator will create:
+# - Product browsing scenarios
+# - Shopping cart workflows  
+# - Checkout and payment flows
+# - User registration and login
+# - Order management tests
+```
+
+## ❓ FAQ
+
+**Q: What API specification formats are supported?**
+A: We support OpenAPI 3.0+ and Swagger 2.0 specifications in JSON and YAML formats.
+
+**Q: Do I need an AI API key?**
+A: Yes, for AI-enhanced generation you need a Together AI API key. Basic generation works without AI.
+
+**Q: Can I customize the generated test templates?**
+A: Absolutely! You can provide custom Jinja2 templates using the `--template-dir` option.
+
+**Q: How do I handle authentication in generated tests?**
+A: The generator automatically detects authentication schemes from your OpenAPI spec and creates appropriate test flows.
+
+**Q: Can I run tests against different environments?**
+A: Yes, use environment variables or configuration files to specify different target hosts and settings.
+
+**Q: What if my API has complex business logic?**
+A: The AI enhancement feature analyzes your API patterns and generates realistic business workflows, not just individual endpoint tests.
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+**Import Errors**
+```bash
+# Ensure proper installation
+pip install -e .
+
+# Check Python path
+python -c "import devdox_ai_locust; print('OK')"
+```
+
+**API Key Issues**
+```bash
+# Verify API key is set
+echo $API_KEY
+
+# Test API connectivity
+python -c "from together import Together; print(Together(api_key='your_key').models.list())"
+```
+
+
+**Template Errors**
+```bash
+# Validate your OpenAPI spec
+# Use online validators like swagger.io/tools/swagger-editor/
+
+# Check template syntax
+# Ensure custom templates use valid Jinja2 syntax
+```
+
+## 📄 License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- **Locust** - The amazing load testing framework that powers our generated tests
+- **Together AI** - Providing the AI capabilities for intelligent test generation  
+- **OpenAPI Initiative** - For standardizing API documentation
+- **Python Community** - For the excellent libraries and tools
+
+
+---
+
+**Made with ❤️ by the DevDox team**
+
+Transform your API documentation into powerful load tests with the magic of AI! 🚀