noraui.cucumber.interceptor.ConditionedInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of noraui Show documentation
Non-Regression Automation for User Interfaces
There is a newer version: 4.4.0
package noraui.cucumber.interceptor;

import java.lang.reflect.Method;
import java.util.List;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.log4j.Logger;

import noraui.cucumber.annotation.Conditioned;
import noraui.gherkin.GherkinStepCondition;
import noraui.utils.Context;
import noraui.utils.Messages;

public class ConditionedInterceptor implements MethodInterceptor {

    private static final String SKIPPED_DUE_TO_CONDITIONS = "SKIPPED_DUE_TO_CONDITIONS";
    private static Logger logger = Logger.getLogger(ConditionedInterceptor.class.getName());

    /**
     * {@inheritDoc}
     */
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        //
        Method m = invocation.getMethod();

        if (m.isAnnotationPresent(Conditioned.class)) {
            Object[] arg = invocation.getArguments();
            if (arg.length > 0 && arg[arg.length - 1] instanceof List && !((List) arg[arg.length - 1]).isEmpty() && ((List) arg[arg.length - 1]).get(0) instanceof GherkinStepCondition) {
                List conditions = (List) arg[arg.length - 1];
                displayMessageAtTheBeginningOfMethod(m.getName(), conditions);
                if (!checkConditions(conditions)) {
                    Context.getCurrentScenario().write(Messages.getMessage(SKIPPED_DUE_TO_CONDITIONS));
                    return Void.TYPE;
                }
            }
        }

        logger.debug("NORAUI ConditionedInterceptor invoke method " + invocation.getMethod());
        return invocation.proceed();
    }

    /**
     * Display a message at the beginning of method.
     *
     * @param methodName
     *            is the name of method for logs
     * @param conditions
     *            list of 'expected' values condition and 'actual' values ({@link noraui.gherkin.GherkinStepCondition}).
     */
    private void displayMessageAtTheBeginningOfMethod(String methodName, List conditions) {
        logger.debug(String.format("%s with %d contition(s)", methodName, conditions.size()));
        displayConditionsAtTheBeginningOfMethod(conditions);
    }

    /**
     * Display a message at the beginning of method.
     *
     * @param methodName
     *            is the name of method for logs
     * @param field
     *            is the value of parameter
     * @param conditions
     *            list of 'expected' values condition and 'actual' values ({@link noraui.gherkin.GherkinStepCondition}).
     */
    protected void displayMessageAtTheBeginningOfMethod(String methodName, String field, List conditions) {
        logger.debug(String.format("%s: %s with %d contition(s)", methodName, field, conditions.size()));
        displayConditionsAtTheBeginningOfMethod(conditions);
    }

    /**
     * Display all conditions at the beginning of method.
     *
     * @param conditions
     *            list of 'expected' values condition and 'actual' values ({@link noraui.gherkin.GherkinStepCondition}).
     */
    private void displayConditionsAtTheBeginningOfMethod(List conditions) {
        int i = 0;
        for (GherkinStepCondition gherkinCondition : conditions) {
            i++;
            logger.debug(String.format("  expected contition N°%d=%s", i, gherkinCondition.getExpected()));
            logger.debug(String.format("  actual   contition N°%d=%s", i, gherkinCondition.getActual()));
        }
    }

    /**
     * Check all conditions.
     *
     * @param conditions
     *            list of 'expected' values condition and 'actual' values ({@link noraui.gherkin.GherkinStepCondition}).
     * @return a boolean
     */
    public boolean checkConditions(List conditions) {
        for (GherkinStepCondition gherkinCondition : conditions) {
            logger.debug("checkConditions " + gherkinCondition.getActual() + " in context is " + Context.getValue(gherkinCondition.getActual()));
            if (!gherkinCondition.checkCondition()) {
                return false;
            }
        }
        return true;
    }

}