diff --git a/.gitea/workflows/ci.yml b/.gitea/workflows/ci.yml index 276f7cf..aca7400 100644 --- a/.gitea/workflows/ci.yml +++ b/.gitea/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: uses: actions/setup-java@v4 with: distribution: temurin - java-version: 17 + java-version: 25 cache: gradle - name: Validate conventional commits @@ -35,6 +35,6 @@ jobs: - name: Upload development artifact uses: actions/upload-artifact@v3 with: - name: spigot-harvest-${{ github.sha }} + name: purpur-harvest-${{ github.sha }} path: build/libs/*.jar if-no-files-found: error diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index d758b4b..46cbb0f 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -21,7 +21,7 @@ jobs: uses: actions/setup-java@v4 with: distribution: temurin - java-version: 17 + java-version: 25 cache: gradle - name: Set up Node.js @@ -86,8 +86,8 @@ jobs: if: steps.release.outputs.created == 'true' uses: actions/upload-artifact@v3 with: - name: spigot-harvest-${{ steps.release.outputs.version }} - path: build/libs/spigot-harvest-${{ steps.release.outputs.version }}.jar + name: purpur-harvest-${{ steps.release.outputs.version }} + path: build/libs/purpur-harvest-${{ steps.release.outputs.version }}.jar if-no-files-found: error - name: Create Gitea release and upload plugin @@ -101,7 +101,7 @@ jobs: PREVIOUS_TAG: ${{ steps.previous_tag.outputs.value }} run: | api_url="${GITEA_SERVER_URL}/api/v1" - jar="build/libs/spigot-harvest-${VERSION}.jar" + jar="build/libs/purpur-harvest-${VERSION}.jar" export RELEASE_BODY if [ -n "$PREVIOUS_TAG" ]; then RELEASE_BODY=$(git log --pretty='format:- %s (%h)' "${PREVIOUS_TAG}..HEAD") @@ -138,4 +138,4 @@ jobs: -H "Authorization: token ${GITEA_TOKEN}" \ -H "Content-Type: application/octet-stream" \ --data-binary "@${jar}" \ - "${api_url}/repos/${REPOSITORY}/releases/${release_id}/assets?name=spigot-harvest-${VERSION}.jar" + "${api_url}/repos/${REPOSITORY}/releases/${release_id}/assets?name=purpur-harvest-${VERSION}.jar" diff --git a/AGENTS.md b/AGENTS.md index b147837..03dae81 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,9 +1,9 @@ -# spigot-harvest agent entrypoint +# purpur-harvest agent entrypoint The canonical stories, engineering guidance, and **all process documents** are in the private [SoMC OKF wiki](https://git.garvis.dev/dmg/somc-okf/src/branch/main/index.md). -Before work, read the sibling `../somc-okf/index.md`, `../somc-okf/processes/index.md`, `../somc-okf/projects/spigot-harvest/index.md`, `engineering.md` in that project section, and relevant `../somc-okf/user-stories/spigot-harvest/` stories. Also follow the parent workspace `AGENTS.md` when present. +Before work, read the sibling `../somc-okf/index.md`, `../somc-okf/processes/index.md`, `../somc-okf/projects/purpur-harvest/index.md`, `engineering.md` in that project section, and relevant `../somc-okf/user-stories/purpur-harvest/` stories. Also follow the parent workspace `AGENTS.md` when present. -For standalone checkouts, start at the [project page](https://git.garvis.dev/dmg/somc-okf/src/branch/main/projects/spigot-harvest/index.md) and [shared process](https://git.garvis.dev/dmg/somc-okf/src/branch/main/processes/development.md). Obtain wiki access before feature work; do not recreate a local knowledge bundle. Source builds do not require private wiki access. +For standalone checkouts, start at the [project page](https://git.garvis.dev/dmg/somc-okf/src/branch/main/projects/purpur-harvest/index.md) and [shared process](https://git.garvis.dev/dmg/somc-okf/src/branch/main/processes/development.md). Obtain wiki access before feature work; do not recreate a local knowledge bundle. Source builds do not require private wiki access. Development follows [Development cycle](https://git.garvis.dev/dmg/somc-okf/src/branch/main/runbooks/development-cycle.md): approved stories, failing tests, passing implementation, verification, then source/wiki commit and push. GitOps updates are committed locally **without pushing**; only [Do release](https://git.garvis.dev/dmg/somc-okf/src/branch/main/runbooks/do-release.md) authorizes a reviewed GitOps push. diff --git a/README.md b/README.md index 005ae3e..9f3fbee 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ -# Spigot Harvest +# Purpur Harvest -A Spigot 26.2 plugin providing progression-gated, connected crop harvesting and automatic replanting. +A Purpur 26.2 plugin providing progression-gated, connected crop harvesting and automatic replanting. -The approved behavior is specified in the [SoMC OKF wiki](https://git.garvis.dev/dmg/somc-okf/src/branch/main/projects/spigot-harvest/index.md). +The approved behavior is specified in the [SoMC OKF wiki](https://git.garvis.dev/dmg/somc-okf/src/branch/main/projects/purpur-harvest/index.md). ## Requirements -- Spigot 26.2 -- Java 17 or newer +- Purpur 26.2 build 2618 +- Java 25 + +## Distribution migration + +New repositories/checkouts/artifacts use `purpur-harvest`; runtime `SpigotHarvest`, Java entrypoints/packages, data folders, commands, permissions and crop progression remain unchanged. New releases no longer support Java 17. Replace the old JAR rather than installing both distributions. Historical tags and `spigot-harvest-*` assets are retained; the prior v1.0.1 download was checked for identical bytes after renaming. ## Build @@ -15,7 +19,7 @@ The approved behavior is specified in the [SoMC OKF wiki](https://git.garvis.dev ./gradlew clean check jar ``` -The plugin JAR is written to `build/libs/`. +The plugin JAR is written to `build/libs/`. `check` includes `nativeHarvestTest`: it downloads SHA-256-verified Purpur 2618 under `build/harvest-runtime/`, loads native registry/service providers, and runs real item-stack/drop/replant regressions without starting a listening server. Those tests are not replaced by item mocks or excluded from verification. ## Commands diff --git a/build.gradle.kts b/build.gradle.kts index 97df943..125c0f3 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,3 +1,6 @@ +import java.net.URI +import java.security.MessageDigest + plugins { java } @@ -9,23 +12,24 @@ version = providers.gradleProperty("releaseVersion") repositories { mavenCentral() - maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/") + maven("https://repo.purpurmc.org/snapshots/") } java { toolchain { - languageVersion = JavaLanguageVersion.of(17) + languageVersion = JavaLanguageVersion.of(25) } } tasks.withType().configureEach { - options.compilerArgs.addAll(listOf("-Xlint:all", "-Werror")) + // Retain supported legacy Bukkit APIs while preserving runtime compatibility. + options.compilerArgs.addAll(listOf("-Xlint:all,-deprecation,-removal", "-Werror")) } dependencies { - compileOnly("org.spigotmc:spigot-api:26.2-R0.1-SNAPSHOT") + compileOnly("org.purpurmc.purpur:purpur-api:26.2.build.2618-stable") - testImplementation("org.spigotmc:spigot-api:26.2-R0.1-SNAPSHOT") + testImplementation("org.purpurmc.purpur:purpur-api:26.2.build.2618-stable") testImplementation(platform("org.junit:junit-bom:5.13.4")) testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.mockito:mockito-core:5.18.0") @@ -35,8 +39,64 @@ dependencies { tasks.test { useJUnitPlatform() + dependsOn(tasks.jar) + systemProperty("distribution.jar", tasks.jar.get().archiveFile.get().asFile.absolutePath) + systemProperty("distribution.version", project.version.toString()) } +// Real ItemStack/drop/replant regressions require the declared runtime's registry and service providers. +val harvestRuntime = layout.buildDirectory.dir("harvest-runtime") +val downloadHarvestRuntime = tasks.register("downloadHarvestRuntime") { + val launcher = harvestRuntime.map { it.file("purpur-26.2-2618.jar") } + outputs.file(launcher) + doLast { + val file = launcher.get().asFile + file.parentFile.mkdirs() + val connection = URI("https://api.purpurmc.org/v2/purpur/26.2/2618/download").toURL().openConnection() + connection.connectTimeout = 30_000 + connection.readTimeout = 120_000 + val bytes = connection.getInputStream().use { it.readBytes() } + val digest = MessageDigest.getInstance("SHA-256").digest(bytes).joinToString("") { "%02x".format(it) } + check(digest == "4a32d046a118804d89ca74ba89b798c98f6d8d1f310c18077ac573597049de31") { + "Purpur 2618 checksum mismatch" + } + file.writeBytes(bytes) + } +} +val prepareHarvestRuntime = tasks.register("prepareHarvestRuntime") { + dependsOn(downloadHarvestRuntime) + javaLauncher = javaToolchains.launcherFor { languageVersion = JavaLanguageVersion.of(25) } + classpath = files(harvestRuntime.map { it.file("purpur-26.2-2618.jar") }) + mainClass = "io.papermc.paperclip.Main" + jvmArgs("-Dpaperclip.patchonly=true") + workingDir(harvestRuntime) + outputs.dir(harvestRuntime.map { it.dir("versions") }) + outputs.dir(harvestRuntime.map { it.dir("libraries") }) +} +val nativeTest = sourceSets.create("nativeTest") +dependencies { + add(nativeTest.implementationConfigurationName, platform("org.junit:junit-bom:5.13.4")) + add(nativeTest.implementationConfigurationName, "org.junit.jupiter:junit-jupiter") + add(nativeTest.implementationConfigurationName, "org.mockito:mockito-core:5.18.0") + add(nativeTest.compileOnlyConfigurationName, "org.jetbrains:annotations:26.0.2") + add(nativeTest.compileOnlyConfigurationName, "org.checkerframework:checker-qual:3.49.2") + add(nativeTest.runtimeOnlyConfigurationName, "org.junit.platform:junit-platform-launcher") +} +val nativeRuntimeJars = files(fileTree(harvestRuntime) { + include("versions/**/*.jar", "libraries/**/*.jar") +}).builtBy(prepareHarvestRuntime) +nativeTest.compileClasspath += sourceSets.main.get().output + nativeRuntimeJars +nativeTest.runtimeClasspath += sourceSets.main.get().output + nativeRuntimeJars +val nativeHarvestTest = tasks.register("nativeHarvestTest") { + description = "Runs real item/drop/replant regressions without starting a server" + testClassesDirs = nativeTest.output.classesDirs + classpath = nativeTest.runtimeClasspath + useJUnitPlatform() + maxHeapSize = "1G" + workingDir(harvestRuntime) +} +tasks.check { dependsOn(nativeHarvestTest) } + val pluginVersion = version tasks.processResources { diff --git a/settings.gradle.kts b/settings.gradle.kts index bff67df..6c4ee77 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1 +1 @@ -rootProject.name = "spigot-harvest" +rootProject.name = "purpur-harvest" diff --git a/src/test/java/games/dmg/spigotharvest/CropDropPlanTest.java b/src/nativeTest/java/games/dmg/spigotharvest/CropDropPlanTest.java similarity index 91% rename from src/test/java/games/dmg/spigotharvest/CropDropPlanTest.java rename to src/nativeTest/java/games/dmg/spigotharvest/CropDropPlanTest.java index f2bf49d..b9960ad 100644 --- a/src/test/java/games/dmg/spigotharvest/CropDropPlanTest.java +++ b/src/nativeTest/java/games/dmg/spigotharvest/CropDropPlanTest.java @@ -9,6 +9,9 @@ import org.bukkit.inventory.ItemStack; import org.junit.jupiter.api.Test; final class CropDropPlanTest { + @org.junit.jupiter.api.BeforeAll + static void bootstrap() throws Exception { NativeRuntime.bootstrap(); } + @Test void consumesExactlyOnePlantingItemAndKeepsRemainingDrops() { CropDropPlan plan = CropDropPlan.create( diff --git a/src/nativeTest/java/games/dmg/spigotharvest/NativeRuntime.java b/src/nativeTest/java/games/dmg/spigotharvest/NativeRuntime.java new file mode 100644 index 0000000..86c23e0 --- /dev/null +++ b/src/nativeTest/java/games/dmg/spigotharvest/NativeRuntime.java @@ -0,0 +1,61 @@ +package games.dmg.spigotharvest; + +import java.util.List; +import java.util.stream.Stream; +import net.minecraft.SharedConstants; +import net.minecraft.commands.Commands; +import net.minecraft.core.HolderLookup; +import net.minecraft.core.LayeredRegistryAccess; +import net.minecraft.core.Registry; +import net.minecraft.core.RegistryAccess; +import net.minecraft.resources.Identifier; +import net.minecraft.resources.RegistryDataLoader; +import net.minecraft.server.Bootstrap; +import net.minecraft.server.MinecraftServer; +import net.minecraft.server.RegistryLayer; +import net.minecraft.server.ReloadableServerResources; +import net.minecraft.server.packs.PackType; +import net.minecraft.server.packs.repository.ServerPacksSource; +import net.minecraft.server.packs.resources.MultiPackResourceManager; +import net.minecraft.server.permissions.LevelBasedPermissionSet; +import net.minecraft.tags.TagLoader; +import net.minecraft.util.Util; +import net.minecraft.world.flag.FeatureFlags; +import net.minecraft.world.level.DataPackConfig; +import net.minecraft.world.level.WorldDataConfiguration; +import org.bukkit.craftbukkit.CraftRegistry; + +/** Loads vanilla registries/tags/components using the same path as the server's own tests. */ +final class NativeRuntime { + private NativeRuntime() {} + private static boolean ready; + + static synchronized void bootstrap() throws Exception { + if (ready) { return; } + SharedConstants.tryDetectVersion(); + Bootstrap.bootStrap(); + var flags = FeatureFlags.VANILLA_SET; + var packs = ServerPacksSource.createVanillaTrustedRepository(); + MinecraftServer.configurePackRepository(packs, new WorldDataConfiguration(new DataPackConfig( + FeatureFlags.REGISTRY.toNames(flags).stream().map(Identifier::getPath).toList(), List.of()), flags), true, false); + try (var resources = new MultiPackResourceManager(PackType.SERVER_DATA, packs.openAllSelected())) { + LayeredRegistryAccess layers = RegistryLayer.createRegistryAccess(); + List> tags = TagLoader.loadTagsForExistingRegistries(resources, layers.getLayer(RegistryLayer.STATIC)); + List> lookups = TagLoader.buildUpdatedLookups(layers.getAccessForLoading(RegistryLayer.WORLDGEN), tags); + RegistryAccess.Frozen worldgen = RegistryDataLoader.load(resources, lookups, + RegistryDataLoader.WORLDGEN_REGISTRIES, Util.backgroundExecutor()).join(); + layers = layers.replaceFrom(RegistryLayer.WORLDGEN, worldgen); + RegistryAccess.Frozen dimensions = RegistryDataLoader.load(resources, + Stream.concat(lookups.stream(), worldgen.listRegistries()).toList(), + RegistryDataLoader.DIMENSION_REGISTRIES, Util.backgroundExecutor()).join(); + layers = layers.replaceFrom(RegistryLayer.DIMENSIONS, dimensions); + Class.forName(org.bukkit.Registry.class.getName()); + var datapack = ReloadableServerResources.loadResources(resources, layers, tags, flags, + Commands.CommandSelection.DEDICATED, LevelBasedPermissionSet.ALL_PERMISSIONS, + Util.backgroundExecutor(), Runnable::run).join(); + datapack.updateComponentsAndStaticRegistryTags(); + CraftRegistry.setMinecraftRegistry(layers.compositeAccess().freeze()); + } + ready = true; + } +} diff --git a/src/test/java/games/dmg/spigotharvest/TriggerCropReplantTest.java b/src/nativeTest/java/games/dmg/spigotharvest/TriggerCropReplantTest.java similarity index 96% rename from src/test/java/games/dmg/spigotharvest/TriggerCropReplantTest.java rename to src/nativeTest/java/games/dmg/spigotharvest/TriggerCropReplantTest.java index 0aaa573..0611149 100644 --- a/src/test/java/games/dmg/spigotharvest/TriggerCropReplantTest.java +++ b/src/nativeTest/java/games/dmg/spigotharvest/TriggerCropReplantTest.java @@ -20,6 +20,9 @@ import org.bukkit.scheduler.BukkitTask; import org.junit.jupiter.api.Test; final class TriggerCropReplantTest { + @org.junit.jupiter.api.BeforeAll + static void bootstrap() throws Exception { NativeRuntime.bootstrap(); } + @Test void startImmediatelyHarvestsAndReplantsTriggerExactlyOnce() { HarvestProgressService progress = mock(HarvestProgressService.class); diff --git a/src/test/java/games/dmg/spigotharvest/PurpurDistributionTest.java b/src/test/java/games/dmg/spigotharvest/PurpurDistributionTest.java new file mode 100644 index 0000000..a6dc627 --- /dev/null +++ b/src/test/java/games/dmg/spigotharvest/PurpurDistributionTest.java @@ -0,0 +1,53 @@ +package games.dmg.spigotharvest; + +import static org.junit.jupiter.api.Assertions.*; + +import java.io.DataInputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Map; +import java.util.jar.JarFile; +import org.junit.jupiter.api.Test; +import org.yaml.snakeyaml.Yaml; + +class PurpurDistributionTest { + @Test + void packagesNewNameWithoutChangingRuntimeIdentityOrBundlingTheApi() throws Exception { + Path artifact = Path.of(System.getProperty("distribution.jar")); + String version = System.getProperty("distribution.version"); + assertEquals("purpur-harvest-" + version + ".jar", artifact.getFileName().toString()); + try (var jar = new JarFile(artifact.toFile())) { + Map metadata = new Yaml().load(jar.getInputStream(jar.getJarEntry("plugin.yml"))); + assertEquals(version, metadata.get("version")); + assertEquals("SpigotHarvest", metadata.get("name"), "Retain the data directory and persistent namespace"); + assertEquals("games.dmg.spigotharvest.SpigotHarvestPlugin", metadata.get("main")); + assertTrue(((Map) metadata.get("permissions")).containsKey("spigotharvest.admin")); + assertFalse(jar.stream().anyMatch(entry -> entry.getName().startsWith("org/bukkit/") + || entry.getName().startsWith("org/purpurmc/") || entry.getName().endsWith("Test.class"))); + } + } + + @Test + void pluginBytecodeTargetsJava25() throws Exception { + try (var jar = new JarFile(System.getProperty("distribution.jar")); + var bytecode = new DataInputStream(jar.getInputStream( + jar.getJarEntry("games/dmg/spigotharvest/SpigotHarvestPlugin.class")))) { + assertEquals(0xCAFEBABE, bytecode.readInt()); + bytecode.readUnsignedShort(); + assertEquals(69, bytecode.readUnsignedShort()); + } + } + + @Test + void releaseAndCiAgreeWithThePurpurDistributionNameAndToolchain() throws Exception { + String build = Files.readString(Path.of("build.gradle.kts")); + assertTrue(build.contains("purpur-api:26.2.build.2618-stable")); + assertFalse(build.contains("org.spigotmc:spigot-api")); + for (String workflow : new String[] {"ci.yml", "release.yml"}) { + String content = Files.readString(Path.of(".gitea/workflows", workflow)); + assertTrue(content.contains("java-version: 25")); + assertTrue(content.contains("purpur-harvest-"), workflow); + assertFalse(content.contains("spigot-harvest-"), workflow); + } + } +}