sft.report.HtmlReport Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of SimpleFunctionalTest Show documentation
Show all versions of SimpleFunctionalTest Show documentation
A JUnit extension to easily adopt functional testing and acceptance testing
/*******************************************************************************
* Copyright (c) 2013, 2014 Sylvain Lézier.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Sylvain Lézier - initial implementation
*******************************************************************************/
package sft.report;
import sft.ContextHandler;
import sft.DefaultConfiguration;
import sft.Fixture;
import sft.FixtureCall;
import sft.Report;
import sft.Scenario;
import sft.UseCase;
import sft.decorators.Decorator;
import sft.decorators.NullDecorator;
import sft.result.ContextResult;
import sft.result.FixtureCallResult;
import sft.result.Issue;
import sft.result.ScenarioResult;
import sft.result.UseCaseResult;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
public class HtmlReport extends Report {
public static final String HTML_DEPENDENCIES_FOLDER = "sft-html-default";
public final RelativeHtmlPathResolver pathResolver;
public String useCaseTemplate =
"\n" +
" \n" +
" @@@useCase.name@@@ \n" +
"@@@useCase.css@@@" +
"@@@useCase.js@@@" +
" \n" +
" \n" +
" \n" +
" \n" +
" \n" +
" @@@useCase.name@@@
\n" +
" \n" +
"@@@useCaseCommentTemplate@@@" +
" \n" +
"@@@beforeUseCaseTemplate@@@" +
"@@@scenarioTemplates@@@" +
"@@@afterUseCaseTemplate@@@" +
"@@@relatedUseCasesTemplates@@@" +
" \n" +
" \n" +
"";
public String useCaseCommentTemplate =
" \n" +
"@@@comment.text@@@" +
" \n";
public String beforeUseCaseTemplate =
" \n" +
" \n" +
"@@@contextInstructionTemplates@@@" +
" \n" +
"@@@exceptionTemplate@@@" +
" \n";
public String scenarioTemplate =
" \n" +
" \n" +
" @@@scenario.name@@@
\n" +
" \n" +
"@@@scenarioCommentTemplate@@@" +
"@@@beforeScenarioTemplate@@@" +
" \n" +
"@@@scenarioInstructionTemplates@@@" +
" \n" +
"@@@afterScenarioTemplate@@@" +
"@@@displayedContextsTemplates@@@" +
"@@@exceptionTemplate@@@" +
" \n";
public String scenarioCommentTemplate =
" \n" +
"@@@comment.text@@@" +
" \n";
public String exceptionTemplate =
" \n" +
" \n" +
" @@@failure.className@@@: @@@failure.message@@@\n" +
" @@@failure.stacktrace@@@
\n" +
" \n" +
" \n";
public String beforeScenarioTemplate =
" \n" +
"@@@contextInstructionTemplates@@@" +
"
\n" +
" ";
public String scenarioInstructionTemplate =
" \n" +
" @@@instruction.text@@@" +
" \n";
public String afterScenarioTemplate =
" \n" +
"
\n " +
"@@@contextInstructionTemplates@@@" +
" ";
public String displayedContextsTemplate =
" \n" +
"@@@displayedContextTemplates@@@" +
" \n";
public String displayedContextTemplate =
" \n" +
"@@@displayedContext.text@@@" +
" \n";
public String afterUseCaseTemplate =
" \n" +
" \n" +
"@@@contextInstructionTemplates@@@" +
" \n" +
"@@@exceptionTemplate@@@" +
" \n";
public String contextInstructionTemplate =
" \n" +
" @@@instruction.text@@@\n" +
" \n";
public String relatedUseCasesTemplate =
" \n" +
" \n" +
" Related uses cases
\n" +
" \n" +
" \n" +
" \n" +
"@@@relatedUseCaseTemplates@@@" +
"
\n" +
" \n" +
" \n";
public String relatedUseCaseTemplate =
" \n" +
" @@@relatedUseCase.name@@@\n" +
" \n";
public String parameterTemplate = "@@@parameter.value@@@";
public String ignoredClass = "ignored";
public String failedClass = "failed";
public String successClass = "succeeded";
private HtmlResources htmlResources;
private DefaultConfiguration configuration;
public HtmlReport(DefaultConfiguration configuration) {
this.configuration = configuration;
setResourcePath(HTML_DEPENDENCIES_FOLDER);
setReportPath(configuration.getTargetFolder().path);
pathResolver = new RelativeHtmlPathResolver();
}
@Override
public void setReportPath(String reportPath) {
if (reportPath != null && !reportPath.equals(getReportPath())) {
super.setReportPath(reportPath);
configuration.setTargetPath(reportPath);
}
}
@Override
public void setResourcePath(String resourcePath) {
if (resourcePath != null && !resourcePath.equals(getResourcePath())) {
super.setResourcePath(resourcePath);
htmlResources = new HtmlResources(configuration, resourcePath);
}
}
public void report(UseCaseResult useCaseResult) throws IOException, IllegalAccessException {
Class classUnderTest = useCaseResult.useCase.classUnderTest;
String useCaseReport = new TemplateString(useCaseTemplate)
.replace("@@@useCase.name@@@", useCaseResult.useCase.getName())
.replace("@@@useCase.css@@@", htmlResources.getIncludeCssDirectives(classUnderTest))
.replace("@@@useCase.js@@@", htmlResources.getIncludeJsDirectives(classUnderTest))
.replace("@@@useCase.issue@@@", htmlResources.convertIssue(useCaseResult.getIssue()))
.replace("@@@useCaseCommentTemplate@@@", getUseCaseComment(useCaseResult.useCase))
.replace("@@@beforeUseCaseTemplate@@@", getBeforeUseCase(useCaseResult))
.replace("@@@scenarioTemplates@@@", getScenarios(useCaseResult))
.replace("@@@afterUseCaseTemplate@@@", getAfterUseCase(useCaseResult))
.replace("@@@relatedUseCasesTemplates@@@", getRelatedUseCases(useCaseResult))
.getText();
useCaseReport = useCaseResult.useCase.useCaseDecorator.applyOnUseCase(useCaseResult, useCaseReport);
File htmlFile = configuration.getTargetFolder().createFileFromClass(classUnderTest, ".html");
Writer html = new OutputStreamWriter(new FileOutputStream(htmlFile));
html.write(useCaseReport);
html.close();
System.out.println("Report wrote: " + htmlFile.getCanonicalPath());
}
private String getRelatedUseCases(UseCaseResult useCaseResult) {
String relatedUseCases = "";
if (!useCaseResult.subUseCaseResults.isEmpty()) {
return new TemplateString(relatedUseCasesTemplate)
.replace("@@@relatedUseCaseTemplates@@@", getRelatedUseCase(useCaseResult))
.getText();
}
return relatedUseCases;
}
private String getRelatedUseCase(UseCaseResult useCaseResult) {
String relatedUseCase = "";
for (UseCaseResult subUseCaseResult : useCaseResult.subUseCaseResults) {
relatedUseCase += new TemplateString(relatedUseCaseTemplate)
.replace("@@@relatedUseCase.issue@@@", htmlResources.convertIssue(subUseCaseResult.getIssue()))
.replace("@@@relatedUseCase.link@@@", getRelativeUrl(subUseCaseResult.useCase, useCaseResult))
.replace("@@@relatedUseCase.name@@@", subUseCaseResult.useCase.getName())
.getText();
}
return relatedUseCase;
}
private String getScenarios(UseCaseResult useCaseResult) {
String scenarioTxt = "";
for (Scenario scenario : useCaseResult.useCase.scenarios) {
for (ScenarioResult scenarioResult : useCaseResult.scenarioResults) {
if (scenarioResult.scenario.equals(scenario)) {
scenarioTxt += getScenario(scenarioResult);
}
}
}
return scenarioTxt;
}
private String getScenario(ScenarioResult scenarioResult) {
String scenarioHtml = new TemplateString(scenarioTemplate)
.replace("@@@scenario.issue@@@", htmlResources.convertIssue(scenarioResult.issue))
.replace("@@@scenario.name@@@", scenarioResult.scenario.getName())
.replace("@@@scenarioCommentTemplate@@@", getScenarioComment(scenarioResult))
.replace("@@@beforeScenarioTemplate@@@", getBeforeScenario(scenarioResult))
.replace("@@@scenarioInstructionTemplates@@@", getScenarioInstructions(scenarioResult))
.replace("@@@afterScenarioTemplate@@@", getAfterScenario(scenarioResult))
.replace("@@@displayedContextsTemplates@@@", extractDisplayedContexts(scenarioResult))
.replace("@@@exceptionTemplate@@@", getStackTrace(scenarioResult.failure))
.getText();
scenarioHtml = scenarioResult.scenario.decorator.applyOnScenario(scenarioHtml);
return scenarioHtml;
}
private String getScenarioInstructions(ScenarioResult scenarioResult) {
String result = "";
Decorator decorator = new NullDecorator();
final ArrayList instructions = new ArrayList();
final ArrayList fixtureCallResults = new ArrayList();
for (FixtureCallResult fixtureCallResult : scenarioResult.fixtureCallResults) {
final Fixture fixture = fixtureCallResult.fixtureCall.fixture;
if( ! decorator.comply(fixture.decorator)){
result+= decorator.applyOnFixtures(instructions, fixtureCallResults);
instructions.clear();
fixtureCallResults.clear();
decorator = fixture.decorator;
}
String instruction = getInstructionWithParameter(fixtureCallResult.fixtureCall);
String instructionHtml = new TemplateString(scenarioInstructionTemplate)
.replace("@@@instruction.issue@@@", htmlResources.convertIssue(fixtureCallResult.issue))
.replace("@@@instruction.text@@@", instruction)
.getText();
instructions.add(instructionHtml);
fixtureCallResults.add(fixtureCallResult);
}
result+= decorator.applyOnFixtures(instructions, fixtureCallResults);
return result;
}
private String getBeforeScenario(ScenarioResult scenarioResult) {
if (scenarioResult.scenario.useCase.beforeScenario != null) {
String instructions = getContextInstructions(scenarioResult.scenario.useCase.beforeScenario);
return new TemplateString(beforeScenarioTemplate)
.replace("@@@contextInstructionTemplates@@@", instructions)
.getText();
}
return "";
}
private String getAfterScenario(ScenarioResult scenarioResult) {
if (scenarioResult.scenario.useCase.afterScenario != null) {
String instructions = getContextInstructions(scenarioResult.scenario.useCase.afterScenario);
return new TemplateString(afterScenarioTemplate)
.replace("@@@contextInstructionTemplates@@@", instructions)
.getText();
}
return "";
}
private String getScenarioComment(ScenarioResult scenarioResult) {
String comment = "";
if (scenarioResult.scenario.getComment() != null) {
comment = new TemplateString(scenarioCommentTemplate)
.replace("@@@comment.text@@@", scenarioResult.scenario.getComment())
.getText();
}
return comment;
}
private String extractDisplayedContexts(ScenarioResult scenarioResult) {
List values = scenarioResult.contextToDisplay;
if (!values.isEmpty()) {
String htmlText = "";
for (String value : values) {
htmlText += extractDisplayedContext(value);
}
return new TemplateString(displayedContextsTemplate)
.replace("@@@displayedContextTemplates@@@", htmlText)
.getText();
}
return "";
}
private String getStackTrace(Throwable failure) {
if (failure != null) {
StringWriter stringWriter = new StringWriter();
failure.printStackTrace(new PrintWriter(stringWriter));
return new TemplateString(exceptionTemplate)
.replace("@@@failure.className@@@", failure.getClass().getSimpleName())
.replace("@@@failure.message@@@", failure.getMessage())
.replace("@@@failure.stacktrace@@@", stringWriter.toString())
.getText();
}
return "";
}
private String extractDisplayedContext(String value) {
return new TemplateString(displayedContextTemplate)
.replace("@@@displayedContext.text@@@", value)
.getText();
}
private String getBeforeUseCase(UseCaseResult useCaseResult) {
UseCase useCase = useCaseResult.useCase;
if (useCase.beforeUseCase != null) {
return new TemplateString(beforeUseCaseTemplate)
.replace("@@@beforeUseCase.issue@@@", htmlResources.convertIssue(useCaseResult.beforeResult.issue))
.replace("@@@contextInstructionTemplates@@@", getContextInstructions(useCase.beforeUseCase))
.replace("@@@exceptionTemplate@@@", getStackTrace(useCaseResult.beforeResult))
.getText();
} else {
return "";
}
}
private String getAfterUseCase(UseCaseResult useCaseResult) throws IOException {
UseCase useCase = useCaseResult.useCase;
if (useCase.afterUseCase != null) {
return new TemplateString(afterUseCaseTemplate)
.replace("@@@afterUseCase.issue@@@", htmlResources.convertIssue(useCaseResult.afterResult.issue))
.replace("@@@contextInstructionTemplates@@@", getContextInstructions(useCase.afterUseCase))
.replace("@@@exceptionTemplate@@@", getStackTrace(useCaseResult.afterResult))
.getText();
} else {
return "";
}
}
private String getStackTrace(ContextResult contextResult) {
if (contextResult.isSuccessful()) {
return "";
} else {
return getStackTrace(contextResult.exception);
}
}
private String getContextInstructions(ContextHandler context) {
String instructions = "";
for (FixtureCall fixtureCall : context.fixtureCalls) {
instructions += new TemplateString(contextInstructionTemplate)
.replace("@@@instruction.text@@@", getInstructionWithParameter(fixtureCall))
.getText();
}
return instructions;
}
private String getInstructionWithParameter(FixtureCall testFixture) {
String instruction = testFixture.fixture.getText();
for (Map.Entry parameter: testFixture.getParameters().entrySet()) {
String value = Matcher.quoteReplacement(getParameter(parameter.getValue()));
instruction = instruction.replaceAll("\\$\\{" + parameter.getKey() + "\\}", value);
}
return instruction;
}
private String getParameter(String value) {
return new TemplateString(parameterTemplate)
.replace("@@@parameter.value@@@", value)
.getText();
}
private String getUseCaseComment(UseCase useCase) {
String comment = "";
if (useCase.haveComment()) {
return new TemplateString(useCaseCommentTemplate)
.replace("@@@comment.text@@@", useCase.getComment())
.getText();
}
return comment;
}
private String getRelativeUrl(UseCase subUseCase, UseCaseResult useCaseResult) {
String source = pathResolver.getPathOf(useCaseResult.useCase.classUnderTest, ".html");
String target = pathResolver.getPathOf(subUseCase.classUnderTest, ".html");
return pathResolver.getRelativePathToFile(source, target);
}
public HtmlResources getHtmlResources() {
return htmlResources;
}
public String getIssueConverter(Issue issue) {
switch (issue) {
case IGNORED:
return ignoredClass;
case FAILED:
return failedClass;
default:
case SUCCEEDED:
return successClass;
}
}
}