Include template name in the client test screenshot missing error (#4434

) * Include template name in the error message if possible * Update javadoc
FabricMC · Feb 15, 2025 · 6816ccd · 6816ccd
1 parent 640e77a
commit 6816ccd
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/...et/fabricmc/fabric/api/client/gametest/v1/screenshot/TestScreenshotComparisonOptions.java b/...et/fabricmc/fabric/api/client/gametest/v1/screenshot/TestScreenshotComparisonOptions.java
@@ -77,6 +77,7 @@ static TestScreenshotComparisonOptions of(NativeImage templateImage) {
 	 * as the one that is compared against in this screenshot comparison.
 	 *
 	 * @return This screenshot comparison options instance
+	 * @throws java.util.NoSuchElementException if template image is not provided by path
 	 */
 	TestScreenshotComparisonOptions save();
 

diff --git a/...ient/java/net/fabricmc/fabric/impl/client/gametest/context/ClientGameTestContextImpl.java b/...ient/java/net/fabricmc/fabric/impl/client/gametest/context/ClientGameTestContextImpl.java
@@ -361,7 +361,7 @@ private Vector2i doAssertScreenshotContains(
 					}
 
 					if (result == null) {
-						throw new AssertionError("Screenshot does not contain template");
+						throw new AssertionError("Screenshot does not contain template" + optionsImpl.getTemplateImagePath().map(" '%s'"::formatted).orElse(""));
 					}
 
 					return result.add(region.getX(), region.getY());
@@ -418,7 +418,7 @@ private static Path saveScreenshot(NativeImage screenshot, String fileName, Test
 
 	private static void onTemplateImageDoesntExist(NativeImage subScreenshot, TestScreenshotComparisonOptionsImpl options) {
 		if (TestSystemProperties.TEST_MOD_RESOURCES_PATH != null) {
-			Path savePath = Path.of(TestSystemProperties.TEST_MOD_RESOURCES_PATH).resolve("templates").resolve(options.getTemplateImagePath() + ".png");
+			Path savePath = Path.of(TestSystemProperties.TEST_MOD_RESOURCES_PATH).resolve("templates").resolve(options.getTemplateImagePathOrThrow() + ".png");
 
 			try {
 				Files.createDirectories(savePath.getParent());

diff --git a/.../fabricmc/fabric/impl/client/gametest/screenshot/TestScreenshotComparisonOptionsImpl.java b/.../fabricmc/fabric/impl/client/gametest/screenshot/TestScreenshotComparisonOptionsImpl.java
@@ -21,6 +21,7 @@
 import java.io.UncheckedIOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Optional;
 
 import com.google.common.base.Preconditions;
 import com.mojang.datafixers.util.Either;
@@ -52,7 +53,7 @@ public TestScreenshotComparisonOptionsImpl(NativeImage templateImage) {
 
 	@Override
 	public TestScreenshotComparisonOptions save() {
-		return saveWithFileName(getTemplateImagePath());
+		return saveWithFileName(getTemplateImagePathOrThrow());
 	}
 
 	@Override
@@ -89,8 +90,20 @@ public TestScreenshotComparisonOptions withRegion(int x, int y, int width, int h
 		return this;
 	}
 
-	public String getTemplateImagePath() {
-		return this.templateImage.left().orElseThrow();
+	/**
+	 * Gets the path to the template image, relative to the {@code templates} directory, if one was provided.
+	 */
+	public Optional<String> getTemplateImagePath() {
+		return this.templateImage.left();
+	}
+
+	/**
+	 * Gets the path to the template image, relative to the {@code templates} directory, if one was provided.
+	 *
+	 * @throws java.util.NoSuchElementException if template image is not provided by path
+	 */
+	public String getTemplateImagePathOrThrow() {
+		return this.getTemplateImagePath().orElseThrow();
 	}
 
 	@Nullable