Test Reporting in Pipelines (JUnit XML, Allure)

# ══════════════════════════════════════════════════════════════
# JUNIT XML REPORTS (standard CI format — works in ALL CI tools)
# ══════════════════════════════════════════════════════════════

# pytest generates JUnit XML:
pytest tests/ --junitxml=results/test-results.xml -v

# JUnit XML structure:
# <?xml version="1.0" encoding="UTF-8"?>
# <testsuites>
#   <testsuite name="tests/api/test_users.py" tests="15" errors="0" failures="2">
#     <testcase classname="test_users" name="test_get_user_by_id" time="0.234">
#     </testcase>
#     <testcase classname="test_users" name="test_create_user" time="0.456">
#       <failure message="AssertionError: Expected 201 but got 400">
#         Full traceback here
#       </failure>
#     </testcase>
#   </testsuite>
# </testsuites>

# GitHub Actions — publish JUnit XML as check annotations:
- name: Publish Test Results
  uses: EnricoMi/publish-unit-test-result-action@v2
  if: always()
  with:
    files: 'results/**/*.xml'
    # Shows test results as PR check with pass/fail annotations

# Jenkins — publish JUnit XML:
post {
    always {
        junit 'results/**/*.xml'
        # Jenkins shows trend graph: pass/fail over last N builds
    }
}

# ══════════════════════════════════════════════════════════════
# ALLURE REPORT GENERATION AND PUBLICATION
# ══════════════════════════════════════════════════════════════

# Step 1: Generate allure-results during test run
# pytest tests/ --alluredir=allure-results

# Step 2: Generate HTML report from allure-results
# allure generate allure-results --clean -o allure-report

# Step 3: Serve report locally
# allure serve allure-results

# GitHub Actions — Full Allure Report with History:
- name: Load Previous Allure History
  uses: actions/checkout@v4
  with:
    ref: gh-pages
    path: gh-pages

- name: Copy History
  run: cp -r gh-pages/history allure-results/ || true

- name: Generate Allure Report
  uses: simple-elf/allure-report-action@master
  with:
    allure_results: allure-results
    allure_report: allure-report
    gh_pages: gh-pages
    allure_history: allure-history

- name: Deploy to GitHub Pages
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    publish_dir: allure-history
# Tests report published to: https://username.github.io/repo-name

# ══════════════════════════════════════════════════════════════
# ALLURE TEST ANNOTATIONS (rich report content)
# ══════════════════════════════════════════════════════════════
import allure
import pytest

@allure.epic("User Management")
@allure.feature("User Registration")
@allure.story("Email Validation")
@allure.severity(allure.severity_level.CRITICAL)
@allure.title("Registration fails with invalid email format")
@allure.description("Verify that registration form rejects invalid email formats")
@allure.link("https://jira.mycompany.com/browse/AUTH-234", name="JIRA Ticket")
def test_registration_invalid_email(api_session):
    with allure.step("Send registration request with invalid email"):
        response = api_session.post("/api/auth/register", json={
            "email": "not-an-email",
            "password": "Test@1234"
        })
    
    with allure.step("Verify 400 Bad Request response"):
        assert response.status_code == 400
        allure.attach(
            response.text,
            name="Response Body",
            attachment_type=allure.attachment_type.JSON
        )
    
    with allure.step("Verify error message mentions email"):
        body = response.json()
        assert "email" in body.get("error", "").lower()