All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
cucumber.runtime.formatter.PrettyFormatter Maven / Gradle / Ivy
package cucumber.runtime.formatter;
import cucumber.api.Result;
import cucumber.api.TestCase;
import cucumber.api.TestStep;
import cucumber.api.event.EventHandler;
import cucumber.api.event.EventPublisher;
import cucumber.api.event.TestCaseStarted;
import cucumber.api.event.TestRunFinished;
import cucumber.api.event.TestSourceRead;
import cucumber.api.event.TestStepFinished;
import cucumber.api.event.TestStepStarted;
import cucumber.api.event.WriteEvent;
import cucumber.api.formatter.ColorAware;
import cucumber.api.formatter.Formatter;
import cucumber.api.formatter.NiceAppendable;
import cucumber.runtime.Argument;
import cucumber.util.FixJava;
import cucumber.util.Mapper;
import gherkin.ast.Background;
import gherkin.ast.Examples;
import gherkin.ast.Feature;
import gherkin.ast.ScenarioDefinition;
import gherkin.ast.ScenarioOutline;
import gherkin.ast.Step;
import gherkin.ast.Tag;
import gherkin.pickles.PickleTag;
import java.util.List;
final class PrettyFormatter implements Formatter, ColorAware {
private static final String SCENARIO_INDENT = " ";
private static final String STEP_INDENT = " ";
private static final String EXAMPLES_INDENT = " ";
private final TestSourcesModel testSources = new TestSourcesModel();
private final NiceAppendable out;
private Formats formats;
private String currentFeatureFile;
private TestCase currentTestCase;
private ScenarioOutline currentScenarioOutline;
private Examples currentExamples;
private int locationIndentation;
private Mapper tagNameMapper = new Mapper() {
@Override
public String map(Tag tag) {
return tag.getName();
}
};
private Mapper pickleTagNameMapper = new Mapper() {
@Override
public String map(PickleTag pickleTag) {
return pickleTag.getName();
}
};
private EventHandler testSourceReadHandler = new EventHandler() {
@Override
public void receive(TestSourceRead event) {
handleTestSourceRead(event);
}
};
private EventHandler caseStartedHandler= new EventHandler() {
@Override
public void receive(TestCaseStarted event) {
handleTestCaseStarted(event);
}
};
private EventHandler stepStartedHandler = new EventHandler() {
@Override
public void receive(TestStepStarted event) {
handleTestStepStarted(event);
}
};
private EventHandler stepFinishedHandler = new EventHandler() {
@Override
public void receive(TestStepFinished event) {
handleTestStepFinished(event);
}
};
private EventHandler writeEventhandler = new EventHandler() {
@Override
public void receive(WriteEvent event) {
handleWrite(event);
}
};
private EventHandler runFinishedHandler = new EventHandler() {
@Override
public void receive(TestRunFinished event) {
finishReport();
}
};
@SuppressWarnings("WeakerAccess") // Used by PluginFactory
public PrettyFormatter(Appendable out) {
this.out = new NiceAppendable(out);
this.formats = new AnsiFormats();
}
@Override
public void setEventPublisher(EventPublisher publisher) {
publisher.registerHandlerFor(TestSourceRead.class, testSourceReadHandler);
publisher.registerHandlerFor(TestCaseStarted.class, caseStartedHandler);
publisher.registerHandlerFor(TestStepStarted.class, stepStartedHandler);
publisher.registerHandlerFor(TestStepFinished.class, stepFinishedHandler);
publisher.registerHandlerFor(WriteEvent.class, writeEventhandler);
publisher.registerHandlerFor(TestRunFinished.class, runFinishedHandler);
}
@Override
public void setMonochrome(boolean monochrome) {
if (monochrome) {
formats = new MonochromeFormats();
} else {
formats = new AnsiFormats();
}
}
private void handleTestSourceRead(TestSourceRead event) {
testSources.addTestSourceReadEvent(event.uri, event);
}
private void handleTestCaseStarted(TestCaseStarted event) {
handleStartOfFeature(event);
handleScenarioOutline(event);
if (testSources.hasBackground(currentFeatureFile, event.testCase.getLine())) {
printBackground(event.testCase);
currentTestCase = event.testCase;
} else {
printScenarioDefinition(event.testCase);
}
}
private void handleTestStepStarted(TestStepStarted event) {
if (!event.testStep.isHook()) {
if (isFirstStepAfterBackground(event.testStep)) {
printScenarioDefinition(currentTestCase);
currentTestCase = null;
}
}
}
private void handleTestStepFinished(TestStepFinished event) {
TestStep testStep = event.testStep;
if (!testStep.isHook()) {
printStep(testStep, event.result);
}
printError(event.result);
}
private void handleWrite(WriteEvent event) {
out.println(event.text);
}
private void finishReport() {
out.close();
}
private void handleStartOfFeature(TestCaseStarted event) {
if (currentFeatureFile == null || !currentFeatureFile.equals(event.testCase.getUri())) {
if (currentFeatureFile != null) {
out.println();
}
currentFeatureFile = event.testCase.getUri();
printFeature(currentFeatureFile);
}
}
private void handleScenarioOutline(TestCaseStarted event) {
TestSourcesModel.AstNode astNode = testSources.getAstNode(currentFeatureFile, event.testCase.getLine());
if (TestSourcesModel.isScenarioOutlineScenario(astNode)) {
ScenarioOutline scenarioOutline = (ScenarioOutline)TestSourcesModel.getScenarioDefinition(astNode);
if (currentScenarioOutline == null || !currentScenarioOutline.equals(scenarioOutline)) {
currentScenarioOutline = scenarioOutline;
printScenarioOutline(currentScenarioOutline);
}
if (currentExamples == null || !currentExamples.equals(astNode.parent.node)) {
currentExamples = (Examples)astNode.parent.node;
printExamples(currentExamples);
}
} else {
currentScenarioOutline = null;
currentExamples = null;
}
}
private void printScenarioOutline(ScenarioOutline scenarioOutline) {
out.println();
printTags(scenarioOutline.getTags(), SCENARIO_INDENT);
out.println(SCENARIO_INDENT + getScenarioDefinitionText(scenarioOutline) + " " + getLocationText(currentFeatureFile, scenarioOutline.getLocation().getLine()));
printDescription(scenarioOutline.getDescription());
for (Step step : scenarioOutline.getSteps()) {
out.println(STEP_INDENT + formats.get("skipped").text(step.getKeyword() + step.getText()));
}
}
private void printExamples(Examples examples) {
out.println();
printTags(examples.getTags(), EXAMPLES_INDENT);
out.println(EXAMPLES_INDENT + examples.getKeyword() + ": " + examples.getName());
printDescription(examples.getDescription());
}
private void printStep(TestStep testStep, Result result) {
String keyword = getStepKeyword(testStep);
String stepText = testStep.getStepText();
String locationPadding = createPaddingToLocation(STEP_INDENT, keyword + stepText);
String formattedStepText = formatStepText(keyword, stepText, formats.get(result.getStatus().lowerCaseName()), formats.get(result.getStatus().lowerCaseName() + "_arg"), testStep.getDefinitionArgument());
out.println(STEP_INDENT + formattedStepText + locationPadding + getLocationText(testStep.getCodeLocation()));
}
String formatStepText(String keyword, String stepText, Format textFormat, Format argFormat, List arguments) {
int beginIndex = 0;
StringBuilder result = new StringBuilder(textFormat.text(keyword));
for (Argument argument : arguments) {
// can be null if the argument is missing.
if (argument.getOffset() != null) {
int argumentOffset = argument.getOffset();
// a nested argument starts before the enclosing argument ends; ignore it when formatting
if (argumentOffset < beginIndex ) {
continue;
}
String text = stepText.substring(beginIndex, argumentOffset);
result.append(textFormat.text(text));
}
// val can be null if the argument isn't there, for example @And("(it )?has something")
if (argument.getVal() != null) {
result.append(argFormat.text(argument.getVal()));
// set beginIndex to end of argument
beginIndex = argument.getOffset() + argument.getVal().length();
}
}
if (beginIndex != stepText.length()) {
String text = stepText.substring(beginIndex, stepText.length());
result.append(textFormat.text(text));
}
return result.toString();
}
private String getScenarioDefinitionText(ScenarioDefinition definition) {
return definition.getKeyword() + ": " + definition.getName();
}
private String getLocationText(String file, int line) {
return getLocationText(file + ":" + line);
}
private String getLocationText(String location) {
return formats.get("comment").text("# " + location);
}
private StringBuffer stepText(TestStep testStep) {
String keyword = getStepKeyword(testStep);
return new StringBuffer(keyword + testStep.getStepText());
}
private String getStepKeyword(TestStep testStep) {
TestSourcesModel.AstNode astNode = testSources.getAstNode(currentFeatureFile, testStep.getStepLine());
if (astNode != null) {
Step step = (Step) astNode.node;
return step.getKeyword();
} else {
return "";
}
}
private boolean isFirstStepAfterBackground(TestStep testStep) {
return currentTestCase != null && !isBackgroundStep(testStep);
}
private boolean isBackgroundStep(TestStep testStep) {
TestSourcesModel.AstNode astNode = testSources.getAstNode(currentFeatureFile, testStep.getStepLine());
if (astNode != null) {
return TestSourcesModel.isBackgroundStep(astNode);
}
return false;
}
private void printFeature(String path) {
Feature feature = testSources.getFeature(path);
printTags(feature.getTags());
out.println(feature.getKeyword() + ": " + feature.getName());
printDescription(feature.getDescription());
}
private void printTags(List tags) {
printTags(tags, "");
}
private void printTags(List tags, String indent) {
if (!tags.isEmpty()) {
out.println(indent + FixJava.join(FixJava.map(tags, tagNameMapper), " "));
}
}
private void printPickleTags(List tags, String indent) {
if (!tags.isEmpty()) {
out.println(indent + FixJava.join(FixJava.map(tags, pickleTagNameMapper), " "));
}
}
private void printDescription(String description) {
if (description != null) {
out.println(description);
}
}
private void printBackground(TestCase testCase) {
TestSourcesModel.AstNode astNode = testSources.getAstNode(currentFeatureFile, testCase.getLine());
if (astNode != null) {
Background background = TestSourcesModel.getBackgroundForTestCase(astNode);
String backgroundText = getScenarioDefinitionText(background);
boolean useBackgroundSteps = true;
calculateLocationIndentation(SCENARIO_INDENT + backgroundText, testCase.getTestSteps(), useBackgroundSteps);
String locationPadding = createPaddingToLocation(SCENARIO_INDENT, backgroundText);
out.println();
out.println(SCENARIO_INDENT + backgroundText + locationPadding + getLocationText(currentFeatureFile, background.getLocation().getLine()));
printDescription(background.getDescription());
}
}
private void printScenarioDefinition(TestCase testCase) {
ScenarioDefinition scenarioDefinition = testSources.getScenarioDefinition(currentFeatureFile, testCase.getLine());
String definitionText = scenarioDefinition.getKeyword() + ": " + testCase.getName();
calculateLocationIndentation(SCENARIO_INDENT + definitionText, testCase.getTestSteps());
String locationPadding = createPaddingToLocation(SCENARIO_INDENT, definitionText);
out.println();
printPickleTags(testCase.getTags(), SCENARIO_INDENT);
out.println(SCENARIO_INDENT + definitionText + locationPadding + getLocationText(currentFeatureFile, testCase.getLine()));
printDescription(scenarioDefinition.getDescription());
}
private void printError(Result result) {
if (result.getError() != null) {
out.println(" " + formats.get(result.getStatus().lowerCaseName()).text(result.getErrorMessage()));
}
}
private void calculateLocationIndentation(String definitionText, List testSteps) {
boolean useBackgroundSteps = false;
calculateLocationIndentation(definitionText, testSteps, useBackgroundSteps);
}
private void calculateLocationIndentation(String definitionText, List testSteps, boolean useBackgroundSteps) {
int maxTextLength = definitionText.length();
for (TestStep step : testSteps) {
if (step.isHook()) {
continue;
}
if (isBackgroundStep(step) == useBackgroundSteps) {
StringBuffer stepText = stepText(step);
maxTextLength = Math.max(maxTextLength, STEP_INDENT.length() + stepText.length());
}
}
locationIndentation = maxTextLength + 1;
}
private String createPaddingToLocation(String indent, String text) {
StringBuffer padding = new StringBuffer();
for (int i = indent.length() + text.length(); i < locationIndentation; ++i) {
padding.append(' ');
}
return padding.toString();
}
}
