Class SuiteHTMLReporter

  • All Implemented Interfaces:
    IReporter, ITestNGListener

    public class SuiteHTMLReporter
    extends java.lang.Object
    implements IReporter
    This class implements an HTML reporter for suites.
    • Constructor Detail

      • SuiteHTMLReporter

        public SuiteHTMLReporter()
    • Method Detail

      • generateReport

        public void generateReport​(java.util.List<XmlSuite> xmlSuites,
                                   java.util.List<ISuite> suites,
                                   java.lang.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 java.lang.String generateOutputDirectoryName​(java.lang.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​(java.util.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 java.lang.String generateClass​(ITestClass cls)
      • dumpMethods

        private java.lang.String dumpMethods​(ITestNGMethod[] testMethods)
      • getMethodName

        private static java.lang.String getMethodName​(java.lang.String name)
      • generateMethodsChronologically

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

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

        private java.lang.String td​(java.lang.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 java.lang.String makeTitle​(ISuite suite)
      • generateMain

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

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

        private java.lang.String pluralize​(int count,
                                           java.lang.String singular)
      • getOutputDirectory

        private java.lang.String getOutputDirectory​(XmlSuite xmlSuite)
      • generateSuiteResult

        private void generateSuiteResult​(java.lang.String suiteName,
                                         ISuiteResult sr,
                                         java.lang.String cssClass,
                                         java.lang.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.