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

Go to download
/*
 * The MIT License
 *
 * Copyright 2018 Intuit 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.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 *
 * @author pthomas3
 */
public class Scenario {

    private final Feature feature;
    private final FeatureSection section;
    private final int exampleIndex;
    
    private int line;
    private List tags;
    private String name;
    private String description;
    private List steps;
    private Map exampleData;
    private String dynamicExpression;

    public Scenario(Feature feature, FeatureSection section, int exampleIndex) {
        this.feature = feature;
        this.section = section;
        this.exampleIndex = exampleIndex;
    }
    
    public boolean isEqualTo(Scenario other) {
        return other.section.getIndex() == section.getIndex() && other.exampleIndex == exampleIndex;
    }

    public String getNameAndDescription() {
        String temp = "";
        if (name != null) {
            temp = temp + name;
        }
        if (description != null) {
            if (!temp.isEmpty()) {
                temp = temp + " ";
            }
            temp = temp + description;
        }
        return temp;
    }

    public String getRefIdAndName() {
        if (name == null) {
            return getRefId();
        } else {
            return getRefId() + " " + name;
        }
    }

    // only called for dynamic scenarios
    public Scenario copy(int exampleIndex) {
        Scenario s = new Scenario(feature, section, exampleIndex);
        s.name = name;
        s.description = description;
        s.tags = tags;
        s.line = line;
        s.dynamicExpression = dynamicExpression;
        s.steps = new ArrayList(steps.size());
        for (Step step : steps) {
            Step temp = new Step(s, step.getIndex());
            s.steps.add(temp);
            temp.setLine(step.getLine());
            temp.setEndLine(step.getEndLine());
            temp.setPrefix(step.getPrefix());
            temp.setText(step.getText());
            temp.setDocString(step.getDocString());
            temp.setTable(step.getTable());
        }
        return s;
    }

    public void replace(String token, String value) {
        if (value == null) {
            // this can happen for a dynamic scenario outline !
            // give up trying a cucumber-style placeholder sub
            // user should be fine with karate-style plain-old variables
            return;
        }
        name = name.replace(token, value);
        for (Step step : steps) {
            String text = step.getText();
            step.setText(text.replace(token, value));
            String docString = step.getDocString();
            if (docString != null) {
                step.setDocString(docString.replace(token, value));
            }
            Table table = step.getTable();
            if (table != null) {
                step.setTable(table.replace(token, value));
            }
        }
    }

    public Step getStepByLine(int line) {
        for (Step step : getStepsIncludingBackground()) {
            if (step.getLine() == line) {
                return step;
            }
        }
        return null;
    }

    public String getRefId() {
        int num = section.getIndex() + 1;
        String meta = "[" + num;
        if (exampleIndex != -1) {
            meta = meta + "." + (exampleIndex + 1);
        }
        return meta + ":" + line + "]";
    }

    public String getDebugInfo() {
        return feature + ":" + line;
    }

    public String getUniqueId() {
        String id = feature.getResource().getPackageQualifiedName() + "_" + (section.getIndex() + 1);
        return exampleIndex == -1 ? id : id + "_" + (exampleIndex + 1);
    }

    public List getBackgroundSteps() {
        return feature.isBackgroundPresent() ? feature.getBackground().getSteps() : Collections.EMPTY_LIST;
    }

    public List getStepsIncludingBackground() {
        List background = feature.isBackgroundPresent() ? feature.getBackground().getSteps() : null;
        int count = background == null ? steps.size() : steps.size() + background.size();
        List temp = new ArrayList(count);
        if (background != null) {
            temp.addAll(background);
        }
        temp.addAll(steps);
        return temp;
    }

    private Tags tagsEffective; // cache

    public Tags getTagsEffective() {
        if (tagsEffective == null) {
            tagsEffective = Tags.merge(feature.getTags(), tags);
        }
        return tagsEffective;
    }

    public FeatureSection getSection() {
        return section;
    }

    public Feature getFeature() {
        return feature;
    }

    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 boolean isOutlineExample() {
        return exampleIndex != -1;
    }

    public boolean isDynamic() {
        return dynamicExpression != null;
    }

    public String getDynamicExpression() {
        return dynamicExpression;
    }

    public void setDynamicExpression(String dynamicExpression) {
        this.dynamicExpression = dynamicExpression;
    }

    public Map getExampleData() {
        return exampleData;
    }

    public void setExampleData(Map exampleData) {
        this.exampleData = exampleData;
    }

    public int getExampleIndex() {
        return exampleIndex;
    }

    @Override
    public String toString() {
        return feature.toString() + getRefId();
    }

    public URI getUriToLineNumber() {
        return URI.create(feature.getResource().getUri() + "?line=" + line);
    }

}