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
266
267
268
269
270
271
272
273
274
275
276
277
|
from unittest.mock import patch
import pytest
from lunr.exceptions import BaseLunrException
from lunr.pipeline import Pipeline
def noop(*args, **kwargs):
pass
def fn(*args, **kwargs):
pass
class BaseTestPipeline:
@pytest.fixture(autouse=True)
def setup_mock_pipline(self, monkeypatch):
monkeypatch.setattr(Pipeline, "registered_functions", {})
monkeypatch.setattr(Pipeline, "warn_if_function_not_registered", noop)
self.pipeline = Pipeline()
class TestAdd(BaseTestPipeline):
def test_add_function_to_pipeline(self):
self.pipeline.add(noop)
assert len(self.pipeline) == 1
def test_add_multiple_functions_to_pipeline(self):
self.pipeline.add(noop, noop)
assert len(self.pipeline) == 2
def test_add_warns_if_function_not_registered(self, monkeypatch):
monkeypatch.undo()
with patch("lunr.pipeline.log") as mock_log:
self.pipeline.add(lambda x: x)
mock_log.warning.assert_called_once()
class TestRemove(BaseTestPipeline):
def test_remove_function_exists_in_pipeline(self):
self.pipeline.add(noop)
assert len(self.pipeline) == 1
self.pipeline.remove(noop)
assert len(self.pipeline) == 0
def test_remove_function_does_not_exist_in_pipeline(self):
self.pipeline.add(noop)
assert len(self.pipeline) == 1
self.pipeline.remove(fn)
assert len(self.pipeline) == 1
class TestBefore(BaseTestPipeline):
def test_before_other_function_exists(self):
self.pipeline.add(noop)
self.pipeline.before(noop, fn)
assert self.pipeline._stack == [fn, noop]
def test_before_other_functions_does_not_exist(self):
with pytest.raises(BaseLunrException):
self.pipeline.before(noop, fn)
assert len(self.pipeline) == 0
class TestAfter(BaseTestPipeline):
def test_after_other_function_exists(self):
self.pipeline.add(noop)
self.pipeline.after(noop, fn)
assert self.pipeline._stack == [noop, fn]
def test_after_other_function_does_not_exist(self):
with pytest.raises(BaseLunrException):
self.pipeline.after(noop, fn)
assert len(self.pipeline) == 0
class TestRun(BaseTestPipeline):
def test_run_calling_each_function_for_each_token(self):
count_1 = []
count_2 = []
def fn1(t, *args):
count_1.append(1)
return t
def fn2(t, *args):
count_2.append(1)
return t
self.pipeline.add(fn1, fn2)
self.pipeline.run([1, 2, 3])
assert len(count_1) == 3
assert len(count_2) == 3
def test_run_passes_token_to_pipeline_function(self):
def fn(token, *args):
assert token == "foo"
self.pipeline.add(fn)
self.pipeline.run(["foo"])
def test_run_passes_index_to_pipeline_function(self):
def fn(_, index, *args):
assert index == 0
self.pipeline.add(fn)
self.pipeline.run(["foo"])
def test_run_passes_entire_token_list_to_pipeline_function(self):
def fn(_, __, tokens):
assert tokens == ["foo"]
self.pipeline.add(fn)
self.pipeline.run(["foo"])
def test_run_passes_output_of_one_function_as_input_to_the_next(self):
def fn1(t, *args):
return t.upper()
def fn2(t, *args):
assert t == "FOO"
self.pipeline.add(fn1, fn2)
self.pipeline.run(["foo"])
def test_run_returns_the_results_of_the_last_function(self):
def fn(t, *args):
return t.upper()
self.pipeline.add(fn)
assert self.pipeline.run(["foo"]) == ["FOO"]
def test_run_filters_out_none_and_empty_string_values(self):
tokens = []
def fn1(t, i, _):
if i % 2:
return t
elif i == 5:
return ""
def fn2(t, *args):
tokens.append(t)
return t
self.pipeline.add(fn1)
self.pipeline.add(fn2)
output = self.pipeline.run(list("abcde"))
assert tokens == ["b", "d"]
assert output == ["b", "d"]
def test_expanding_tokens_passed_to_output(self):
self.pipeline.add(lambda t, *args: [t, t.upper()])
assert self.pipeline.run(["foo"]) == ["foo", "FOO"]
def test_expanding_tokens_not_passed_to_same_function(self):
received = []
def fn(t, *args):
received.append(t)
return [t, t.upper()]
self.pipeline.add(fn)
self.pipeline.run(["foo"])
assert received == ["foo"]
def test_expanding_tokens_passed_to_the_next_pipeline_function(self):
received = []
def fn1(t, *args):
return [t, t.upper()]
def fn2(t, *args):
received.append(t)
self.pipeline.add(fn1)
self.pipeline.add(fn2)
self.pipeline.run(["foo"])
assert received == ["foo", "FOO"]
def test_skip_pipeline_function(self) -> None:
def upper(t, *args):
return t.upper()
def lower(t, *args):
return t.lower()
self.pipeline.add(upper)
self.pipeline.skip(upper, ["no_upper", "nothing"])
assert self.pipeline.run(["Foo"]) == ["FOO"]
self.pipeline.add(lower)
self.pipeline.skip(lower, ["no_lower", "nothing"])
assert self.pipeline.run(["Foo"]) == ["foo"]
assert self.pipeline.run(["Foo"], field_name="no_lower") == ["FOO"]
assert self.pipeline.run(["Foo"], field_name="no_upper") == ["foo"]
assert self.pipeline.run(["Foo"], field_name="nothing") == ["Foo"]
class TestSerialize(BaseTestPipeline):
def test_serialize_returns_array_of_registered_function_labels(self):
Pipeline.register_function(fn, "fn")
self.pipeline.add(fn)
assert self.pipeline.serialize() == ["fn"]
assert repr(self.pipeline) == '<Pipeline stack="fn">'
class TestRegisterFunction(BaseTestPipeline):
def setup_method(self, method):
def fn(*args):
pass
self.fn = fn
def test_register_function_adds_a_label_property_to_the_function(self):
Pipeline.register_function(self.fn, "fn")
assert self.fn.label == "fn"
def test_register_function_adds_defaults_to_name_of_the_function(self):
Pipeline.register_function(self.fn)
assert self.fn.label == self.fn.__name__
def test_register_function_adds_function_to_list_of_registered_functions(self):
Pipeline.register_function(self.fn, "fn")
assert Pipeline.registered_functions["fn"] == self.fn
def test_register_function_warns_when_adding_function_with_same_label(self):
Pipeline.register_function(self.fn, "fn")
with patch("lunr.pipeline.log") as mock_log:
Pipeline.register_function(self.fn, "fn")
mock_log.warning.assert_called_once()
class TestLoad(BaseTestPipeline):
def test_load_with_registered_functions(self):
serialized_pipeline = ["fn"]
Pipeline.register_function(fn, "fn")
pipeline = Pipeline.load(serialized_pipeline)
assert len(pipeline) == 1
assert pipeline._stack[0] == fn
def test_load_with_unregistered_functions(self):
serialized_pipeline = ["fn"]
with pytest.raises(BaseLunrException):
Pipeline.load(serialized_pipeline)
class TestReset(BaseTestPipeline):
def test_reset_empties_the_stack(self):
self.pipeline.add(noop)
assert len(self.pipeline) == 1
self.pipeline.reset()
assert len(self.pipeline) == 0
|
