Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-03-02 11:22:01 +01:00
Code Issues Projects Releases Wiki Activity

#1020: Cast instead of using #typed when getting BlockType and ItemType to better work with testing / mocks

Browse Source 
By: DerFrZocker <derrieple@gmail.com>
This commit is contained in:
Bukkit/Spigot 2024-06-03 07:15:10 +10:00
parent f9b0675bdd
commit b0df4fc813
3 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
paper-api/src/main/java/org/bukkit/block/BlockType.java
View File

@ -3409,11 +3409,12 @@ public interface BlockType extends Keyed, Translatable {
//</editor-fold> //</editor-fold>
@NotNull @NotNull
private static <B extends BlockData> BlockType.Typed<B> getBlockType(@NotNull String key) { private static <B extends BlockType> B getBlockType(@NotNull String key) {
NamespacedKey namespacedKey = NamespacedKey.minecraft(key); NamespacedKey namespacedKey = NamespacedKey.minecraft(key);
BlockType.Typed<?> blockType = Registry.BLOCK.get(namespacedKey).typed(); BlockType blockType = Registry.BLOCK.get(namespacedKey);
Preconditions.checkNotNull(blockType, "No BlockType found for %s. This is a bug.", namespacedKey); Preconditions.checkNotNull(blockType, "No BlockType found for %s. This is a bug.", namespacedKey);
return (BlockType.Typed<B>) blockType; // Cast instead of using BlockType#typed, since block type can be a mock during testing and would return null
return (B) blockType;
} }
/** /**

7
paper-api/src/main/java/org/bukkit/inventory/ItemType.java
View File

@ -2257,11 +2257,12 @@ public interface ItemType extends Keyed, Translatable {
//</editor-fold> //</editor-fold>
@NotNull @NotNull
private static <M extends ItemMeta> Typed<M> getItemType(@NotNull String key) { private static <M extends ItemType> M getItemType(@NotNull String key) {
NamespacedKey namespacedKey = NamespacedKey.minecraft(key); NamespacedKey namespacedKey = NamespacedKey.minecraft(key);
Typed<?> itemType = Registry.ITEM.get(namespacedKey).typed(); ItemType itemType = Registry.ITEM.get(namespacedKey);
Preconditions.checkNotNull(itemType, "No ItemType found for %s. This is a bug.", namespacedKey); Preconditions.checkNotNull(itemType, "No ItemType found for %s. This is a bug.", namespacedKey);
return (Typed<M>) itemType; // Cast instead of using ItemType#typed, since item type can be a mock during testing and would return null
return (M) itemType;
} }
/** /**

15
paper-api/src/test/java/org/bukkit/support/TestServer.java
View File

@ -3,6 +3,7 @@ package org.bukkit.support;
import static org.mockito.Mockito.*; import static org.mockito.Mockito.*;
import java.util.HashMap; import java.util.HashMap;
import java.util.Iterator; import java.util.Iterator;
import java.util.Locale;
import java.util.Map; import java.util.Map;
import java.util.logging.Logger; import java.util.logging.Logger;
import java.util.stream.Stream; import java.util.stream.Stream;
@ -38,12 +39,22 @@ public final class TestServer {
when(instance.getBukkitVersion()).thenReturn("BukkitVersion_" + TestServer.class.getPackage().getImplementationVersion()); when(instance.getBukkitVersion()).thenReturn("BukkitVersion_" + TestServer.class.getPackage().getImplementationVersion());
Map<Class<? extends Keyed>, Registry<?>> registers = new HashMap<>(); Map<Class<? extends Keyed>, Registry<?>> registers = new HashMap<>();
when(instance.getRegistry(any())).then(invocationOnMock -> registers.computeIfAbsent(invocationOnMock.getArgument(0), aClass -> new Registry<Keyed>() { when(instance.getRegistry(any())).then(invocationOnMock -> registers.computeIfAbsent(invocationOnMock.getArgument(0), aClass -> new Registry<>() {
private final Map<NamespacedKey, Keyed> cache = new HashMap<>(); private final Map<NamespacedKey, Keyed> cache = new HashMap<>();
@Override @Override
public Keyed get(NamespacedKey key) { public Keyed get(NamespacedKey key) {
return cache.computeIfAbsent(key, key2 -> mock(aClass, withSettings().stubOnly())); Class<? extends Keyed> theClass;
// Some registries have extra Typed classes such as BlockType and ItemType.
// To avoid class cast exceptions during init mock the Typed class.
// To get the correct class, we just use the field type.
try {
theClass = (Class<? extends Keyed>) aClass.getField(key.getKey().toUpperCase(Locale.ROOT).replace('.', '_')).getType();
} catch (ClassCastException | NoSuchFieldException e) {
throw new RuntimeException(e);
}
return cache.computeIfAbsent(key, key2 -> mock(theClass, withSettings().stubOnly()));
} }
@NotNull @NotNull