"""
PDF Renderer classes for test report objects.
"""
import logging
from collections import OrderedDict
from typing import Optional, Tuple, Union
from reportlab.lib import colors, styles
from reportlab.platypus import Paragraph
from testplan.common.exporters.pdf import RowStyle
from testplan.common.utils.registry import Registry
from testplan.common.utils.strings import format_description, split_text, wrap
from testplan.report import (
ReportCategories,
Status,
TestCaseReport,
TestGroupReport,
TestReport,
)
from testplan.report.testing.styles import StyleFlag
from testplan.testing import tagging
from . import constants as const
from .base import BaseRowRenderer, MetadataMixin, RowData, format_duration
[docs]class ReportRendererRegistry(Registry):
def __getitem__(self, item):
"""Try to get renderers for TestGroupReports by category first"""
if isinstance(item, TestGroupReport):
try:
return self.data[(type(item), item.category)]
except KeyError:
pass
return super(ReportRendererRegistry, self).__getitem__(item)
registry = ReportRendererRegistry()
[docs]@registry.bind(TestReport)
class TestReportRenderer(BaseRowRenderer, MetadataMixin):
"""Renders the rows for the root node: ``report.testing.TestReport``."""
always_display = True # Root element always get displayed
# Need to make this configurable for OS version
datetime_fmt = "%Y-%m-%d %H:%M:%S %Z"
metadata_labels = (
("user", "User"),
("project", "Project"),
("git_url", "Git URL"),
("git_commit", "Git commit"),
("hostname", "Host"),
("command_line_string", "Command line string"),
("python_version", "Python version"),
# These two will be set via `get_tag_pdf_ctx`
("report_tags_all", "Report tags (all)"),
("report_tags_any", "Report tags (any)"),
)
[docs] def get_metadata_context(self, source: TestReport) -> OrderedDict:
"""
Enriched meta context with test counts, run times etc.
:param source: Source object for the renderer. Report for a Testplan test run.
"""
ctx = super(TestReportRenderer, self).get_metadata_context(source)
ctx.update(
[
(
"Style (Passing / Failing)",
"{} / {}".format(
self.style.passing.label, self.style.failing.label
),
)
]
)
if "run" in source.timer:
run_interval = source.timer.last(key="run")
ctx.update(
[
(
"Start time",
run_interval.start.strftime(self.datetime_fmt),
),
("End time", run_interval.end.strftime(self.datetime_fmt)),
("Elapsed", format_duration(run_interval.elapsed)),
]
)
return ctx
[docs] def get_row_data(
self,
source: TestReport,
depth: int,
row_idx: int,
) -> RowData:
"""
Render Testplan header & metadata
:param source: Source object for the renderer. Report for a Testplan test run.
:param depth: Depth of the source object on report tree. Used for indentation.
:param row_idx: Index of the current table row to be rendered.
"""
row_data = RowData(
start=row_idx,
content=[source.name, "", "", format_status(source.status)],
style=[
RowStyle(
bottom_padding=const.TITLE_PADDING,
font=(const.FONT_BOLD, const.FONT_SIZE_LARGE),
left_padding=0,
),
RowStyle(
text_color=colors.green if source.passed else colors.red,
start_column=3,
),
],
)
samplestyles = styles.getSampleStyleSheet()
# Metadata
for key, value in self.get_metadata_context(source).items():
row_data.append(
content=[
key,
Paragraph(value, samplestyles["Normal"]),
"",
"",
],
style=[
RowStyle(
bottom_padding=0,
left_padding=0,
top_padding=0,
valign="TOP",
),
RowStyle(
font=(const.FONT_BOLD, const.FONT_SIZE_SMALL),
start_column=0,
end_column=0,
),
RowStyle(
font=(const.FONT, const.FONT_SIZE_SMALL),
start_column=1,
end_column=1,
),
RowStyle(
span=True,
start_column=1,
end_column=3,
),
],
)
# Error logs that are higher than ERROR level
log_data = self.get_logs(source, depth=depth + 1, row_idx=row_data.end)
if log_data:
row_data += log_data
return row_data
[docs] def get_logs(
self,
source: TestReport,
depth: int,
row_idx: int,
lvl: int = logging.ERROR,
) -> Optional[RowData]:
"""
Get logs created by the `report.logger` object.
Only select the logs with severity level equal to or higher than `lvl`.
:param source: Source object for the renderer. Report for a Testplan test run.
:param depth: Depth of the source object on report tree. Used for indentation.
:param row_idx: Index of the current table row to be rendered.
:param lvl: Log severity level.
"""
font_size = const.FONT_SIZE_SMALL
width = const.WRAP_LIMITS[font_size]
logs = [log for log in source.logs if log["levelno"] >= lvl]
return (
RowData(
start=row_idx,
content=[
[wrap(log["message"], width=width), "", "", ""]
for log in logs
],
style=RowStyle(
font=(const.FONT, font_size),
left_padding=const.INDENT * depth,
text_color=colors.gray,
),
)
if logs
else None
)
[docs]@registry.bind(TestGroupReport)
class TestRowRenderer(BaseRowRenderer, MetadataMixin):
"""Common logic for rendering test report objects."""
[docs] def get_row_data(
self,
source: TestGroupReport,
depth: int,
row_idx: int,
) -> RowData:
"""
Display test name/description, passed status & logs (if enabled).
:param source: Source object for the renderer. Report for a Testplan test run.
:param depth: Depth of the source object on report tree. Used for indentation.
:param row_idx: Index of the current table row to be rendered.
"""
row_data = self.get_header(source, depth, row_idx)
if source.description:
row_data += self.get_description(
description=source.description,
depth=depth,
row_idx=row_data.end,
)
# Error logs that are higher than ERROR level
log_data = self.get_logs(source, depth=depth + 1, row_idx=row_data.end)
if log_data:
row_data += log_data
return row_data
[docs] def get_description(
self,
description: str,
depth: int,
row_idx: int,
) -> RowData:
"""
Description for a test object,
this will generally be docstring text.
:param description: Description for a test object. Report for a Testplan test run.
:param depth: Depth of the source object on report tree. Used for indentation.
:param row_idx: Index of the current table row to be rendered.
"""
return RowData(
start=row_idx,
content=split_text(
format_description(description),
const.FONT_ITALIC,
const.FONT_SIZE_SMALL,
const.PAGE_WIDTH - (depth * const.INDENT),
keep_leading_whitespace=True,
),
style=RowStyle(
font=(const.FONT_ITALIC, const.FONT_SIZE_SMALL),
left_padding=const.INDENT * depth,
text_color=colors.grey,
),
)
[docs] def get_logs(
self,
source: TestGroupReport,
depth: int,
row_idx: int,
lvl: int = logging.ERROR,
) -> Optional[RowData]:
"""
Get logs created by the `report.logger` object.
Only select the logs with severity level equal to or higher than `lvl`.
:param source: Source object for the renderer.
:param depth: Depth of the source object on report tree. Used for indentation.
:param row_idx: Index of the current table row to be rendered.
:param lvl: Log severity level.
"""
font_size = const.FONT_SIZE_SMALL
width = const.WRAP_LIMITS[font_size]
logs = [log for log in source.logs if log["levelno"] >= lvl]
return (
RowData(
start=row_idx,
content=[
[wrap(log["message"], width=width), "", "", ""]
for log in logs
],
style=RowStyle(
font=(const.FONT, font_size),
left_padding=const.INDENT * depth,
text_color=colors.gray,
),
)
if logs
else None
)
[docs] def get_style(self, source) -> StyleFlag:
if source.passed:
return self.style.passing
return self.style.failing
[docs] def should_display(self, source: TestGroupReport) -> bool:
"""
Filter out passing rows if `failing_tests` is `True`.
:param source: Source object for the renderer.
"""
style = self.get_style(source)
if source.category in (
ReportCategories.TESTSUITE,
ReportCategories.SYNTHESIZED,
):
return style.display_testsuite
elif source.category == ReportCategories.PARAMETRIZATION:
return style.display_testcase
return style.display_test
[docs]@registry.bind(TestCaseReport)
class TestCaseRowBuilder(TestRowRenderer):
"""
Row builder for TestCaseReport, this mainly corresponds
to a testcase method / function.
"""
[docs] def should_display(self, source: TestCaseReport) -> bool:
return self.get_style(source).display_testcase
[docs]@registry.bind((TestGroupReport, ReportCategories.MULTITEST))
class MultiTestRowBuilder(TestRowRenderer):
"""Multitests get special treatment with extra formatting & summary."""