Add extended failure message for visual testing

Author: uarlouski

docs/modules/plugins/pages/plugin-visual.adoc

@@ -30,6 +30,12 @@ include::partial$plugin-installation.adoc[]
 |`<empty>`
 |Used to append scenario based index to a baseline name
 
+|`ui.visual.enable-extended-assertion-format`
+a|`true`
+`false`
+|`false`
+|Extends assertion message for baseline validation by including baseline name
+
 |`ui.visual.override-baselines`
 a|`true`
 `false`

vividus-extension-visual-testing/src/main/java/org/vividus/visual/steps/AbstractVisualSteps.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2026 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,6 +37,8 @@ public abstract class AbstractVisualSteps
     private final IAttachmentPublisher attachmentPublisher;
     private final ISoftAssert softAssert;
 
+    private boolean enableExtendedAssertionFormat;
+
     protected AbstractVisualSteps(IUiContext uiContext, IAttachmentPublisher attachmentPublisher,
             ISoftAssert softAssert)
     {
@@ -90,7 +92,14 @@ private <T extends AbstractVisualCheck, R extends VisualCheckResult> Optional<R>
     protected void verifyResult(VisualCheckResult result)
     {
         boolean passed = result.isPassed() ^ result.getActionType() == VisualActionType.CHECK_INEQUALITY_AGAINST;
-        softAssert.assertTrue("Visual check passed", passed);
+        if (enableExtendedAssertionFormat)
+        {
+            softAssert.assertTrue("Visual check for '%s' baseline".formatted(result.getBaselineName()), passed);
+        }
+        else
+        {
+            softAssert.assertTrue("Visual check passed", passed);
+        }
     }
 
     protected abstract String getTemplateName();
@@ -99,4 +108,9 @@ protected ISoftAssert getSoftAssert()
     {
         return softAssert;
     }
+
+    public void setEnableExtendedAssertionFormat(boolean enableExtendedAssertionFormat)
+    {
+        this.enableExtendedAssertionFormat = enableExtendedAssertionFormat;
+    }
 }

vividus-extension-visual-testing/src/main/resources/properties/defaults/default.properties

@@ -1 +1,2 @@
 ui.visual.indexer=
+ui.visual.enable-extended-assertion-format=false

vividus-extension-visual-testing/src/main/resources/vividus-extension/spring.xml

@@ -6,6 +6,10 @@
         http://www.springframework.org/schema/util https://www.springframework.org/schema/util/spring-util.xsd"
        default-lazy-init="true">
 
+    <bean name="abstractVisualSteps" class="org.vividus.visual.steps.AbstractVisualSteps" abstract="true">
+        <property name="enableExtendedAssertionFormat" value="${ui.visual.enable-extended-assertion-format}" />
+    </bean>
+
     <beans profile="web_selenium,mobile_app">
         <bean id="scenario" class="org.vividus.visual.screenshot.ScenarioBasedIndexer" />
 

vividus-extension-visual-testing/src/test/java/org/vividus/visual/steps/VisualStepsTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 the original author or authors.
+ * Copyright 2019-2026 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -150,6 +150,19 @@ void shouldPerformVisualCheckAndPublishAttachment(boolean passed, VisualActionTy
         assertNull(visualCheck.getSearchContext());
     }
 
+    @Test
+    void shouldUseExtendedAssertionFormat()
+    {
+        var visualCheck = new AbstractVisualCheck(BASELINE_NAME, VisualActionType.COMPARE_AGAINST) { };
+        var visualCheckResult = new VisualCheckResult(visualCheck);
+        visualCheckResult.setPassed(false);
+
+        visualSteps.setEnableExtendedAssertionFormat(true);
+        visualSteps.verifyResult(visualCheckResult);
+
+        verify(softAssert).assertTrue("Visual check for '%s' baseline".formatted(BASELINE_NAME), false);
+    }
+
     private static final class TestVisualSteps extends AbstractVisualSteps
     {
         private TestVisualSteps(IUiContext uiContext, IAttachmentPublisher attachmentPublisher, ISoftAssert softAssert)

vividus-plugin-applitools/src/main/resources/vividus-plugin/spring.xml

@@ -25,11 +25,11 @@
     <bean class="org.vividus.visual.eyes.converter.ExamplesTableToRenderingBrowserInfoConverter" />
     <bean class="org.vividus.visual.eyes.converter.StringToAccessibilitySettingsConverter" />
 
-    <bean id="visualTestingSteps" class="org.vividus.visual.eyes.VisualTestingSteps" >
+    <bean id="visualTestingSteps" class="org.vividus.visual.eyes.VisualTestingSteps" parent="abstractVisualSteps">
         <constructor-arg index="2" ref="screenshotParametersFactory" />
     </bean>
 
-    <bean id="ufgSteps" class="org.vividus.visual.eyes.UfgSteps" />
+    <bean id="ufgSteps" class="org.vividus.visual.eyes.UfgSteps" parent="abstractVisualSteps"/>
 
     <bean id="eyesLogHandler" class="org.vividus.visual.eyes.logger.EyesLogHandler">
         <constructor-arg value="org.vividus.visual.eyes.service.ImageVisualTestingService" />

vividus-plugin-visual/src/main/resources/vividus-plugin/spring.xml

@@ -8,7 +8,7 @@
 
     <context:component-scan base-package="org.vividus.visual.storage" />
 
-    <bean id="visualSteps" class="org.vividus.visual.VisualSteps">
+    <bean id="visualSteps" class="org.vividus.visual.VisualSteps" parent="abstractVisualSteps">
         <constructor-arg ref="screenshotParametersFactory" />
     </bean>