package jp.vmi.html.result;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.floreysoft.jmte.AnnotationProcessor;
import com.floreysoft.jmte.Engine;
import com.floreysoft.jmte.TemplateContext;
import com.floreysoft.jmte.token.AnnotationToken;
import jp.vmi.html.result.TestSuiteTree.Node;
import jp.vmi.selenium.selenese.Selenese;
import jp.vmi.selenium.selenese.TestCase;
import jp.vmi.selenium.selenese.TestSuite;
import jp.vmi.selenium.selenese.command.ICommand;
import jp.vmi.selenium.selenese.result.CommandResult;
import jp.vmi.selenium.selenese.result.CommandResultList;
import jp.vmi.selenium.selenese.result.Result;
import jp.vmi.selenium.selenese.utils.SystemInformation;
/**
* HTML result generator.
*/
public class HtmlResult {
private static final Logger log = LoggerFactory.getLogger(HtmlResult.class);
// Usage: ${@commandResults VAR RESULT_LIST COMMAND}
private static class AnnoCommandResults implements AnnotationProcessor<String> {
@Override
public String getType() {
return "commandResults";
}
@Override
public String eval(AnnotationToken token, TemplateContext context) {
String[] args = token.getArguments().split("\\s+");
TestCase testCase = (TestCase) context.model.get(args[1]);
CommandResultList cresultList = testCase.getResultList();
ICommand command = (ICommand) context.model.get(args[2]);
List<CommandResult> results = cresultList.getResults(command);
context.model.put(args[0], results);
return null;
}
}
private String[] commandLineArgs = null;
private String htmlResultDir = null;
private Engine engine = null;
private final TestSuiteTree tree = new TestSuiteTree();
/**
* Set command line arguments.
*
* @param args command line arguments.
*/
public void setCommandLineArgs(String[] args) {
commandLineArgs = args;
}
/**
* Get HTML result directory.
*
* @return HTML result directory.
*/
public String getDir() {
return htmlResultDir;
}
/**
* Set HTML result directory.
*
* @param dir HTML result directory.
*/
public void setDir(String dir) {
this.htmlResultDir = dir;
}
private String getTemplate(String filename) {
try (InputStream is = getClass().getResourceAsStream(filename)) {
return IOUtils.toString(is, StandardCharsets.UTF_8);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private Engine getEngine() {
if (engine == null) {
engine = Engine.createCompilingEngine();
engine.registerNamedRenderer(new HtmlEscapeRenderer());
engine.registerNamedRenderer(new LogRenderer(this));
engine.registerNamedRenderer(new IndexRenderer());
engine.registerNamedRenderer(new RelativePathRenderer(this));
engine.registerNamedRenderer(new NumberRenderer());
engine.registerNamedRenderer(new TimeRenderer());
engine.registerNamedRenderer(new StringRenderer());
engine.registerRenderer(Result.class, new ResultRenderer());
engine.registerRenderer(Node.class, new NodeRenderer(engine, getTemplate("index-node.html")));
engine.registerAnnotationProcessor(new AnnoCommandResults());
}
return engine;
}
/**
* Generate HTML result.
*
* @param testSuite test-suite instance.
* @return test-suite summary.
*/
public TestSuiteSummary generate(TestSuite testSuite) {
if (htmlResultDir == null)
return null;
TestSuiteSummary summary = tree.getSummary(testSuite);
if (summary != null)
return summary;
List<Selenese> seleneseList = testSuite.getSeleneseList();
summary = new TestSuiteSummary();
for (Selenese selenese : seleneseList) {
switch (selenese.getType()) {
case TEST_SUITE:
if (selenese.isError())
break;
summary.merge(generate((TestSuite) selenese));
break;
case TEST_CASE:
summary.numTestTotal++;
if (selenese.isError()) {
summary.numTestFailures++;
break;
}
TestCase testCase = (TestCase) selenese;
switch (testCase.getResult().getLevel()) {
case UNEXECUTED:
// no count.
break;
case SUCCESS:
case WARNING:
summary.numTestPasses++;
break;
case FAILURE:
case ERROR:
case MAX_TIME_EXCEEDED:
summary.numTestFailures++;
break;
}
for (ICommand command : testCase.getCommandList()) {
switch (command.getResult().getLevel()) {
case UNEXECUTED:
// no count
break;
case SUCCESS:
case WARNING:
summary.numCommandPasses++;
break;
case FAILURE:
summary.numCommandFailures++;
break;
case ERROR:
case MAX_TIME_EXCEEDED:
summary.numCommandErrors++;
break;
}
}
break;
}
}
File dir = new File(htmlResultDir);
if (!dir.exists()) {
// A HTML result is invalid when output directory does not exist.
// Because a result of the pathname normalization is different in a presence of a directory.
dir.mkdirs();
log.info("Make the directory for HTML resut: {}", dir);
}
Map<String, Object> model = new HashMap<>();
model.put("title", testSuite.getName() + " results");
model.put("sysInfo", SystemInformation.getInstance());
model.put("testSuite", testSuite);
model.put("seleneseList", seleneseList);
model.put("numTestTotal", summary.numTestTotal);
model.put("numTestPasses", summary.numTestPasses);
model.put("numTestFailures", summary.numTestFailures);
model.put("numCommandPasses", summary.numCommandPasses);
model.put("numCommandFailures", summary.numCommandFailures);
model.put("numCommandErrors", summary.numCommandErrors);
model.put("commandLine", commandLineArgs);
String html = getEngine().transform(getTemplate("result.html"), model);
File file = new File(dir, "TEST-" + testSuite.getBaseName() + ".html");
try {
FileUtils.write(file, html, StandardCharsets.UTF_8);
log.info("Generated HTML result: {}", file);
} catch (IOException e) {
throw new RuntimeException(e);
}
tree.add(testSuite, summary);
return summary;
}
/**
* Generate index for HTML result.
*/
public void generateIndex() {
if (htmlResultDir == null)
return;
Map<String, Object> model = new HashMap<>();
model.put("title", "Index of test-suite results.");
model.put("tree", tree);
String html = getEngine().transform(getTemplate("index.html"), model);
File file = new File(htmlResultDir, "index.html");
try {
FileUtils.write(file, html, StandardCharsets.UTF_8);
log.info("Generated index of HTML results: {}", file);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}