Class SuiteHTMLReporter

java.lang.Object
org.testng.reporters.SuiteHTMLReporter
All Implemented Interfaces:
IReporter, ITestNGListener

public class SuiteHTMLReporter extends Object implements IReporter
This class implements an HTML reporter for suites.
  • Field Details

  • Constructor Details

    • SuiteHTMLReporter

      public SuiteHTMLReporter()
  • Method Details

    • generateReport

      public void generateReport(List<XmlSuite> xmlSuites, List<ISuite> suites, String outputDirectory)
      Description copied from interface: IReporter
      Generate a report for the given suites into the specified output directory.
      Specified by:
      generateReport in interface IReporter
      Parameters:
      xmlSuites - The list of XmlSuite
      suites - The list of ISuite
      outputDirectory - The output directory
    • generateOutputDirectoryName

      protected String generateOutputDirectoryName(String outputDirectory)
      Overridable by subclasses to create different directory names (e.g. with timestamps).
      Parameters:
      outputDirectory - the output directory specified by the user
      Returns:
      the name of the output directory of the report
    • generateXmlFile

      private void generateXmlFile(XmlSuite xmlSuite)
    • generateIndex

      private void generateIndex(List<ISuite> suites)
      Generate the main index.html file that lists all the suites and their result
    • generateExcludedMethodsReport

      private void generateExcludedMethodsReport(XmlSuite xmlSuite, ISuite suite)
    • generateReporterOutput

      private void generateReporterOutput(XmlSuite xmlSuite)
    • generateClasses

      private void generateClasses(XmlSuite xmlSuite)
    • generateClass

      private String generateClass(ITestClass cls)
    • dumpMethods

      private String dumpMethods(ITestNGMethod[] testMethods)
    • getMethodName

      private static String getMethodName(String name)
    • generateMethodsChronologically

      private void generateMethodsChronologically(XmlSuite xmlSuite, ISuite suite, String outputFileName, boolean alphabetical)
    • createColor

      private String createColor(ITestNGMethod tm)
      Generate a HTML color based on the class of the method
    • td

      private String td(String s)
    • generateMethodsAndGroups

      private void generateMethodsAndGroups(XmlSuite xmlSuite, ISuite suite)
      Generate information about methods and groups
    • generateIndex

      private void generateIndex(XmlSuite xmlSuite, ISuite sr)
    • makeTitle

      private String makeTitle(ISuite suite)
    • generateMain

      private void generateMain(XmlSuite xmlSuite, ISuite sr)
    • generateTableOfContents

      private void generateTableOfContents(XmlSuite xmlSuite, ISuite suite)
    • pluralize

      private String pluralize(int count, String singular)
    • getOutputDirectory

      private String getOutputDirectory(XmlSuite xmlSuite)
    • sortResults

      private ISuiteResult[] sortResults(Collection<ISuiteResult> r)
    • generateSuiteResult

      private void generateSuiteResult(String suiteName, ISuiteResult sr, String cssClass, StringBuilder tableOfContents)
    • generateSuites

      private void generateSuites(XmlSuite xmlSuite, ISuite suite)
      Writes a property file for each suite result.
      Parameters:
      xmlSuite - - The XmlSuite suite.
      suite - - The ISuite object.