de.qytera.qtaf.testng.context.QtafTestNGContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtaf-core Show documentation
There is a newer version: 0.2.23
package de.qytera.qtaf.testng.context;

import com.google.inject.Injector;
import de.qytera.qtaf.core.QtafFactory;
import de.qytera.qtaf.core.QtafInitializer;
import de.qytera.qtaf.core.config.annotations.TestFeature;
import de.qytera.qtaf.core.config.entity.ConfigMap;
import de.qytera.qtaf.core.context.IQtafTestContext;
import de.qytera.qtaf.core.context.TestContextHelper;
import de.qytera.qtaf.core.guice.QtafInjector;
import de.qytera.qtaf.core.guice.QtafModule;
import de.qytera.qtaf.core.log.model.collection.TestFeatureLogCollection;
import de.qytera.qtaf.core.log.model.collection.TestScenarioLogCollection;
import de.qytera.qtaf.core.log.model.collection.TestSuiteLogCollection;
import de.qytera.qtaf.core.selenium.DriverFactory;
import de.qytera.qtaf.testng.event_listener.TestNGEventListener;
import de.qytera.qtaf.testng.event_listener.TestNGInvocationEventListener;
import org.openqa.selenium.JavascriptExecutor;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.support.PageFactory;
import org.testng.annotations.Guice;
import org.testng.annotations.Listeners;

/**
 * Test context works as a factory class and state manager for test classes.
 * It provides information about the current test class like information about
 * annotations and holds objects needed during test executing (i.e. loggers, etc).
 */
@Listeners({TestNGEventListener.class, TestNGInvocationEventListener.class})
@Guice(modules = {QtafModule.class})
public abstract class QtafTestNGContext implements IQtafTestContext, AssertionContext {

    /**
     * Holds values from JSON configuration files.
     */
    public static ConfigMap config;

    /**
     * Web driver instance (chrome, firefox, ...).
     */
    public static WebDriver driver = null;

    /**
     * JavaScript executor.
     */
    protected static JavascriptExecutor js = null;

    /**
     * Global log collection that holds all log messages from the tests.
     */
    public static final TestSuiteLogCollection testSuiteLogCollection = QtafFactory.getTestSuiteLogCollection();

    /**
     * Page object annotation reference.
     */
    protected TestFeature testFeatureAnnotation;

    /**
     * Log collection for all methods in this class.
     */
    protected TestFeatureLogCollection testFeatureLogCollection = null;

    /**
     * Log collection for the current method.
     */
    protected TestScenarioLogCollection logCollection;

    /**
     * Flag for controlling if test context has been initialized.
     */
    private boolean isInitialized = false;

    /**
     * Placeholder for missing messages in assertions.
     */
    protected String NO_MESSAGE = "";

    /**
     * Guice injector.
     */
    protected static final Injector injector = QtafInjector.getInstance();

    /**
     * Constructor.
     */
    protected QtafTestNGContext() {
        initialize();
    }

    /**
     * Initialize test context.
     */
    @Override
    public QtafTestNGContext initialize() {
        if (isInitialized) {
            return this;
        }

        // Initialize the framework
        QtafInitializer.initialize();

        // Get configuration
        config = QtafFactory.getConfiguration();

        // Initialize driver
        driver = QtafFactory.getWebDriver();
        js = (JavascriptExecutor) driver;

        // Get Test feature annotation
        testFeatureAnnotation = this.getClass().getAnnotation(TestFeature.class);

        isInitialized = true;

        return this;
    }

    /**
     * Load class instance.
     *
     * @param context The current test context (pass 'this' for this argument)
     * @param c       The desired class you want to create an instance of
     * @param      the class type
     * @return Instance of the desired class
     */
    protected static  T load(IQtafTestContext context, Class c) {
        T pageObject = injector.getInstance(c);
        if (pageObject instanceof IQtafTestContext testContext) {
            testContext.setLogCollection(context.getLogCollection());
            testContext.initialize();
        }
        return pageObject;
    }

    /**
     * Load class instance.
     *
     * @param c   The desired class you want to create an instance of
     * @param  the class type
     * @return Instance of the desired class
     */
    protected  T load(Class c) {
        return load(this, c);
    }

    /**
     * Call the Selenium PageFactory initElements method on this instance.
     */
    protected void initElements() {
        PageFactory.initElements(driver, this);
    }

    /**
     * Restart browser.
     */
    @Override
    public void restartDriver() {
        driver = DriverFactory.getDriver(true);
    }

    /**
     * Execute JavaScript code.
     *
     * @param script JavaScript code
     */
    public void jsExec(String script) {
        js.executeScript(script);
    }

    /**
     * Execute JavaScript code.
     *
     * @param script JavaScript code
     * @param args   variables
     */
    public void jsExec(String script, Object... args) {
        js.executeScript(script, args);
    }

    /**
     * Get current log collection.
     *
     * @return log collection
     */
    @Override
    public TestScenarioLogCollection getLogCollection() {
        return logCollection;
    }

    /**
     * Set the current log collection.
     *
     * @param collection log collection
     * @return this
     */
    @Override
    public QtafTestNGContext setLogCollection(TestScenarioLogCollection collection) {
        this.logCollection = collection;
        return this;
    }

    /**
     * Add logger to all instance fields.
     */
    @Override
    public void addLoggerToFieldsRecursively() {
        TestContextHelper.addLoggerToFieldsRecursively(this);
    }
}