com.intuit.karate.core.ScenarioOutline Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karate-core Show documentation
The newest version!
/*
 * The MIT License
 *
 * Copyright 2022 Karate Labs Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.intuit.karate.core;

import java.util.ArrayList;
import java.util.List;

/**
 * @author pthomas3
 */
public class ScenarioOutline {
    
    private final Feature feature;
    private final FeatureSection section;
    
    private int line;
    private List tags;
    private String name;
    private String description;
    private List steps;
    private List examplesTables;
    
    public ScenarioOutline(Feature feature, FeatureSection section) {
        this.feature = feature;
        this.section = section;
    }
    
    public Scenario toScenario(String dynamicExpression, int exampleIndex, int updateLine, List tagsForExamples) {
        Scenario s = new Scenario(feature, section, exampleIndex);
        s.setName(name);
        s.setDescription(description);
        s.setLine(updateLine);
        s.setDynamicExpression(dynamicExpression);
        if (tags != null || tagsForExamples != null) {
            List temp = new ArrayList();
            if (tags != null) {
                temp.addAll(tags);
            }
            if (tagsForExamples != null) {
                temp.addAll(tagsForExamples);
            }
            s.setTags(temp);
        }
        List temp = new ArrayList(steps.size());
        s.setSteps(temp);
        for (Step original : steps) {
            Step step = new Step(s, original.getIndex());
            temp.add(step);
            step.setLine(original.getLine());
            step.setEndLine(original.getEndLine());
            step.setPrefix(original.getPrefix());
            step.setText(original.getText());
            step.setDocString(original.getDocString());
            step.setTable(original.getTable());
            step.setComments(original.getComments());
        }
        return s;
    }
    
    public List getScenarios() {
        return this.getScenarios(null);
    }
    
    public List getScenarios(FeatureRuntime fr) {
        List list = new ArrayList();
        boolean examplesHaveTags = examplesTables.stream().anyMatch(t -> !t.getTags().isEmpty());
        for (ExamplesTable examples : examplesTables) {
            boolean selectedForExecution = false;
            if (fr != null && examplesHaveTags && fr.caller.isNone()) {
                // getting examples in the context of an execution
                // if the examples do not have any tagged example, do not worry about selecting
                Tags tableTags = Tags.merge(fr.featureCall.feature.getTags(), tags, examples.getTags());
                boolean executeForTable = tableTags.evaluate(fr.suite.tagSelector, fr.suite.env);
                if (executeForTable) {
                    selectedForExecution = true;
                }
            } else {
                selectedForExecution = true;
            }
            if (selectedForExecution) {
                Table table = examples.getTable();
                if (table.isDynamic()) {
                    Scenario scenario = toScenario(table.getDynamicExpression(), -1, table.getLineNumberForRow(0), examples.getTags());
                    list.add(scenario);
                } else {
                    int rowCount = table.getRows().size();
                    for (int i = 1; i < rowCount; i++) { // don't include header row
                        int exampleIndex = i - 1; // next line will set exampleIndex on scenario
                        Scenario scenario = toScenario(null, exampleIndex, table.getLineNumberForRow(i), examples.getTags());
                        scenario.setExampleData(table.getExampleData(exampleIndex)); // and we set exampleData here
                        list.add(scenario);
                        for (String key : table.getKeys()) {
                            scenario.replace("<" + key + ">", table.getValueAsString(key, i));
                        }
                    }
                }
            }
        }
        return list;
    }
    
    public FeatureSection getSection() {
        return section;
    }
    
    public int getLine() {
        return line;
    }
    
    public void setLine(int line) {
        this.line = line;
    }
    
    public List getTags() {
        return tags;
    }
    
    public void setTags(List tags) {
        this.tags = tags;
    }
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
    
    public String getDescription() {
        return description;
    }
    
    public void setDescription(String description) {
        this.description = description;
    }
    
    public List getSteps() {
        return steps;
    }
    
    public void setSteps(List steps) {
        this.steps = steps;
    }
    
    public List getExamplesTables() {
        return examplesTables;
    }
    
    public void setExamplesTables(List examplesTables) {
        this.examplesTables = examplesTables;
    }
    
}