Skip to content

docs: refresh README and testing guidance #25

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 #25

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: 9 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,31 +34,15 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests

With Java 21 and Maven installed, run `mvn clean verify`. Tests exercise domain
rules, YAML persistence, and plugin workflows using JUnit, Mockito, and MockBukkit.
JaCoCo measures all production classes and writes its HTML report to
`target/site/jacoco/index.html` and machine-readable results to
`target/site/jacoco/jacoco.xml`. The build workflow uploads the coverage report.

Tests should assert gameplay behavior, data preservation, or failure handling.
Do not add tests solely to execute a line or manufacture unreachable states to
increase coverage. MockBukkit tests do not replace testing on a real Paper server
with the optional ItemsAdder and MMOItems integrations installed.

Adapter contract tests can also run against locally supplied plugin jars:

```sh
mvn -Ppack-api-tests clean verify \
-Ditemsadder.jar=/path/to/ItemsAdder.jar \
-Dfastnbt.jar=/path/to/FastNbt-jar.jar \
-Dmmoitems.jar=/path/to/MMOItems.jar \
-Dmythiclib.jar=/path/to/MythicLib.jar
```

These tests bind the actual API classes and mock their external operations; they
do not start those plugins. The jars remain outside this repository and are used
only on the test runtime classpath. Use the FastNbt version declared by your
ItemsAdder jar. The ordinary test suite needs none of these files.
With Java 21 and Maven installed, run `mvn clean verify`. JUnit 4, Mockito and
MockBukkit test domain rules, YAML persistence and plugin workflows. Surefire
results are in `target/surefire-reports/`. JaCoCo reports all production classes
in `target/site/jacoco/index.html` and `target/site/jacoco/jacoco.xml`; no minimum
coverage gate is enforced. The Build workflow uploads both report directories.

The ordinary suite needs no private plugin JARs and does not start a live Paper
server. See the [testing guide](https://github.com/TF-Minecraft/Docs/blob/main/projects/Archaeo/docs/testing.md)
for optional adapter contract tests with ItemsAdder and MMOItems API JARs.

## License

Expand Down
Loading