Plugin for generating HTML reports for pytest results

Overview
Comments
  • Garbage date-time is printed in the Captured log.

    Garbage date-time is printed in the Captured log.

    Garbage date-time is printed in the Captured log.

    pytest-html report:

    ------------------------------ Captured log setup ------------------------------ INFO  root:test_cyclic_switchover.py:26 Inside Setup INFO  root:test_cyclic_switchover.py:54 ------------------------------ Captured log call ------------------------------- INFO  root:test_cyclic_switchover.py:82 Switchover Process : SCM

    pytest console log :

    collected 4 items / 2 deselected / 2 selected

    test_cyclic_switchover.py::test_process_switchover[SCM] ------------------------------------------------------------ live log setup ------------------------------------------------------------- 2020-07-13 21:51:50 [ INFO] Inside Setup (test_cyclic_switchover.py:26) 2020-07-13 21:51:50 [ INFO] (test_cyclic_switchover.py:54) ------------------------------------------------------------- live log call ------------------------------------------------------------- 2020-07-13 21:51:50 [ INFO] Switchover Process : SCM (test_cyclic_switchover.py:82) PASSED [ 50%] test_cyclic_switchover.py::test_process_switchover[SAM] ------------------------------------------------------------- live log call ------------------------------------------------------------- 2020-07-13 21:51:50 [ INFO] Switchover Process : SAM (test_cyclic_switchover.py:82) PASSED [100%] ----------------------------------------------------------- live log teardown ----------------------------------------------------------- 2020-07-13 21:51:50 [ INFO] Inside Teardown (test_cyclic_switchover.py:60)

    opened by pawan7476 20
  • environment table needs to be whitelisted/blacklisted

    environment table needs to be whitelisted/blacklisted

    when I use pytest-html in docker (with gitlab-ci) it needs a lot of environment variables set, some holds token and passwords. I do not want to show in my jenkins report to a wider audience. pytest-html_envs

    It seems they are collected in the very first test, so adding this to a test is working using the request autofixture:

            # remove eventual gitlab settings
            for k in list(request.config._metadata.keys()):
                if re.search(r'^(GITLAB_|CI_)', k):
                    del request.config._metadata[k]
    

    But I like to do it in conftest.py

    enhancement feature 
    opened by fenchu 19
  • Don't include any captured stdout/stderr/log output to the report

    Don't include any captured stdout/stderr/log output to the report

    Hi, To reduce report file size, I'm trying to exclude any captured stdout/stderr/log output. I'm running tests with the following command:

    pytest --html=report.html --self-contained-html --capture=no --show-capture=no tests/
    

    With this I still get the Captured log call section for every test no matter if it pass or not. So the question, how to not include any captured output to the report?

    enhancement help wanted 
    opened by bigunyak 19
  • unrecognized arguments: --html=report.htm

    unrecognized arguments: --html=report.htm

    I see below error when i tried to run my py test

    command tried : pytest test_blank_pages.py --html=report.html

    irb-6672:static cirb_apasunoori$ pytest test_blank_pages.py --html=report.html
    usage: pytest [options] [file_or_dir] [file_or_dir] [...]
    pytest: error: unrecognized arguments: --html=report.html
      inifile: None
      rootdir: /Users/cirb_apasunoori/PycharmProjects/pythonsitecore/static
    irb-6672:static cirb_apasunoori$ 
    
    opened by anand853 18
  • Error or failure information can be collapsed

    Error or failure information can be collapsed

    Hi,

    Could you please add a new feature that user could collapse the error or failure log? it's a little bit hard to find the useful information once there're hundreds of errors or failures in the report. For better understanding, I would like to give an example:

    balabala
    Thanks very much and looking forward for that.

    Regards,

    Hailin

    enhancement 
    opened by hailin-xiao 18
  • Clarifying the release schedule

    Clarifying the release schedule

    Hi everyone.

    I think it may make sense to create a release schedule. I looked at PyPI and it looks like we haven't released a new version of this plugin since March of this year.

    While we're at it, perhaps it would make sense to automate the process as much as possible and create a RELEASING.rst doc similar to pytest's. This way users could be aware of what to expect in terms of feature delivery.

    Thoughts @ssbarnea @BeyondEvil @davehunt ?

    docs packaging Infrastructure 
    opened by gnikonorov 17
  • Post process html to include teardown in log

    Post process html to include teardown in log

    I believe this would resolve #131 ... however it isn't really optimal, I didn't want to dig into the html logic, so instead just moved it to be post processed and tried to coerce the test result into what the existing code seemed to want.

    bug 
    opened by csm10495 17
  • Opening report is slow when it contains long logs

    Opening report is slow when it contains long logs

    I have some test runs that generate a lot of log entries. When opening the report is seems my browser is spending a lot of time presenting all these entries which are immediately collapsed right after.

    If I change the behavior to have everything collapsed by default I can open/render the html report much faster.

    What I have tested is essentially the same as adding a "collapsed" class here https://github.com/pytest-dev/pytest-html/blob/master/pytest_html/plugin.py#L140

    I have no idea if this breaks other use-cases or if other changes are necessary. I also realize that everything related to the collapse functionality is currently in js. Regardless, if something could be done to generate everything collapsed and open the necessary stuff afterwards I believe performance would be a lot better.

    Edit: I should mention I use self-contained reports.

    opened by Wramberg 16
  • Page header does not take environment variables into account

    Page header does not take environment variables into account

    In pytest.ini, I have :

    addopts = --html $APPRENTI_MOTEUR_LOGS_DIR_TEST/$APPRENTI_MOTEUR_LOGS_HTML_NAME
    

    The path of the html report takes the content of the environment variable into account.

    But the page header does not : image

    It would be nice if it would as well :-)

    opened by MaximeWeyl 16
  • Change color for text in HTML report

    Change color for text in HTML report

    Hi!

    First, thank you for this plugin!

    I want to recommend to change font color in report because read grey text on white background is "hard" for eyes. Also if we can increase font size it would be great!

    Thanks in advance!

    opened by APshenkin 15
  • Allow unicode in test names

    Allow unicode in test names

    @The-Compiler unicode hurts my head! I encountered a test with as a parameter. This caused the report to fail due to UnicodeDecodeError. This patch fixes it, but would you mind taking a look to see if there's a smarter approach? I also found it difficult to write a test for this use case.

    opened by davehunt 15
  • pytest --html=report.html, is working locally, but not creating report in GIt repository with help of GitHub Action

    pytest --html=report.html, is working locally, but not creating report in GIt repository with help of GitHub Action

    pytest --html=report.html, is working locally, but not creating report in GIt repository with help of GitHub Action

    in Github action, im expecting report to get created in root directory. but nothing is getting created. can you help?

    Following is my yml file 👍 name: Test Execution for OrangeHRM - Demo Environment on: schedule:

    • cron: '20 * * * *'

    jobs: build:

    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v3
    - name: Set up Python
      uses: actions/setup-python@v3
      with:
        python-version: '3.x'
    - name: Install dependencies
      run: |
         python -m pip install --upgrade pip
         pip install setuptools wheel twine
         pip install selenium
         pip install pytest
         pip install PyGithub
         pip install pytest-html
         pip install allure-pytest
         pip install pytest-github-report
         pip install webdriver-manager
         pip install pytest-failed-screenshot
         pip install pytest-metadata
         pip install pytest-cov
    - name: Test Execution after 20 mins interval
      run: |
         pytest --html=report.html
    
    opened by autotaskit 0
  • pytest-html 3.2.0 error on report generation on Gitlab-CI

    pytest-html 3.2.0 error on report generation on Gitlab-CI

    pytest-html 3.2.0 error on report generation on Gitlab-CI Observed: error on report generation NB: we have downgraded to version 3.1.1 and everything works well

    I think the problem is in: Explicitly add py.xml dependency.

    And the issue is the same as: https://github.com/microsoft/pylance-release/issues/2357

    Log: File "/Users/mobile-ci/.pyenv/versions/3.9.16/bin/pytest", line 8, in sys.exit(console_main()) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/_pytest/config/init.py", line 190, in console_main code = main() File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/_pytest/config/init.py", line 167, in main ret: Union[ExitCode, int] = config.hook.pytest_cmdline_main( File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_hooks.py", line 265, in call return self._hookexec(self.name, self.get_hookimpls(), kwargs, firstresult) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_manager.py", line 80, in _hookexec return self._inner_hookexec(hook_name, methods, kwargs, firstresult) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_callers.py", line 60, in _multicall return outcome.get_result() File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_result.py", line 60, in get_result raise ex[1].with_traceback(ex[2]) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_callers.py", line 39, in _multicall res = hook_impl.function(*args) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/_pytest/main.py", line 317, in pytest_cmdline_main return wrap_session(config, _main) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/_pytest/main.py", line 305, in wrap_session config.hook.pytest_sessionfinish( File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_hooks.py", line 265, in call return self._hookexec(self.name, self.get_hookimpls(), kwargs, firstresult) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_manager.py", line 80, in _hookexec return self._inner_hookexec(hook_name, methods, kwargs, firstresult) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_callers.py", line 55, in _multicall gen.send(outcome) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/_pytest/terminal.py", line 808, in pytest_sessionfinish outcome.get_result() File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_result.py", line 60, in get_result raise ex[1].with_traceback(ex[2]) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pluggy/_callers.py", line 39, in _multicall res = hook_impl.function(*args) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pytest_html/html_report.py", line 332, in pytest_sessionfinish report_content = self._generate_report(session) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/pytest_html/html_report.py", line 206, in _generate_report unicode_doc = "\n{}".format(doc.unicode(indent=2)) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 69, in unicode HtmlVisitor(l.append, indent, shortempty=False).visit(self) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 128, in visit visitmethod(node) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 160, in Tag self.visit(x) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 128, in visit visitmethod(node) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 160, in Tag self.visit(x) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 128, in visit visitmethod(node) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 160, in Tag self.visit(x) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 128, in visit visitmethod(node) File "/Users/mobile-ci/.pyenv/versions/3.9.16/lib/python3.9/site-packages/py/_xmlgen.py", line 140, in list assert id(obj) not in self.visited AssertionError: assert 4500331456 not in {4500220800: 1, 4500222816: 1, 4500259040: 1, 4500259280: 1, ...}

    • where 4500331456 = id([<'span' tag object 4500315888>, <'span' tag object 4500315728>, <'span' tag object 4500315408>, <'span' tag object 4500313728>])
    • and {4500220800: 1, 4500222816: 1, 4500259040: 1, 4500259280: 1, ...} = <py._xmlgen.HtmlVisitor object at 0x10c3bbb20>.visited
    opened by musjaster 0
  • Large img preview in self-contained mode

    Large img preview in self-contained mode

    opened by mganisin 1
  • Changing path of html directory using a fixture value for parametrized test

    Changing path of html directory using a fixture value for parametrized test

    Hello everyone,

    I was wondering if there was a way to change the output path of the html report after the test has run by using a test fixture which contains the name and parametrized values of a test i.e. :

    during the test there is a fixture that creates a directory whose name is based on the values of the current test, for example : output_path = /path/to/test/test_name_parametrized_val1_val2.

    However since the value of the config.option.htmlpath seems to be given during the pytest_configure hook and the tests have not been intialized yet (output_path is not yet created and, even if it was, it is not reachable from the pytest_configure hook) I haven't been able to figure this one out yet.

    I would really appreciate any advice on how to accomplish this and I apologize if the solution is trivial as I'm quite new to pytest...

    Thanks and have a good day!

    next-gen 
    opened by jnunez10010 6
  • Error in html report related to versions

    Error in html report related to versions

    Although the installed versions of pythest html 3.2.0 and meta 1.0.4 in report there is still version 3.1.1. for html report and 1.0.2 for meta. Also, the test execution time is slower than on another computer, and the code is the same. What could be the problem?

    element click intercepted error intercepted

    opened by Vladeemeer 1
Releases(v3.2.0)
  • v3.2.0(Nov 11, 2022)

    Changes

    • Revert "Rename master branch to main" (#562) @BeyondEvil
    • Release v3.2.0 (#556) @BeyondEvil
    • Add py as dependency (#555) @smartEBL
    • pip isn't a build dependency (#516) @rossburton
    • Migrate to precommit.ci (#487) @BeyondEvil
    • Use the tests reusable workflow (#486) @BeyondEvil

    Minor Changes

    • Allow for redacting of environment table values (#431) @gnikonorov
    • Implement the visible URL query parameter to control visibility of test results on page load. (#433) @gnikonorov
    • Make the report tab title reflect the report name (#420) @gnikonorov

    Bugfixes

    • Rename master branch to main (#560) @ssbarnea
    • chore: Deactivate broken test for now (#557) @BeyondEvil
    • Use pathlib.Path for file path handling (#514) @mrlegohead0x45
    • Re-enable tests against latest pytest (#421) @BeyondEvil
    Source code(tar.gz)
    Source code(zip)
  • v3.1.1(Jul 4, 2022)

  • v3.1.0(Jul 4, 2022)

    • Stop attaching test reruns to final test report entries (https://github.com/pytest-dev/pytest-html/issues/374)
    • Allow for report duration formatting (https://github.com/pytest-dev/pytest-html/issues/376)
    Source code(tar.gz)
    Source code(zip)
  • v3.0.0(Jul 4, 2022)

    • Respect --capture=no, --show-capture=no, and -s pytest flags (https://github.com/pytest-dev/pytest-html/issues/171)
    • Make the Results table Links column sortable (https://github.com/pytest-dev/pytest-html/issues/242)
    • Fix issue with missing image or video in extras. (https://github.com/pytest-dev/pytest-html/issues/265 and https://github.com/pytest-dev/pytest-selenium/issues/237) @christiansandberg and @superdodd and @dhalperi for the fix
    • Fix attribute name for compatibility with pytest-xdist 2. (https://github.com/pytest-dev/pytest-html/issues/305)
    • Post process HTML generation to allow teardown to appear in the HTML output. (https://github.com/pytest-dev/pytest-html/issues/131)
    Source code(tar.gz)
    Source code(zip)
  • v3.0.0a0(Nov 12, 2020)

    Changed below are not curated yet and is machine generated. Look at https://github.com/pytest-dev/pytest-html/blob/master/CHANGES.rst for human curated changelist.

    Changes

    • Prep version 3.0.0 for release (#362) @gnikonorov

    Major Changes

    • Stop shadowing the 'format' builtin (#347) @gnikonorov
    • Drop support for legacy Python 2.7 (#230) @hugovk

    Minor Changes

    • Add support for py39 (#345) @ssbarnea
    • Enable py38 testing (#326) @ssbarnea
    • Strip ANSI escape sequences when ansi2html is missing (#315) @BeyondEvil
    • Make the links column in the results table sortable (#324) @gnikonorov
    • Make the maximum asset filename length configurable. (#313) @D3X
    • Fix broken development docs (#316) @BeyondEvil
    • Update link to Tox (#301) @gnikonorov

    Bugfixes

    • Add ESLint to project (#367) @gnikonorov
    • Assure scm versioning is pypa compatible (#364) @ssbarnea
    • Move release from travis to github actions (#360) @ssbarnea
    • Respect --show-capture=no flag (#359) @gnikonorov
    • Respect pytest --capture=no and -s flags (#353) @gnikonorov
    • Stop shadowing the 'format' builtin (#347) @gnikonorov
    • Post process html to include teardown in log (#271) @csm10495
    • Avoid pytest 6.0.0 (#319) @ssbarnea
    • Rename "slave" -> "worker" for xdist compatibility (#307) @Zac-HD
    • Fix embedded images (and videos) (#298) @dhalperi
    • Fix image missing when using Base64 content (#277) @christiansandberg
    • Better fix for TerminalReporter issue (#299) @BeyondEvil
    • Fix collapsable bug (#268) @BeyondEvil
    • Fix min-width which produced horizontal scrolls (#237) @ssbarnea
    • Support utf8 display (#244) @lzhu666
    • Trigger sorting for initial sort column (#248) @wanam
    • Close opened resource. (#235) @krzysztof-pawlik-gat
    • Keep sort preference for previously sorted columns (#220) @wanam
    • Fix assets file naming to work across both *nix and windows (#223) @BeyondEvil
    • Remove unused and undocumented markers (#224) @BeyondEvil
    • Append a line break after captured log sections (#217) @borntyping
    • Handle when report title is stored as an environment variable (#203) @BeyondEvil
    • Removed extraneous space from anchor tag (#192) @chardbury
    • Stop filtering out falsy environment values (#180) @crazymerlyn
    • Always define version even if get_distribution() fails (#178) @nicoddemus
    • Disable sort on environment table when metadata is ordered (#162) @jacebrowning
    • Fix for including a screenshot bug on Windows (#124) (#136) @pinkie1378
    Source code(tar.gz)
    Source code(zip)
Owner
pytest-dev
pytest-dev
pytest plugin providing a function to check if pytest is running.

pytest-is-running pytest plugin providing a function to check if pytest is running. Installation Install with: python -m pip install pytest-is-running

Adam Johnson 21 Nov 1, 2022
Pytest-typechecker - Pytest plugin to test how type checkers respond to code

pytest-typechecker this is a plugin for pytest that allows you to create tests t

vivax 2 Aug 20, 2022
A pytest plugin to run an ansible collection's unit tests with pytest.

pytest-ansible-units An experimental pytest plugin to run an ansible collection's unit tests with pytest. Description pytest-ansible-units is a pytest

Community managed Ansible repositories 9 Dec 9, 2022
Playwright Python tool practice pytest pytest-bdd screen-play page-object allure cucumber-report

pytest-ui-automatic Playwright Python tool practice pytest pytest-bdd screen-play page-object allure cucumber-report How to run Run tests execute_test

moyu6027 11 Nov 8, 2022
Pytest-rich - Pytest + rich integration (proof of concept)

pytest-rich Leverage rich for richer test session output. This plugin is not pub

Bruno Oliveira 170 Dec 2, 2022
A Django plugin for pytest.

Welcome to pytest-django! pytest-django allows you to test your Django project/applications with the pytest testing tool. Quick start / tutorial Chang

pytest-dev 1.1k Dec 31, 2022
A command-line tool and Python library and Pytest plugin for automated testing of RESTful APIs, with a simple, concise and flexible YAML-based syntax

1.0 Release See here for details about breaking changes with the upcoming 1.0 release: https://github.com/taverntesting/tavern/issues/495 Easier API t

null 909 Dec 15, 2022
Coverage plugin for pytest.

Overview docs tests package This plugin produces coverage reports. Compared to just using coverage run this plugin does some extras: Subprocess suppor

pytest-dev 1.4k Dec 29, 2022
pytest plugin for distributed testing and loop-on-failures testing modes.

xdist: pytest distributed testing plugin The pytest-xdist plugin extends pytest with some unique test execution modes: test run parallelization: if yo

pytest-dev 1.1k Dec 30, 2022
Mypy static type checker plugin for Pytest

pytest-mypy Mypy static type checker plugin for pytest Features Runs the mypy static type checker on your source files as part of your pytest test run

Dan Bader 218 Jan 3, 2023
:game_die: Pytest plugin to randomly order tests and control random.seed

pytest-randomly Pytest plugin to randomly order tests and control random.seed. Features All of these features are on by default but can be disabled wi

pytest-dev 471 Dec 30, 2022
A rewrite of Python's builtin doctest module (with pytest plugin integration) but without all the weirdness

The xdoctest package is a re-write of Python's builtin doctest module. It replaces the old regex-based parser with a new abstract-syntax-tree based pa

Jon Crall 174 Dec 16, 2022
pytest plugin for manipulating test data directories and files

pytest-datadir pytest plugin for manipulating test data directories and files. Usage pytest-datadir will look up for a directory with the name of your

Gabriel Reis 191 Dec 21, 2022
pytest plugin that let you automate actions and assertions with test metrics reporting executing plain YAML files

pytest-play pytest-play is a codeless, generic, pluggable and extensible automation tool, not necessarily test automation only, based on the fantastic

pytest-dev 67 Dec 1, 2022
pytest plugin for a better developer experience when working with the PyTorch test suite

pytest-pytorch What is it? pytest-pytorch is a lightweight pytest-plugin that enhances the developer experience when working with the PyTorch test sui

Quansight 39 Nov 18, 2022
Pytest plugin for testing the idempotency of a function.

pytest-idempotent Pytest plugin for testing the idempotency of a function. Usage pip install pytest-idempotent Documentation Suppose we had the follo

Tyler Yep 3 Dec 14, 2022
A pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database

This is a pytest plugin, that enables you to test your code that relies on a running PostgreSQL Database. It allows you to specify fixtures for PostgreSQL process and client.

Clearcode 252 Dec 21, 2022
A pytest plugin that enables you to test your code that relies on a running Elasticsearch search engine

pytest-elasticsearch What is this? This is a pytest plugin that enables you to test your code that relies on a running Elasticsearch search engine. It

Clearcode 65 Nov 10, 2022
This is a pytest plugin, that enables you to test your code that relies on a running MongoDB database

This is a pytest plugin, that enables you to test your code that relies on a running MongoDB database. It allows you to specify fixtures for MongoDB process and client.

Clearcode 19 Oct 21, 2022