com.github.noraui.data.gherkin.InputGherkinDataProvider 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
/**
 * NoraUi is licensed under the license GNU AFFERO GENERAL PUBLIC LICENSE
 *
 * @author Nicolas HALLOUIN
 * @author Stéphane GRILLON
 */
package com.github.noraui.data.gherkin;

import java.util.ArrayList;
import java.util.Arrays;

import org.slf4j.Logger;

import com.github.noraui.data.CommonDataProvider;
import com.github.noraui.data.DataInputProvider;
import com.github.noraui.exception.TechnicalException;
import com.github.noraui.exception.data.EmptyDataFileContentException;
import com.github.noraui.gherkin.GherkinFactory;
import com.github.noraui.log.annotation.Loggable;
import com.github.noraui.model.Model;
import com.github.noraui.utils.Messages;

/**
 * This DataInputProvider can be used if you want to provide Gherkin example by
 * your own. Scenario initiator inserts will be skipped.
 */
@Loggable
public class InputGherkinDataProvider extends CommonDataProvider implements DataInputProvider {

    static Logger log;

    private static final String GHERKIN_INPUT_DATA_PROVIDER_USED = "GHERKIN_INPUT_DATA_PROVIDER_USED";

    private String[] examples = new String[] {};

    public InputGherkinDataProvider() {
        log.info(Messages.getMessage(GHERKIN_INPUT_DATA_PROVIDER_USED));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void prepare(String scenario) throws TechnicalException {
        examples = GherkinFactory.getExamples(scenario);
        try {
            initColumns();
        } catch (final EmptyDataFileContentException e) {
            log.error(Messages.getMessage(TechnicalException.TECHNICAL_ERROR_MESSAGE_DATA_IOEXCEPTION), e);
            System.exit(-1);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int getNbLines() throws TechnicalException {
        return examples.length;
    }

    /**
     * Gets prepared Gherkin examples.
     *
     * @return an array of examples
     */
    public String[] getExamples() {
        return examples;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String readValue(String column, int line) throws TechnicalException {
        if (examples.length > 0) {
            final String[] lineContent = readLine(line, true);
            final int i = columns.indexOf(column) + 1;
            if (i > 0 && null != lineContent && lineContent.length > i) {
                return lineContent[i];
            } else {
                return "";
            }

        }
        return "";
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String[] readLine(int line, boolean readResult) throws TechnicalException {
        if (examples.length > 0 && examples.length > line) {
            final String[] lineContent = examples[line].split("\\|", -1);

            // Means that current line has no content (#END)
            if (lineContent.length == 1) {
                return null;
            }

            // Means that current line has content but is not well-formed
            if (lineContent.length < 3) {
                throw new TechnicalException(Messages.getMessage(TechnicalException.TECHNICAL_EXPECTED_AT_LEAST_AN_ID_COLUMN_IN_EXAMPLES));
            }

            return Arrays.copyOfRange(lineContent, 2, readResult ? lineContent.length : lineContent.length - 1);
        }
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Class getModel(String modelPackages) throws TechnicalException {
        return null;
    }

    private void initColumns() throws EmptyDataFileContentException {
        columns = new ArrayList<>();
        if (examples.length > 1) {
            final String[] cols = examples[0].split("\\|", -1);
            for (int i = 1; i < cols.length - 1; i++) {
                columns.addAll(Arrays.asList(cols).subList(1, cols.length - 1));
            }
        } else {
            throw new EmptyDataFileContentException(Messages.getMessage(EmptyDataFileContentException.EMPTY_DATA_FILE_CONTENT_ERROR_MESSAGE));
        }
        if (columns.size() < 2) {
            throw new EmptyDataFileContentException(Messages.getMessage(EmptyDataFileContentException.EMPTY_DATA_FILE_CONTENT_ERROR_MESSAGE));
        }
        resultColumnName = columns.get(columns.size() - 1);
        if (!isResultColumnNameAuthorized(resultColumnName)) {
            resultColumnName = Messages.getMessage(ResultColumnNames.RESULT_COLUMN_NAME);
        }
    }

}