aquality.selenium.browser.AqualityServices Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aquality-selenium Show documentation
Library around Selenium WebDriver
There is a newer version: 4.9.0
package aquality.selenium.browser;

import aquality.selenium.configuration.IBrowserProfile;
import aquality.selenium.configuration.IConfiguration;
import aquality.selenium.configuration.ITimeoutConfiguration;
import aquality.selenium.core.localization.ILocalizedLogger;
import aquality.selenium.core.logging.Logger;
import aquality.selenium.core.utilities.IActionRetrier;
import aquality.selenium.core.waitings.IConditionalWait;
import aquality.selenium.elements.interfaces.IElementFactory;
import com.google.inject.Injector;

/**
 * Controls browser and Aquality services.
 */
public class AqualityServices extends aquality.selenium.core.applications.AqualityServices {
    private static final ThreadLocal INSTANCE_CONTAINER = ThreadLocal.withInitial(AqualityServices::new);
    private IBrowserFactory browserFactory;

    private AqualityServices() {
        super(AqualityServices::getBrowser, () -> new BrowserModule(AqualityServices::getBrowser));
    }

    private AqualityServices(BrowserModule module) {
        super(AqualityServices::getBrowser, () -> module);
    }

    private static AqualityServices getInstance() {
        return INSTANCE_CONTAINER.get();
    }

    /**
     * Gets instance of browser.
     *
     * @return Instance of desired browser.
     */
    public static Browser getBrowser() {
        return getInstance().getApp(injector -> AqualityServices.startBrowser());
    }

    /**
     * Check if browser already started or not.
     *
     * @return true if browser started and false otherwise.
     */
    public static boolean isBrowserStarted() {
        return getInstance().isAppStarted();
    }

    /**
     * Resolves required service from DI container.
     * Note that the service should be binded in {@link BrowserModule}.
     *
     * @param type class of required service.
     * @param   type of required service.
     * @return required service.
     */
    public static  T get(Class type) {
        return getServiceProvider().getInstance(type);
    }

    private static Injector getServiceProvider() {
        return getInstance().getInjector();
    }

    /**
     * Sets default(local {@link LocalBrowserFactory} or remote {@link RemoteBrowserFactory}) browser factory.
     */
    public static void setDefaultBrowserFactory() {
        IBrowserFactory browserFactory = getBrowserProfile().isRemote()
                ? new RemoteBrowserFactory(get(IActionRetrier.class), getBrowserProfile(), get(ITimeoutConfiguration.class), getLocalizedLogger())
                : new LocalBrowserFactory(get(IActionRetrier.class), getBrowserProfile(), getLocalizedLogger());
        setBrowserFactory(browserFactory);
    }

    /**
     * Gets factory for browser creation.
     *
     * @return current instance of browser factory.
     */
    public static IBrowserFactory getBrowserFactory() {
        if (getInstance().browserFactory == null) {
            setDefaultBrowserFactory();
        }

        return getInstance().browserFactory;
    }

    /**
     * Sets custom browser factory.
     *
     * @param browserFactory Custom implementation of {@link IBrowserFactory}
     */
    public static void setBrowserFactory(IBrowserFactory browserFactory) {
        getInstance().browserFactory = browserFactory;
    }

    private static Browser startBrowser() {
        return getBrowserFactory().getBrowser();
    }

    /**
     * Sets instance of browser.
     *
     * @param browser Instance of desired browser.
     */
    public static void setBrowser(Browser browser) {
        getInstance().setApp(browser);
    }

    /**
     * Reinitializes the dependency injector with custom {@link BrowserModule}.
     *
     * @param module {@link BrowserModule} object with custom or overriden services.
     */
    public static void initInjector(BrowserModule module) {
        if (INSTANCE_CONTAINER.get() != null) {
            INSTANCE_CONTAINER.remove();
        }
        INSTANCE_CONTAINER.set(new AqualityServices(module));
    }

    /**
     * Gets logger.
     *
     * @return instance of logger.
     */
    public static Logger getLogger() {
        return get(Logger.class);
    }

    /**
     * Gets logger which logs messages in current language.
     *
     * @return instance of localized logger.
     */
    public static ILocalizedLogger getLocalizedLogger() {
        return get(ILocalizedLogger.class);
    }

    /**
     * Provides the utility used to wait for some condition.
     *
     * @return instance of conditional wait.
     */
    public static IConditionalWait getConditionalWait() {
        return get(IConditionalWait.class);
    }

    /**
     * Gets factory to create elements.
     *
     * @return Factory of elements.
     */
    public static IElementFactory getElementFactory() {
        return get(IElementFactory.class);
    }

    /**
     * Gets current profile of browser settings.
     *
     * @return current browser profile.
     */
    public static IBrowserProfile getBrowserProfile() {
        return get(IBrowserProfile.class);
    }

    /**
     * Provides interface to access all described configurations.
     *
     * @return configuration.
     */
    public static IConfiguration getConfiguration() {
        return get(IConfiguration.class);
    }
}