qastudio-pytest 1.0.5__tar.gz

qastudio_pytest-1.0.5/LICENSE

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

qastudio_pytest-1.0.5/PKG-INFO

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: qastudio-pytest
+Version: 1.0.5
+Summary: pytest plugin for QAStudio.dev test management platform
+Author-email: QAStudio <ben@qastudio.dev>
+License: MIT
+Project-URL: Homepage, https://github.com/QAStudio-Dev/playwright-reporter-python
+Project-URL: Repository, https://github.com/QAStudio-Dev/playwright-reporter-python
+Project-URL: Issues, https://github.com/QAStudio-Dev/playwright-reporter-python/issues
+Project-URL: Documentation, https://github.com/QAStudio-Dev/playwright-reporter-python#readme
+Keywords: pytest,testing,test-management,qa,qastudio
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest>=7.0.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-requests>=2.28.0; extra == "dev"
+Dynamic: license-file
+
+# QAStudio pytest Plugin
+
+A pytest plugin that integrates with [QAStudio.dev](https://qastudio.dev) test management platform.
+
+## Features
+
+- 🔄 Automatic test result reporting to QAStudio.dev
+- 📊 Real-time test run tracking
+- 🏷️ Test case linking via markers or test IDs
+- 📸 Screenshot and attachment support
+- 🔧 Configurable via pytest.ini, command line, or environment variables
+- 🎯 Batch result submission for performance
+- 🛡️ Silent mode - won't fail tests if API is unavailable
+- 📝 Error code snippets with context around failure points
+- 📍 Precise error location tracking (file, line, column)
+- 📤 Console output capture (stdout/stderr)
+- 🔍 Enhanced debugging context for test failures
+
+## Installation
+
+```bash
+pip install qastudio-pytest
+```
+
+## Quick Start
+
+### 1. Configure via pytest.ini
+
+```ini
+[pytest]
+qastudio_api_url = https://qastudio.dev/api
+qastudio_api_key = your-api-key
+qastudio_project_id = your-project-id
+qastudio_environment = CI
+```
+
+### 2. Configure via Environment Variables
+
+```bash
+export QASTUDIO_API_URL=https://qastudio.dev/api
+export QASTUDIO_API_KEY=your-api-key
+export QASTUDIO_PROJECT_ID=your-project-id
+export QASTUDIO_ENVIRONMENT=CI
+```
+
+### 3. Configure via Command Line
+
+```bash
+pytest --qastudio-api-url=https://qastudio.dev/api \
+       --qastudio-api-key=your-api-key \
+       --qastudio-project-id=your-project-id
+```
+
+## Usage
+
+### Linking Tests to QAStudio Test Cases
+
+#### Method 1: Using pytest markers
+
+```python
+import pytest
+
+@pytest.mark.qastudio_id("QA-123")
+def test_login():
+    assert user.login("user", "pass")
+```
+
+#### Method 2: Using test ID in test name
+
+```python
+def test_QA123_login():
+    """Test case QA-123"""
+    assert user.login("user", "pass")
+```
+
+#### Method 3: Using docstring
+
+```python
+def test_login():
+    """
+    Test user login functionality
+
+    QAStudio ID: QA-123
+    """
+    assert user.login("user", "pass")
+```
+
+### Adding Custom Metadata
+
+```python
+import pytest
+
+@pytest.mark.qastudio_id("QA-456")
+@pytest.mark.qastudio_priority("high")
+@pytest.mark.qastudio_tags("smoke", "authentication")
+def test_important_feature():
+    assert True
+```
+
+## Configuration Options
+
+| Option | Environment Variable | Description | Default |
+|--------|---------------------|-------------|---------|
+| `qastudio_api_url` | `QASTUDIO_API_URL` | QAStudio.dev API URL | `https://qastudio.dev/api` |
+| `qastudio_api_key` | `QASTUDIO_API_KEY` | API authentication key | Required |
+| `qastudio_project_id` | `QASTUDIO_PROJECT_ID` | Project ID | Required |
+| `qastudio_environment` | `QASTUDIO_ENVIRONMENT` | Environment name | `default` |
+| `qastudio_test_run_name` | `QASTUDIO_TEST_RUN_NAME` | Custom test run name | Auto-generated |
+| `qastudio_test_run_id` | `QASTUDIO_TEST_RUN_ID` | Existing test run ID | None |
+| `qastudio_create_test_run` | `QASTUDIO_CREATE_TEST_RUN` | Create new test run | `true` |
+| `qastudio_batch_size` | `QASTUDIO_BATCH_SIZE` | Results batch size | `10` |
+| `qastudio_silent` | `QASTUDIO_SILENT` | Fail silently on API errors | `true` |
+| `qastudio_verbose` | `QASTUDIO_VERBOSE` | Enable verbose logging | `false` |
+| `qastudio_include_error_snippet` | `QASTUDIO_INCLUDE_ERROR_SNIPPET` | Include error code snippet | `true` |
+| `qastudio_include_error_location` | `QASTUDIO_INCLUDE_ERROR_LOCATION` | Include precise error location | `true` |
+| `qastudio_include_test_steps` | `QASTUDIO_INCLUDE_TEST_STEPS` | Include test execution steps | `true` |
+| `qastudio_include_console_output` | `QASTUDIO_INCLUDE_CONSOLE_OUTPUT` | Include console output | `false` |
+
+## Error Context and Debugging
+
+The plugin automatically captures rich debugging context for failed tests:
+
+### Error Code Snippets
+
+When a test fails, the plugin captures the relevant code snippet showing where the error occurred:
+
+```python
+def test_calculation():
+    result = calculate(5, 0)  # This line will be captured in the error snippet
+    assert result == 10
+```
+
+Disable with:
+```ini
+[pytest]
+qastudio_include_error_snippet = false
+```
+
+### Error Location
+
+Precise error location information (file path, line number) is automatically captured:
+
+```json
+{
+  "errorLocation": {
+    "file": "tests/test_example.py",
+    "line": 42,
+    "column": 0
+  }
+}
+```
+
+Disable with:
+```ini
+[pytest]
+qastudio_include_error_location = false
+```
+
+### Console Output
+
+Capture stdout and stderr from test execution (disabled by default to avoid sensitive data):
+
+```ini
+[pytest]
+qastudio_include_console_output = true
+```
+
+Or via command line:
+```bash
+pytest --qastudio-include-console-output
+```
+
+## Advanced Usage
+
+### Using with pytest-xdist (Parallel Testing)
+
+```bash
+pytest -n auto --qastudio-api-key=your-api-key
+```
+
+The plugin handles parallel test execution automatically.
+
+### CI/CD Integration
+
+#### GitHub Actions
+
+```yaml
+- name: Run Tests
+  run: |
+    pytest --junitxml=report.xml
+  env:
+    QASTUDIO_API_KEY: ${{ secrets.QASTUDIO_API_KEY }}
+    QASTUDIO_PROJECT_ID: ${{ secrets.QASTUDIO_PROJECT_ID }}
+    QASTUDIO_ENVIRONMENT: CI
+```
+
+#### GitLab CI
+
+```yaml
+test:
+  script:
+    - pytest
+  variables:
+    QASTUDIO_API_KEY: $QASTUDIO_API_KEY
+    QASTUDIO_PROJECT_ID: $QASTUDIO_PROJECT_ID
+    QASTUDIO_ENVIRONMENT: CI
+```
+
+## Examples
+
+### Playwright Example
+
+A complete Playwright test framework example is available in `examples/playwright_tests/`:
+
+```bash
+# Navigate to example directory
+cd examples/playwright_tests
+
+# Install dependencies
+pip install -r requirements.txt
+playwright install chromium
+
+# Run the tests
+./run_tests.sh
+
+# Or run directly with pytest
+pytest -v
+```
+
+The example demonstrates:
+- ✅ Testing the QAStudio.dev website
+- ✅ Automatic screenshot capture
+- ✅ Playwright trace recording (`.zip` files)
+- ✅ Integration with qastudio-pytest reporter
+- ✅ Test case linking with `@pytest.mark.qastudio_id()`
+
+See [`examples/playwright_tests/README.md`](examples/playwright_tests/README.md) for detailed documentation.
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/QAStudio-Dev/playwright-reporter-python.git
+cd playwright-reporter-python
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e .[dev]
+
+# Run tests
+pytest tests/
+
+# Run linting
+black src/ tests/
+flake8 src/ tests/
+mypy src/
+
+# Build package
+python -m build
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📧 Email: ben@qastudio.dev
+- 🐛 Issues: https://github.com/QAStudio-Dev/playwright-reporter-python/issues
+- 📖 Documentation: https://qastudio.dev/docs

qastudio_pytest-1.0.5/README.md

@@ -0,0 +1,273 @@
+# QAStudio pytest Plugin
+
+A pytest plugin that integrates with [QAStudio.dev](https://qastudio.dev) test management platform.
+
+## Features
+
+- 🔄 Automatic test result reporting to QAStudio.dev
+- 📊 Real-time test run tracking
+- 🏷️ Test case linking via markers or test IDs
+- 📸 Screenshot and attachment support
+- 🔧 Configurable via pytest.ini, command line, or environment variables
+- 🎯 Batch result submission for performance
+- 🛡️ Silent mode - won't fail tests if API is unavailable
+- 📝 Error code snippets with context around failure points
+- 📍 Precise error location tracking (file, line, column)
+- 📤 Console output capture (stdout/stderr)
+- 🔍 Enhanced debugging context for test failures
+
+## Installation
+
+```bash
+pip install qastudio-pytest
+```
+
+## Quick Start
+
+### 1. Configure via pytest.ini
+
+```ini
+[pytest]
+qastudio_api_url = https://qastudio.dev/api
+qastudio_api_key = your-api-key
+qastudio_project_id = your-project-id
+qastudio_environment = CI
+```
+
+### 2. Configure via Environment Variables
+
+```bash
+export QASTUDIO_API_URL=https://qastudio.dev/api
+export QASTUDIO_API_KEY=your-api-key
+export QASTUDIO_PROJECT_ID=your-project-id
+export QASTUDIO_ENVIRONMENT=CI
+```
+
+### 3. Configure via Command Line
+
+```bash
+pytest --qastudio-api-url=https://qastudio.dev/api \
+       --qastudio-api-key=your-api-key \
+       --qastudio-project-id=your-project-id
+```
+
+## Usage
+
+### Linking Tests to QAStudio Test Cases
+
+#### Method 1: Using pytest markers
+
+```python
+import pytest
+
+@pytest.mark.qastudio_id("QA-123")
+def test_login():
+    assert user.login("user", "pass")
+```
+
+#### Method 2: Using test ID in test name
+
+```python
+def test_QA123_login():
+    """Test case QA-123"""
+    assert user.login("user", "pass")
+```
+
+#### Method 3: Using docstring
+
+```python
+def test_login():
+    """
+    Test user login functionality
+
+    QAStudio ID: QA-123
+    """
+    assert user.login("user", "pass")
+```
+
+### Adding Custom Metadata
+
+```python
+import pytest
+
+@pytest.mark.qastudio_id("QA-456")
+@pytest.mark.qastudio_priority("high")
+@pytest.mark.qastudio_tags("smoke", "authentication")
+def test_important_feature():
+    assert True
+```
+
+## Configuration Options
+
+| Option | Environment Variable | Description | Default |
+|--------|---------------------|-------------|---------|
+| `qastudio_api_url` | `QASTUDIO_API_URL` | QAStudio.dev API URL | `https://qastudio.dev/api` |
+| `qastudio_api_key` | `QASTUDIO_API_KEY` | API authentication key | Required |
+| `qastudio_project_id` | `QASTUDIO_PROJECT_ID` | Project ID | Required |
+| `qastudio_environment` | `QASTUDIO_ENVIRONMENT` | Environment name | `default` |
+| `qastudio_test_run_name` | `QASTUDIO_TEST_RUN_NAME` | Custom test run name | Auto-generated |
+| `qastudio_test_run_id` | `QASTUDIO_TEST_RUN_ID` | Existing test run ID | None |
+| `qastudio_create_test_run` | `QASTUDIO_CREATE_TEST_RUN` | Create new test run | `true` |
+| `qastudio_batch_size` | `QASTUDIO_BATCH_SIZE` | Results batch size | `10` |
+| `qastudio_silent` | `QASTUDIO_SILENT` | Fail silently on API errors | `true` |
+| `qastudio_verbose` | `QASTUDIO_VERBOSE` | Enable verbose logging | `false` |
+| `qastudio_include_error_snippet` | `QASTUDIO_INCLUDE_ERROR_SNIPPET` | Include error code snippet | `true` |
+| `qastudio_include_error_location` | `QASTUDIO_INCLUDE_ERROR_LOCATION` | Include precise error location | `true` |
+| `qastudio_include_test_steps` | `QASTUDIO_INCLUDE_TEST_STEPS` | Include test execution steps | `true` |
+| `qastudio_include_console_output` | `QASTUDIO_INCLUDE_CONSOLE_OUTPUT` | Include console output | `false` |
+
+## Error Context and Debugging
+
+The plugin automatically captures rich debugging context for failed tests:
+
+### Error Code Snippets
+
+When a test fails, the plugin captures the relevant code snippet showing where the error occurred:
+
+```python
+def test_calculation():
+    result = calculate(5, 0)  # This line will be captured in the error snippet
+    assert result == 10
+```
+
+Disable with:
+```ini
+[pytest]
+qastudio_include_error_snippet = false
+```
+
+### Error Location
+
+Precise error location information (file path, line number) is automatically captured:
+
+```json
+{
+  "errorLocation": {
+    "file": "tests/test_example.py",
+    "line": 42,
+    "column": 0
+  }
+}
+```
+
+Disable with:
+```ini
+[pytest]
+qastudio_include_error_location = false
+```
+
+### Console Output
+
+Capture stdout and stderr from test execution (disabled by default to avoid sensitive data):
+
+```ini
+[pytest]
+qastudio_include_console_output = true
+```
+
+Or via command line:
+```bash
+pytest --qastudio-include-console-output
+```
+
+## Advanced Usage
+
+### Using with pytest-xdist (Parallel Testing)
+
+```bash
+pytest -n auto --qastudio-api-key=your-api-key
+```
+
+The plugin handles parallel test execution automatically.
+
+### CI/CD Integration
+
+#### GitHub Actions
+
+```yaml
+- name: Run Tests
+  run: |
+    pytest --junitxml=report.xml
+  env:
+    QASTUDIO_API_KEY: ${{ secrets.QASTUDIO_API_KEY }}
+    QASTUDIO_PROJECT_ID: ${{ secrets.QASTUDIO_PROJECT_ID }}
+    QASTUDIO_ENVIRONMENT: CI
+```
+
+#### GitLab CI
+
+```yaml
+test:
+  script:
+    - pytest
+  variables:
+    QASTUDIO_API_KEY: $QASTUDIO_API_KEY
+    QASTUDIO_PROJECT_ID: $QASTUDIO_PROJECT_ID
+    QASTUDIO_ENVIRONMENT: CI
+```
+
+## Examples
+
+### Playwright Example
+
+A complete Playwright test framework example is available in `examples/playwright_tests/`:
+
+```bash
+# Navigate to example directory
+cd examples/playwright_tests
+
+# Install dependencies
+pip install -r requirements.txt
+playwright install chromium
+
+# Run the tests
+./run_tests.sh
+
+# Or run directly with pytest
+pytest -v
+```
+
+The example demonstrates:
+- ✅ Testing the QAStudio.dev website
+- ✅ Automatic screenshot capture
+- ✅ Playwright trace recording (`.zip` files)
+- ✅ Integration with qastudio-pytest reporter
+- ✅ Test case linking with `@pytest.mark.qastudio_id()`
+
+See [`examples/playwright_tests/README.md`](examples/playwright_tests/README.md) for detailed documentation.
+
+## Development
+
+```bash
+# Clone repository
+git clone https://github.com/QAStudio-Dev/playwright-reporter-python.git
+cd playwright-reporter-python
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e .[dev]
+
+# Run tests
+pytest tests/
+
+# Run linting
+black src/ tests/
+flake8 src/ tests/
+mypy src/
+
+# Build package
+python -m build
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+- 📧 Email: ben@qastudio.dev
+- 🐛 Issues: https://github.com/QAStudio-Dev/playwright-reporter-python/issues
+- 📖 Documentation: https://qastudio.dev/docs

qastudio_pytest-1.0.5/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "qastudio-pytest"
+version = "1.0.5"
+description = "pytest plugin for QAStudio.dev test management platform"
+authors = [{name = "QAStudio", email = "ben@qastudio.dev"}]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.8"
+keywords = ["pytest", "testing", "test-management", "qa", "qastudio"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Testing",
+]
+
+dependencies = [
+    "pytest>=7.0.0",
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "flake8>=6.0.0",
+    "mypy>=1.0.0",
+    "types-requests>=2.28.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/QAStudio-Dev/playwright-reporter-python"
+Repository = "https://github.com/QAStudio-Dev/playwright-reporter-python"
+Issues = "https://github.com/QAStudio-Dev/playwright-reporter-python/issues"
+Documentation = "https://github.com/QAStudio-Dev/playwright-reporter-python#readme"
+
+[project.entry-points.pytest11]
+qastudio = "qastudio_pytest.plugin"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ["py38", "py39", "py310", "py311", "py312"]
+
+[tool.flake8]
+max-line-length = 100
+extend-ignore = ["E203", "W503"]
+
+[tool.mypy]
+python_version = "1.0.5"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+exclude = [
+    "venv/",
+    ".venv/",
+    "build/",
+    "dist/",
+]
+
+# Ignore errors in installed packages
+[[tool.mypy.overrides]]
+module = [
+    "pytest.*",
+    "_pytest.*",
+]
+ignore_errors = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --strict-markers"

qastudio_pytest-1.0.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

qastudio_pytest-1.0.5/src/qastudio_pytest/__init__.py

@@ -0,0 +1,13 @@
+"""
+QAStudio pytest plugin for test management integration.
+
+This plugin automatically reports pytest test results to QAStudio.dev platform.
+"""
+
+__version__ = "1.0.5"
+__author__ = "QAStudio"
+__email__ = "support@qastudio.dev"
+
+from .plugin import QAStudioPlugin
+
+__all__ = ["QAStudioPlugin"]