How to use pytest_report_to_serializable method in Pytest

Best Python code snippet using pytest

test_reports.py

Source:test_reports.py

...233        reprec = testdir.inline_run()234        reports = reprec.getreports("pytest_runtest_logreport")235        assert len(reports) == 6236        for rep in reports:237            data = pytestconfig.hook.pytest_report_to_serializable(238                config=pytestconfig, report=rep239            )240            assert data["_report_type"] == "TestReport"241            new_rep = pytestconfig.hook.pytest_report_from_serializable(242                config=pytestconfig, data=data243            )244            assert new_rep.nodeid == rep.nodeid245            assert new_rep.when == rep.when246            assert new_rep.outcome == rep.outcome247    def test_collect_report(self, testdir, pytestconfig):248        testdir.makepyfile(249            """250            def test_a(): assert False251            def test_b(): pass252        """253        )254        reprec = testdir.inline_run()255        reports = reprec.getreports("pytest_collectreport")256        assert len(reports) == 2257        for rep in reports:258            data = pytestconfig.hook.pytest_report_to_serializable(259                config=pytestconfig, report=rep260            )261            assert data["_report_type"] == "CollectReport"262            new_rep = pytestconfig.hook.pytest_report_from_serializable(263                config=pytestconfig, data=data264            )265            assert new_rep.nodeid == rep.nodeid266            assert new_rep.when == "collect"267            assert new_rep.outcome == rep.outcome268    @pytest.mark.parametrize(269        "hook_name", ["pytest_runtest_logreport", "pytest_collectreport"]270    )271    def test_invalid_report_types(self, testdir, pytestconfig, hook_name):272        testdir.makepyfile(273            """274            def test_a(): pass275            """276        )277        reprec = testdir.inline_run()278        reports = reprec.getreports(hook_name)279        assert reports280        rep = reports[0]281        data = pytestconfig.hook.pytest_report_to_serializable(282            config=pytestconfig, report=rep283        )284        data["_report_type"] = "Unknown"285        with pytest.raises(AssertionError):286            _ = pytestconfig.hook.pytest_report_from_serializable(287                config=pytestconfig, data=data...

remote.py

Source:remote.py

...86        self.sendevent("logstart", nodeid=nodeid, location=location)87    def pytest_runtest_logfinish(self, nodeid, location):88        self.sendevent("logfinish", nodeid=nodeid, location=location)89    def pytest_runtest_logreport(self, report):90        data = self.config.hook.pytest_report_to_serializable(91            config=self.config, report=report92        )93        data["item_index"] = self.item_index94        data["worker_id"] = self.workerid95        data["testrun_uid"] = self.testrunuid96        assert self.session.items[self.item_index].nodeid == report.nodeid97        self.sendevent("testreport", data=data)98    def pytest_collectreport(self, report):99        # send only reports that have not passed to master as optimization (#330)100        if not report.passed:101            data = self.config.hook.pytest_report_to_serializable(102                config=self.config, report=report103            )104            self.sendevent("collectreport", data=data)105    def pytest_warning_recorded(self, warning_message, when, nodeid, location):106        self.sendevent(107            "warning_recorded",108            warning_message_data=serialize_warning_message(warning_message),109            when=when,110            nodeid=nodeid,111            location=location,112        )113def serialize_warning_message(warning_message):114    if isinstance(warning_message.message, Warning):115        message_module = type(warning_message.message).__module__...

plugin.py

Source:plugin.py

...45    def pytest_sessionfinish(self, exitstatus):46        data = {"exitstatus": exitstatus, "$report_type": "SessionFinish"}47        self._write_json_data(data)48    def pytest_runtest_logreport(self, report):49        data = self._config.hook.pytest_report_to_serializable(50            config=self._config, report=report51        )52        self._write_json_data(data)53    def pytest_collectreport(self, report):54        data = self._config.hook.pytest_report_to_serializable(55            config=self._config, report=report56        )57        self._write_json_data(data)58    def pytest_terminal_summary(self, terminalreporter):59        terminalreporter.write_sep(60            "-", "generated report log file: {}".format(self._log_path)61        )62def cleanup_unserializable(d: Dict[str, Any]) -> Dict[str, Any]:63    """Return new dict with entries that are not json serializable by their str()."""64    result = {}65    for k, v in d.items():66        try:67            json.dumps({k: v})68        except TypeError:...

Pytest Tutorial

Looking for an in-depth tutorial around pytest? LambdaTest covers the detailed pytest tutorial that has everything related to the pytest, from setting up the pytest framework to automation testing. Delve deeper into pytest testing by exploring advanced use cases like parallel testing, pytest fixtures, parameterization, executing multiple test cases from a single file, and more.

Chapters

What is pytest
Pytest installation: Want to start pytest from scratch? See how to install and configure pytest for Python automation testing.
Run first test with pytest framework: Follow this step-by-step tutorial to write and run your first pytest script.
Parallel testing with pytest: A hands-on guide to parallel testing with pytest to improve the scalability of your test automation.
Generate pytest reports: Reports make it easier to understand the results of pytest-based test runs. Learn how to generate pytest reports.
Pytest Parameterized tests: Create and run your pytest scripts while avoiding code duplication and increasing test coverage with parameterization.
Pytest Fixtures: Check out how to implement pytest fixtures for your end-to-end testing needs.
Execute Multiple Test Cases: Explore different scenarios for running multiple test cases in pytest from a single file.
Stop Test Suite after N Test Failures: See how to stop your test suite after n test failures in pytest using the @pytest.mark.incremental decorator and maxfail command-line option.