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
|
import os
import sys
from alembic import command
from alembic import util
from alembic.script import write_hooks
from alembic.testing import assert_raises_message
from alembic.testing import combinations
from alembic.testing import eq_
from alembic.testing import mock
from alembic.testing import TestBase
from alembic.testing.env import _get_staging_directory
from alembic.testing.env import _no_sql_testing_config
from alembic.testing.env import clear_staging_env
from alembic.testing.env import staging_env
from alembic.util import compat
class HookTest(TestBase):
def test_register(self):
@write_hooks.register("my_writer")
def my_writer(path, config):
return path
assert "my_writer" in write_hooks._registry
def test_invoke(self):
my_formatter = mock.Mock()
write_hooks.register("my_writer")(my_formatter)
write_hooks._invoke("my_writer", "/some/path", {"option": 1})
my_formatter.assert_called_once_with("/some/path", {"option": 1})
class RunHookTest(TestBase):
def setUp(self):
self.env = staging_env()
def tearDown(self):
clear_staging_env()
def test_generic(self):
hook1 = mock.Mock()
hook2 = mock.Mock()
write_hooks.register("hook1")(hook1)
write_hooks.register("hook2")(hook2)
self.cfg = _no_sql_testing_config(
directives=(
"\n[post_write_hooks]\n"
"hooks=hook1,hook2\n"
"hook1.type=hook1\n"
"hook1.arg1=foo\n"
"hook2.type=hook2\n"
"hook2.arg1=bar\n"
)
)
rev = command.revision(self.cfg, message="x")
eq_(
hook1.mock_calls,
[
mock.call(
rev.path,
{"type": "hook1", "arg1": "foo", "_hook_name": "hook1"},
)
],
)
eq_(
hook2.mock_calls,
[
mock.call(
rev.path,
{"type": "hook2", "arg1": "bar", "_hook_name": "hook2"},
)
],
)
def test_empty_section(self):
self.cfg = _no_sql_testing_config(
directives=("\n[post_write_hooks]\n")
)
command.revision(self.cfg, message="x")
def test_no_section(self):
self.cfg = _no_sql_testing_config(directives="")
command.revision(self.cfg, message="x")
def test_empty_hooks(self):
self.cfg = _no_sql_testing_config(
directives=("\n[post_write_hooks]\n" "hooks=\n")
)
command.revision(self.cfg, message="x")
def test_no_type(self):
self.cfg = _no_sql_testing_config(
directives=(
"\n[post_write_hooks]\n" "hooks=foo\n" "foo.bar=somebar\n"
)
)
assert_raises_message(
util.CommandError,
"Key foo.type is required for post write hook 'foo'",
command.revision,
self.cfg,
message="x",
)
def test_console_scripts_entrypoint_missing(self):
self.cfg = _no_sql_testing_config(
directives=(
"\n[post_write_hooks]\n"
"hooks=black\n"
"black.type=console_scripts\n"
)
)
assert_raises_message(
util.CommandError,
"Key black.entrypoint is required for post write hook 'black'",
command.revision,
self.cfg,
message="x",
)
def _run_black_with_config(
self, input_config, expected_additional_arguments_fn, cwd=None
):
self.cfg = _no_sql_testing_config(directives=input_config)
retVal = [
compat.EntryPoint(
name="black",
value="black.foo:patched_main",
group="console_scripts",
),
compat.EntryPoint(
name="alembic",
value="alembic.config:main",
group="console_scripts",
),
]
importlib_metadata_get = mock.Mock(return_value=retVal)
with mock.patch(
"alembic.util.compat.importlib_metadata_get",
importlib_metadata_get,
), mock.patch(
"alembic.script.write_hooks.subprocess"
) as mock_subprocess:
rev = command.revision(self.cfg, message="x")
eq_(importlib_metadata_get.mock_calls, [mock.call("console_scripts")])
eq_(
mock_subprocess.mock_calls,
[
mock.call.run(
[
sys.executable,
"-c",
"import black.foo; black.foo.patched_main()",
]
+ expected_additional_arguments_fn(rev.path),
cwd=cwd,
)
],
)
def test_console_scripts(self):
input_config = """
[post_write_hooks]
hooks = black
black.type = console_scripts
black.entrypoint = black
black.options = -l 79
"""
def expected_additional_arguments_fn(rev_path):
return [rev_path, "-l", "79"]
self._run_black_with_config(
input_config, expected_additional_arguments_fn
)
@combinations(True, False)
def test_filename_interpolation(self, posix):
input_config = """
[post_write_hooks]
hooks = black
black.type = console_scripts
black.entrypoint = black
black.options = arg1 REVISION_SCRIPT_FILENAME 'multi-word arg' \
--flag1='REVISION_SCRIPT_FILENAME'
"""
def expected_additional_arguments_fn(rev_path):
if compat.is_posix:
return [
"arg1",
rev_path,
"multi-word arg",
"--flag1=" + rev_path,
]
else:
return [
"arg1",
rev_path,
"'multi-word arg'",
"--flag1='%s'" % rev_path,
]
with mock.patch("alembic.util.compat.is_posix", posix):
self._run_black_with_config(
input_config, expected_additional_arguments_fn
)
def test_path_in_config(self):
input_config = """
[post_write_hooks]
hooks = black
black.type = console_scripts
black.entrypoint = black
black.options = arg1 REVISION_SCRIPT_FILENAME --config %(here)s/pyproject.toml
"""
def expected_additional_arguments_fn(rev_path):
return [
"arg1",
rev_path,
"--config",
os.path.abspath(_get_staging_directory()) + "/pyproject.toml",
]
self._run_black_with_config(
input_config, expected_additional_arguments_fn
)
def test_black_with_cwd(self):
input_config = """
[post_write_hooks]
hooks = black
black.type = console_scripts
black.entrypoint = black
black.cwd = /path/to/cwd
"""
def expected_additional_arguments_fn(rev_path):
return [rev_path]
self._run_black_with_config(
input_config, expected_additional_arguments_fn, cwd="/path/to/cwd"
)
|
