com.aventstack.extentreports.GherkinKeyword Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extentreports Show documentation
ExtentReports library
There is a newer version: 5.1.2
package com.aventstack.extentreports;

import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.logging.Level;
import java.util.logging.Logger;

import com.aventstack.extentreports.gherkin.GherkinDialect;
import com.aventstack.extentreports.gherkin.GherkinDialectManager;
import com.aventstack.extentreports.gherkin.model.Asterisk;
import com.aventstack.extentreports.gherkin.model.IGherkinFormatterModel;

import freemarker.template.utility.StringUtil;
import lombok.Getter;

/**
 * Allows {@link IGherkinFormatterModel} to be returned by using a name, from
 * the below gherkin model classes:
 * 
 * 
 * {@link com.aventstack.extentreports.gherkin.model.Feature}
 * {@link com.aventstack.extentreports.gherkin.model.Background}
 * {@link com.aventstack.extentreports.gherkin.model.Scenario}
 * {@link com.aventstack.extentreports.gherkin.model.Given}
 * {@link com.aventstack.extentreports.gherkin.model.When}
 * {@link com.aventstack.extentreports.gherkin.model.Then}
 * {@link com.aventstack.extentreports.gherkin.model.And}
 * {@link com.aventstack.extentreports.gherkin.model.But}
 * 
 * 
 * 
 * Example:
 * 
 * 
 *  * extent.createTest(new GherkinKeyword("Feature"), "bddTest");
 * test.createNode(new GherkinKeyword("Scenario"), bddNode");
 * 
 * 
 * @see IGherkinFormatterModel
 */
@Getter
public class GherkinKeyword {
    private static final Logger logger = Logger.getLogger(GherkinKeyword.class.getName());

    private Class clazz = IGherkinFormatterModel.class;
    private IGherkinFormatterModel keyword;

    public GherkinKeyword(String gk) throws ClassNotFoundException {
        GherkinDialect dialect = null;
        String apiKeyword = StringUtil.capitalize(gk.trim());
        String refPath = clazz.getPackage().getName();

        try {
            apiKeyword = apiKeyword.equals("*") ? Asterisk.class.getSimpleName() : apiKeyword;
            dialect = GherkinDialectManager.getDialect();
            if (dialect != null
                    && !dialect.getLanguage().equalsIgnoreCase(GherkinDialectManager.getDefaultLanguage())) {
                apiKeyword = null;
                Map> keywords = dialect.getKeywords();
                for (Entry> key : keywords.entrySet()) {
                    apiKeyword = key.getValue().stream()
                            .filter(x -> x.trim().equalsIgnoreCase(gk.trim()))
                            .findAny()
                            .map(x -> StringUtil.capitalize(x))
                            .orElse(null);
                    if (apiKeyword != null) {
                        apiKeyword = StringUtil.capitalize(key.getKey());
                        break;
                    }
                }
            }
            if (apiKeyword == null)
                throw new GherkinKeywordNotFoundException("Keyword cannot be found. " +
                        "You supplied: " + gk + " for dialect " + dialect + " which couldn't be mapped.");
            if (apiKeyword.toLowerCase().contains("scenario") && apiKeyword.toLowerCase().contains("outline"))
                apiKeyword = "ScenarioOutline";
            String clazzName = refPath + "." + apiKeyword.replace(" ", "");
            Class c = Class.forName(clazzName);
            keyword = (IGherkinFormatterModel) c.newInstance();
        } catch (InstantiationException | IllegalAccessException e) {
            logger.log(Level.SEVERE, "", e);
        }
    }
}