600 lines
20 KiB
Python
600 lines
20 KiB
Python
import os
|
|
from io import StringIO
|
|
from pprint import pprint
|
|
from typing import Any
|
|
from typing import cast
|
|
from typing import Dict
|
|
from typing import Iterable
|
|
from typing import Iterator
|
|
from typing import List
|
|
from typing import Mapping
|
|
from typing import Optional
|
|
from typing import Tuple
|
|
from typing import Type
|
|
from typing import TYPE_CHECKING
|
|
from typing import TypeVar
|
|
from typing import Union
|
|
|
|
import attr
|
|
|
|
from _pytest._code.code import ExceptionChainRepr
|
|
from _pytest._code.code import ExceptionInfo
|
|
from _pytest._code.code import ExceptionRepr
|
|
from _pytest._code.code import ReprEntry
|
|
from _pytest._code.code import ReprEntryNative
|
|
from _pytest._code.code import ReprExceptionInfo
|
|
from _pytest._code.code import ReprFileLocation
|
|
from _pytest._code.code import ReprFuncArgs
|
|
from _pytest._code.code import ReprLocals
|
|
from _pytest._code.code import ReprTraceback
|
|
from _pytest._code.code import TerminalRepr
|
|
from _pytest._io import TerminalWriter
|
|
from _pytest.compat import final
|
|
from _pytest.config import Config
|
|
from _pytest.nodes import Collector
|
|
from _pytest.nodes import Item
|
|
from _pytest.outcomes import skip
|
|
|
|
if TYPE_CHECKING:
|
|
from typing import NoReturn
|
|
from typing_extensions import Literal
|
|
|
|
from _pytest.runner import CallInfo
|
|
|
|
|
|
def getworkerinfoline(node):
|
|
try:
|
|
return node._workerinfocache
|
|
except AttributeError:
|
|
d = node.workerinfo
|
|
ver = "%s.%s.%s" % d["version_info"][:3]
|
|
node._workerinfocache = s = "[{}] {} -- Python {} {}".format(
|
|
d["id"], d["sysplatform"], ver, d["executable"]
|
|
)
|
|
return s
|
|
|
|
|
|
_R = TypeVar("_R", bound="BaseReport")
|
|
|
|
|
|
class BaseReport:
|
|
when: Optional[str]
|
|
location: Optional[Tuple[str, Optional[int], str]]
|
|
longrepr: Union[
|
|
None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr
|
|
]
|
|
sections: List[Tuple[str, str]]
|
|
nodeid: str
|
|
outcome: "Literal['passed', 'failed', 'skipped']"
|
|
|
|
def __init__(self, **kw: Any) -> None:
|
|
self.__dict__.update(kw)
|
|
|
|
if TYPE_CHECKING:
|
|
# Can have arbitrary fields given to __init__().
|
|
def __getattr__(self, key: str) -> Any:
|
|
...
|
|
|
|
def toterminal(self, out: TerminalWriter) -> None:
|
|
if hasattr(self, "node"):
|
|
worker_info = getworkerinfoline(self.node)
|
|
if worker_info:
|
|
out.line(worker_info)
|
|
|
|
longrepr = self.longrepr
|
|
if longrepr is None:
|
|
return
|
|
|
|
if hasattr(longrepr, "toterminal"):
|
|
longrepr_terminal = cast(TerminalRepr, longrepr)
|
|
longrepr_terminal.toterminal(out)
|
|
else:
|
|
try:
|
|
s = str(longrepr)
|
|
except UnicodeEncodeError:
|
|
s = "<unprintable longrepr>"
|
|
out.line(s)
|
|
|
|
def get_sections(self, prefix: str) -> Iterator[Tuple[str, str]]:
|
|
for name, content in self.sections:
|
|
if name.startswith(prefix):
|
|
yield prefix, content
|
|
|
|
@property
|
|
def longreprtext(self) -> str:
|
|
"""Read-only property that returns the full string representation of
|
|
``longrepr``.
|
|
|
|
.. versionadded:: 3.0
|
|
"""
|
|
file = StringIO()
|
|
tw = TerminalWriter(file)
|
|
tw.hasmarkup = False
|
|
self.toterminal(tw)
|
|
exc = file.getvalue()
|
|
return exc.strip()
|
|
|
|
@property
|
|
def caplog(self) -> str:
|
|
"""Return captured log lines, if log capturing is enabled.
|
|
|
|
.. versionadded:: 3.5
|
|
"""
|
|
return "\n".join(
|
|
content for (prefix, content) in self.get_sections("Captured log")
|
|
)
|
|
|
|
@property
|
|
def capstdout(self) -> str:
|
|
"""Return captured text from stdout, if capturing is enabled.
|
|
|
|
.. versionadded:: 3.0
|
|
"""
|
|
return "".join(
|
|
content for (prefix, content) in self.get_sections("Captured stdout")
|
|
)
|
|
|
|
@property
|
|
def capstderr(self) -> str:
|
|
"""Return captured text from stderr, if capturing is enabled.
|
|
|
|
.. versionadded:: 3.0
|
|
"""
|
|
return "".join(
|
|
content for (prefix, content) in self.get_sections("Captured stderr")
|
|
)
|
|
|
|
@property
|
|
def passed(self) -> bool:
|
|
"""Whether the outcome is passed."""
|
|
return self.outcome == "passed"
|
|
|
|
@property
|
|
def failed(self) -> bool:
|
|
"""Whether the outcome is failed."""
|
|
return self.outcome == "failed"
|
|
|
|
@property
|
|
def skipped(self) -> bool:
|
|
"""Whether the outcome is skipped."""
|
|
return self.outcome == "skipped"
|
|
|
|
@property
|
|
def fspath(self) -> str:
|
|
"""The path portion of the reported node, as a string."""
|
|
return self.nodeid.split("::")[0]
|
|
|
|
@property
|
|
def count_towards_summary(self) -> bool:
|
|
"""**Experimental** Whether this report should be counted towards the
|
|
totals shown at the end of the test session: "1 passed, 1 failure, etc".
|
|
|
|
.. note::
|
|
|
|
This function is considered **experimental**, so beware that it is subject to changes
|
|
even in patch releases.
|
|
"""
|
|
return True
|
|
|
|
@property
|
|
def head_line(self) -> Optional[str]:
|
|
"""**Experimental** The head line shown with longrepr output for this
|
|
report, more commonly during traceback representation during
|
|
failures::
|
|
|
|
________ Test.foo ________
|
|
|
|
|
|
In the example above, the head_line is "Test.foo".
|
|
|
|
.. note::
|
|
|
|
This function is considered **experimental**, so beware that it is subject to changes
|
|
even in patch releases.
|
|
"""
|
|
if self.location is not None:
|
|
fspath, lineno, domain = self.location
|
|
return domain
|
|
return None
|
|
|
|
def _get_verbose_word(self, config: Config):
|
|
_category, _short, verbose = config.hook.pytest_report_teststatus(
|
|
report=self, config=config
|
|
)
|
|
return verbose
|
|
|
|
def _to_json(self) -> Dict[str, Any]:
|
|
"""Return the contents of this report as a dict of builtin entries,
|
|
suitable for serialization.
|
|
|
|
This was originally the serialize_report() function from xdist (ca03269).
|
|
|
|
Experimental method.
|
|
"""
|
|
return _report_to_json(self)
|
|
|
|
@classmethod
|
|
def _from_json(cls: Type[_R], reportdict: Dict[str, object]) -> _R:
|
|
"""Create either a TestReport or CollectReport, depending on the calling class.
|
|
|
|
It is the callers responsibility to know which class to pass here.
|
|
|
|
This was originally the serialize_report() function from xdist (ca03269).
|
|
|
|
Experimental method.
|
|
"""
|
|
kwargs = _report_kwargs_from_json(reportdict)
|
|
return cls(**kwargs)
|
|
|
|
|
|
def _report_unserialization_failure(
|
|
type_name: str, report_class: Type[BaseReport], reportdict
|
|
) -> "NoReturn":
|
|
url = "https://github.com/pytest-dev/pytest/issues"
|
|
stream = StringIO()
|
|
pprint("-" * 100, stream=stream)
|
|
pprint("INTERNALERROR: Unknown entry type returned: %s" % type_name, stream=stream)
|
|
pprint("report_name: %s" % report_class, stream=stream)
|
|
pprint(reportdict, stream=stream)
|
|
pprint("Please report this bug at %s" % url, stream=stream)
|
|
pprint("-" * 100, stream=stream)
|
|
raise RuntimeError(stream.getvalue())
|
|
|
|
|
|
@final
|
|
class TestReport(BaseReport):
|
|
"""Basic test report object (also used for setup and teardown calls if
|
|
they fail).
|
|
|
|
Reports can contain arbitrary extra attributes.
|
|
"""
|
|
|
|
__test__ = False
|
|
|
|
def __init__(
|
|
self,
|
|
nodeid: str,
|
|
location: Tuple[str, Optional[int], str],
|
|
keywords: Mapping[str, Any],
|
|
outcome: "Literal['passed', 'failed', 'skipped']",
|
|
longrepr: Union[
|
|
None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr
|
|
],
|
|
when: "Literal['setup', 'call', 'teardown']",
|
|
sections: Iterable[Tuple[str, str]] = (),
|
|
duration: float = 0,
|
|
user_properties: Optional[Iterable[Tuple[str, object]]] = None,
|
|
**extra,
|
|
) -> None:
|
|
#: Normalized collection nodeid.
|
|
self.nodeid = nodeid
|
|
|
|
#: A (filesystempath, lineno, domaininfo) tuple indicating the
|
|
#: actual location of a test item - it might be different from the
|
|
#: collected one e.g. if a method is inherited from a different module.
|
|
self.location: Tuple[str, Optional[int], str] = location
|
|
|
|
#: A name -> value dictionary containing all keywords and
|
|
#: markers associated with a test invocation.
|
|
self.keywords = keywords
|
|
|
|
#: Test outcome, always one of "passed", "failed", "skipped".
|
|
self.outcome = outcome
|
|
|
|
#: None or a failure representation.
|
|
self.longrepr = longrepr
|
|
|
|
#: One of 'setup', 'call', 'teardown' to indicate runtest phase.
|
|
self.when = when
|
|
|
|
#: User properties is a list of tuples (name, value) that holds user
|
|
#: defined properties of the test.
|
|
self.user_properties = list(user_properties or [])
|
|
|
|
#: Tuples of str ``(heading, content)`` with extra information
|
|
#: for the test report. Used by pytest to add text captured
|
|
#: from ``stdout``, ``stderr``, and intercepted logging events. May
|
|
#: be used by other plugins to add arbitrary information to reports.
|
|
self.sections = list(sections)
|
|
|
|
#: Time it took to run just the test.
|
|
self.duration = duration
|
|
|
|
self.__dict__.update(extra)
|
|
|
|
def __repr__(self) -> str:
|
|
return "<{} {!r} when={!r} outcome={!r}>".format(
|
|
self.__class__.__name__, self.nodeid, self.when, self.outcome
|
|
)
|
|
|
|
@classmethod
|
|
def from_item_and_call(cls, item: Item, call: "CallInfo[None]") -> "TestReport":
|
|
"""Create and fill a TestReport with standard item and call info."""
|
|
when = call.when
|
|
# Remove "collect" from the Literal type -- only for collection calls.
|
|
assert when != "collect"
|
|
duration = call.duration
|
|
keywords = {x: 1 for x in item.keywords}
|
|
excinfo = call.excinfo
|
|
sections = []
|
|
if not call.excinfo:
|
|
outcome: Literal["passed", "failed", "skipped"] = "passed"
|
|
longrepr: Union[
|
|
None,
|
|
ExceptionInfo[BaseException],
|
|
Tuple[str, int, str],
|
|
str,
|
|
TerminalRepr,
|
|
] = None
|
|
else:
|
|
if not isinstance(excinfo, ExceptionInfo):
|
|
outcome = "failed"
|
|
longrepr = excinfo
|
|
elif isinstance(excinfo.value, skip.Exception):
|
|
outcome = "skipped"
|
|
r = excinfo._getreprcrash()
|
|
if excinfo.value._use_item_location:
|
|
path, line = item.reportinfo()[:2]
|
|
assert line is not None
|
|
longrepr = os.fspath(path), line + 1, r.message
|
|
else:
|
|
longrepr = (str(r.path), r.lineno, r.message)
|
|
else:
|
|
outcome = "failed"
|
|
if call.when == "call":
|
|
longrepr = item.repr_failure(excinfo)
|
|
else: # exception in setup or teardown
|
|
longrepr = item._repr_failure_py(
|
|
excinfo, style=item.config.getoption("tbstyle", "auto")
|
|
)
|
|
for rwhen, key, content in item._report_sections:
|
|
sections.append((f"Captured {key} {rwhen}", content))
|
|
return cls(
|
|
item.nodeid,
|
|
item.location,
|
|
keywords,
|
|
outcome,
|
|
longrepr,
|
|
when,
|
|
sections,
|
|
duration,
|
|
user_properties=item.user_properties,
|
|
)
|
|
|
|
|
|
@final
|
|
class CollectReport(BaseReport):
|
|
"""Collection report object.
|
|
|
|
Reports can contain arbitrary extra attributes.
|
|
"""
|
|
|
|
when = "collect"
|
|
|
|
def __init__(
|
|
self,
|
|
nodeid: str,
|
|
outcome: "Literal['passed', 'failed', 'skipped']",
|
|
longrepr: Union[
|
|
None, ExceptionInfo[BaseException], Tuple[str, int, str], str, TerminalRepr
|
|
],
|
|
result: Optional[List[Union[Item, Collector]]],
|
|
sections: Iterable[Tuple[str, str]] = (),
|
|
**extra,
|
|
) -> None:
|
|
#: Normalized collection nodeid.
|
|
self.nodeid = nodeid
|
|
|
|
#: Test outcome, always one of "passed", "failed", "skipped".
|
|
self.outcome = outcome
|
|
|
|
#: None or a failure representation.
|
|
self.longrepr = longrepr
|
|
|
|
#: The collected items and collection nodes.
|
|
self.result = result or []
|
|
|
|
#: Tuples of str ``(heading, content)`` with extra information
|
|
#: for the test report. Used by pytest to add text captured
|
|
#: from ``stdout``, ``stderr``, and intercepted logging events. May
|
|
#: be used by other plugins to add arbitrary information to reports.
|
|
self.sections = list(sections)
|
|
|
|
self.__dict__.update(extra)
|
|
|
|
@property
|
|
def location(self):
|
|
return (self.fspath, None, self.fspath)
|
|
|
|
def __repr__(self) -> str:
|
|
return "<CollectReport {!r} lenresult={} outcome={!r}>".format(
|
|
self.nodeid, len(self.result), self.outcome
|
|
)
|
|
|
|
|
|
class CollectErrorRepr(TerminalRepr):
|
|
def __init__(self, msg: str) -> None:
|
|
self.longrepr = msg
|
|
|
|
def toterminal(self, out: TerminalWriter) -> None:
|
|
out.line(self.longrepr, red=True)
|
|
|
|
|
|
def pytest_report_to_serializable(
|
|
report: Union[CollectReport, TestReport]
|
|
) -> Optional[Dict[str, Any]]:
|
|
if isinstance(report, (TestReport, CollectReport)):
|
|
data = report._to_json()
|
|
data["$report_type"] = report.__class__.__name__
|
|
return data
|
|
# TODO: Check if this is actually reachable.
|
|
return None # type: ignore[unreachable]
|
|
|
|
|
|
def pytest_report_from_serializable(
|
|
data: Dict[str, Any],
|
|
) -> Optional[Union[CollectReport, TestReport]]:
|
|
if "$report_type" in data:
|
|
if data["$report_type"] == "TestReport":
|
|
return TestReport._from_json(data)
|
|
elif data["$report_type"] == "CollectReport":
|
|
return CollectReport._from_json(data)
|
|
assert False, "Unknown report_type unserialize data: {}".format(
|
|
data["$report_type"]
|
|
)
|
|
return None
|
|
|
|
|
|
def _report_to_json(report: BaseReport) -> Dict[str, Any]:
|
|
"""Return the contents of this report as a dict of builtin entries,
|
|
suitable for serialization.
|
|
|
|
This was originally the serialize_report() function from xdist (ca03269).
|
|
"""
|
|
|
|
def serialize_repr_entry(
|
|
entry: Union[ReprEntry, ReprEntryNative]
|
|
) -> Dict[str, Any]:
|
|
data = attr.asdict(entry) # type:ignore[arg-type]
|
|
for key, value in data.items():
|
|
if hasattr(value, "__dict__"):
|
|
data[key] = attr.asdict(value)
|
|
entry_data = {"type": type(entry).__name__, "data": data}
|
|
return entry_data
|
|
|
|
def serialize_repr_traceback(reprtraceback: ReprTraceback) -> Dict[str, Any]:
|
|
result = attr.asdict(reprtraceback) # type:ignore[arg-type]
|
|
result["reprentries"] = [
|
|
serialize_repr_entry(x) for x in reprtraceback.reprentries
|
|
]
|
|
return result
|
|
|
|
def serialize_repr_crash(
|
|
reprcrash: Optional[ReprFileLocation],
|
|
) -> Optional[Dict[str, Any]]:
|
|
if reprcrash is not None:
|
|
return attr.asdict(reprcrash) # type:ignore[arg-type]
|
|
else:
|
|
return None
|
|
|
|
def serialize_exception_longrepr(rep: BaseReport) -> Dict[str, Any]:
|
|
assert rep.longrepr is not None
|
|
# TODO: Investigate whether the duck typing is really necessary here.
|
|
longrepr = cast(ExceptionRepr, rep.longrepr)
|
|
result: Dict[str, Any] = {
|
|
"reprcrash": serialize_repr_crash(longrepr.reprcrash),
|
|
"reprtraceback": serialize_repr_traceback(longrepr.reprtraceback),
|
|
"sections": longrepr.sections,
|
|
}
|
|
if isinstance(longrepr, ExceptionChainRepr):
|
|
result["chain"] = []
|
|
for repr_traceback, repr_crash, description in longrepr.chain:
|
|
result["chain"].append(
|
|
(
|
|
serialize_repr_traceback(repr_traceback),
|
|
serialize_repr_crash(repr_crash),
|
|
description,
|
|
)
|
|
)
|
|
else:
|
|
result["chain"] = None
|
|
return result
|
|
|
|
d = report.__dict__.copy()
|
|
if hasattr(report.longrepr, "toterminal"):
|
|
if hasattr(report.longrepr, "reprtraceback") and hasattr(
|
|
report.longrepr, "reprcrash"
|
|
):
|
|
d["longrepr"] = serialize_exception_longrepr(report)
|
|
else:
|
|
d["longrepr"] = str(report.longrepr)
|
|
else:
|
|
d["longrepr"] = report.longrepr
|
|
for name in d:
|
|
if isinstance(d[name], os.PathLike):
|
|
d[name] = os.fspath(d[name])
|
|
elif name == "result":
|
|
d[name] = None # for now
|
|
return d
|
|
|
|
|
|
def _report_kwargs_from_json(reportdict: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Return **kwargs that can be used to construct a TestReport or
|
|
CollectReport instance.
|
|
|
|
This was originally the serialize_report() function from xdist (ca03269).
|
|
"""
|
|
|
|
def deserialize_repr_entry(entry_data):
|
|
data = entry_data["data"]
|
|
entry_type = entry_data["type"]
|
|
if entry_type == "ReprEntry":
|
|
reprfuncargs = None
|
|
reprfileloc = None
|
|
reprlocals = None
|
|
if data["reprfuncargs"]:
|
|
reprfuncargs = ReprFuncArgs(**data["reprfuncargs"])
|
|
if data["reprfileloc"]:
|
|
reprfileloc = ReprFileLocation(**data["reprfileloc"])
|
|
if data["reprlocals"]:
|
|
reprlocals = ReprLocals(data["reprlocals"]["lines"])
|
|
|
|
reprentry: Union[ReprEntry, ReprEntryNative] = ReprEntry(
|
|
lines=data["lines"],
|
|
reprfuncargs=reprfuncargs,
|
|
reprlocals=reprlocals,
|
|
reprfileloc=reprfileloc,
|
|
style=data["style"],
|
|
)
|
|
elif entry_type == "ReprEntryNative":
|
|
reprentry = ReprEntryNative(data["lines"])
|
|
else:
|
|
_report_unserialization_failure(entry_type, TestReport, reportdict)
|
|
return reprentry
|
|
|
|
def deserialize_repr_traceback(repr_traceback_dict):
|
|
repr_traceback_dict["reprentries"] = [
|
|
deserialize_repr_entry(x) for x in repr_traceback_dict["reprentries"]
|
|
]
|
|
return ReprTraceback(**repr_traceback_dict)
|
|
|
|
def deserialize_repr_crash(repr_crash_dict: Optional[Dict[str, Any]]):
|
|
if repr_crash_dict is not None:
|
|
return ReprFileLocation(**repr_crash_dict)
|
|
else:
|
|
return None
|
|
|
|
if (
|
|
reportdict["longrepr"]
|
|
and "reprcrash" in reportdict["longrepr"]
|
|
and "reprtraceback" in reportdict["longrepr"]
|
|
):
|
|
|
|
reprtraceback = deserialize_repr_traceback(
|
|
reportdict["longrepr"]["reprtraceback"]
|
|
)
|
|
reprcrash = deserialize_repr_crash(reportdict["longrepr"]["reprcrash"])
|
|
if reportdict["longrepr"]["chain"]:
|
|
chain = []
|
|
for repr_traceback_data, repr_crash_data, description in reportdict[
|
|
"longrepr"
|
|
]["chain"]:
|
|
chain.append(
|
|
(
|
|
deserialize_repr_traceback(repr_traceback_data),
|
|
deserialize_repr_crash(repr_crash_data),
|
|
description,
|
|
)
|
|
)
|
|
exception_info: Union[
|
|
ExceptionChainRepr, ReprExceptionInfo
|
|
] = ExceptionChainRepr(chain)
|
|
else:
|
|
exception_info = ReprExceptionInfo(reprtraceback, reprcrash)
|
|
|
|
for section in reportdict["longrepr"]["sections"]:
|
|
exception_info.addsection(*section)
|
|
reportdict["longrepr"] = exception_info
|
|
|
|
return reportdict
|