""" Various common utilities for testing. """ import pathlib import sys import pytest pytest_plugins = ("pytest_asyncio",) ROOT_PATH = pathlib.Path(__file__).parents[0].resolve() DIST_PATH = ROOT_PATH / "dist" sys.path.append(str(ROOT_PATH / "pyodide-test-runner")) sys.path.append(str(ROOT_PATH / "pyodide-build")) sys.path.append(str(ROOT_PATH / "src" / "py")) from pyodide_test_runner.fixture import ( # noqa: F401 script_type, selenium, selenium_common, selenium_context_manager, selenium_esm, selenium_module_scope, selenium_standalone, selenium_standalone_noload, selenium_standalone_noload_common, selenium_webworker_standalone, web_server_main, web_server_secondary, ) from pyodide_test_runner.utils import maybe_skip_test from pyodide_test_runner.utils import package_is_built as _package_is_built def pytest_addoption(parser): group = parser.getgroup("general") group.addoption( "--dist-dir", action="store", default=DIST_PATH, help="Path to the dist directory", ) group.addoption( "--run-xfail", action="store_true", help="If provided, tests marked as xfail will be run", ) def pytest_configure(config): """Monkey patch the function cwd_relative_nodeid returns the description of a test for the short summary table. Monkey patch it to reduce the verbosity of the test names in the table. This leaves enough room to see the information about the test failure in the summary. """ global CONFIG old_cwd_relative_nodeid = config.cwd_relative_nodeid def cwd_relative_nodeid(*args): result = old_cwd_relative_nodeid(*args) result = result.replace("src/tests/", "") result = result.replace("packages/", "") result = result.replace("::test_", "::") return result config.cwd_relative_nodeid = cwd_relative_nodeid pytest.pyodide_dist_dir = config.getoption("--dist-dir") def pytest_collection_modifyitems(config, items): """Called after collect is completed. Parameters ---------- config : pytest config items : list of collected items """ for item in items: maybe_skip_test(item, config.getoption("--dist-dir"), delayed=True) @pytest.hookimpl(hookwrapper=True) def pytest_runtest_call(item): """We want to run extra verification at the start and end of each test to check that we haven't leaked memory. According to pytest issue #5044, it's not possible to "Fail" a test from a fixture (no matter what you do, pytest sets the test status to "Error"). The approach suggested there is hook pytest_runtest_call as we do here. To get access to the selenium fixture, we imitate the definition of pytest_pyfunc_call: https://github.com/pytest-dev/pytest/blob/6.2.2/src/_pytest/python.py#L177 Pytest issue #5044: https://github.com/pytest-dev/pytest/issues/5044 """ browser = None for fixture in item._fixtureinfo.argnames: if fixture.startswith("selenium"): browser = item.funcargs[fixture] break if browser and browser.pyodide_loaded: trace_pyproxies = pytest.mark.skip_pyproxy_check.mark not in item.own_markers trace_hiwire_refs = ( trace_pyproxies and pytest.mark.skip_refcount_check.mark not in item.own_markers ) yield from extra_checks_test_wrapper( browser, trace_hiwire_refs, trace_pyproxies ) else: yield def extra_checks_test_wrapper(browser, trace_hiwire_refs, trace_pyproxies): """Extra conditions for test to pass: 1. No explicit request for test to fail 2. No leaked JsRefs 3. No leaked PyProxys """ browser.clear_force_test_fail() init_num_keys = browser.get_num_hiwire_keys() if trace_pyproxies: browser.enable_pyproxy_tracing() init_num_proxies = browser.get_num_proxies() a = yield try: # If these guys cause a crash because the test really screwed things up, # we override the error message with the better message returned by # a.result() in the finally block. browser.disable_pyproxy_tracing() browser.restore_state() finally: # if there was an error in the body of the test, flush it out by calling # get_result (we don't want to override the error message by raising a # different error here.) a.get_result() if browser.force_test_fail: raise Exception("Test failure explicitly requested but no error was raised.") if trace_pyproxies and trace_hiwire_refs: delta_proxies = browser.get_num_proxies() - init_num_proxies delta_keys = browser.get_num_hiwire_keys() - init_num_keys assert (delta_proxies, delta_keys) == (0, 0) or delta_keys < 0 if trace_hiwire_refs: delta_keys = browser.get_num_hiwire_keys() - init_num_keys assert delta_keys <= 0 def package_is_built(package_name): return _package_is_built(package_name, pytest.pyodide_dist_dir) import ast from copy import deepcopy from typing import Any from _pytest.assertion.rewrite import AssertionRewritingHook, rewrite_asserts from _pytest.python import ( pytest_pycollect_makemodule as orig_pytest_pycollect_makemodule, ) # Handling for pytest assertion rewrites # First we find the pytest rewrite config. It's an attribute of the pytest # assertion rewriting meta_path_finder, so we locate that to get the config. def _get_pytest_rewrite_config() -> Any: for meta_path_finder in sys.meta_path: if isinstance(meta_path_finder, AssertionRewritingHook): break else: return None return meta_path_finder.config # Now we need to parse the ast of the files, rewrite the ast, and store the # original and rewritten ast into dictionaries. `run_in_pyodide` will look the # ast up in the appropriate dictionary depending on whether or not it is using # pytest assert rewrites. REWRITE_CONFIG = _get_pytest_rewrite_config() del _get_pytest_rewrite_config ORIGINAL_MODULE_ASTS: dict[str, ast.Module] = {} REWRITTEN_MODULE_ASTS: dict[str, ast.Module] = {} def pytest_pycollect_makemodule( module_path: pathlib.Path, path: Any, parent: Any ) -> None: source = module_path.read_bytes() strfn = str(module_path) tree = ast.parse(source, filename=strfn) ORIGINAL_MODULE_ASTS[strfn] = tree tree2 = deepcopy(tree) rewrite_asserts(tree2, source, strfn, REWRITE_CONFIG) REWRITTEN_MODULE_ASTS[strfn] = tree2 orig_pytest_pycollect_makemodule(module_path, parent)