fastapi-cli/tests/test_utils_package.py at 6f3ef3e78e786ef16a57a317284a3ec2d222a976 · fastapi/fastapi-cli · GitHub

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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
from pathlib import Path

import pytest
from pytest import CaptureFixture

from fastapi_cli.discover import get_import_data
from fastapi_cli.exceptions import FastAPICLIException
from tests.utils import changing_dir

assets_path = Path(__file__).parent / "assets"


def test_package_app_root() -> None:
    with changing_dir(assets_path):
        import_data = get_import_data(path=Path("package/mod/app.py"))

    assert import_data.import_string == "package.mod.app:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.app"


def test_package_api_root() -> None:
    with changing_dir(assets_path):
        import_data = get_import_data(path=Path("package/mod/api.py"))

    assert import_data.import_string == "package.mod.api:api"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.api"


def test_package_other_root() -> None:
    with changing_dir(assets_path):
        import_data = get_import_data(path=Path("package/mod/other.py"))

    assert import_data.import_string == "package.mod.other:first_other"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.other"


def test_package_app_mod() -> None:
    with changing_dir(assets_path / "package/mod"):
        import_data = get_import_data(path=Path("app.py"))

    assert import_data.import_string == "package.mod.app:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.app"


def test_package_api_mod() -> None:
    with changing_dir(assets_path / "package/mod"):
        import_data = get_import_data(path=Path("api.py"))

    assert import_data.import_string == "package.mod.api:api"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.api"


def test_package_other_mod() -> None:
    with changing_dir(assets_path / "package/mod"):
        import_data = get_import_data(path=Path("other.py"))

    assert import_data.import_string == "package.mod.other:first_other"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.other"


def test_package_app_above() -> None:
    with changing_dir(assets_path.parent):
        import_data = get_import_data(path=Path("assets/package/mod/app.py"))

    assert import_data.import_string == "package.mod.app:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.app"


def test_package_api_parent() -> None:
    with changing_dir(assets_path.parent):
        import_data = get_import_data(path=Path("assets/package/mod/api.py"))

    assert import_data.import_string == "package.mod.api:api"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.api"


def test_package_other_parent() -> None:
    with changing_dir(assets_path.parent):
        import_data = get_import_data(path=Path("assets/package/mod/other.py"))

    assert import_data.import_string == "package.mod.other:first_other"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod.other"


def test_package_mod_init_inside() -> None:
    with changing_dir(assets_path / "package/mod"):
        import_data = get_import_data(path=Path("__init__.py"))
        assert import_data.import_string == "package.mod:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod"


def test_package_mod_dir() -> None:
    with changing_dir(assets_path):
        import_data = get_import_data(path=Path("package/mod"))

    assert import_data.import_string == "package.mod:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package.mod"


def test_package_init_inside() -> None:
    with changing_dir(assets_path / "package"):
        import_data = get_import_data(path=Path("__init__.py"))

    assert import_data.import_string == "package:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package"


def test_package_dir_inside_package() -> None:
    with changing_dir(assets_path / "package/mod"):
        import_data = get_import_data(path=Path("../"))

    assert import_data.import_string == "package:app"
    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package"


def test_package_dir_above_package() -> None:
    with changing_dir(assets_path.parent):
        import_data = get_import_data(path=Path("assets/package"))

    assert import_data.import_string == "package:app"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package"


def test_package_dir_explicit_app() -> None:
    with changing_dir(assets_path):
        import_data = get_import_data(path=Path("package"), app_name="api")

    assert import_data.import_string == "package:api"

    assert import_data.module_data.extra_sys_path == assets_path
    assert import_data.module_data.module_import_str == "package"


def test_broken_package_dir(capsys: CaptureFixture[str]) -> None:
    with changing_dir(assets_path):
        # TODO (when deprecating Python 3.8): remove ValueError
        with pytest.raises((ImportError, ValueError)):
            get_import_data(path=Path("broken_package/mod/app.py"))

    captured = capsys.readouterr()
    assert "Import error:" in captured.out
    assert "Ensure all the package directories have an __init__.py file" in captured.out


def test_package_dir_no_app() -> None:
    with changing_dir(assets_path):
        with pytest.raises(FastAPICLIException) as e:
            get_import_data(path=Path("package/core/utils.py"))
        assert (
            "Could not find FastAPI app or app factory in module, try using --app"
            in e.value.args[0]
        )


def test_package_dir_object_not_an_app() -> None:
    with changing_dir(assets_path):
        with pytest.raises(FastAPICLIException) as e:
            get_import_data(
                path=Path("package/core/utils.py"), app_name="get_hello_world"
            )
        assert (
            "The app name get_hello_world in package.core.utils doesn't seem to be a FastAPI app"
            in e.value.args[0]
        )


def test_package_dir_object_app_name_not_found() -> None:
    with changing_dir(assets_path):
        with pytest.raises(FastAPICLIException) as e:
            get_import_data(path=Path("package"), app_name="non_existent_app")
        assert "Could not find app name non_existent_app in package" in e.value.args[0]