#1512: Test Art class based on specific values instead of the implementation, to better catch implementation changes

By: DerFrZocker <derrieple@gmail.com>
This commit is contained in:
CraftBukkit/Spigot 2024-11-23 21:14:14 +11:00
parent 5a6e315a79
commit 4487df57e1

View file

@ -1,67 +1,56 @@
package org.bukkit; package org.bukkit;
import static org.bukkit.support.MatcherAssert.*;
import static org.hamcrest.Matchers.*;
import static org.junit.jupiter.api.Assertions.*; import static org.junit.jupiter.api.Assertions.*;
import com.google.common.collect.Lists; import java.util.stream.Stream;
import java.util.Collections; import org.bukkit.support.environment.VanillaFeature;
import java.util.HashMap; import org.junit.jupiter.params.ParameterizedTest;
import java.util.List; import org.junit.jupiter.params.provider.Arguments;
import java.util.Map; import org.junit.jupiter.params.provider.MethodSource;
import net.minecraft.core.Holder;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.minecraft.world.entity.decoration.PaintingVariant;
import org.bukkit.craftbukkit.CraftArt;
import org.bukkit.craftbukkit.CraftRegistry;
import org.bukkit.support.environment.AllFeatures;
import org.junit.jupiter.api.Test;
@AllFeatures @VanillaFeature
public class ArtTest { public class ArtTest {
@Test public static Stream<Arguments> widthData() {
public void verifyMapping() { return Stream.of(Arguments.of(Art.KEBAB, 1),
List<Art> arts = Lists.newArrayList(Art.values()); Arguments.of(Art.WANDERER, 1),
Arguments.of(Art.POOL, 2),
for (ResourceKey<PaintingVariant> key : CraftRegistry.getMinecraftRegistry(Registries.PAINTING_VARIANT).registryKeySet()) { Arguments.of(Art.MATCH, 2),
Holder<PaintingVariant> enumArt = CraftRegistry.getMinecraftRegistry(Registries.PAINTING_VARIANT).getOrThrow(key); Arguments.of(Art.BOUQUET, 3),
String name = key.location().getPath(); Arguments.of(Art.BACKYARD, 3),
int width = enumArt.value().width(); Arguments.of(Art.FIGHTERS, 4),
int height = enumArt.value().height(); Arguments.of(Art.SKELETON, 4),
Arguments.of(Art.POINTER, 4));
Art subject = CraftArt.minecraftHolderToBukkit(enumArt);
String message = String.format("org.bukkit.Art is missing '%s'", name);
assertNotNull(subject, message);
assertThat(Art.getByName(name), is(subject));
assertThat(subject.getBlockWidth(), is(width), "Art." + subject + "'s width");
assertThat(subject.getBlockHeight(), is(height), "Art." + subject + "'s height");
arts.remove(subject);
}
assertThat(arts, is(Collections.EMPTY_LIST), "org.bukkit.Art has too many arts");
} }
@Test public static Stream<Arguments> heightData() {
public void testCraftArtToNotch() { return Stream.of(Arguments.of(Art.KEBAB, 1),
Map<Holder<PaintingVariant>, Art> cache = new HashMap<>(); Arguments.of(Art.WANDERER, 2),
for (Art art : Art.values()) { Arguments.of(Art.POOL, 1),
Holder<PaintingVariant> enumArt = CraftArt.bukkitToMinecraftHolder(art); Arguments.of(Art.MATCH, 2),
assertNotNull(enumArt, art.name()); Arguments.of(Art.BOUQUET, 3),
assertThat(cache.put(enumArt, art), is(nullValue()), art.name()); Arguments.of(Art.BACKYARD, 4),
} Arguments.of(Art.FIGHTERS, 2),
Arguments.of(Art.SKELETON, 3),
Arguments.of(Art.POINTER, 4));
} }
@Test @ParameterizedTest
public void testCraftArtToBukkit() { @MethodSource("widthData")
Map<Art, Holder<PaintingVariant>> cache = new HashMap<>(); public void testWidth(Art art, int expected) {
for (Holder<PaintingVariant> enumArt : CraftRegistry.getMinecraftRegistry(Registries.PAINTING_VARIANT).asHolderIdMap()) { assertEquals(expected, art.getBlockWidth(), """
Art art = CraftArt.minecraftHolderToBukkit(enumArt); Art '%s' does not have the correct width.
assertNotNull(art, "Could not CraftArt.NotchToBukkit " + enumArt); This can be caused by either a change in the Implementation.
assertThat(cache.put(art, enumArt), is(nullValue()), "Duplicate artwork " + enumArt); Or the width for this specific art was changed in which case the test needs to be updated.
} """.formatted(art.getKey()));
}
@ParameterizedTest
@MethodSource("heightData")
public void testHeight(Art art, int expected) {
assertEquals(expected, art.getBlockHeight(), """
Art '%s' does not have the correct height.
This can be caused by either a change in the Implementation.
Or the height for this specific art was changed in which case the test needs to be updated.
""".formatted(art.getKey()));
} }
} }