Skip to content

docs: refresh README and testing guidance #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 1 commit into from
Oct 8, 2026
Merged

docs: refresh README and testing guidance #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,18 @@ With Java 21 and the pinned plugin dependencies installed (see the build workflo
mvn -B --no-transfer-progress clean verify
```

JUnit, MockBukkit and Mockito exercise configuration, persistence, inventory transfers,
ownership rules, commands, plugin lifecycle and theft sessions. Fixtures use temporary
directories; legacy relative persistence paths are isolated under `target/test-runtime`.
Tests mock external plugin APIs where a live server is required and assert the observable
result of each scenario. Optional RPCharacters API compatibility uses a test fixture
loaded separately to model servers with and without that API.

JaCoCo includes every production class. Open `target/site/jacoco/index.html` for the
HTML report, or use `target/site/jacoco/jacoco.xml` for tooling. CI uploads the coverage
report and Surefire test results. Use a clean full run for combined coverage; focused
test runs are for development and do not establish the suite's coverage.

`verify` requires 100% instruction, line, branch, method and class coverage,
without excluding production code. CI also rejects skipped tests.
Unused utility constructors, empty hooks and demonstrably unreachable alternatives
have been removed; guards for real configuration, metadata and integration failures
remain and have behavioral tests.

Coverage is a guide to missing behavior checks. Tests should verify a contract or a
regression, not invoke private constructors or invent impossible inventory states
to increase the percentage. MockBukkit's unimplemented operations can appear as skipped
tests; a successful coverage run must also have zero skipped tests.
JUnit, MockBukkit and Mockito exercise configuration, persistence, inventory
transfers, ownership rules, commands, plugin lifecycle and theft sessions.
External plugin APIs are mocked or represented by fixtures; live Paper gameplay
and integration checks remain separate.

Surefire writes test results to `target/surefire-reports/`; JaCoCo writes HTML
and XML coverage reports to `target/site/jacoco/`. Build CI uploads both.
`verify` requires 100% production instruction, line, branch, method and class
coverage, with no exclusions. CI also rejects skipped tests. Use a clean full
run for combined coverage; focused runs do not establish the suite's coverage.
See the [testing guide](https://github.com/TF-Minecraft/Docs/blob/main/projects/Thievery/docs/testing.md)
for fixture isolation and local report checks.

## License

Expand Down
Loading