qapytest 0.1.0__tar.gz

qapytest-0.1.0/.gitignore

@@ -0,0 +1,33 @@
+# MacOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# IDE specific files
+.vscode/
+.idea/
+
+# Virtual environments
+venv/
+.venv/
+**/*.env
+
+# Data
+**/*.html
+**/*.log
+
+# PyTest
+**/*cache*
+**/*.pyc

qapytest-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.12
+    hooks:
+      - id: ruff
+      - id: ruff-format

qapytest-0.1.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+# 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).
+
+## [0.1.0] - 2025-09-19
+
+### Added
+- 🚀 **Initial release** of QaPyTest - powerful testing framework for QA engineers
+- 📊 **HTML report generation** with customizable themes (light/dark/auto)
+- 🎯 **Soft assertions** - collect multiple failures in single test run
+- 📝 **Structured test steps** with nested hierarchy support
+- 📎 **Attachments system** - add files, logs, and screenshots to reports
+- 🌐 **HttpClient** - built-in HTTP client with automatic request/response logging
+- 🗄️ **SqlClient** - direct database access for SQL queries and validation
+- 🔴 **RedisClient** - Redis integration with automatic JSON serialization
+- 📊 **GraphQLClient** - GraphQL query execution with error handling
+- ✅ **JSON Schema validation** - validate API responses with soft-assert support
+- 🏷️ **Custom pytest markers** - `@pytest.mark.title()` and `@pytest.mark.component()`
+- ⚙️ **CLI options** - environment file loading, report customization, theme selection
+- 🔧 **Environment configuration** - `.env` file support with override options
+- 📚 **Comprehensive documentation** - API reference and CLI guide
+
+### Features
+- Python 3.10+ support
+- Pytest plugin architecture
+- Self-contained HTML reports
+- Automatic request/response timing
+- Configurable attachment size limits
+- Professional report styling with responsive design
+
+[0.1.0]: https://github.com/o73k51i/qapytest/releases/tag/v0.1.0

qapytest-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 o73k51i
+
+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.

qapytest-0.1.0/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: qapytest
+Version: 0.1.0
+Summary: A powerful testing framework based on pytest, specifically designed for QA engineers
+Project-URL: Homepage, https://github.com/o73k51i/qapytest
+Project-URL: Repository, https://github.com/o73k51i/qapytest
+Project-URL: Documentation, https://github.com/o73k51i/qapytest/blob/main/README.md
+Project-URL: Bug Reports, https://github.com/o73k51i/qapytest/issues
+Author-email: o73k51i <o73k51i@proton.me>
+License: MIT License
+        
+        Copyright (c) 2025 o73k51i
+        
+        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.
+License-File: LICENSE
+Keywords: automation,graphql,http,pytest,qa,redis,soft-assert,sql,test,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: <3.14,>=3.10
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: jsonschema>=4.25.1
+Requires-Dist: pytest>=8.4.2
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: redis>=6.4.0
+Requires-Dist: sqlalchemy>=2.0.43
+Description-Content-Type: text/markdown
+
+# QaPyTest
+
+[![PyPI version](https://img.shields.io/pypi/v/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![Python versions](https://img.shields.io/pypi/pyversions/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![License](https://img.shields.io/github/license/o73k51i/qapytest.svg)](https://github.com/o73k51i/qapytest/blob/main/LICENSE)
+[![Downloads](https://img.shields.io/pypi/dm/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![GitHub stars](https://img.shields.io/github/stars/o73k51i/qapytest.svg?style=social)](https://github.com/o73k51i/qapytest)
+
+`QaPyTest` — a powerful testing framework based on pytest, specifically designed for QA engineers.
+Turn your ordinary tests into detailed, structured reports with built-in HTTP, SQL, Redis and GraphQL clients.
+
+🎯 **QA made for QA** — every feature is designed for real testing and debugging needs.
+
+## ⚡ Why QaPyTest?
+
+- **🚀 Ready to use:** Install → run → get a beautiful report
+- **🔧 Built-in clients:** HTTP, SQL, Redis, GraphQL — all in one package
+- **📊 Professional reports:** HTML reports with attachments and logs
+- **🎯 Soft assertions:** Collect multiple failures in one run instead of stopping at the first
+- **📝 Structured steps:** Make your tests self-documenting
+- **🔍 Debugging friendly:** Full traceability of every action in the test
+
+## ⚙️ Key features
+
+- **HTML report generation:** simple report at `report.html`.
+- **Soft assertions:** allow collecting multiple failures in a single run without immediately ending the test.
+- **Advanced steps:** structured logging of test steps for better report readability.
+- **Attachments:** ability to add files, logs and screenshots to test reports.
+- **HTTP client:** client for performing HTTP requests.
+- **SQL client:** client for executing raw SQL queries.
+- **Redis client:** client for working with Redis with automatic JSON (de)serialization.
+- **GraphQL client:** client for executing GraphQL requests.
+- **JSON Schema validation:** function to validate API responses or test artifacts with support for soft-assert and strict mode.
+
+## 👥 Ideal for
+
+- **QA Engineers** — automate testing of APIs, databases and web services
+- **Test Automation specialists** — get a ready toolkit for comprehensive testing
+
+## 🚀 Quick start
+
+### 1️⃣ Installation
+
+```bash
+pip install qapytest
+```
+
+### 2️⃣ Your first powerful test
+
+```python
+from qapytest import step, attach, soft_assert, HttpClient, SqlClient
+
+def test_comprehensive_api_validation():
+    # Structured steps for readability
+    with step('🌐 Testing API endpoint'):
+        client = HttpClient(base_url="https://api.example.com")
+        response = client.get("/users/1")
+        assert response.status_code == 200
+    
+    # Add artifacts for debugging
+    attach(response.text, 'api_response.json')
+    
+    # Soft assertions - collect all failures
+    soft_assert(response.json()['id'] == 1, 'User ID check')
+    soft_assert(response.json()['active'], 'User is active')
+    
+    # Database integration
+    with step('🗄️ Validate data in DB'):
+        db = SqlClient("postgresql://user:pass@localhost/db")
+        user_data = db.fetch_data("SELECT * FROM users WHERE id = 1")
+        assert len(user_data) == 1
+```
+
+### 3️⃣ Run with beautiful reports
+
+```bash
+pytest --report-html
+# Open report.html 🎨
+```
+
+## 🔌 Built-in clients — everything QA needs
+
+### 🌐 HttpClient — HTTP testing on steroids
+```python
+client = HttpClient(base_url="https://api.example.com", timeout=30)
+response = client.post("/auth/login", json={"username": "test"})
+# Automatic logging of requests/responses + timing + headers
+```
+
+### 🗄️ SqlClient — Direct DB access  
+```python
+db = SqlClient("postgresql://localhost/testdb")
+users = db.fetch_data("SELECT * FROM users WHERE active = true")
+db.execute_and_commit("UPDATE users SET last_login = NOW() WHERE id = 1")
+```
+
+### 📊 GraphQL client — Modern APIs with minimal effort
+```python
+gql = GraphQLClient("https://api.github.com/graphql", 
+                   headers={"Authorization": "Bearer token"})
+result = gql.execute("query { viewer { login } }")
+```
+
+### 🔴 RedisClient — Caching and sessions under control
+```python
+redis = RedisClient(host="localhost", port=6379)
+redis.set_value("session:123", {"user_id": 1, "expires": "2024-01-01"})
+session_data = redis.get_value("session:123")  # Automatic JSON serialization!
+```
+
+## 🎛️ Core testing tools
+
+### 📝 Structured steps
+```python
+with step('🔍 Check authorization'):
+    with step('Send login request'):
+        response = client.post("/login", json=creds)
+    with step('Validate token'):
+        assert "token" in response.json()
+```
+
+### 🎯 Soft Assertions — collect all failures  
+```python
+soft_assert(user.id == 1, 'User ID')
+soft_assert(user.active, 'Active status')
+soft_assert('admin' == user.roles, 'Access rights')
+# The test will continue and show all failures together!
+```
+
+### 📎 Attachments — full context
+```python
+attach(response.json(), 'server response')
+attach(screenshot_bytes, 'error page') 
+attach(content, 'application', mime='text/plain')
+```
+
+### ✅ JSON Schema validation
+```python
+# Strict validation — stop the test on schema validation error
+validate_json(api_response, schema_path="user_schema.json", strict=True)
+
+# Soft mode — collect all schema errors and continue test execution
+validate_json(api_response, schema=user_schema, strict=False)
+```
+
+More about the API on the [documentation page](./docs/API.md).
+
+## Test markers
+
+QaPyTest also supports custom pytest markers to improve reporting:
+
+- **`@pytest.mark.title("Custom Test Name")`** : sets a custom test name in the HTML report
+- **`@pytest.mark.component("API", "Database")`** : adds component tags to the test
+
+### Example usage of markers
+
+```python
+import pytest
+
+@pytest.mark.title("User authorization check")
+@pytest.mark.component("Auth", "API")
+def test_user_login():
+    # test code
+    pass
+```
+
+## ⚙️ CLI options
+
+- **`--env-file`** : path to an `.env` file with environment settings (default — `./.env`).
+- **`--env-override`** : if set, values from the `.env` file will override existing environment variables.
+- **`--report-html [PATH]`** : create a self-contained HTML report; optionally specify a path (default — `report.html`).
+- **`--report-title NAME`** : set the HTML report title.
+- **`--report-theme {light,dark,auto}`** : choose the report theme: `light`, `dark` or `auto` (default).
+- **`--max-attachment-bytes N`** : maximum size of an attachment (in bytes) that will be inlined in the HTML; larger files will be truncated.
+
+More about CLI options on the [documentation page](./docs/CLI.md).
+
+## 📑 License
+
+This project is distributed under the [license](./LICENSE).

qapytest-0.1.0/README.md

@@ -0,0 +1,180 @@
+# QaPyTest
+
+[![PyPI version](https://img.shields.io/pypi/v/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![Python versions](https://img.shields.io/pypi/pyversions/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![License](https://img.shields.io/github/license/o73k51i/qapytest.svg)](https://github.com/o73k51i/qapytest/blob/main/LICENSE)
+[![Downloads](https://img.shields.io/pypi/dm/qapytest.svg)](https://pypi.org/project/qapytest/)
+[![GitHub stars](https://img.shields.io/github/stars/o73k51i/qapytest.svg?style=social)](https://github.com/o73k51i/qapytest)
+
+`QaPyTest` — a powerful testing framework based on pytest, specifically designed for QA engineers.
+Turn your ordinary tests into detailed, structured reports with built-in HTTP, SQL, Redis and GraphQL clients.
+
+🎯 **QA made for QA** — every feature is designed for real testing and debugging needs.
+
+## ⚡ Why QaPyTest?
+
+- **🚀 Ready to use:** Install → run → get a beautiful report
+- **🔧 Built-in clients:** HTTP, SQL, Redis, GraphQL — all in one package
+- **📊 Professional reports:** HTML reports with attachments and logs
+- **🎯 Soft assertions:** Collect multiple failures in one run instead of stopping at the first
+- **📝 Structured steps:** Make your tests self-documenting
+- **🔍 Debugging friendly:** Full traceability of every action in the test
+
+## ⚙️ Key features
+
+- **HTML report generation:** simple report at `report.html`.
+- **Soft assertions:** allow collecting multiple failures in a single run without immediately ending the test.
+- **Advanced steps:** structured logging of test steps for better report readability.
+- **Attachments:** ability to add files, logs and screenshots to test reports.
+- **HTTP client:** client for performing HTTP requests.
+- **SQL client:** client for executing raw SQL queries.
+- **Redis client:** client for working with Redis with automatic JSON (de)serialization.
+- **GraphQL client:** client for executing GraphQL requests.
+- **JSON Schema validation:** function to validate API responses or test artifacts with support for soft-assert and strict mode.
+
+## 👥 Ideal for
+
+- **QA Engineers** — automate testing of APIs, databases and web services
+- **Test Automation specialists** — get a ready toolkit for comprehensive testing
+
+## 🚀 Quick start
+
+### 1️⃣ Installation
+
+```bash
+pip install qapytest
+```
+
+### 2️⃣ Your first powerful test
+
+```python
+from qapytest import step, attach, soft_assert, HttpClient, SqlClient
+
+def test_comprehensive_api_validation():
+    # Structured steps for readability
+    with step('🌐 Testing API endpoint'):
+        client = HttpClient(base_url="https://api.example.com")
+        response = client.get("/users/1")
+        assert response.status_code == 200
+    
+    # Add artifacts for debugging
+    attach(response.text, 'api_response.json')
+    
+    # Soft assertions - collect all failures
+    soft_assert(response.json()['id'] == 1, 'User ID check')
+    soft_assert(response.json()['active'], 'User is active')
+    
+    # Database integration
+    with step('🗄️ Validate data in DB'):
+        db = SqlClient("postgresql://user:pass@localhost/db")
+        user_data = db.fetch_data("SELECT * FROM users WHERE id = 1")
+        assert len(user_data) == 1
+```
+
+### 3️⃣ Run with beautiful reports
+
+```bash
+pytest --report-html
+# Open report.html 🎨
+```
+
+## 🔌 Built-in clients — everything QA needs
+
+### 🌐 HttpClient — HTTP testing on steroids
+```python
+client = HttpClient(base_url="https://api.example.com", timeout=30)
+response = client.post("/auth/login", json={"username": "test"})
+# Automatic logging of requests/responses + timing + headers
+```
+
+### 🗄️ SqlClient — Direct DB access  
+```python
+db = SqlClient("postgresql://localhost/testdb")
+users = db.fetch_data("SELECT * FROM users WHERE active = true")
+db.execute_and_commit("UPDATE users SET last_login = NOW() WHERE id = 1")
+```
+
+### 📊 GraphQL client — Modern APIs with minimal effort
+```python
+gql = GraphQLClient("https://api.github.com/graphql", 
+                   headers={"Authorization": "Bearer token"})
+result = gql.execute("query { viewer { login } }")
+```
+
+### 🔴 RedisClient — Caching and sessions under control
+```python
+redis = RedisClient(host="localhost", port=6379)
+redis.set_value("session:123", {"user_id": 1, "expires": "2024-01-01"})
+session_data = redis.get_value("session:123")  # Automatic JSON serialization!
+```
+
+## 🎛️ Core testing tools
+
+### 📝 Structured steps
+```python
+with step('🔍 Check authorization'):
+    with step('Send login request'):
+        response = client.post("/login", json=creds)
+    with step('Validate token'):
+        assert "token" in response.json()
+```
+
+### 🎯 Soft Assertions — collect all failures  
+```python
+soft_assert(user.id == 1, 'User ID')
+soft_assert(user.active, 'Active status')
+soft_assert('admin' == user.roles, 'Access rights')
+# The test will continue and show all failures together!
+```
+
+### 📎 Attachments — full context
+```python
+attach(response.json(), 'server response')
+attach(screenshot_bytes, 'error page') 
+attach(content, 'application', mime='text/plain')
+```
+
+### ✅ JSON Schema validation
+```python
+# Strict validation — stop the test on schema validation error
+validate_json(api_response, schema_path="user_schema.json", strict=True)
+
+# Soft mode — collect all schema errors and continue test execution
+validate_json(api_response, schema=user_schema, strict=False)
+```
+
+More about the API on the [documentation page](./docs/API.md).
+
+## Test markers
+
+QaPyTest also supports custom pytest markers to improve reporting:
+
+- **`@pytest.mark.title("Custom Test Name")`** : sets a custom test name in the HTML report
+- **`@pytest.mark.component("API", "Database")`** : adds component tags to the test
+
+### Example usage of markers
+
+```python
+import pytest
+
+@pytest.mark.title("User authorization check")
+@pytest.mark.component("Auth", "API")
+def test_user_login():
+    # test code
+    pass
+```
+
+## ⚙️ CLI options
+
+- **`--env-file`** : path to an `.env` file with environment settings (default — `./.env`).
+- **`--env-override`** : if set, values from the `.env` file will override existing environment variables.
+- **`--report-html [PATH]`** : create a self-contained HTML report; optionally specify a path (default — `report.html`).
+- **`--report-title NAME`** : set the HTML report title.
+- **`--report-theme {light,dark,auto}`** : choose the report theme: `light`, `dark` or `auto` (default).
+- **`--max-attachment-bytes N`** : maximum size of an attachment (in bytes) that will be inlined in the HTML; larger files will be truncated.
+
+More about CLI options on the [documentation page](./docs/CLI.md).
+
+## 📑 License
+
+This project is distributed under the [license](./LICENSE).