All Downloads are FREE. Search and download functionalities are using the official Maven repository.

co.verisoft.fw.selenium.junit.extensions.DriverInjectionExtension Maven / Gradle / Ivy

Go to download

VeriSoft framework for testing web and mobile applications. Selenium Module

There is a newer version: 2.3.1
Show newest version
/*
 * (C) Copyright 2022 VeriSoft (http://www.verisoft.co)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package co.verisoft.fw.selenium.junit.extensions;

import co.verisoft.fw.extensions.jupiter.XrayPluginExtension;
import co.verisoft.fw.selenium.drivers.VerisoftDriver;
import co.verisoft.fw.selenium.drivers.VerisoftDriverManager;
import co.verisoft.fw.selenium.drivers.VerisoftMobileDriver;
import co.verisoft.fw.selenium.drivers.factory.AnnotationsReader;
import co.verisoft.fw.selenium.drivers.factory.DriverName;
import co.verisoft.fw.selenium.drivers.factory.SingleSession;
import co.verisoft.fw.store.StoreManager;
import co.verisoft.fw.store.StoreType;
import io.appium.java_client.AppiumDriver;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.*;
import org.openqa.selenium.Capabilities;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.remote.HttpCommandExecutor;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.net.URL;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;

/**
 * Extension to inject VerisoftDriver and VerisoftMobileDriver directly into the test instances

 * This class is inspired by Boni Garcia code Selenium-Jupiter. Boni Garcia's code can be found
 * here.
 *
 * @author Nir Gallner @ www.VeriSoft.co
 * @since 0.0.. (March 2022)
 */
@ToString
@Slf4j
public class DriverInjectionExtension implements ParameterResolver, AfterEachCallback, AfterAllCallback {

    AnnotationsReader annotationsReader;

    public DriverInjectionExtension() {
        annotationsReader = new AnnotationsReader();
    }


    @Override
    public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {

        // Extract the parameter and it's type
        Parameter parameter = parameterContext.getParameter();
        Class type = parameter.getType();

        // Is the type assignable from WebDriver && test is NOT a test template?
        return (WebDriver.class.isAssignableFrom(type) && !isTestTemplate(extensionContext));
    }


    @Override
    public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {

        ApplicationContext applicationContext;
        try {
            applicationContext = SpringExtension.getApplicationContext(extensionContext);
        }
        catch (Exception e)
        {
            applicationContext=null;
        }

        Parameter parameter = parameterContext.getParameter();


        int index = parameterContext.getIndex();
        Optional testInstance = extensionContext.getTestInstance();
        log.trace("Resolving parameter " + parameter + ", index " + index);
        String driverNameKey = Optional.ofNullable(parameter.getAnnotation(DriverName.class))
                .map(DriverName::value)
                .orElse(parameter.getName());

        StoreManager.getStore(StoreType.LOCAL_THREAD).putValueInStore("current driver name",driverNameKey);
        Class type = parameter.getType();

        // Mobile Driver
        if (AppiumDriver.class.isAssignableFrom(type) || VerisoftMobileDriver.class.isAssignableFrom(type))
            return resolveMobileDriver(applicationContext,extensionContext, testInstance, parameter);
        // Web Driver
        else if (WebDriver.class.isAssignableFrom(type))
            return resolveWebDriver(applicationContext,extensionContext, parameter, testInstance, type);
        else
            throw new RuntimeException("Could not resolve parameter. " + type + " is neither assignable from " +
                    "WebDriver nor VerisoftDriver / VerisoftMobileDriver");
    }


    /**
     * Get the capabilities and create new VerisoftDriver insatnce
     * @param extensionContext Junit 5 context object
     * @param parameter paameter extracted from the test to be initizlized with WebDriver based object
     * @param testInstance Junit 5 instance object
     * @param type Type definition of the object to be initialized
     * @return a VerisoftDriver object.
     */
    private Object resolveWebDriver(ApplicationContext applicationContext,ExtensionContext extensionContext, Parameter parameter, Optional testInstance, Class type) {
        if (isSingleSession(extensionContext)) {
            RemoteWebDriver driver = VerisoftDriverManager.getDriver();
            if (driver != null && driver.getSessionId()!=null)
                return new VerisoftDriver(driver);
        }
        Optional capabilities = annotationsReader.getCapabilities(applicationContext,parameter,
                extensionContext.getTestInstance());

        Optional commandExecutor = annotationsReader.getCommandExecutor(applicationContext,parameter,
                testInstance);

        Optional url = annotationsReader.getUrl(applicationContext,parameter, testInstance);
        if (commandExecutor.isPresent())
            return new VerisoftDriver(((HttpCommandExecutor) commandExecutor.get()), capabilities.orElse(null));
        else if (url.isPresent())
            return new VerisoftDriver(url.orElse(null), capabilities.orElse(null));
        else
            return new VerisoftDriver(capabilities.orElse(null));
    }


    /**
     * Get the capabilities and create new VerisoftobileDriver insatnce
     * @param extensionContext Junit 5 context object
     * @param testInstance Junit 5 instance object
     * @param parameter paameter extracted from the test to be initizlized with WebDriver based object
     * @return a VerisoftMobileDriver object.
     */
    private Object resolveMobileDriver(ApplicationContext applicationContext, ExtensionContext extensionContext, Optional testInstance, Parameter parameter) {

        if (isSingleSession(extensionContext)){
            AppiumDriver driver = VerisoftDriverManager.getDriver();
            if (driver != null && driver.getSessionId() != null)
                return new VerisoftMobileDriver(driver);
        }

        Optional capabilities = annotationsReader.getCapabilities(applicationContext, parameter,
                extensionContext.getTestInstance());

        Optional commandExecutor = annotationsReader.getCommandExecutor(applicationContext,parameter,
                testInstance);

        Optional url = annotationsReader.getUrl(applicationContext,parameter, testInstance);

        if (commandExecutor.isPresent())
            return new VerisoftMobileDriver(((HttpCommandExecutor) commandExecutor.get()), capabilities.orElse(null));
        else
            return new VerisoftMobileDriver(url.orElse(null), capabilities.orElse(null));
    }


    /**
     * Is the test method marked as Junit 5 TestTemplate?
     * @param extensionContext Junit 5 context object
     * @return true if TestTemplate, false otherwise
     */
    private boolean isTestTemplate(ExtensionContext extensionContext) {
        Optional testMethod = extensionContext.getTestMethod();
        return testMethod.isPresent()
                && testMethod.get().isAnnotationPresent(TestTemplate.class);
    }


    @Override
    public void afterEach(ExtensionContext extensionContext) throws Exception {

        // Close the driver, unless test class is marked as @SingleSession, which will has 1 driver for class
        Map drivers = VerisoftDriverManager.getDrivers();
        if (extensionContext.getExecutionException().isPresent() || (!isSingleSession(extensionContext) && Objects.nonNull(drivers))) {
            for (WebDriver driver : drivers.values()) {
                driver.quit();
            }
        }
    }


    @Override
    public void afterAll(ExtensionContext extensionContext) throws Exception {

        if (isSingleSession(extensionContext)) {
            Map drivers = VerisoftDriverManager.getDrivers();
            if (drivers != null) {
                for (WebDriver driver : drivers.values()) {
                    driver.quit();
                }
            }
        }
    }


    /**
     * Is test class is marked as @SingleSession, which will has 1 driver for class?
     *
     * @param extensionContext Junit 5 context object
     * @return True if the class is a single session class, false otherwise
     */
    private boolean isSingleSession(ExtensionContext extensionContext) {
        boolean singleSession = false;
        Optional> testClass = extensionContext.getTestClass();
        if (testClass.isPresent()) {
            singleSession = testClass.get()
                    .isAnnotationPresent(SingleSession.class);
        }
        log.trace("Single session " + singleSession);
        return singleSession;
    }
}
 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy