[visual-testing] Simplify conversion of ExamplesTable to screenshot configuration

Author: valfirst

vividus-extension-selenium/src/main/java/org/vividus/ui/converter/AbstractExamplesTableToScreenshotConfigurationConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2024 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.
@@ -16,17 +16,22 @@
 
 package org.vividus.ui.screenshot;
 
+import static org.apache.commons.lang3.Validate.isTrue;
+
+import java.lang.reflect.ParameterizedType;
 import java.util.Collection;
 import java.util.EnumMap;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.BinaryOperator;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.apache.commons.lang3.Validate;
+import org.jbehave.core.model.ExamplesTable;
+import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.vividus.selenium.locator.Locator;
@@ -49,22 +54,36 @@ public Optional<ScreenshotParameters> create()
     }
 
     @Override
-    public P create(Optional<C> screenshotConfiguration, String sourceKey, Map<IgnoreStrategy, Set<Locator>> ignores)
+    public P create(@Nullable ExamplesTable screenshotConfiguration, String sourceKey,
+            Map<IgnoreStrategy, Set<Locator>> ignores)
     {
         Optional<C> defaultConfiguration = getDefaultConfiguration();
 
-        return screenshotConfiguration.map(currentConfig ->
+        if (screenshotConfiguration == null)
         {
-            patchIgnores(sourceKey, currentConfig, ignores);
-
-            C configuration = defaultConfiguration
-                    .map(defaultConfig -> getConfigurationMerger().apply(currentConfig, defaultConfig))
-                    .orElse(currentConfig);
-            return createParameters(configuration);
-        }).orElseGet(() -> {
             C configuration = defaultConfiguration.orElseGet(this::createScreenshotConfiguration);
             return createParameters(configuration, ignores);
-        });
+        }
+        List<C> screenshotConfigurations = screenshotConfiguration.getRowsAs(getScreenshotConfigurationClass());
+        int rowNumber = screenshotConfigurations.size();
+        isTrue(rowNumber == 1,
+                "Exactly one row is expected in ExamplesTable in order to convert it to screenshot configuration, "
+                        + "but found %d row(s)",
+                rowNumber);
+        C currentConfig = screenshotConfigurations.get(0);
+        patchIgnores(sourceKey, currentConfig, ignores);
+
+        C configuration = defaultConfiguration
+                .map(defaultConfig -> getConfigurationMerger().apply(currentConfig, defaultConfig))
+                .orElse(currentConfig);
+        return createParameters(configuration);
+    }
+
+    public Class<C> getScreenshotConfigurationClass()
+    {
+        ParameterizedType parameterizedType = (ParameterizedType) getClass().getGenericSuperclass();
+        //noinspection unchecked
+        return (Class<C>) parameterizedType.getActualTypeArguments()[0];
     }
 
     protected abstract C createScreenshotConfiguration();
@@ -91,7 +110,7 @@ private Set<Locator> getIgnoresFromOneOf(Set<Locator> configIgnores, String sour
     {
         if (!source.isEmpty())
         {
-            Validate.isTrue(configIgnores.isEmpty(), "The elements and areas to ignore must be passed "
+            isTrue(configIgnores.isEmpty(), "The elements and areas to ignore must be passed "
                     + "either through screenshot configuration or %s", sourceKey);
             LOGGER.atWarn().addArgument(sourceKey).log("The passing of elements and areas to ignore through {}"
                     + " is deprecated, please use screenshot configuration instead");
@@ -143,7 +162,7 @@ private P createParameters(C configuration, Map<IgnoreStrategy, Set<Locator>> st
 
     protected int ensureValidCutSize(int value, String key)
     {
-        Validate.isTrue(value >= 0, "The %s to cut must be greater than or equal to zero", key);
+        isTrue(value >= 0, "The %s to cut must be greater than or equal to zero", key);
         return value;
     }
 

vividus-extension-selenium/src/main/java/org/vividus/ui/screenshot/AbstractScreenshotParametersFactory.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.
@@ -20,13 +20,15 @@
 import java.util.Optional;
 import java.util.Set;
 
+import org.jbehave.core.model.ExamplesTable;
+import org.jspecify.annotations.Nullable;
 import org.vividus.selenium.locator.Locator;
 import org.vividus.selenium.screenshot.IgnoreStrategy;
 
 public interface ScreenshotParametersFactory<C extends ScreenshotConfiguration>
 {
     Optional<ScreenshotParameters> create();
 
-    ScreenshotParameters create(Optional<C> screenshotConfiguration, String sourceKey,
+    ScreenshotParameters create(@Nullable ExamplesTable screenshotConfiguration, String sourceKey,
             Map<IgnoreStrategy, Set<Locator>> ignores);
 }

vividus-extension-selenium/src/main/java/org/vividus/ui/screenshot/ScreenshotParametersFactory.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.
@@ -23,6 +23,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 import java.util.HashMap;
 import java.util.List;
@@ -36,6 +37,7 @@
 import com.github.valfirst.slf4jtest.TestLoggerFactory;
 import com.github.valfirst.slf4jtest.TestLoggerFactoryExtension;
 
+import org.jbehave.core.model.ExamplesTable;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.vividus.selenium.locator.Locator;
@@ -64,7 +66,7 @@ void shouldUseDefaultConfiguration()
         factory.setShootingStrategy(DEFAULT);
         factory.setIgnoreStrategies(createEmptyIgnores());
 
-        var parameters = factory.create(Optional.empty(), null, createEmptyIgnores());
+        var parameters = factory.create(null, null, createEmptyIgnores());
         assertEquals(cutBottom, parameters.getCutBottom());
         assertEquals(1, parameters.getCutTop());
         assertEquals(2, parameters.getCutLeft());
@@ -79,22 +81,30 @@ void shouldMergeUserDefinedAndDefaultConfigurations()
         factory.setShootingStrategy(DEFAULT);
         factory.setIgnoreStrategies(createEmptyIgnores());
 
-        var parameters = factory.create(Optional.of(createConfiguration(10)), null, createEmptyIgnores());
+        var screenshotConfiguration = new ExamplesTable("""
+                | cutTop | cutBottom | cutLeft | cutRight |
+                | 1      | 10        | 2       | 3        |);
+                """);
+
+        var parameters = factory.create(screenshotConfiguration, null, createEmptyIgnores());
         assertEquals(15, parameters.getCutBottom());
     }
 
     @Test
     void shouldReturnCustomConfigurationWhenDefaultIsMissing()
     {
-        var cutBottom = 5;
+        var screenshotConfiguration = new ExamplesTable("""
+                | cutTop | cutBottom | cutLeft | cutRight |
+                | 1      | 5        | 2       | 3        |);
+                """);
 
         factory.setScreenshotConfigurations(new PropertyMappedCollection<>(Map.of()));
         factory.setShootingStrategy(DEFAULT);
         factory.setIgnoreStrategies(createEmptyIgnores());
 
-        var parameters = factory.create(Optional.of(createConfiguration(cutBottom)), null,
+        var parameters = factory.create(screenshotConfiguration, null,
                 createEmptyIgnores());
-        assertEquals(cutBottom, parameters.getCutBottom());
+        assertEquals(5, parameters.getCutBottom());
         assertEquals(1, parameters.getCutTop());
     }
 
@@ -117,6 +127,9 @@ void shouldCreateParametersFromUserDefinedConfiguration()
         configuration.setShootingStrategy(Optional.of(DEFAULT));
         configuration.setCutBottom(1);
 
+        ExamplesTable examplesTable = mock();
+        when(examplesTable.getRowsAs(ScreenshotConfiguration.class)).thenReturn(List.of(configuration));
+
         var globalElementLocator = mock(Locator.class);
         var globalAreaLocator = mock(Locator.class);
 
@@ -126,7 +139,7 @@ void shouldCreateParametersFromUserDefinedConfiguration()
                 IgnoreStrategy.AREA, Set.of(globalAreaLocator)
         ));
 
-        ScreenshotParameters parameters = factory.create(Optional.of(configuration), null, createEmptyIgnores());
+        ScreenshotParameters parameters = factory.create(examplesTable, null, createEmptyIgnores());
 
         assertEquals(Optional.of(DEFAULT), parameters.getShootingStrategy());
         assertEquals(Map.of(
@@ -153,9 +166,10 @@ void shouldFailIfBothSourcesAreNotEmpty()
                 IgnoreStrategy.AREA, Set.of(locator),
                 IgnoreStrategy.ELEMENT, Set.of(locator)
         );
-        var configuration = Optional.of(screenshotConfiguration);
+        ExamplesTable examplesTable = mock();
+        when(examplesTable.getRowsAs(ScreenshotConfiguration.class)).thenReturn(List.of(screenshotConfiguration));
         var thrown = assertThrows(IllegalArgumentException.class,
-                () -> factory.create(configuration, IGNORES_TABLE, ignores));
+                () -> factory.create(examplesTable, IGNORES_TABLE, ignores));
         assertEquals("The elements and areas to ignore must be passed either through screenshot configuration"
                         + " or ignores table", thrown.getMessage());
     }
@@ -165,6 +179,8 @@ void shouldPatchIgnores()
     {
         var locator = mock(Locator.class);
         var screenshotConfiguration = new ScreenshotConfiguration();
+        ExamplesTable examplesTable = mock();
+        when(examplesTable.getRowsAs(ScreenshotConfiguration.class)).thenReturn(List.of(screenshotConfiguration));
 
         factory.setScreenshotConfigurations(new PropertyMappedCollection<>(new HashMap<>()));
         factory.setIgnoreStrategies(createEmptyIgnores());
@@ -174,7 +190,7 @@ void shouldPatchIgnores()
                 IgnoreStrategy.ELEMENT, Set.of(locator)
         );
 
-        ScreenshotParameters parameters = factory.create(Optional.of(screenshotConfiguration), IGNORES_TABLE, ignores);
+        ScreenshotParameters parameters = factory.create(examplesTable, IGNORES_TABLE, ignores);
 
         assertEquals(ignores, parameters.getIgnoreStrategies());
         assertThat(testLogger.getLoggingEvents(), equalTo(List.of(WARNING_MESSAGE, WARNING_MESSAGE)));

vividus-extension-selenium/src/test/java/org/vividus/ui/converter/AbstractExamplesTableToScreenshotConfigurationConverterTests.java

@@ -3,8 +3,8 @@ project.description = 'VIVIDUS plugin for Applitools'
 dependencies {
     implementation project(':vividus-engine')
     implementation project(':vividus-extension-visual-testing')
+    implementation project(':vividus-extension-selenium')
     implementation project(':vividus-http-client')
-    implementation project(':vividus-plugin-web-app')
     implementation project(':vividus-reporter')
     implementation project(':vividus-soft-assert')
     implementation project(':vividus-util')
@@ -20,4 +20,5 @@ dependencies {
     testImplementation platform(libs.mockito.bom)
     testImplementation(libs.mockito.junitJupiter)
     testImplementation(libs.slf4jTest)
+    testImplementation project(':vividus-plugin-web-app')
 }