Rework warmup of Browser(s)TCIFactory

Fixes #409

Author: AB-xdev

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.8.0
+* ``selenium``
+  * Moved warmUp code to correct factory
+  * Warmup will try to download/pre-pull the recording container image if required (as long as `recordingMode != SKIP`)
+  * Behavior can be customized with method `withPullVideoRecordingContainerOnWarmUp`
+
 # 2.7.2
 * `LazyNetwork`: Use explicitly defined `ExecutorService`
 * Updated dependencies

selenium/src/main/java/software/xdev/tci/selenium/factory/BrowserTCIFactory.java

@@ -34,20 +34,25 @@
 import org.testcontainers.containers.wait.strategy.HostPortWaitStrategy;
 import org.testcontainers.containers.wait.strategy.LogMessageWaitStrategy;
 import org.testcontainers.containers.wait.strategy.WaitAllStrategy;
+import org.testcontainers.images.RemoteDockerImage;
 
 import software.xdev.tci.concurrent.TCIExecutorServiceHolder;
 import software.xdev.tci.factory.prestart.PreStartableTCIFactory;
 import software.xdev.tci.factory.prestart.config.PreStartConfig;
+import software.xdev.tci.logging.JULtoSLF4JRedirector;
 import software.xdev.tci.misc.ContainerMemory;
 import software.xdev.tci.selenium.BrowserTCI;
 import software.xdev.tci.selenium.containers.SeleniumBrowserWebDriverContainer;
 import software.xdev.tci.selenium.factory.config.BrowserTCIFactoryConfig;
 import software.xdev.tci.serviceloading.TCIServiceLoaderHolder;
+import software.xdev.testcontainers.selenium.containers.browser.BrowserWebDriverContainer;
 import software.xdev.testcontainers.selenium.containers.recorder.SeleniumRecordingContainer;
 
 
 public class BrowserTCIFactory extends PreStartableTCIFactory<SeleniumBrowserWebDriverContainer, BrowserTCI>
 {
+	protected static boolean warmupRecordingContainerPullStarted;
+	protected boolean pullVideoRecordingContainerOnWarmUp;
 	protected final String browserName;
 
 	public BrowserTCIFactory(final MutableCapabilities capabilities)
@@ -103,6 +108,8 @@ public BrowserTCIFactory(final MutableCapabilities capabilities, final BrowserTC
 			"container.browserwebdriver." + capabilities.getBrowserName(),
 			"Browser-" + capabilities.getBrowserName());
 		this.browserName = capabilities.getBrowserName();
+		this.pullVideoRecordingContainerOnWarmUp =
+			config.recordingMode() != BrowserWebDriverContainer.RecordingMode.SKIP;
 	}
 
 	public BrowserTCIFactory(
@@ -132,6 +139,53 @@ public BrowserTCIFactory(
 		this.browserName = browserName;
 	}
 
+	public BrowserTCIFactory withPullVideoRecordingContainerOnWarmUp(final boolean pull)
+	{
+		this.pullVideoRecordingContainerOnWarmUp = pull;
+		return this;
+	}
+	
+	@Override
+	protected void warmUpInternal()
+	{
+		// Selenium uses JUL
+		JULtoSLF4JRedirector.redirect();
+		
+		this.pullRecordingContainerOnWarmUpAsync();
+	}
+	
+	protected void pullRecordingContainerOnWarmUpAsync()
+	{
+		if(this.pullVideoRecordingContainerOnWarmUp)
+		{
+			pullRecordingContainerOnWarmUpAsyncDefault();
+		}
+	}
+	
+	protected static synchronized void pullRecordingContainerOnWarmUpAsyncDefault()
+	{
+		if(warmupRecordingContainerPullStarted)
+		{
+			return;
+		}
+		
+		CompletableFuture.runAsync(
+			() -> {
+				try
+				{
+					new RemoteDockerImage(SeleniumRecordingContainer.DEFAULT_IMAGE).get(10, TimeUnit.MINUTES);
+				}
+				catch(final Exception e)
+				{
+					LoggerFactory.getLogger(BrowserTCIFactory.class)
+						.warn("Failed to pull {}", SeleniumRecordingContainer.DEFAULT_IMAGE, e);
+				}
+			},
+			TCIExecutorServiceHolder.instance());
+		
+		warmupRecordingContainerPullStarted = true;
+	}
+	
 	protected static Consumer<String> logBrowserConsoleConsumer(final BrowserConsoleLogLevel level)
 	{
 		if(!level.active())

selenium/src/main/java/software/xdev/tci/selenium/factory/BrowsersTCIFactory.java

@@ -21,32 +21,24 @@
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.TimeUnit;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import org.openqa.selenium.MutableCapabilities;
-import org.slf4j.LoggerFactory;
 import org.testcontainers.containers.Network;
-import org.testcontainers.images.RemoteDockerImage;
 
 import software.xdev.tci.concurrent.TCIExecutorServiceHolder;
 import software.xdev.tci.factory.TCIFactory;
-import software.xdev.tci.logging.JULtoSLF4JRedirector;
 import software.xdev.tci.selenium.BrowserTCI;
 import software.xdev.tci.selenium.TestBrowser;
 import software.xdev.tci.selenium.containers.SeleniumBrowserWebDriverContainer;
 import software.xdev.tci.tracing.TCITracer;
-import software.xdev.testcontainers.selenium.containers.recorder.SeleniumRecordingContainer;
 
 
 public class BrowsersTCIFactory implements TCIFactory<SeleniumBrowserWebDriverContainer, BrowserTCI>
 {
 	protected final Map<String, BrowserTCIFactory> browserFactories = new ConcurrentHashMap<>();
-	protected boolean pullVideoRecordingContainer;
-	
-	protected boolean alreadyWarmedUp;
 
 	public BrowsersTCIFactory()
 	{
@@ -65,58 +57,16 @@ public BrowsersTCIFactory(final Map<String, BrowserTCIFactory> browserFactories)
 		this.browserFactories.putAll(browserFactories);
 	}
 
-	public BrowsersTCIFactory withPullVideoRecordingContainer(final boolean pullVideoRecordingContainer)
+	public BrowsersTCIFactory withPullVideoRecordingContainerOnWarmUp(final boolean pull)
 	{
-		this.pullVideoRecordingContainer = pullVideoRecordingContainer;
+		this.browserFactories.values().forEach(f -> f.withPullVideoRecordingContainerOnWarmUp(pull));
 		return this;
 	}
 
 	@Override
 	public void warmUp()
 	{
-		if(this.alreadyWarmedUp)
-		{
-			return;
-		}
-		
-		this.warmUpInternal();
-	}
-	
-	protected synchronized void warmUpInternal()
-	{
-		if(this.alreadyWarmedUp)
-		{
-			return;
-		}
-		
-		// Selenium uses JUL
-		JULtoSLF4JRedirector.redirect();
-		
-		this.browserFactories.values().forEach(BrowserTCIFactory::warmUp);
-		
-		if(this.pullVideoRecordingContainer)
-		{
-			this.pullRecordingContainerAsync();
-		}
-		
-		this.alreadyWarmedUp = true;
-	}
-	
-	protected void pullRecordingContainerAsync()
-	{
-		CompletableFuture.runAsync(
-			() -> {
-				try
-				{
-					new RemoteDockerImage(SeleniumRecordingContainer.DEFAULT_IMAGE).get(10, TimeUnit.MINUTES);
-				}
-				catch(final Exception e)
-				{
-					LoggerFactory.getLogger(this.getClass())
-						.warn("Failed to pull {}", SeleniumRecordingContainer.DEFAULT_IMAGE, e);
-				}
-			},
-			TCIExecutorServiceHolder.instance());
+		// No effect - Done in downstream factories
 	}
 
 	@SuppressWarnings("resource")