forked from PrefectHQ/prefect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_plugins.py
265 lines (203 loc) · 7.98 KB
/
test_plugins.py
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
import importlib
import pathlib
import textwrap
from unittest.mock import Mock
import pytest
import prefect
from prefect.plugins import load_extra_entrypoints
from prefect.settings import PREFECT_EXTRA_ENTRYPOINTS, temporary_settings
from prefect.testing.utilities import exceptions_equal
@pytest.fixture
def module_fixture(tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch):
monkeypatch.syspath_prepend(tmp_path)
(tmp_path / "test_module_name.py").write_text(
textwrap.dedent(
"""
import os
from unittest.mock import MagicMock
def returns_test():
return "test"
def returns_foo():
return "foo"
def returns_bar():
return "bar"
def raises_value_error():
raise ValueError("test")
def raises_base_exception():
raise BaseException("test")
def mock_function(*args, **kwargs):
mock = MagicMock()
mock(*args, **kwargs)
return mock
"""
)
)
yield
importlib.invalidate_caches()
@pytest.fixture
def raising_module_fixture(tmp_path: pathlib.Path, monkeypatch: pytest.MonkeyPatch):
monkeypatch.syspath_prepend(tmp_path)
(tmp_path / "raising_module_name.py").write_text(
textwrap.dedent(
"""
raise RuntimeError("test")
"""
)
)
yield
importlib.invalidate_caches()
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_imports_module():
with temporary_settings({PREFECT_EXTRA_ENTRYPOINTS: "test_module_name"}):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name"}
assert result["test_module_name"] == importlib.import_module("test_module_name")
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_strips_spaces():
with temporary_settings({PREFECT_EXTRA_ENTRYPOINTS: " test_module_name "}):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name"}
assert result["test_module_name"] == importlib.import_module("test_module_name")
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_unparsable_entrypoint(capsys):
with temporary_settings({PREFECT_EXTRA_ENTRYPOINTS: "foo$bar"}):
result = load_extra_entrypoints()
assert set(result.keys()) == {"foo$bar"}
assert exceptions_equal(
result["foo$bar"], AttributeError("'NoneType' object has no attribute 'group'")
)
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to load extra entrypoint 'foo$bar': "
"AttributeError: 'NoneType' object has no attribute 'group'"
in stderr
)
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_callable():
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name:returns_test"}
):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name:returns_test"}
assert result["test_module_name:returns_test"] == "test"
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_multiple_entrypoints():
with temporary_settings(
{
PREFECT_EXTRA_ENTRYPOINTS: (
"test_module_name:returns_foo,test_module_name:returns_bar"
)
}
):
result = load_extra_entrypoints()
assert result == {
"test_module_name:returns_foo": "foo",
"test_module_name:returns_bar": "bar",
}
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_callable_given_no_arguments():
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name:mock_function"}
):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name:mock_function"}
result["test_module_name:mock_function"].assert_called_once_with()
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_callable_that_raises(capsys):
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name:raises_value_error"}
):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name:raises_value_error"}
assert exceptions_equal(
result["test_module_name:raises_value_error"], ValueError("test")
)
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to run callable entrypoint "
"'test_module_name:raises_value_error': ValueError: test"
in stderr
)
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_callable_that_raises_base_exception():
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name:raises_base_exception"}
):
with pytest.raises(BaseException, match="test"):
load_extra_entrypoints()
@pytest.mark.usefixtures("raising_module_fixture")
def test_load_extra_entrypoints_error_on_import(capsys):
with temporary_settings({PREFECT_EXTRA_ENTRYPOINTS: "raising_module_name"}):
result = load_extra_entrypoints()
assert set(result.keys()) == {"raising_module_name"}
assert exceptions_equal(result["raising_module_name"], RuntimeError("test"))
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to load extra entrypoint 'raising_module_name': "
"RuntimeError: test"
in stderr
)
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_missing_module(capsys):
with temporary_settings({PREFECT_EXTRA_ENTRYPOINTS: "nonexistant_module"}):
result = load_extra_entrypoints()
assert set(result.keys()) == {"nonexistant_module"}
assert exceptions_equal(
result["nonexistant_module"],
ModuleNotFoundError("No module named 'nonexistant_module'"),
)
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to load extra entrypoint 'nonexistant_module': "
"ModuleNotFoundError"
in stderr
)
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_missing_submodule(capsys):
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name.missing_module"}
):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name.missing_module"}
assert exceptions_equal(
result["test_module_name.missing_module"],
ModuleNotFoundError(
"No module named 'test_module_name.missing_module'; "
"'test_module_name' is not a package"
),
)
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to load extra entrypoint 'test_module_name.missing_module': "
"ModuleNotFoundError"
in stderr
)
@pytest.mark.usefixtures("module_fixture")
def test_load_extra_entrypoints_missing_attribute(capsys):
with temporary_settings(
{PREFECT_EXTRA_ENTRYPOINTS: "test_module_name:missing_attr"}
):
result = load_extra_entrypoints()
assert set(result.keys()) == {"test_module_name:missing_attr"}
assert exceptions_equal(
result["test_module_name:missing_attr"],
AttributeError("module 'test_module_name' has no attribute 'missing_attr'"),
)
_, stderr = capsys.readouterr()
assert (
"Warning! Failed to load extra entrypoint 'test_module_name:missing_attr': "
"AttributeError"
in stderr
)
def test_plugin_load_on_prefect_package_init(monkeypatch):
mock_load_prefect_collections = Mock()
mock_load_extra_entrypoints = Mock()
monkeypatch.setattr(
prefect.plugins, "load_prefect_collections", mock_load_prefect_collections
)
monkeypatch.setattr(
prefect.plugins, "load_extra_entrypoints", mock_load_extra_entrypoints
)
importlib.reload(prefect)
mock_load_prefect_collections.assert_not_called() # We no longer load collections on import due to high performance cost
mock_load_extra_entrypoints.assert_called_once()