package org.testng.reporters;

import static org.testng.internal.Utils.isStringNotEmpty;

import org.testng.IInvokedMethod;
import org.testng.IReporter;
import org.testng.ISuite;
import org.testng.ISuiteResult;
import org.testng.ITestClass;
import org.testng.ITestContext;
import org.testng.ITestNGMethod;
import org.testng.Reporter;
import org.testng.collections.Maps;
import org.testng.internal.ConstructorOrMethod;
import org.testng.internal.Utils;
import org.testng.log4testng.Logger;
import org.testng.xml.XmlSuite;

import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
import java.util.Map;

This class implements an HTML reporter for suites.
Author:cbeust, Alexandru Popescu
/** * This class implements an HTML reporter for suites. * * @author cbeust * @author <a href='mailto:the_mindstorm@evolva.ro'>Alexandru Popescu</a> */
public class SuiteHTMLReporter implements IReporter { public static final String METHODS_CHRONOLOGICAL = "methods.html"; public static final String METHODS_ALPHABETICAL = "methods-alphabetical.html"; public static final String GROUPS = "groups.html"; public static final String CLASSES = "classes.html"; public static final String REPORTER_OUTPUT = "reporter-output.html"; public static final String METHODS_NOT_RUN = "methods-not-run.html"; public static final String TESTNG_XML = "testng.xml.html"; private static final String TD_A_TARGET_MAIN_FRAME_HREF = "<td><a target='mainFrame' href='"; private static final String CLOSE_TD = "</td>"; private Map<String, ITestClass> m_classes = Maps.newHashMap(); private String m_outputDirectory; @Override public void generateReport( List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory) { m_outputDirectory = generateOutputDirectoryName(outputDirectory + File.separator + "old"); try { HtmlHelper.generateStylesheet(outputDirectory); } catch (IOException e) { Logger.getLogger(SuiteHTMLReporter.class).error(e.getMessage(), e); } for (ISuite suite : suites) { // // Generate the various reports // XmlSuite xmlSuite = suite.getXmlSuite(); if (xmlSuite.getTests().size() == 0) { continue; } generateTableOfContents(xmlSuite, suite); generateSuites(xmlSuite, suite); generateIndex(xmlSuite, suite); generateMain(xmlSuite, suite); generateMethodsAndGroups(xmlSuite, suite); generateMethodsChronologically(xmlSuite, suite, METHODS_CHRONOLOGICAL, false); generateMethodsChronologically(xmlSuite, suite, METHODS_ALPHABETICAL, true); generateClasses(xmlSuite); generateReporterOutput(xmlSuite); generateExcludedMethodsReport(xmlSuite, suite); generateXmlFile(xmlSuite); } generateIndex(suites); }
Overridable by subclasses to create different directory names (e.g. with timestamps).
Params:
  • outputDirectory – the output directory specified by the user
Returns:the name of the output directory of the report
/** * Overridable by subclasses to create different directory names (e.g. with timestamps). * * @param outputDirectory the output directory specified by the user * @return the name of the output directory of the report */
protected String generateOutputDirectoryName(String outputDirectory) { return outputDirectory; } private void generateXmlFile(XmlSuite xmlSuite) { String content = xmlSuite .toXml() .replaceAll("<", "&lt;") .replaceAll(">", "&gt;") .replaceAll(" ", "&nbsp;") .replaceAll("\n", "<br/>"); String sb = "<html><head><title>testng.xml for " + xmlSuite.getName() + "</title></head><body><tt>" + content + "</tt></body></html>"; Utils.writeFile(getOutputDirectory(xmlSuite), TESTNG_XML, sb); }
Generate the main index.html file that lists all the suites and their result
/** Generate the main index.html file that lists all the suites and their result */
private void generateIndex(List<ISuite> suites) { StringBuilder sb = new StringBuilder(); String title = "Test results"; sb.append("<html>\n<head><title>") .append("</title>") .append(HtmlHelper.getCssString(".")) .append("</head><body>\n") .append("<h2><p align='center'>") .append(title) .append("</p></h2>\n") .append("<table border='1' width='100%' class='main-page'>") .append( "<tr><th>Suite</th><th>Passed</th><th>Failed</th><th>Skipped</th><th>testng.xml</th></tr>\n"); int totalFailedTests = 0; int totalPassedTests = 0; int totalSkippedTests = 0; StringBuilder suiteBuf = new StringBuilder(); for (ISuite suite : suites) { if (suite.getResults().size() == 0) { continue; } String name = suite.getName(); int failedTests = 0; int passedTests = 0; int skippedTests = 0; Map<String, ISuiteResult> results = suite.getResults(); for (ISuiteResult result : results.values()) { ITestContext context = result.getTestContext(); failedTests += context.getFailedTests().size(); totalFailedTests += context.getFailedTests().size(); passedTests += context.getPassedTests().size(); totalPassedTests += context.getPassedTests().size(); skippedTests += context.getSkippedTests().size(); totalSkippedTests += context.getSkippedTests().size(); } String cls = failedTests > 0 ? "invocation-failed" : (passedTests > 0 ? "invocation-passed" : "invocation-failed"); suiteBuf .append("<tr align='center' class='") .append(cls) .append("'>") .append("<td><a href='") .append(name) .append("/index.html'>") .append(name) .append("</a></td>\n"); suiteBuf .append("<td>") .append(passedTests) .append(CLOSE_TD) .append("<td>") .append(failedTests) .append(CLOSE_TD) .append("<td>") .append(skippedTests) .append(CLOSE_TD) .append("<td><a href='") .append(name) .append("/") .append(TESTNG_XML) .append("'>Link") .append("</a></td>") .append("</tr>"); } String cls = totalFailedTests > 0 ? "invocation-failed" : (totalPassedTests > 0 ? "invocation-passed" : "invocation-failed"); sb.append("<tr align='center' class='") .append(cls) .append("'>") .append("<td><em>Total</em></td>") .append("<td><em>") .append(totalPassedTests) .append("</em></td>") .append("<td><em>") .append(totalFailedTests) .append("</em></td>") .append("<td><em>") .append(totalSkippedTests) .append("</em></td>") .append("<td>&nbsp;</td>") .append("</tr>\n"); sb.append(suiteBuf); sb.append("</table>").append("</body></html>\n"); Utils.writeFile(m_outputDirectory, "index.html", sb.toString()); } private void generateExcludedMethodsReport(XmlSuite xmlSuite, ISuite suite) { Collection<ITestNGMethod> excluded = suite.getExcludedMethods(); StringBuilder sb2 = new StringBuilder("<h2>Methods that were not run</h2><table>\n"); for (ITestNGMethod method : excluded) { ConstructorOrMethod m = method.getConstructorOrMethod(); if (m != null) { sb2.append("<tr><td>") .append(m.getDeclaringClass().getName()) .append(".") .append(m.getName()); String description = method.getDescription(); if (isStringNotEmpty(description)) { sb2.append("<br/>").append(SP2).append("<i>").append(description).append("</i>"); } sb2.append("</td></tr>\n"); } } sb2.append("</table>"); Utils.writeFile(getOutputDirectory(xmlSuite), METHODS_NOT_RUN, sb2.toString()); } private void generateReporterOutput(XmlSuite xmlSuite) { StringBuilder sb = new StringBuilder(); // // Reporter output // sb.append("<h2>Reporter output</h2>").append("<table>"); List<String> output = Reporter.getOutput(); for (String line : output) { sb.append("<tr><td>").append(line).append("</td></tr>\n"); } sb.append("</table>"); Utils.writeFile(getOutputDirectory(xmlSuite), REPORTER_OUTPUT, sb.toString()); } private void generateClasses(XmlSuite xmlSuite) { StringBuilder sb = new StringBuilder(); sb.append("<table border='1'>\n") .append("<tr>\n") .append("<th>Class name</th>\n") .append("<th>Method name</th>\n") .append("<th>Groups</th>\n") .append("</tr>"); for (ITestClass tc : m_classes.values()) { sb.append(generateClass(tc)); } sb.append("</table>\n"); Utils.writeFile(getOutputDirectory(xmlSuite), CLASSES, sb.toString()); } private static final String SP = "&nbsp;"; private static final String SP2 = SP + SP + SP + SP; private String generateClass(ITestClass cls) { StringBuilder sb = new StringBuilder(); sb.append("<tr>\n") .append("<td>") .append(cls.getRealClass().getName()) .append("</td>\n") .append("<td>&nbsp;</td>") .append("<td>&nbsp;</td>") .append("</tr>\n"); String[] tags = new String[] {"@Test", "@BeforeClass", "@BeforeMethod", "@AfterMethod", "@AfterClass"}; ITestNGMethod[][] methods = new ITestNGMethod[][] { cls.getTestMethods(), cls.getBeforeClassMethods(), cls.getBeforeTestMethods(), cls.getAfterTestMethods(), cls.getAfterClassMethods() }; for (int i = 0; i < tags.length; i++) { sb.append("<tr>\n") .append("<td align='center' colspan='3'>") .append(tags[i]) .append("</td>\n") .append("</tr>\n") .append(dumpMethods(methods[i])); } return sb.toString(); } private String dumpMethods(ITestNGMethod[] testMethods) { StringBuilder sb = new StringBuilder(); if (null == testMethods || testMethods.length == 0) { return ""; } for (ITestNGMethod m : testMethods) { sb.append("<tr>\n"); sb.append("<td>&nbsp;</td>\n").append("<td>").append(m.getMethodName()).append("</td>\n"); String[] groups = m.getGroups(); if (groups != null && groups.length > 0) { sb.append("<td>"); for (String g : groups) { sb.append(g).append(" "); } sb.append("</td>\n"); } else { sb.append("<td>&nbsp;</td>"); } sb.append("</tr>\n"); } return sb.toString(); }
Generate information about the methods that were run
/** Generate information about the methods that were run */
public static final String AFTER = "&lt;&lt;"; public static final String BEFORE = "&gt;&gt;"; private static String getMethodName(String name) { if (name == null) { return ""; } return name; } private void generateMethodsChronologically( XmlSuite xmlSuite, ISuite suite, String outputFileName, boolean alphabetical) { try (BufferedWriter bw = Utils.openWriter(getOutputDirectory(xmlSuite), outputFileName)) { bw.append("<h2>Methods run, sorted chronologically</h2>"); bw.append("<h3>") .append(BEFORE) .append(" means before, ") .append(AFTER) .append(" means after</h3><p/>"); long startDate = -1; bw.append("<br/><em>").append(suite.getName()).append("</em><p/>"); bw.append("<small><i>(Hover the method name to see the test class name)</i></small><p/>\n"); List<IInvokedMethod> invokedMethods = suite.getAllInvokedMethods(); if (alphabetical) { invokedMethods.sort(Comparator.comparing(o -> getMethodName(o.getTestMethod().getMethodName()))); } SimpleDateFormat format = new SimpleDateFormat("yy/MM/dd HH:mm:ss"); boolean addedHeader = false; for (IInvokedMethod iim : invokedMethods) { ITestNGMethod tm = iim.getTestMethod(); if (!addedHeader) { bw.append("<table border=\"1\">\n") .append("<tr>") .append("<th>Time</th>") .append("<th>Delta (ms)</th>") .append("<th>Suite<br>configuration</th>") .append("<th>Test<br>configuration</th>") .append("<th>Class<br>configuration</th>") .append("<th>Groups<br>configuration</th>") .append("<th>Method<br>configuration</th>") .append("<th>Test<br>method</th>") .append("<th>Thread</th>") .append("<th>Instances</th>") .append("</tr>\n"); addedHeader = true; } String methodName = tm.toString(); boolean bc = tm.isBeforeClassConfiguration(); boolean ac = tm.isAfterClassConfiguration(); boolean bt = tm.isBeforeTestConfiguration(); boolean at = tm.isAfterTestConfiguration(); boolean bs = tm.isBeforeSuiteConfiguration(); boolean as = tm.isAfterSuiteConfiguration(); boolean bg = tm.isBeforeGroupsConfiguration(); boolean ag = tm.isAfterGroupsConfiguration(); boolean setUp = tm.isBeforeMethodConfiguration(); boolean tearDown = tm.isAfterMethodConfiguration(); boolean isClassConfiguration = bc || ac; boolean isGroupsConfiguration = bg || ag; boolean isTestConfiguration = bt || at; boolean isSuiteConfiguration = bs || as; boolean isSetupOrTearDown = setUp || tearDown; String configurationClassMethod = isClassConfiguration ? (bc ? BEFORE : AFTER) + methodName : SP; String configurationTestMethod = isTestConfiguration ? (bt ? BEFORE : AFTER) + methodName : SP; String configurationGroupsMethod = isGroupsConfiguration ? (bg ? BEFORE : AFTER) + methodName : SP; String configurationSuiteMethod = isSuiteConfiguration ? (bs ? BEFORE : AFTER) + methodName : SP; String setUpOrTearDownMethod = isSetupOrTearDown ? (setUp ? BEFORE : AFTER) + methodName : SP; String testMethod = tm.isTest() ? methodName : SP; StringBuilder instances = new StringBuilder(); for (long o : tm.getInstanceHashCodes()) { instances.append(o).append(" "); } if (startDate == -1) { startDate = iim.getDate(); } String date = format.format(iim.getDate()); bw.append("<tr bgcolor=\"") .append(createColor(tm)) .append("\">") .append(" <td>") .append(date) .append("</td> ") .append(" <td>") .append(Long.toString(iim.getDate() - startDate)) .append("</td> ") .append(td(configurationSuiteMethod)) .append(td(configurationTestMethod)) .append(td(configurationClassMethod)) .append(td(configurationGroupsMethod)) .append(td(setUpOrTearDownMethod)) .append(td(testMethod)) .append(" <td>") .append(tm.getId()) .append("</td> ") .append(" <td>") .append(instances) .append("</td> ") .append("</tr>\n"); } bw.append("</table>\n"); } catch (IOException e) { Utils.log( "[SuiteHTMLReporter]", 1, "Error writing to " + outputFileName + ": " + e.getMessage()); } }
Generate a HTML color based on the class of the method
/** Generate a HTML color based on the class of the method */
private String createColor(ITestNGMethod tm) { // real class can be null if this client is remote (not serializable) long color = tm.getRealClass() != null ? tm.getRealClass().hashCode() & 0xffffff : 0xffffff; long[] rgb = { ((color & 0xff0000) >> 16) & 0xff, ((color & 0x00ff00) >> 8) & 0xff, color & 0xff }; // Not too dark for (int i = 0; i < rgb.length; i++) { if (rgb[i] < 0x60) { rgb[i] += 0x60; } } long adjustedColor = (rgb[0] << 16) | (rgb[1] << 8) | rgb[2]; return Long.toHexString(adjustedColor); } private String td(String s) { StringBuilder result = new StringBuilder(); String prefix = ""; if (s.startsWith(BEFORE)) { prefix = BEFORE; } else if (s.startsWith(AFTER)) { prefix = AFTER; } if (!s.equals(SP)) { result.append("<td title=\"").append(s).append("\">"); int open = s.lastIndexOf("("); int start = s.substring(0, open).lastIndexOf("."); if (start >= 0) { result.append(prefix).append(s, start + 1, open); } else { result.append(prefix).append(s); } result.append("</td> \n"); } else { result.append("<td>").append(SP).append(CLOSE_TD); } return result.toString(); }
Generate information about methods and groups
/** Generate information about methods and groups */
private void generateMethodsAndGroups(XmlSuite xmlSuite, ISuite suite) { StringBuilder sb = new StringBuilder(); Map<String, Collection<ITestNGMethod>> groups = suite.getMethodsByGroups(); sb.append("<h2>Groups used for this test run</h2>"); if (groups.size() > 0) { sb.append("<table border=\"1\">\n") .append("<tr> <td align=\"center\"><b>Group name</b></td>") .append("<td align=\"center\"><b>Methods</b></td></tr>"); String[] groupNames = groups.keySet().toArray(new String[0]); Arrays.sort(groupNames); for (String group : groupNames) { Collection<ITestNGMethod> methods = groups.get(group); sb.append("<tr><td>").append(group).append(CLOSE_TD); StringBuilder methodNames = new StringBuilder(); Map<ITestNGMethod, ITestNGMethod> uniqueMethods = Maps.newHashMap(); for (ITestNGMethod tm : methods) { uniqueMethods.put(tm, tm); } for (ITestNGMethod tm : uniqueMethods.values()) { methodNames.append(tm.toString()).append("<br/>"); } sb.append("<td>").append(methodNames.toString()).append("</td></tr>\n"); } sb.append("</table>\n"); } Utils.writeFile(getOutputDirectory(xmlSuite), GROUPS, sb.toString()); } private void generateIndex(XmlSuite xmlSuite, ISuite sr) { String index = String.format("<html><head><title>Results for %s</title></head>%n", sr.getName()) + "<frameset cols=\"26%,74%\">\n" + "<frame src=\"toc.html\" name=\"navFrame\">\n" + "<frame src=\"main.html\" name=\"mainFrame\">\n" + "</frameset>\n" + "</html>\n"; Utils.writeFile(getOutputDirectory(xmlSuite), "index.html", index); } private String makeTitle(ISuite suite) { return "Results for<br/><em>" + suite.getName() + "</em>"; } private void generateMain(XmlSuite xmlSuite, ISuite sr) { String index = String.format("<html><head><title>Results for %s</title></head>%n", sr.getName()) + "<body>Select a result on the left-hand pane.</body>" + "</html>\n"; Utils.writeFile(getOutputDirectory(xmlSuite), "main.html", index); } /** */ private void generateTableOfContents(XmlSuite xmlSuite, ISuite suite) { StringBuilder tableOfContents = new StringBuilder(); // // Generate methods and groups hyperlinks // Map<String, ISuiteResult> suiteResults = suite.getResults(); int groupCount = suite.getMethodsByGroups().size(); int methodCount = 0; for (ISuiteResult sr : suiteResults.values()) { ITestNGMethod[] methods = sr.getTestContext().getAllTestMethods(); methodCount += methods.length; // Collect testClasses for (ITestNGMethod tm : methods) { ITestClass tc = tm.getTestClass(); m_classes.put(tc.getRealClass().getName(), tc); } } String name = "Results for " + suite.getName(); tableOfContents .append("<html>\n") .append("<head>\n") .append("<title>") .append(name) .append("</title>\n") .append(HtmlHelper.getCssString()) .append("</head>\n"); tableOfContents .append("<body>\n") .append("<h3><p align=\"center\">") .append(makeTitle(suite)) .append("</p></h3>\n") .append("<table border='1' width='100%'>\n") .append("<tr valign='top'>\n") .append("<td>") .append(suiteResults.size()) .append(" ") .append(pluralize(suiteResults.size(), "test")) .append("</td>\n") .append("<td>") .append("<a target='mainFrame' href='") .append(CLASSES) .append("'>") .append(m_classes.size()) .append(" ") .append(pluralize(m_classes.size(), "class")) .append("</a>") .append("</td>\n") .append("<td>") .append(methodCount) .append(" ") .append(pluralize(methodCount, "method")) .append(":<br/>\n") .append("&nbsp;&nbsp;<a target='mainFrame' href='") .append(METHODS_CHRONOLOGICAL) .append("'>") .append("chronological</a><br/>\n") .append("&nbsp;&nbsp;<a target='mainFrame' href='") .append(METHODS_ALPHABETICAL) .append("\'>") .append("alphabetical</a><br/>\n") .append("&nbsp;&nbsp;<a target='mainFrame' href='") .append(METHODS_NOT_RUN) .append("'>not run (") .append(suite.getExcludedMethods().size()) .append(")</a>") .append("</td>\n") .append("</tr>\n") .append("<tr>\n") .append(TD_A_TARGET_MAIN_FRAME_HREF) .append(GROUPS) .append("'>") .append(groupCount) .append(pluralize(groupCount, " group")) .append("</a></td>\n") .append(TD_A_TARGET_MAIN_FRAME_HREF) .append(REPORTER_OUTPUT) .append("'>reporter output</a></td>\n") .append(TD_A_TARGET_MAIN_FRAME_HREF) .append(TESTNG_XML) .append("'>testng.xml</a></td>\n") .append("</tr>") .append("</table>"); // // Generate results for individual tests // // Order the results so we can show the failures first, then the skip and // finally the successes Map<String, ISuiteResult> redResults = Maps.newHashMap(); Map<String, ISuiteResult> yellowResults = Maps.newHashMap(); Map<String, ISuiteResult> greenResults = Maps.newHashMap(); for (Map.Entry<String, ISuiteResult> entry : suiteResults.entrySet()) { String suiteName = entry.getKey(); ISuiteResult sr = entry.getValue(); ITestContext tc = sr.getTestContext(); int failed = tc.getFailedTests().size(); int skipped = tc.getSkippedTests().size(); int passed = tc.getPassedTests().size(); if (failed > 0) { redResults.put(suiteName, sr); } else if (skipped > 0) { yellowResults.put(suiteName, sr); } else if (passed > 0) { greenResults.put(suiteName, sr); } else { redResults.put(suiteName, sr); } } ISuiteResult[][] results = new ISuiteResult[][] { sortResults(redResults.values()), sortResults(yellowResults.values()), sortResults(greenResults.values()) }; String[] colors = {"failed", "skipped", "passed"}; for (int i = 0; i < colors.length; i++) { ISuiteResult[] r = results[i]; for (ISuiteResult sr : r) { String suiteName = sr.getTestContext().getName(); generateSuiteResult(suiteName, sr, colors[i], tableOfContents); } } tableOfContents.append("</body></html>"); Utils.writeFile(getOutputDirectory(xmlSuite), "toc.html", tableOfContents.toString()); } private String pluralize(int count, String singular) { return count > 1 ? (singular.endsWith("s") ? singular + "es" : singular + "s") : singular; } private String getOutputDirectory(XmlSuite xmlSuite) { File fileResult = new File(m_outputDirectory + File.separatorChar + xmlSuite.getName()).getAbsoluteFile(); if (!fileResult.exists()) { fileResult.mkdirs(); if (!fileResult.exists()) { Utils.log( "Reports", 2, "Problem creating output directory " + fileResult.getAbsolutePath()); } } return fileResult.getAbsolutePath(); } private ISuiteResult[] sortResults(Collection<ISuiteResult> r) { ISuiteResult[] result = r.toArray(new ISuiteResult[0]); Arrays.sort(result); return result; } private void generateSuiteResult( String suiteName, ISuiteResult sr, String cssClass, StringBuilder tableOfContents) { ITestContext tc = sr.getTestContext(); int passed = tc.getPassedTests().size(); int failed = tc.getFailedTests().size(); int skipped = tc.getSkippedTests().size(); String baseFile = tc.getName(); tableOfContents .append("\n<table width='100%' class='test-") .append(cssClass) .append("'>\n") .append("<tr><td>\n") .append("<table style='width: 100%'><tr>") .append("<td valign='top'>") .append(suiteName) .append(" (") .append(passed) .append("/") .append(failed) .append("/") .append(skipped) .append(")") .append(CLOSE_TD) .append("<td valign='top' align='right'>\n") .append(" <a href='") .append(baseFile) .append(".html' target='mainFrame'>Results</a>\n") .append(CLOSE_TD) .append("</tr></table>\n") .append("</td></tr><p/>\n"); tableOfContents.append("</table>\n"); }
Writes a property file for each suite result.
Params:
/** * Writes a property file for each suite result. * * @param xmlSuite - The {@link XmlSuite} suite. * @param suite - The {@link ISuite} object. */
private void generateSuites(XmlSuite xmlSuite, ISuite suite) { Map<String, ISuiteResult> suiteResults = suite.getResults(); for (ISuiteResult sr : suiteResults.values()) { ITestContext testContext = sr.getTestContext(); StringBuilder sb = new StringBuilder(); for (ISuiteResult suiteResult : suiteResults.values()) { sb.append(suiteResult.toString()); } Utils.writeFile( getOutputDirectory(xmlSuite), testContext.getName() + ".properties", sb.toString()); } } }