HTML report generation in Selenium Python - Build an Automation Script

Verify login functionality and generate HTML report

Preconditions (2)

Step 1: Open the browser and navigate to 'https://example.com/login'

Step 2: Enter 'testuser' in the username input field with id 'username'

Step 3: Enter 'Test@1234' in the password input field with id 'password'

Step 4: Click the login button with id 'loginBtn'

Step 5: Wait until the URL changes to 'https://example.com/dashboard'

Step 6: Verify that the page title is 'Dashboard - Example'

Step 7: Close the browser

✅ Expected Result: User is successfully logged in and redirected to the dashboard page with correct title. An HTML report is generated showing the test steps and pass/fail status.

Automation Requirements - Selenium with Python unittest and HtmlTestRunner

Assertions Needed:

Assert current URL is 'https://example.com/dashboard'

Assert page title is 'Dashboard - Example'

Best Practices:

Use explicit waits to wait for URL change

Use Page Object Model to separate page locators and actions

Generate HTML report using HtmlTestRunner

Use setUp and tearDown methods for browser setup and cleanup

Automated Solution

Selenium Python

import unittest
from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
import HtmlTestRunner

class LoginPage:
    def __init__(self, driver):
        self.driver = driver
        self.username_input = (By.ID, 'username')
        self.password_input = (By.ID, 'password')
        self.login_button = (By.ID, 'loginBtn')

    def enter_username(self, username):
        self.driver.find_element(*self.username_input).clear()
        self.driver.find_element(*self.username_input).send_keys(username)

    def enter_password(self, password):
        self.driver.find_element(*self.password_input).clear()
        self.driver.find_element(*self.password_input).send_keys(password)

    def click_login(self):
        self.driver.find_element(*self.login_button).click()

class TestLogin(unittest.TestCase):
    def setUp(self):
        self.driver = webdriver.Chrome()
        self.driver.maximize_window()
        self.driver.get('https://example.com/login')
        self.login_page = LoginPage(self.driver)

    def test_login_success(self):
        self.login_page.enter_username('testuser')
        self.login_page.enter_password('Test@1234')
        self.login_page.click_login()

        wait = WebDriverWait(self.driver, 10)
        wait.until(EC.url_to_be('https://example.com/dashboard'))

        current_url = self.driver.current_url
        self.assertEqual(current_url, 'https://example.com/dashboard', 'URL after login should be dashboard')

        title = self.driver.title
        self.assertEqual(title, 'Dashboard - Example', 'Page title should be Dashboard - Example')

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

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

The code uses unittest framework with Selenium WebDriver to automate the login test.

The LoginPage class follows the Page Object Model pattern to keep locators and actions organized.

In setUp, the browser opens and navigates to the login page.

The test enters username and password, clicks login, then waits explicitly for the URL to change to the dashboard URL.

Assertions check the current URL and page title to confirm successful login.

The tearDown method closes the browser after the test.

The test runner HtmlTestRunner generates an HTML report saved in the reports folder showing test steps and pass/fail results.

Common Mistakes - 4 Pitfalls

Using time.sleep() instead of explicit waits

Hardcoding locators inside test methods

Not closing the browser after test

Not generating or checking HTML reports

Bonus Challenge

Now add data-driven testing with 3 different username and password combinations to verify login success or failure.

Show Hint

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