Skip to content

Feature: Template result filters #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2023
Merged

Feature: Template result filters #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/pytest_html/basereport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ def _generate_report(self, self_contained=False):
__version__,
self.css,
self_contained=self_contained,
outcomes=self._report.data["outcomes"],
test_data=cleanup_unserializable(self._report.data),
table_head=self._report.data["resultsTableHeader"],
prefix=self._report.data["additionalSummary"]["prefix"],
Expand Down Expand Up @@ -123,6 +124,7 @@ def _render_html(
version,
styles,
self_contained,
outcomes,
test_data,
table_head,
summary,
Expand All @@ -135,6 +137,7 @@ def _render_html(
version=version,
styles=styles,
self_contained=self_contained,
outcomes=outcomes,
test_data=json.dumps(test_data),
table_head=table_head,
summary=summary,
Expand Down Expand Up @@ -189,8 +192,9 @@ def pytest_runtest_logreport(self, report):
DeprecationWarning,
)

outcome = _process_outcome(report)
data = {
"result": _process_outcome(report),
"result": outcome,
"duration": _format_duration(report.duration),
}

Expand Down Expand Up @@ -223,6 +227,10 @@ def pytest_runtest_logreport(self, report):
cells = _fix_py(cells)
data["resultsTableRow"] = cells

# don't count passed setups and teardowns
if not (report.when in ["setup", "teardown"] and report.outcome == "passed"):
self._report.data["outcomes"][outcome.lower()]["value"] += 1

processed_logs = _process_logs(report)
self._config.hook.pytest_html_results_table_html(
report=report, data=processed_logs
Expand Down
11 changes: 11 additions & 0 deletions src/pytest_html/report_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ def __init__(self, config):
"<th>Links</th>",
]

outcomes = {
"failed": {"label": "Failed", "value": 0},
"passed": {"label": "Passed", "value": 0},
"skipped": {"label": "Skipped", "value": 0},
"xfailed": {"label": "Unexpected failures", "value": 0},
"xpassed": {"label": "Unexpected passes", "value": 0},
"error": {"label": "Errors", "value": 0},
"rerun": {"label": "Reruns", "value": 0},
}

self._data = {
"title": "",
"collectedItems": 0,
Expand All @@ -27,6 +37,7 @@ def __init__(self, config):
},
"runningState": "not_started",
"environment": {},
"outcomes": outcomes,
"tests": defaultdict(list),
"additionalSummary": defaultdict(list),
"resultsTableHeader": default_headers,
Expand Down
34 changes: 15 additions & 19 deletions src/pytest_html/resources/index.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<head>
<meta charset="utf-8"/>
<title id="head-title"></title>
{% if self_contained %}
{%- if self_contained %}
<style type="text/css">
{{- styles|safe }}
</style>
{% else %}
<link href="{{ styles }}" rel="stylesheet" type="text/css"/>
{% endif %}
{%- endif %}
</head>
<body>
<h1 id="title"></h1>
Expand Down Expand Up @@ -55,9 +55,9 @@
<template id="template_results-table__head">
<thead id="results-table-head">
<tr>
{% for th in table_head %}
{{ th|safe }}
{% endfor %}
{%- for th in table_head %}
{{ th|safe }}
{%- endfor %}
</tr>
</thead>
</template>
Expand All @@ -78,9 +78,9 @@
<div class="summary">
<div class="summary__data">
<h2>Summary</h2>
{% for p in prefix %}
{%- for p in prefix %}
{{ p|safe }}
{% endfor %}
{%- endfor %}
<p class="run-count"></p>
<p class="filter">(Un)check the boxes to filter the results.</p>
<div class="summary__reload">
Expand All @@ -91,27 +91,23 @@
<div class="summary__spacer"></div>
<div class="controls">
<div class="filters">
<input checked="true" class="filter" data-test-result="failed" name="filter_checkbox" type="checkbox"/><span class="failed"></span>
<input checked="true" class="filter" data-test-result="passed" name="filter_checkbox" type="checkbox"/><span class="passed"></span>
<input checked="true" class="filter" data-test-result="skipped" name="filter_checkbox" type="checkbox"/><span class="skipped"></span>
<input checked="true" class="filter" data-test-result="xfailed" name="filter_checkbox" type="checkbox"/><span class="xfailed"></span>
<input checked="true" class="filter" data-test-result="xpassed" name="filter_checkbox" type="checkbox"/><span class="xpassed"></span>
<input checked="true" class="filter" data-test-result="error" name="filter_checkbox" type="checkbox"/><span class="error"></span>
<input checked="true" class="filter" data-test-result="rerun" name="filter_checkbox" type="checkbox"/><span class="rerun"></span>
{%- for result, values in outcomes.items() %}
<input checked="true" class="filter" name="filter_checkbox" type="checkbox" data-test-result="{{ result }}" {{ "disabled" if values["value"] == 0 }}/>
<span class="{{ result }}">{{ values["value"] }} {{ values["label"] }}{{ "," if result != "rerun" }}</span>
{%- endfor %}
</div>
<div class="collapse">
<button id="show_all_details">Show all details</button>&nbsp;/&nbsp;<button id="hide_all_details">Hide all details</button>
<div>
</div>
</div>
</div>
{% for s in summary %}
{%- for s in summary %}
{{ s|safe }}
{% endfor %}
{% for p in postfix %}
{%- endfor %}
{%- for p in postfix %}
{{ p|safe }}
{% endfor %}

{%- endfor %}
<table id="results-table"></table>
</body>
<footer>
Expand Down
13 changes: 2 additions & 11 deletions src/pytest_html/scripts/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ const { dom, findAll } = require('./dom.js')
const { manager } = require('./datamanager.js')
const { doSort } = require('./sort.js')
const { doFilter } = require('./filter.js')
const { getVisible, getSort, getSortDirection, possibleResults } = require('./storage.js')
const { getVisible, getSort, getSortDirection, possibleFilters } = require('./storage.js')

const removeChildren = (node) => {
while (node.firstChild) {
Expand Down Expand Up @@ -68,17 +68,8 @@ const renderContent = (tests) => {

const renderDerived = (tests, collectedItems, isFinished, formattedDuration) => {
const currentFilter = getVisible()
possibleResults.forEach(({ result, label }) => {
const count = tests.filter((test) => test.result.toLowerCase() === result).length
possibleFilters.forEach((result) => {
const input = document.querySelector(`input[data-test-result="${result}"]`)
const lastInput = document.querySelector(`input[data-test-result="${result}"]:last-of-type`)
document.querySelector(`.${result}`).innerText = `${count} ${label}`
// add a comma and whitespace between the results
if (input !== lastInput) {
document.querySelector(`.${result}`).innerText += ', '
}

input.disabled = !count
input.checked = currentFilter.includes(result)
})

Expand Down