HTML report generation in Selenium Python

Introduction

HTML report generation helps you see test results in a clear, colorful webpage. It makes understanding test outcomes easy and quick.

After running automated tests to share results with your team.

When you want a visual summary of passed and failed tests.

To keep a record of test runs for future reference.

When you need to show test results to non-technical people.

To quickly spot which tests need fixing.

Syntax

Selenium Python

from selenium import webdriver
from selenium.webdriver.common.by import By
import unittest
import HtmlTestRunner

class TestExample(unittest.TestCase):
    def setUp(self):
        self.driver = webdriver.Chrome()

    def test_google_title(self):
        self.driver.get('https://www.google.com')
        self.assertIn('Google', self.driver.title)

    def tearDown(self):
        self.driver.quit()

if __name__ == '__main__':
    unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='reports'))

Use HtmlTestRunner to create HTML reports easily with unittest.

The output folder stores the generated HTML files.

Examples

This saves the HTML report in the folder named my_reports.

Selenium Python

unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='my_reports'))

This sets a custom report file name TestReport.html.

Selenium Python

unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='reports', report_name='TestReport'))

This combines all test results into one HTML report file.

Selenium Python

unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='reports', combine_reports=True))

Sample Program

This test opens Google, checks the page title contains 'Google', then closes the browser. The test results are saved as an HTML report in the 'reports' folder.

Selenium Python

from selenium import webdriver
from selenium.webdriver.common.by import By
import unittest
import HtmlTestRunner

class GoogleTest(unittest.TestCase):
    def setUp(self):
        self.driver = webdriver.Chrome()

    def test_title(self):
        self.driver.get('https://www.google.com')
        self.assertIn('Google', self.driver.title)

    def tearDown(self):
        self.driver.quit()

if __name__ == '__main__':
    unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='reports'))

Important Notes

Make sure to install HtmlTestRunner with pip install html-testRunner before running tests.

Keep your test names clear; they appear in the report.

Open the generated HTML file in a browser to view the colorful test results.

Summary

HTML reports make test results easy to read and share.

Use HtmlTestRunner with unittest for simple HTML report generation.

Reports save in a folder you choose and show pass/fail details clearly.

Practice

1. What is the main purpose of generating an HTML report in Selenium Python testing?

easy

A. To avoid writing assertions

B. To speed up test execution

C. To make test results easy to read and share

D. To write test cases faster

Solution

1. Step 1: Understand the role of HTML reports

   HTML reports present test results in a clear, visual format that anyone can read.

2. Step 2: Compare with other options

   Speeding tests, writing tests faster, or avoiding assertions are unrelated to HTML reports.

3. Final Answer:

   To make test results easy to read and share -> Option C

4. Quick Check:

   HTML reports = clear, shareable results [OK]

Hint: HTML reports show results clearly for sharing [OK]

Common Mistakes:

• Thinking HTML reports speed up tests
• Confusing report generation with test writing
• Believing reports remove need for assertions

2. Which Python package is commonly used with unittest to generate HTML reports in Selenium tests?

easy

A. pytest-html

B. unittest-html

C. selenium-html

D. HtmlTestRunner

Solution

1. Step 1: Identify the package for unittest HTML reports

   HtmlTestRunner is designed to work with unittest for HTML report generation.

2. Step 2: Eliminate other options

   pytest-html is for pytest, selenium-html and unittest-html are not standard packages.

3. Final Answer:

   HtmlTestRunner -> Option D

4. Quick Check:

   unittest + HtmlTestRunner = HTML reports [OK]

Hint: HtmlTestRunner works with unittest for HTML reports [OK]

Common Mistakes:

• Choosing pytest-html for unittest tests
• Assuming selenium-html is a real package
• Confusing unittest-html as official

3. Given this code snippet using HtmlTestRunner, what folder will the HTML report be saved in?

import unittest
import HtmlTestRunner

class TestExample(unittest.TestCase):
    def test_pass(self):
        self.assertTrue(True)

if __name__ == '__main__':
    unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='reports'))

medium

A. Current directory

B. reports folder

C. HtmlTestRunner folder

D. No folder, prints to console only

Solution

1. Step 1: Check the output parameter in HTMLTestRunner

   The output='reports' argument tells HtmlTestRunner to save reports in the 'reports' folder.

2. Step 2: Understand default behavior

   Without output specified, reports save in current directory, but here 'reports' is explicit.

3. Final Answer:

   reports folder -> Option B

4. Quick Check:

   output='reports' means save in reports folder [OK]

Hint: output='foldername' sets report save location [OK]

Common Mistakes:

• Assuming reports save in current directory by default
• Thinking HtmlTestRunner creates its own folder
• Believing reports print only to console

4. What is wrong with this code snippet for generating an HTML report using HtmlTestRunner?

import unittest
import HtmlTestRunner

class TestExample(unittest.TestCase):
    def test_fail(self):
        self.assertEqual(1, 2)

if __name__ == '__main__':
    unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output=''))

medium

A. Empty output string causes report not to save

B. assertEqual syntax is incorrect

C. Missing import for HtmlTestRunner

D. Test class must inherit from HtmlTestRunner

Solution

1. Step 1: Check the output parameter usage

   Setting output='' means no folder is specified, which can cause HtmlTestRunner to fail saving reports properly.

2. Step 2: Verify other parts

   assertEqual syntax is correct, HtmlTestRunner is imported, and test class inheritance is correct.

3. Final Answer:

   Empty output string causes report not to save -> Option A

4. Quick Check:

   output='' disables report folder, causing save issues [OK]

Hint: Provide a valid folder name in output to save reports [OK]

Common Mistakes:

• Thinking assertEqual(1, 2) is syntax error
• Believing test class must inherit HtmlTestRunner
• Ignoring output parameter effect

5. You want to generate an HTML report that shows detailed pass/fail results and saves in a folder named 'test_reports'. Which code snippet correctly sets this up using HtmlTestRunner with unittest?

hard

A. unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='test_reports'))

B. unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(report='test_reports'))

C. unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(folder='test_reports'))

D. unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(path='test_reports'))

Solution

1. Step 1: Identify correct parameter for output folder

   HtmlTestRunner uses 'output' parameter to specify the folder for saving reports.

2. Step 2: Check other parameter names

   'report', 'folder', and 'path' are not valid parameters for HtmlTestRunner's HTMLTestRunner class.

3. Final Answer:

   unittest.main(testRunner=HtmlTestRunner.HTMLTestRunner(output='test_reports')) -> Option A

4. Quick Check:

   Use output='foldername' to save reports correctly [OK]

Hint: Use output='foldername' to set report save location [OK]

Common Mistakes:

• Using wrong parameter names like report or folder
• Not specifying output folder at all
• Confusing HtmlTestRunner options with other packages