pytest-html for HTML reports - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is pytest-html used for?

pytest-html is a plugin for pytest that generates easy-to-read HTML reports after running tests. It helps you see which tests passed or failed in a web page format.

beginner

How do you install pytest-html?

You install it using pip with the command: pip install pytest-html. This adds the plugin to your pytest setup.

beginner

How do you generate an HTML report using pytest-html?

Run your tests with the option --html=report.html. For example: pytest --html=report.html. This creates a file named report.html with the test results.

intermediate

What information does the pytest-html report show?

The report shows test results with details like which tests passed, failed, or were skipped. It also shows error messages and can include screenshots if configured.

intermediate

Can you customize the pytest-html report?

Yes, you can customize the report by adding environment info, extra logs, or screenshots using hooks and options in your test code or pytest configuration.

Which command generates an HTML report with pytest-html?

A pytest --html=report.html

B pytest --report=html

C pytest-html generate

D pytest --output=html

The correct command is pytest --html=report.html to create an HTML report file.

How do you add pytest-html to your Python environment?

A pytest --install-html

B pip install pytest_report

C python setup.py install pytest-html

D pip install pytest-html

You install pytest-html using pip: pip install pytest-html.

What type of file does pytest-html create?

A JSON file

B HTML file

C TXT file

D XML file

pytest-html creates an HTML file that you can open in a browser to view test results.

Which of these can pytest-html reports include?

A Database dumps

B Only test names

C Screenshots and logs

D Compiled binaries

pytest-html can include screenshots and logs to help understand test failures.

Is it possible to customize the pytest-html report?

A Yes, by adding environment info and extra logs

B No, it is fixed format

C Only by editing the HTML file manually

D Only by changing pytest version

You can customize pytest-html reports by adding environment info, logs, and screenshots using hooks.

Explain how to generate and view an HTML report using pytest-html.

Think about the commands and the file you get.

Describe ways to customize the pytest-html report to make it more useful.

Customization involves adding more details to the report.

Practice

1. What is the main purpose of using pytest-html in testing?

easy

A. To run tests faster than usual

B. To convert Python code into HTML

C. To write tests in HTML format

D. To generate easy-to-read HTML reports of test results

Solution

1. Step 1: Understand pytest-html functionality

   pytest-html is a plugin that creates HTML reports summarizing test results.

2. Step 2: Identify the main use

   The main use is to generate readable reports, not to speed up tests or convert code.

3. Final Answer:

   To generate easy-to-read HTML reports of test results -> Option D

4. Quick Check:

   pytest-html = HTML reports [OK]

Hint: Remember: pytest-html = HTML report generator [OK]

Common Mistakes:

• Thinking pytest-html speeds up tests
• Confusing report generation with test execution
• Assuming tests are written in HTML

2. Which command correctly generates an HTML report named report.html using pytest?

easy

A. pytest --report=report.html

B. pytest -html report.html

C. pytest --html=report.html

D. pytest -r html=report.html

Solution

1. Step 1: Recall pytest-html command syntax

   The correct syntax to generate an HTML report is pytest --html=filename.html.

2. Step 2: Match the options

   Only pytest --html=report.html matches the correct syntax exactly.

3. Final Answer:

   pytest --html=report.html -> Option C

4. Quick Check:

   Use --html=filename.html for reports [OK]

Hint: Use double dash and equals for HTML report file [OK]

Common Mistakes:

• Using single dash instead of double dash
• Using incorrect option names like --report
• Missing equals sign between option and filename

3. Given this pytest command: pytest --html=results.html, what will happen after the tests finish?

medium

A. Tests will run and output will be printed only in the console

B. An HTML file named results.html will be created with test results

C. Tests will run but no report will be generated

D. An error will occur because the command is invalid

Solution

1. Step 1: Understand the command effect

   The command pytest --html=results.html tells pytest to run tests and save results in an HTML file named results.html.

2. Step 2: Identify the expected output

   After tests finish, the HTML report file is created for easy viewing.

3. Final Answer:

   An HTML file named results.html will be created with test results -> Option B

4. Quick Check:

   --html=filename creates HTML report file [OK]

Hint: --html=filename always creates HTML report file [OK]

Common Mistakes:

• Thinking no report is generated
• Expecting output only in console
• Assuming command syntax is wrong

4. You ran pytest --html=report.html but no HTML report was created. What is the most likely cause?

medium

A. pytest-html plugin is not installed

B. The command syntax is incorrect

C. Tests did not run due to syntax errors

D. HTML reports are disabled by default

Solution

1. Step 1: Check plugin requirement

   pytest-html must be installed for --html option to work.

2. Step 2: Analyze other options

   The command syntax is correct, tests can run without errors, and reports are not disabled by default.

3. Final Answer:

   pytest-html plugin is not installed -> Option A

4. Quick Check:

   Missing plugin causes no report [OK]

Hint: Install pytest-html plugin to enable reports [OK]

Common Mistakes:

• Assuming command syntax is wrong
• Thinking reports are off by default
• Ignoring plugin installation requirement

5. You want to generate an HTML report with pytest that includes extra environment info like Python version and OS. Which approach is best?

hard

A. Use pytest --html=report.html --self-contained-html and add environment info via pytest hooks

B. Run pytest --html=report.html only; environment info is added automatically

C. Manually edit the HTML report after generation to add environment info

D. Use pytest --html=report.html --env-info option

Solution

1. Step 1: Understand pytest-html capabilities

   pytest-html can include environment info if you add it via hooks in your test setup.

2. Step 2: Evaluate options

   Use pytest --html=report.html --self-contained-html and add environment info via pytest hooks uses the correct command and mentions adding info via hooks, which is the recommended way. Run pytest --html=report.html only; environment info is added automatically is incorrect because environment info is not automatic. Manually edit the HTML report after generation to add environment info is manual and error-prone. Use pytest --html=report.html --env-info option is invalid; no such option exists.

3. Final Answer:

   Use pytest --html=report.html --self-contained-html and add environment info via pytest hooks -> Option A

4. Quick Check:

   Add env info via hooks + --html [OK]

Hint: Add environment info via hooks, not command options [OK]

Common Mistakes:

• Expecting environment info added automatically
• Trying to edit HTML manually
• Using non-existent command options