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
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from datetime import datetime
import pytest
from elasticsearch.dsl.faceted_search import (
DateHistogramFacet,
FacetedSearch,
TermsFacet,
)
class BlogSearch(FacetedSearch):
doc_types = ["user", "post"]
fields = [
"title^5",
"body",
]
facets = {
"category": TermsFacet(field="category.raw"),
"tags": TermsFacet(field="tags"),
}
def test_query_is_created_properly() -> None:
bs = BlogSearch("python search")
s = bs.build_search()
assert s._doc_type == ["user", "post"]
assert {
"aggs": {
"_filter_tags": {
"filter": {"match_all": {}},
"aggs": {"tags": {"terms": {"field": "tags"}}},
},
"_filter_category": {
"filter": {"match_all": {}},
"aggs": {"category": {"terms": {"field": "category.raw"}}},
},
},
"query": {
"multi_match": {"fields": ["title^5", "body"], "query": "python search"}
},
"highlight": {"fields": {"body": {}, "title": {}}},
} == s.to_dict()
def test_query_is_created_properly_with_sort_tuple() -> None:
bs = BlogSearch("python search", sort=("category", "-title"))
s = bs.build_search()
assert s._doc_type == ["user", "post"]
assert {
"aggs": {
"_filter_tags": {
"filter": {"match_all": {}},
"aggs": {"tags": {"terms": {"field": "tags"}}},
},
"_filter_category": {
"filter": {"match_all": {}},
"aggs": {"category": {"terms": {"field": "category.raw"}}},
},
},
"query": {
"multi_match": {"fields": ["title^5", "body"], "query": "python search"}
},
"highlight": {"fields": {"body": {}, "title": {}}},
"sort": ["category", {"title": {"order": "desc"}}],
} == s.to_dict()
def test_filter_is_applied_to_search_but_not_relevant_facet() -> None:
bs = BlogSearch("python search", filters={"category": "elastic"})
s = bs.build_search()
assert {
"aggs": {
"_filter_tags": {
"filter": {"terms": {"category.raw": ["elastic"]}},
"aggs": {"tags": {"terms": {"field": "tags"}}},
},
"_filter_category": {
"filter": {"match_all": {}},
"aggs": {"category": {"terms": {"field": "category.raw"}}},
},
},
"post_filter": {"terms": {"category.raw": ["elastic"]}},
"query": {
"multi_match": {"fields": ["title^5", "body"], "query": "python search"}
},
"highlight": {"fields": {"body": {}, "title": {}}},
} == s.to_dict()
def test_filters_are_applied_to_search_ant_relevant_facets() -> None:
bs = BlogSearch(
"python search", filters={"category": "elastic", "tags": ["python", "django"]}
)
s = bs.build_search()
d = s.to_dict()
# we need to test post_filter without relying on order
f = d["post_filter"]["bool"].pop("must")
assert len(f) == 2
assert {"terms": {"category.raw": ["elastic"]}} in f
assert {"terms": {"tags": ["python", "django"]}} in f
assert {
"aggs": {
"_filter_tags": {
"filter": {"terms": {"category.raw": ["elastic"]}},
"aggs": {"tags": {"terms": {"field": "tags"}}},
},
"_filter_category": {
"filter": {"terms": {"tags": ["python", "django"]}},
"aggs": {"category": {"terms": {"field": "category.raw"}}},
},
},
"query": {
"multi_match": {"fields": ["title^5", "body"], "query": "python search"}
},
"post_filter": {"bool": {}},
"highlight": {"fields": {"body": {}, "title": {}}},
} == d
def test_date_histogram_facet_with_1970_01_01_date() -> None:
dhf = DateHistogramFacet()
assert dhf.get_value({"key": None}) == datetime(1970, 1, 1, 0, 0) # type: ignore[arg-type]
assert dhf.get_value({"key": 0}) == datetime(1970, 1, 1, 0, 0) # type: ignore[arg-type]
@pytest.mark.parametrize(
["interval_type", "interval"],
[
("interval", "year"),
("calendar_interval", "year"),
("interval", "month"),
("calendar_interval", "month"),
("interval", "week"),
("calendar_interval", "week"),
("interval", "day"),
("calendar_interval", "day"),
("fixed_interval", "day"),
("interval", "hour"),
("fixed_interval", "hour"),
("interval", "1Y"),
("calendar_interval", "1Y"),
("interval", "1M"),
("calendar_interval", "1M"),
("interval", "1w"),
("calendar_interval", "1w"),
("interval", "1d"),
("calendar_interval", "1d"),
("fixed_interval", "1d"),
("interval", "1h"),
("fixed_interval", "1h"),
],
)
def test_date_histogram_interval_types(interval_type: str, interval: str) -> None:
dhf = DateHistogramFacet(field="@timestamp", **{interval_type: interval})
assert dhf.get_aggregation().to_dict() == {
"date_histogram": {
"field": "@timestamp",
interval_type: interval,
"min_doc_count": 0,
}
}
dhf.get_value_filter(datetime.now())
def test_date_histogram_no_interval_keyerror() -> None:
dhf = DateHistogramFacet(field="@timestamp")
with pytest.raises(KeyError) as e:
dhf.get_value_filter(datetime.now())
assert str(e.value) == "'interval'"
def test_params_added_to_search() -> None:
bs = BlogSearch("python search")
assert bs._s._params == {}
bs.params(routing="42")
assert bs._s._params == {"routing": "42"}
|
