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

Show more of this group Show more artifacts with this name
Show all versions of karate-core Show documentation
There is a newer version: 1.4.1
/*
 * 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 com.intuit.karate.FileUtils;
import com.intuit.karate.Resource;
import com.intuit.karate.StringUtils;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;

/**
 *
 * @author pthomas3
 */
public class Feature {
    
    public static final String KEYWORD = "Feature";
    
    private final Resource resource;
    
    private int line;
    private List tags;
    private String name;
    private String description;
    private Background background;
    private List sections = new ArrayList();
    
    private List lines;
    
    private String callTag;
    private String callName;
    
    public Feature(Resource resource) {
        this.resource = resource;
    }
    
    public boolean isBackgroundPresent() {
        return background != null && background.getSteps() != null;
    }
    
    public List getScenarios() {
        List scenarios = new ArrayList();
        for (FeatureSection section : sections) {
            if (section.isOutline()) {
                scenarios.addAll(section.getScenarioOutline().getScenarios());
            } else {
                scenarios.add(section.getScenario());
            }
        }
        return scenarios;
    }
    
    public void addSection(FeatureSection section) {
        section.setIndex(sections.size());
        sections.add(section);
    }    
    
    public FeatureSection getSection(int sectionIndex) {
        return sections.get(sectionIndex);
    }    
    
    public Scenario getScenario(int sectionIndex, int scenarioIndex) {
        FeatureSection section = getSection(sectionIndex);
        if (scenarioIndex == -1) {
            return section.getScenario();
        }
        ScenarioOutline outline = section.getScenarioOutline();
        return outline.getScenarios().get(scenarioIndex);
    } 
    
    public Step getStep(int sectionIndex, int scenarioIndex, int stepIndex) {
        Scenario scenario = getScenario(sectionIndex, scenarioIndex);
        return scenario.getSteps().get(stepIndex);
    }    
    
    public Feature replaceStep(Step step, String text) {
        return replaceLines(step.getLine(), step.getEndLine(), text);
    }    
    
    public Feature replaceLines(int start, int end, String text) {
        for (int i = start - 1; i < end - 1; i++) {
            lines.remove(start);
        }
        lines.set(start - 1, text);
        return replaceText(getText());
    }    
    
    public Feature addLine(int index, String line) {
        lines.add(index, line);
        return replaceText(getText());
    }    
    
    public String getText() {
        initLines();
        return joinLines();
    }
    
    public void initLines() {
        if (lines == null) {
            if (resource != null) {
                lines = StringUtils.toStringLines(resource.toString());
            }
        }        
    }
    
    public String joinLines(int startLine, int endLine) {
        initLines();
        StringBuilder sb = new StringBuilder();
        if (endLine > lines.size()) {
            endLine = lines.size();
        }
        for (int i = startLine; i < endLine; i++) {
            String temp = lines.get(i);
            sb.append(temp).append("\n");
        }
        return sb.toString();
    }    
    
    public String joinLines() {
        int lineCount = lines.size();
        return joinLines(0, lineCount);
    }    

    public Feature replaceText(String text) {
        return FeatureParser.parseText(this, text);
    }
    
    public String getCallTag() {
        return callTag;
    }

    public void setCallTag(String callTag) {
        this.callTag = callTag;
    }

    public String getCallName() {
        return callName;
    }

    public void setCallName(String callName) {
        this.callName = callName;
    }    

    public List getLines() {
        return lines;
    }

    public void setLines(List lines) {
        this.lines = lines;
    }          

    public Resource getResource() {
        return resource;
    }        

    public Path getPath() {
        return resource.getPath();
    }

    public String getRelativePath() {
        return resource.getRelativePath();
    }
        
    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 Background getBackground() {
        return background;
    }

    public void setBackground(Background background) {
        this.background = background;
    }

    public List getSections() {
        return sections;
    }

    public void setSections(List sections) {
        this.sections = sections;
    }
    
}