dev.galasa.selenium.internal.SeleniumManagerImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.selenium.manager Show documentation
The newest version!
/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.selenium.internal;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.nio.file.Path;
import java.util.List;

import javax.validation.constraints.NotNull;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.osgi.service.component.annotations.Component;

import dev.galasa.ManagerException;
import dev.galasa.artifact.IArtifactManager;
import dev.galasa.docker.IDockerManager;
import dev.galasa.docker.spi.IDockerManagerSpi;
import dev.galasa.framework.spi.AbstractManager;
import dev.galasa.framework.spi.AnnotatedField;
import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.GenerateAnnotatedField;
import dev.galasa.framework.spi.IConfigurationPropertyStoreService;
import dev.galasa.framework.spi.IDynamicStatusStoreService;
import dev.galasa.framework.spi.IFramework;
import dev.galasa.framework.spi.IManager;
import dev.galasa.framework.spi.Result;
import dev.galasa.framework.spi.ResourceUnavailableException;
import dev.galasa.framework.spi.language.GalasaMethod;
import dev.galasa.framework.spi.language.GalasaTest;
import dev.galasa.http.spi.IHttpManagerSpi;
import dev.galasa.kubernetes.spi.IKubernetesManagerSpi;
import dev.galasa.selenium.Browser;
import dev.galasa.selenium.ISeleniumManager;
import dev.galasa.selenium.IWebDriver;
import dev.galasa.selenium.SeleniumManager;
import dev.galasa.selenium.SeleniumManagerException;
import dev.galasa.selenium.SeleniumManagerField;
import dev.galasa.selenium.WebDriver;
import dev.galasa.selenium.internal.properties.SeleniumPropertiesSingleton;
import dev.galasa.selenium.internal.properties.SeleniumScreenshotFailure;
import dev.galasa.selenium.internal.properties.SeleniumWebDriverType;
import dev.galasa.selenium.spi.ISeleniumManagerSpi;

@Component(service = { IManager.class })
public class SeleniumManagerImpl extends AbstractManager implements ISeleniumManagerSpi {
	
	private static final Log logger = LogFactory.getLog(SeleniumManagerImpl.class);

    public static final String NAMESPACE = "selenium";

    private IConfigurationPropertyStoreService cps; // NOSONAR
    private IDynamicStatusStoreService dss;
    private Path screenshotRasDirectory;
    
    private IFramework framework;

    private IDockerManagerSpi dockerManager;
    private IHttpManagerSpi httpManager;
    private IKubernetesManagerSpi k8Manager;
    private IArtifactManager artifactManager;
    
    private String currentMethod;
    
    private SeleniumEnvironment seleniumEnvironment;

    private boolean required = false;

    @Override
    public void initialise(@NotNull IFramework framework, @NotNull List allManagers,
            @NotNull List activeManagers, @NotNull GalasaTest galasaTest) throws ManagerException {
        super.initialise(framework, allManagers, activeManagers, galasaTest);
        this.framework = framework;
        try {
            this.cps = framework.getConfigurationPropertyService(NAMESPACE);
            this.dss = framework.getDynamicStatusStoreService(NAMESPACE);
            SeleniumPropertiesSingleton.setCps(cps);
        } catch (Exception e) {
            throw new SeleniumManagerException("Unable to request framework services", e);
        }
        
        logger.info("Selenium manager has been succesfully initialised.");

        if (galasaTest.isJava()) {
            List ourFields = findAnnotatedFields(SeleniumManagerField.class);
            if (!ourFields.isEmpty() || this.required) {
                youAreRequired(allManagers, activeManagers, galasaTest);
            }
        }
    }

    @Override
    public boolean areYouProvisionalDependentOn(@NotNull IManager otherManager) {
		if (otherManager instanceof IDockerManager) {
	        return true;
	    }
		if (otherManager instanceof IKubernetesManagerSpi) {
	        return true;
	    }

        return super.areYouProvisionalDependentOn(otherManager);
    }

    @Override
    public void youAreRequired(@NotNull List allManagers, @NotNull List activeManagers, @NotNull GalasaTest galasaTest)
            throws ManagerException {
        this.required = true;

        if (activeManagers.contains(this)) {
            return;
        }
        
        try {
	        switch (SeleniumWebDriverType.get()) {
	        case "docker":
	        	this.dockerManager = this.addDependentManager(allManagers, activeManagers, galasaTest, IDockerManagerSpi.class);
	    		if (this.dockerManager == null) {
	    			throw new SeleniumManagerException("Unable to locate the Docker Manager");
	    	    }
	    		break;
	        case "kubernetes":
	        	this.k8Manager = this.addDependentManager(allManagers, activeManagers, galasaTest, IKubernetesManagerSpi.class);
	        	if (this.k8Manager == null) {
	                throw new SeleniumManagerException("Unable to locate the Kubernetes Manager");
	            }
	        	break;
	        }
        } catch (ConfigurationPropertyStoreException e) {
        	throw new SeleniumManagerException("Unable to determine selenium driver type");
        }

        activeManagers.add(this);
    	
		
        this.httpManager = this.addDependentManager(allManagers, activeManagers, galasaTest, IHttpManagerSpi.class);
        if (this.httpManager == null) {
            throw new SeleniumManagerException("Unable to locate the Http Manager");
        }
        this.artifactManager = this.addDependentManager(allManagers, activeManagers, galasaTest, IArtifactManager.class);        
        if (this.artifactManager == null) {
            throw new SeleniumManagerException("Unable to locate the Artifact Manager");
        }
        
    }

    @Override
    public void provisionGenerate() throws ManagerException, ResourceUnavailableException {
        Path storedArtifactsRoot = getFramework().getResultArchiveStore().getStoredArtifactsRoot();
        screenshotRasDirectory = storedArtifactsRoot.resolve("selenium").resolve("screenshots");
        this.seleniumEnvironment = new SeleniumEnvironment(this, screenshotRasDirectory);

        generateAnnotatedFields(SeleniumManagerField.class);
    }
    
    @Override
    public void startOfTestMethod(@NotNull GalasaMethod galasaMethod) throws ManagerException {
    	this.currentMethod = galasaMethod.getJavaExecutionMethod().getName();
    }
    
    @Override
    public void provisionStop() {
    	try {
    		seleniumEnvironment.closePages();
		} catch (SeleniumManagerException e) {
			logger.error("Failed to discard pages", e);
		}
    }
    
    @Override
    public void provisionDiscard() {
    	try {
			seleniumEnvironment.discard();
		} catch (SeleniumManagerException e) {
			logger.error("Failed to discard seleniumEnvironment", e);
		}
    }

    @GenerateAnnotatedField(annotation = SeleniumManager.class)
    public ISeleniumManager generateSeleniumManager(Field field, List annotations) throws ResourceUnavailableException, SeleniumManagerException {
    	SeleniumManager annoation = field.getAnnotation(SeleniumManager.class);
        Browser browser = annoation.browser();
       return this.seleniumEnvironment.allocateDriver(browser);
    }
    
    @GenerateAnnotatedField(annotation = WebDriver.class)
    public IWebDriver generateWebDriver(Field field, List annotations) throws ResourceUnavailableException, SeleniumManagerException {
    	WebDriver annoation = field.getAnnotation(WebDriver.class);
        Browser browser = annoation.browser();
       return this.seleniumEnvironment.allocateWebDriver(browser);
    }

    @Override
    public Result endOfTestMethod(@NotNull GalasaMethod galasaMethod, @NotNull Result currentResult,
            Throwable currentException) throws ManagerException {
        try {
            if (!currentResult.equals("Passed")) {
                if (SeleniumScreenshotFailure.get()) {
                	seleniumEnvironment.screenShotPages();
                }
            }
        } catch (ConfigurationPropertyStoreException e) {

        }
        return null;
    }
    
    @Override
    public IWebDriver provisionWebDriver(Browser browser) throws ResourceUnavailableException, SeleniumManagerException {
    	return this.seleniumEnvironment.allocateWebDriver(browser);
    }
    
    
    public IFramework getFramework() {
    	return this.framework;
    }
    public String getCurrentMethod() {
    	return this.currentMethod;
    }
    public IConfigurationPropertyStoreService getCps() {
    	return this.cps;
    }
    public IDynamicStatusStoreService getDss() {
    	return this.dss;
    }
    public IDockerManagerSpi getDockerManager() {
    	return this.dockerManager;
    }
    public IKubernetesManagerSpi getKubernetesManager() {
    	return this.k8Manager;
    }
    public IArtifactManager getArtifactManager() {
    	return this.artifactManager;
    }
    public IHttpManagerSpi getHttpManager() {
    	return this.httpManager;
    }
}