au.com.agic.apptesting.utils.ThreadWebDriverMap Maven / Gradle / Ivy

Go to download
package au.com.agic.apptesting.utils;

import au.com.agic.apptesting.profiles.configuration.UrlMapping;

import org.openqa.selenium.remote.DesiredCapabilities;

import java.io.File;
import java.util.List;
import java.util.Map;

import javax.validation.constraints.NotNull;

/**
 * This class maintains a mapping between a thread id and the Selenium desired capabilities that
 * will be used by the web driver created inside that thread.  This is necessary because Cucumber
 * doesn't really support the notion of running tests in multiple threads with multiple
 * configurations (http://www.drobsonconsulting.co.uk/cucumber-and-concurrency/). But this is
 * exactly what we want to do when running against BrowserStack.  So this class provides a lookup
 * that is linked to a thread id. This means that when cucumber is creating instances of the Step
 * definitions, the actual configuration of the web driver can be retrieved against a specific
 * thread. In this way we can have multiple threads each creating webdrivers that are consistent for
 * that thread, but different to the other threads.
 */
public interface ThreadWebDriverMap {

	/**
	 * Initialise any internal structures with the list of loaded capabilities
	 *
	 * @param desiredCapabilities the list of capabilities that were loaded
	 * @param applicationUrls     the list of urls assocaited with the application we are testing
	 * @param datasets            the datasets that can be used by a test script
	 * @param reportDirectory     The directory that holds reports and other test script outputs
	 * @param tempFolders	      A list of directories that need to be deleted once the test is complete
	 * @param proxies	  		  A list of the proxies that have been configured
	 */
	void initialise(
		@NotNull final List desiredCapabilities,
		@NotNull final List applicationUrls,
		@NotNull final Map> datasets,
		@NotNull final String myReportDirectory,
		@NotNull final List myTempFolders,
		@NotNull final List> myProxies);

	/**
	 * @param name The name of the currently executing thread
	 * @return The web driver and url associated with the thread
	 */
	@NotNull
	ThreadDetails getDesiredCapabilitiesForThread(@NotNull final String name);

	/**
	 * @return The number of threads that should be run in order to conver all the defined
	 * configurations
	 */
	int getNumberCapabilities();

	/**
	 *
	 * @return The list of temporary folders to be cleaned up when shutdown is called
	 */
	List getTempFolders();

	/**
	 * Cleans up the web drivers
	 */
	void shutdown();

	/**
	 * Cleans up the web drivers for an individual thread
	 *
	 * @param name The name of the thread that should have its associated resources cleaned up
	 */
	void shutdown(@NotNull final String name);
}