Road to generate html report for Python Webdriver test suite using HTMLTestRunner

In my previous post ""Road to create test suite for python Webdriver scripts, I posted that how to create Suite file for webdriver python test script, but In this post I will show you how to integrate test suite with HTMLTestRunner to generate report in html format.

Before going through this post click here ( “Road to create test suite for python Webdriver scripts” ) to see both webdrive python unit test scripts.  I am taking these as example.

Follow below steps to setup:
1. Click on link "HTMLTestRunner" and download “HTMLTestRunner.py”, and “test_HTMLTestRunner.py” file put in your webdriver python project root folder.
2. Import all your test script in “test_HTMLTestRunner.py” as below:

import WebdriverTest2

import WebdriverTest1

3. If your test scripts are not parallel to “test _HTMLTestRunner.py” file, like I put under ${rootfolder}/test then use from in import section.

from test import WebdriverTest2

from test import WebdriverTest1

4. Associate your unit test with suite  object in “test_main” method as below:

self.suite = unittest.TestSuite()

        self.suite.addTests([           

            unittest.defaultTestLoader.loadTestsFromTestCase(WebdriverTest1.WebdriverTest1),

            unittest.defaultTestLoader.loadTestsFromTestCase(WebdriverTest2.WebdriverTest2),

                               

            ])

Example: Here is complete example

import StringIO
import sys
import unittest
from test import WebdriverTest2
from test import WebdriverTest1
import HTMLTestRunner

# ----------------------------------------------------------------------

def test_HTMLTestRunner(obj, *args):
    """ return the unicode representation of obj """
    try:
        return unicode(obj, *args)
    except UnicodeDecodeError:
        # obj is byte string
        ascii_text = str(obj).encode('string_escape')
        return unicode(ascii_text)

def safe_str(obj):
    """ return the byte string representation of obj """
    try:
        return str(obj)
    except UnicodeEncodeError:
        # obj is unicode
        return unicode(obj).encode('unicode_escape')

# This is the main test on HTMLTestRunner

class Test_HTMLTestRunner(unittest.TestCase):

    def test_main(self):
        # Run HTMLTestRunner. Verify the HTML report.

        # suite of TestCases
        self.suite = unittest.TestSuite()
        self.suite.addTests([            
            unittest.defaultTestLoader.loadTestsFromTestCase(WebdriverTest1.WebdriverTest1),
            unittest.defaultTestLoader.loadTestsFromTestCase(WebdriverTest2.WebdriverTest2),
                                
            ])

        # Invoke TestRunner
        buf = StringIO.StringIO()
        #runner = unittest.TextTestRunner(buf)       
        runner = HTMLTestRunner.HTMLTestRunner(
                    stream=buf,
                    title='',
                    description='This demonstrates the report output by Suite Execution.'
                    )
        runner.run(self.suite)

        # check out the output
        byte_output = buf.getvalue()
        # output the main test output for debugging & demo
        print byte_output
        # HTMLTestRunner pumps UTF-8 output
        output = byte_output.decode('utf-8')
        self._checkoutput(output,EXPECTED)
        EXPECTED = u"""
        """
        # check out the output
        byte_output = buf.getvalue()
        # output the main test output for debugging & demo
        print byte_output
        # HTMLTestRunner pumps UTF-8 output
        output = byte_output.decode('utf-8')
        self._checkoutput(output,EXPECTED)


    def _checkoutput(self,output,EXPECTED):
        i = 0
        for lineno, p in enumerate(EXPECTED.splitlines()):
            if not p:
                continue
            j = output.find(p,i)
            if j < 0:
                self.fail(safe_str('Pattern not found lineno %s: "%s"' % (lineno+1,p)))
            i = j + len(p)
    

import unittest
if __name__ == "__main__":
    if len(sys.argv) > 1:
        argv = sys.argv
    else:
        argv=['test_HTMLTestRunner.py', 'Test_HTMLTestRunner']
    unittest.main(argv=argv)

Execution: Run “test_HTMLTestRunner.py” using command, you should see report is generated in result.html file.

    >>python test_HTMLTestRunner.py > result.html 

Report: you should see report like this: