# Test & Quality Reports

All reports are generated automatically by the CI/CD pipeline on every push to `main`
and published to GitHub Pages alongside the Sphinx portal.

## Javadoc API Reference

Generated by `maven-javadoc-plugin` during `mvn site`.

```{note}
**[→ Open Javadoc](../site/apidocs/index.html)**
```

## JaCoCo — Code Coverage

```{note}
**[→ JaCoCo Coverage Report](../site/jacoco/index.html)**
```

Minimum enforced: **25 % line coverage** via `mvn verify`.

## Surefire — Unit Test Report

```{note}
**[→ Surefire Unit Test Report](../site/surefire-report.html)**
```

## Performance Tests

```{note}
**[→ Performance Report](../site/reports/perf-report.html)**
```

Generated by the `performance` Maven profile (`mvn -Pperformance integration-test`),
then copied into `target/site/reports/` before `mvn site` runs.

## Checkstyle

```{note}
**[→ Checkstyle Report](../site/checkstyle.html)**
```

## PMD — Static Analysis

```{note}
**[→ PMD Report](../site/pmd.html)**

**[→ CPD (Copy-Paste Detector)](../site/cpd.html)**
```

## JDepend — Package Metrics

```{note}
**[→ JDepend Report](../site/jdepend-report.html)**
```

## Doxygen

```{note}
**[→ Doxygen HTML Reference](../doxygen/html/index.html)**
```

---

## Complete path map

| Report | Published path on GitHub Pages | Generated by |
|---|---|---|
| Javadoc | `site/apidocs/index.html` | `maven-javadoc-plugin` in `<reporting>` |
| JaCoCo | `site/jacoco/index.html` | `mvn test jacoco:report` |
| Surefire | `site/surefire-report.html` | `surefire-report-plugin` `report` goal |
| Performance | `site/reports/perf-report.html` | `mvn -Pperformance integration-test` |
| Checkstyle | `site/checkstyle.html` | `mvn site` |
| PMD | `site/pmd.html` | `mvn site` |
| CPD | `site/cpd.html` | `mvn site` |
| JDepend | `site/jdepend-report.html` | `mvn site` |
| Doxygen | `doxygen/html/index.html` | `doxygen-maven-plugin` via `mvn site` |

---

## Generating All Reports Locally

```bash
# 1. Unit tests + JaCoCo
mvn test jacoco:report

# 2. Performance tests + copy report into site/reports/
mvn -Pperformance integration-test
mvn -Pperformance resources:copy-resources@copy-perf-report

# 3. Full Maven site (Javadoc, Checkstyle, PMD, JDepend, Surefire, JaCoCo, Doxygen)
mvn site

# 4. Copy everything to docs/ (local preview only — not committed)
mvn post-site
```