From 05bdc5c201dd386c30988c2132183b346d718e6d Mon Sep 17 00:00:00 2001 From: Ryan Barlow <7389646+ryanbarlow97@users.noreply.github.com> Date: Thu, 8 Oct 2026 19:03:45 +0000 Subject: [PATCH 1/2] docs: refresh README and testing guidance --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b9fa234..76bad88 100644 --- a/README.md +++ b/README.md @@ -26,12 +26,20 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/ ## Tests and coverage -Run `mvn clean verify` with Java 21. The build runs the unit tests and enforces -100% executable runtime **line coverage** with JaCoCo, without production-class -exclusions. Instruction and branch coverage are reported separately. - -The HTML report is `target/site/jacoco/index.html`; the machine-readable report is -`target/site/jacoco/jacoco.xml`. CI uploads these reports alongside test results. +Run `mvn clean verify` with Java 21 after preparing the pinned dependencies. +JUnit 5, Mockito and MockBukkit exercise item/block APIs, equipment and socket +handling, inventory scanning, SQLite storage and plugin lifecycle. These tests +do not start a live Paper server or verify the full dependent-plugin stack. + +JaCoCo enforces 100% production line coverage with no exclusions; instruction +and branch coverage are reported separately. HTML/XML reports are written to +`target/site/jacoco/`, and Surefire results to `target/surefire-reports/`. +Build CI uploads both. + +Run `python3 -m unittest discover -s tests -v` for the dependency installer and +artifact validation tests. These use Python's standard-library `unittest`, +report to the terminal and are outside the Java coverage gate. The Dependency +installer workflow also checks release resolution and Maven installation. ## License From b9c54de69ac9c21a5a5cb19850856477912918ee Mon Sep 17 00:00:00 2001 From: Ryan Barlow <7389646+ryanbarlow97@users.noreply.github.com> Date: Thu, 8 Oct 2026 20:31:50 +0000 Subject: [PATCH 2/2] docs: link pinned dependency setup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 76bad88..3275696 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/ ## Tests and coverage -Run `mvn clean verify` with Java 21 after preparing the pinned dependencies. +Run `mvn clean verify` with Java 21 after preparing the [pinned dependencies](DEPENDENCIES.md#tlibs-source-builds). JUnit 5, Mockito and MockBukkit exercise item/block APIs, equipment and socket handling, inventory scanning, SQLite storage and plugin lifecycle. These tests do not start a live Paper server or verify the full dependent-plugin stack.