Skip to content

testing.md

Latest commit

 

History

History
62 lines (50 loc) · 3.52 KB

testing.md

File metadata and controls

62 lines (50 loc) · 3.52 KB
Raw

Testing

./gradlew build compiles, runs the unit tests, checks the license headers and builds the shaded jar. ./gradlew test runs only the tests; the JaCoCo report lands in build/reports/jacoco/test/html.

What is tested

  • PlayerBrushManagerTest – brush cycling, lookup by name and concurrent lookups sharing one brush.
  • PaintBrushTest – collecting the points of a stroke and dropping them when a player quits.
  • BezierSplineTest – the curve the Paint Brush follows.
  • StrokeContextFactoryTest – the stroke context is captured without asking the world for anything, and the palette weights every entry equally.
  • SphereTest, HeightTest, SurfaceTest, ConnectedBlocksTest – the geometry helpers against an in-memory extent.
  • ShapeBrushesTest, TerrainBrushesTest, StrokeRulesTest – every brush with a fixed seed and expected positions, plus palette, mask, the global mask of the session and thread independence.
  • NoBukkitWorldAccessTest – the brush and geometry sources contain no Bukkit world, block, location or player calls.
  • TranslationBundleTest – every translation key used in the code exists in every bundle and parses as MiniMessage.
  • ExportedBrushCodecTest – brushes stored on items, including 1.x lore and edited values.
  • BrushSizesTest – range and tab completion of /gopaint size.
  • SettingsHolderTest – reading, defaults, invalid values and reload of config.yml.
  • UpdateServiceTest – the update check with a stubbed Hangar.
  • ConnectListenerTest, InteractListenerTest, InventoryListenerTest – permission, world and menu checks of the listeners.
  • DIValidationTest – the Guice module graph.

Tests use JUnit 6, AssertJ and Mockito. Bukkit types such as World are mocked; there is no running server. Code that needs a server (the GUI, listeners, running a stroke in a real edit session) is covered by manual testing with ./gradlew run-<version>, which starts Paper with FastAsyncWorldEdit preinstalled.

Testing on Folia

./gradlew run-folia-26.2 -PfoliaSupported=true -PfoliaFaweUrl=<url> starts a local Folia 26.2 server. -PfoliaSupported=true makes the built plugin declare Folia support, and -PfoliaFaweUrl installs FastAsyncWorldEdit from the given URL. Use a Folia-capable FAWE build there. Stable FAWE does not support Folia, so the task fails without -PfoliaFaweUrl. The same tasks exist for every version in supportedMinecraftVersions, as run-folia-<version>.

This is for local testing only. Do not publish a jar built with -PfoliaSupported=true, and do not describe Folia as supported until a stable FastAsyncWorldEdit release supports it.

Testing brushes without a server

Brushes work on a WorldEdit Extent, so the tests paint on MemoryExtent (src/test/java/.../support), an extent backed by a map. WorldEdit's block registry only exists on a running server, so BlockTypes.STONE cannot be initialised in a unit test. TestBlocks creates BlockType mocks that answer the default state and whether the material is air or solid, which is all the brushes ask. Terrain builds the small worlds, StrokeBuilder builds a stroke context with a seeded random generator. BlockVector3, Vector3, RandomPattern and Mask work offline as they are.

A real EditSession needs a platform as well, so the tests call Brush#apply(Extent, StrokeContext) and wrap the extent with the session mask the way the stroke does.

Adding tests

Put tests next to the package they cover under src/test/java. ./gradlew spotlessApply adds the license header.