Html test report python

Python unittest Coverage

Summary: in this tutorial, you’ll learn how to use the Python unittest coverage command to generate a test coverage report.

What is a test coverage

Test coverage is a ratio between the number of lines executed by at least one test case and the total number of lines of the code base:

test coverage = lines of code executed / total number of lines

The test coverage is also known as code coverage.

The test coverage is often used to assess the quality of a test suite. If the test coverage is low e.g., 5%, it is an indicator that you’re not testing enough.

However, the reverse may not be true. For example, 100% test coverage is not a guarantee that you have a good test suite. In other words, a test suite with high coverage can still be of poor quality.

Unittest coverage example

We’ll use the following project structure to demo the unittest coverage. Note that you can get the source code from this tutorial.

D:\python-unit-testing ├── shapes | ├── circle.py | ├── shape.py | └── square.py └── test ├── test_circle.py ├── test_square.py └── __init__.py

To generate a coverage report, you need to carry out two steps:

First, run the coverage module to generate the coverage data:

python -m coverage run -m unittest

Second, turn the coverage data into a report:

Name Stmts Miss Cover ----------------------------------------- shapes\circle.py 9 0 100% shapes\shape.py 4 0 100% shapes\square.py 9 0 100% test\__init__.py 0 0 100% test\test_circle.py 14 0 100% test\test_square.py 14 0 100% ----------------------------------------- TOTAL 50 0 100%Code language: plaintext (plaintext)

To generate the coverage report in HTML format, you change the option of the coverage module to HTML like this:

Wrote HTML report to htmlcov\index.htmlCode language: CSS (css)

The output indicates the location of the HTML coverage report htmlcov\index.html under the project folder.

If you open the index.html file of the htmlcov folder, it’ll look like the following:

Examining unittest coverage detailed report

First, add the perimeter() method to the Circle class as follows:

import math from .shape import Shape class Circle(Shape): def __init__(self, radius: float) -> None: if radius < 0: raise ValueError('The radius cannot be negative') self._radius = radius def area(self) -> float: return math.pi * math.pow(self._radius, 2) def perimeter(self) -> float: return 2 * math.pi * self._radius Code language: Python (python)

Next, gather the coverage data by running the following command:

python -m coverage run -m unittest

Then, generate the coverage report by executing the following command:

Name Stmts Miss Cover ----------------------------------------- shapes\circle.py 11 1 91% shapes\shape.py 4 0 100% shapes\square.py 9 0 100% test\__init__.py 0 0 100% test\test_circle.py 14 0 100% test\test_square.py 14 0 100% ----------------------------------------- TOTAL 52 1 98%Code language: plaintext (plaintext)

The coverage now is 98% in total and 91% in the shape\circle.py module. This is because the perimeter() method is not tested.

After that, generate the coverage report in HTML format:

The circle.py has 11 statements. The test executes 10 of them and misses one statement. Therefore, the test coverage is 10/11 ~ 91%.

Finally, click the circle.py module for the detailed report:

Summary

• Use the python -m coverage run -m unittest command to gather coverage data and the python -m coverage report command to generate a coverage report.
• Use the python -m coverage html to generate the test coverage report in HTML format.

Источник

Generating HTML Test Reports in Python

We can generate HTML reports with our Selenium test using the Pytest Testing Framework. To configure Pytest, we have to run the following command:

Once the installation is done, we can run the command to check the Pytest version installed −

As a Pytest standard, the Python file containing the Pytest should start with test_ or end with _test. Also, all the test steps should be within a method whose name should start with test_.

To run a Pytest file, we can open the terminal and move from the current directory to the directory of the Pytest file that we want to execute. Then, run the command mentioned below −

Let us look at a project structure following the Pytest Test Framework.

In the above image, it shows that the Pytest file has the name test_p.py and it contains a test method with the name test_SeleniumTest.

To generate a HTML report for a Selenium test, we have to install a plugin with the command: pip install pytest-html. To generate the report, we have to move from the current directory to the directory of the Pytest file that we want to execute. Then run the command: pytest —html=report.html.

After this command is successfully executed, a new file called the report.html gets generated within the project.

Right-click on the report.html and select the option Copy Path.

Open the path of the file copied in a browser, to get the HTML report.

The HTML report gives information of the Environment on which the test is executed. It also contains the information on test Summary and Results.

Источник

Create Pytest HTML Test Reports

This tutorial will make web UI testing easy. We will build a simple yet robust web UI test solution using Python, pytest, and Selenium WebDriver. We will learn strategies for good test design as well as patterns for good automation code. By the end of the tutorial, you’ll be a web test automation champ! Your Python test project can be the foundation for your own test cases, too.

📍 If you are looking for a single Python Package for Android, iOS and Web Testing – there is also an easy open source solution provided by TestProject. With a single executable, zero configurations, and familiar Selenium APIs, you can develop and execute robust Python tests and get automatic HTML test reports as a bonus! All you need is: pip install testproject-python-sdk . Simply follow this Github link to learn more about it, or read through this great tutorial to get started.

Tutorial Chapters

1. Set Your Test Automation Goals (Chapter 1)
2. Create A Python Test Automation Project Using Pytest (Chapter 2)
3. Installing Selenium WebDriver Using Python and Chrome (Chapter 3)
4. Write Your First Web Test Using Selenium WebDriver, Python and Chrome (Chapter 4)
5. Develop Page Object Selenium Tests Using Python (Chapter 5)
6. How to Read Config Files in Python Selenium Tests (Chapter 6)
7. Take Your Python Test Automation To The Next Level (Chapter 7)
   • You’re here →Create Pytest HTML Test Reports (Chapter 7.1)
   • Parallel Test Execution with Pytest (Chapter 7.2)
   • Scale Your Test Automation using Selenium Grid and Remote WebDrivers (Chapter 7.3)
   • Test Automation for Mobile Apps using Appium and Python (Chapter 7.4)
   • Create Behavior-Driven Python Tests using Pytest-BDD (Chapter 7.5)

When pytest runs at the command line, it sometimes prints an unhelpful wall of text. Visual reports are a much better way to consume test result information, especially for non-developers. Adding the pytest-html plugin to your test project enables you to print pretty HTML reports with one simple command line option.

Reports will look like this:

When it comes to Python and Selenium/Appium functional tests there is an easy open-source solution provided by TestProject that automatically creates the HTML and PDF reports for you ( out of the box, no additional configuration needed ). Simply follow this Github link to learn more about it, or read through this great tutorial to get started.

Reports will look like this:

Go ahead and check out the next tip for taking your web UI testing with Python to the next level.

About the author

Andy Knight is the “Automation Panda” – an engineer, consultant, and international speaker who loves all things software. He specializes in building robust test automation systems from the ground up. Read his tech blog at AutomationPanda.com, and follow him on Twitter at @AutomationPanda.

Источник

User Guide¶

Note that ANSI code support depends on the ansi2html package. Due to the use of a less permissive license, this package is not included as a dependency. If you have this package installed, then ANSI codes will be converted to HTML in your report.

Creating a self-contained report¶

In order to respect the Content Security Policy (CSP), several assets such as CSS and images are stored separately by default. You can alternatively create a self-contained report, which can be more convenient when sharing your results. This can be done in the following way:

$ pytest --html=report.html --self-contained-html

Images added as files or links are going to be linked as external resources, meaning that the standalone report HTML file may not display these images as expected.

The plugin will issue a warning when adding files or links to the standalone report.

Enhancing reports¶

Appearance¶

Custom CSS (Cascasding Style Sheets) can be passed on the command line using the —css option. These will be applied in the order specified, and can be used to change the appearance of the report.

$ pytest --html=report.html --css=highcontrast.css --css=accessible.css

Report Title¶

By default the report title will be the filename of the report, you can edit it by using the pytest_html_report_title hook:

def pytest_html_report_title(report): report.title = "My very own title!" 

Environment¶

The Environment section is provided by the pytest-metadata plugin, and can be accessed via the pytest_configure and pytest_sessionfinish hooks:

To modify the Environment section before tests are run, use pytest_configure :

from pytest_metadata.plugin import metadata_key def pytest_configure(config): config.stash[metadata_key]["foo"] = "bar" 

To modify the Environment section after tests are run, use pytest_sessionfinish :

import pytest from pytest_metadata.plugin import metadata_key @pytest.hookimpl(tryfirst=True) def pytest_sessionfinish(session, exitstatus): session.config.stash[metadata_key]["foo"] = "bar" 

Note that in the above example @pytest.hookimpl(tryfirst=True) is important, as this ensures that a best effort attempt is made to run your pytest_sessionfinish before any other plugins ( including pytest-html and pytest-metadata ) run theirs. If this line is omitted, then the Environment table will not be updated since the pytest_sessionfinish of the plugins will execute first, and thus not pick up your change.

The generated table will be sorted alphabetically unless the metadata is a collections.OrderedDict .

It is possible to redact variables from the environment table. Redacted variables will have their names displayed, but their values grayed out. This can be achieved by setting environment_table_redact_list in your INI configuration file (e.g.: pytest.ini ). environment_table_redact_list is a linelist of regexes. Any environment table variable that matches a regex in this list has its value redacted.

For example, the following will redact all environment table variables that match the regexes ^foo$ , .*redact.* , or bar :

[pytest] environment_table_redact_list = ^foo$ .*redact.* bar 

Additional summary information¶

You can edit the Summary section by using the pytest_html_results_summary hook:

def pytest_html_results_summary(prefix, summary, postfix): prefix.extend(["
foo: bar
"]) 

Extra content¶

You can add details to the HTML report by creating an ‘extras’ list on the report object. Here are the types of extra content that can be added:

Источник