qastudio-pytest 1.0.4__py3-none-any.whl

qastudio_pytest/utils.py

@@ -0,0 +1,284 @@
+"""Utility functions for QAStudio pytest plugin."""
+
+import re
+from datetime import datetime
+from typing import Any, List, Optional, TypeVar
+
+T = TypeVar("T")
+
+
+def extract_test_case_id(item: Any) -> Optional[str]:
+    """
+    Extract QAStudio test case ID from pytest item.
+
+    Checks in order:
+    1. @pytest.mark.qastudio_id marker
+    2. Test name pattern (test_QA123_name or test_name_QA123)
+    3. Docstring pattern (QAStudio ID: QA-123)
+    """
+    # Check for qastudio_id marker
+    marker = item.get_closest_marker("qastudio_id")
+    if marker and marker.args:
+        return str(marker.args[0])
+
+    # Check test name for ID pattern
+    name = item.name
+    # Pattern: QA-123 or QA123
+    match = re.search(r"QA[-_]?(\d+)", name, re.IGNORECASE)
+    if match:
+        return f"QA-{match.group(1)}"
+
+    # Check docstring
+    if item.function.__doc__:
+        doc = item.function.__doc__
+        match = re.search(r"QAStudio\s+ID:\s*(QA[-_]?\d+)", doc, re.IGNORECASE)
+        if match:
+            test_id = match.group(1).upper()
+            # Normalize to QA-123 format
+            return re.sub(r"QA[-_]?(\d+)", r"QA-\1", test_id)
+
+    return None
+
+
+def get_full_test_name(item: Any) -> str:
+    """
+    Get full test name including class and module hierarchy.
+
+    Examples:
+        test_example.py::test_function
+        test_example.py::TestClass::test_method
+        test_example.py::TestClass::test_method[param]
+    """
+    parts = []
+
+    # Add module/file name
+    if hasattr(item, "fspath"):
+        parts.append(item.fspath.basename)
+
+    # Add class name if exists
+    if item.cls:
+        parts.append(item.cls.__name__)
+
+    # Add test function name
+    parts.append(item.name)
+
+    return "::".join(parts)
+
+
+def generate_test_run_name() -> str:
+    """Generate default test run name with timestamp."""
+    now = datetime.now()
+    date_str = now.strftime("%Y-%m-%d")
+    time_str = now.strftime("%H-%M-%S")
+    return f"pytest Run - {date_str} {time_str}"
+
+
+def batch_list(items: List[T], batch_size: int) -> List[List[T]]:
+    """Split list into batches of specified size."""
+    return [items[i : i + batch_size] for i in range(0, len(items), batch_size)]
+
+
+def format_duration(seconds: float) -> str:
+    """Format duration in human-readable format."""
+    if seconds < 1:
+        return f"{int(seconds * 1000)}ms"
+
+    total_seconds = int(seconds)
+    hours = total_seconds // 3600
+    minutes = (total_seconds % 3600) // 60
+    secs = total_seconds % 60
+
+    if hours > 0:
+        return f"{hours}h {minutes}m {secs}s"
+    elif minutes > 0:
+        return f"{minutes}m {secs}s"
+    else:
+        return f"{secs}s"
+
+
+def strip_ansi(text: str) -> str:
+    """
+    Strip ANSI escape codes from string.
+
+    Removes color codes and terminal formatting that can interfere with API calls.
+    """
+    if not text:
+        return text
+
+    # Remove ANSI escape sequences
+    text = re.sub(r"\x1b\[[0-9;]*[a-zA-Z]", "", text)
+    # Remove bracket codes
+    text = re.sub(r"\[\d+m", "", text)
+    # Remove multi-digit bracket codes
+    text = re.sub(r"\[\d+;\d+m", "", text)
+
+    return text.strip()
+
+
+def sanitize_string(text: Optional[str]) -> Optional[str]:
+    """Sanitize string by removing ANSI codes."""
+    if text is None:
+        return None
+    return strip_ansi(text)
+
+
+def validate_config(config: Any) -> None:
+    """
+    Validate required configuration options.
+
+    Raises:
+        ValueError: If required config is missing
+    """
+    if not config.api_url:
+        raise ValueError("QAStudio API URL is required")
+
+    if not config.api_key:
+        raise ValueError("QAStudio API key is required")
+
+    if not config.project_id:
+        raise ValueError("QAStudio project ID is required")
+
+    # Validate URL format
+    if not config.api_url.startswith(("http://", "https://")):
+        raise ValueError(f"Invalid API URL format: {config.api_url}")
+
+
+def extract_error_snippet(report: Any) -> Optional[str]:
+    """
+    Extract code snippet showing where the error occurred.
+
+    Args:
+        report: pytest test report
+
+    Returns:
+        Code snippet with context around the error line, or None if not available
+    """
+    if not hasattr(report, "longrepr") or not report.longrepr:
+        return None
+
+    try:
+        # Try to extract from longrepr
+        longrepr_str = str(report.longrepr)
+
+        # Look for code sections in the traceback (lines starting with >)
+        lines = longrepr_str.split("\n")
+        snippet_lines = []
+        in_code_section = False
+
+        for line in lines:
+            # Detect code lines (often prefixed with spaces or >)
+            if line.strip().startswith(">") or (in_code_section and line.startswith(" " * 4)):
+                snippet_lines.append(line)
+                in_code_section = True
+            elif in_code_section and line.strip():
+                # Continue collecting until we hit a non-code line
+                if not line.startswith("E "):
+                    snippet_lines.append(line)
+                else:
+                    break
+
+        if snippet_lines:
+            return "\n".join(snippet_lines[:10])  # Limit to 10 lines
+
+    except Exception:
+        pass
+
+    return None
+
+
+def extract_error_location(report: Any) -> Optional[dict]:
+    """
+    Extract precise error location (file, line, column).
+
+    Args:
+        report: pytest test report
+
+    Returns:
+        Dictionary with file, line, and column information, or None if not available
+    """
+    if not hasattr(report, "longrepr") or not report.longrepr:
+        return None
+
+    try:
+        # Try to get location from reprcrash
+        if hasattr(report.longrepr, "reprcrash"):
+            crash = report.longrepr.reprcrash
+            return {
+                "file": str(crash.path) if hasattr(crash, "path") else None,
+                "line": crash.lineno if hasattr(crash, "lineno") else None,
+                "column": 0,  # pytest doesn't provide column info
+            }
+
+        # Try to parse from longrepr string
+        longrepr_str = str(report.longrepr)
+        # Look for file:line pattern
+        match = re.search(r"([^\s]+\.py):(\d+):", longrepr_str)
+        if match:
+            return {"file": match.group(1), "line": int(match.group(2)), "column": 0}
+
+    except Exception:
+        pass
+
+    return None
+
+
+def extract_console_output(report: Any) -> Optional[dict]:
+    """
+    Extract console output (stdout/stderr) from test execution.
+
+    Args:
+        report: pytest test report
+
+    Returns:
+        Dictionary with stdout and stderr, or None if no output
+    """
+    stdout = None
+    stderr = None
+
+    try:
+        # Extract captured stdout
+        if hasattr(report, "capstdout") and report.capstdout:
+            stdout = sanitize_string(report.capstdout)
+
+        # Extract captured stderr
+        if hasattr(report, "capstderr") and report.capstderr:
+            stderr = sanitize_string(report.capstderr)
+
+        # Also try sections
+        if hasattr(report, "sections"):
+            for section_name, section_content in report.sections:
+                if "stdout" in section_name.lower():
+                    stdout_text = sanitize_string(section_content)
+                    if stdout_text:
+                        stdout = stdout_text
+                elif "stderr" in section_name.lower():
+                    stderr_text = sanitize_string(section_content)
+                    if stderr_text:
+                        stderr = stderr_text
+
+    except Exception:
+        pass
+
+    if stdout or stderr:
+        return {"stdout": stdout, "stderr": stderr}
+
+    return None
+
+
+def extract_test_steps(report: Any) -> Optional[List[dict]]:
+    """
+    Extract test execution steps.
+
+    Note: pytest doesn't have built-in step tracking like Playwright.
+    This is a placeholder that returns None for now.
+    Users can implement custom step tracking using pytest plugins if needed.
+
+    Args:
+        report: pytest test report
+
+    Returns:
+        List of step dictionaries, or None if not available
+    """
+    # pytest doesn't have native step tracking
+    # This could be enhanced with pytest-bdd or custom plugins in the future
+    return None

qastudio_pytest-1.0.4.dist-info/METADATA

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: qastudio-pytest
+Version: 1.0.4
+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.4.dist-info/RECORD

@@ -0,0 +1,11 @@
+qastudio_pytest/__init__.py,sha256=YqS1t8gG-dWNmvgD_GvIlLkdC-xSReTO9FYZKA6Kiyc,293
+qastudio_pytest/api_client.py,sha256=kTspiUPHd23V89cD8P-02q12LChLFz8FQlTQzYLBrZA,11433
+qastudio_pytest/models.py,sha256=yfSr-kCCgb8Tq6ZMe8lzIJMLyUiM8ay26WHE9bFXlOs,9083
+qastudio_pytest/plugin.py,sha256=fuNeGNeDus7iTRwupTh9jZtDxcukt10YBFd7mADuQnE,16604
+qastudio_pytest/utils.py,sha256=2dqb5hbmC-PrXd_sPzN87AdLqWdgEgkGZ7m4dOabsvo,8170
+qastudio_pytest-1.0.4.dist-info/licenses/LICENSE,sha256=in3Nfu01STBi3qLqTzYIcPufjpn2Ii5b6JqvW0L3xeY,1065
+qastudio_pytest-1.0.4.dist-info/METADATA,sha256=zU8617ApJe2VC1GUkDo8Sn1Cz3MU2U9CUb8J-FphGXY,8246
+qastudio_pytest-1.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+qastudio_pytest-1.0.4.dist-info/entry_points.txt,sha256=uaS6HwPI7xFBYraAVHljAqxa-tk87FH17celN75EsZA,45
+qastudio_pytest-1.0.4.dist-info/top_level.txt,sha256=oBnv6a1ZsPrv_bgzcl-LXLna-M92zf1YYFkyzzSlYW0,16
+qastudio_pytest-1.0.4.dist-info/RECORD,,

qastudio_pytest-1.0.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

qastudio_pytest-1.0.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+qastudio = qastudio_pytest.plugin

qastudio_pytest-1.0.4.dist-info/licenses/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.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+qastudio_pytest