File: test_collect_imported_tests.py

package info (click to toggle)
pytest 9.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 8,308 kB
  • sloc: python: 65,808; makefile: 45
file content (102 lines) | stat: -rw-r--r-- 2,889 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
"""Tests for the `collect_imported_tests` configuration value."""

from __future__ import annotations

import textwrap

from _pytest.pytester import Pytester
import pytest


def setup_files(pytester: Pytester) -> None:
    src_dir = pytester.mkdir("src")
    tests_dir = pytester.mkdir("tests")
    src_file = src_dir / "foo.py"

    src_file.write_text(
        textwrap.dedent("""\
            class Testament:
                def test_collections(self):
                    pass

            def test_testament(): pass
        """),
        encoding="utf-8",
    )

    test_file = tests_dir / "foo_test.py"
    test_file.write_text(
        textwrap.dedent("""\
            from foo import Testament, test_testament

            class TestDomain:
                def test(self):
                    testament = Testament()
                    assert testament
        """),
        encoding="utf-8",
    )

    pytester.syspathinsert(src_dir)


def test_collect_imports_disabled(pytester: Pytester) -> None:
    """
    When collect_imported_tests is disabled, only objects in the
    test modules are collected as tests, so the imported names (`Testament` and `test_testament`)
    are not collected.
    """
    pytester.makeini(
        """
        [pytest]
        collect_imported_tests = false
        """
    )

    setup_files(pytester)
    result = pytester.runpytest("-v", "tests")
    result.stdout.fnmatch_lines(
        [
            "tests/foo_test.py::TestDomain::test PASSED*",
        ]
    )

    # Ensure that the hooks were only called for the collected item.
    reprec = result.reprec  # type:ignore[attr-defined]
    reports = reprec.getreports("pytest_collectreport")
    [modified] = reprec.getcalls("pytest_collection_modifyitems")
    [item_collected] = reprec.getcalls("pytest_itemcollected")

    assert [x.nodeid for x in reports] == [
        "",
        "tests/foo_test.py::TestDomain",
        "tests/foo_test.py",
        "tests",
    ]
    assert [x.nodeid for x in modified.items] == ["tests/foo_test.py::TestDomain::test"]
    assert item_collected.item.nodeid == "tests/foo_test.py::TestDomain::test"


@pytest.mark.parametrize("configure_ini", [False, True])
def test_collect_imports_enabled(pytester: Pytester, configure_ini: bool) -> None:
    """
    When collect_imported_tests is enabled (the default), all names in the
    test modules are collected as tests.
    """
    if configure_ini:
        pytester.makeini(
            """
            [pytest]
            collect_imported_tests = true
            """
        )

    setup_files(pytester)
    result = pytester.runpytest("-v", "tests")
    result.stdout.fnmatch_lines(
        [
            "tests/foo_test.py::Testament::test_collections PASSED*",
            "tests/foo_test.py::test_testament PASSED*",
            "tests/foo_test.py::TestDomain::test PASSED*",
        ]
    )