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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
|
# 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
from typing import Tuple, Type
import pytest
from elasticsearch import Elasticsearch
from elasticsearch.dsl import A, Boolean, Date, Document, Keyword, Search
from elasticsearch.dsl.faceted_search import (
DateHistogramFacet,
FacetedSearch,
NestedFacet,
RangeFacet,
TermsFacet,
)
from .test_document import PullRequest
class Repos(Document):
is_public = Boolean()
created_at = Date()
class Index:
name = "git"
class Commit(Document):
files = Keyword()
committed_date = Date()
class Index:
name = "git"
class MetricSearch(FacetedSearch):
index = "git"
doc_types = [Commit]
facets = {
"files": TermsFacet(field="files", metric=A("max", field="committed_date")),
}
@pytest.fixture
def commit_search_cls(es_version: Tuple[int, ...]) -> Type[FacetedSearch]:
if es_version >= (7, 2):
interval_kwargs = {"fixed_interval": "1d"}
else:
interval_kwargs = {"interval": "day"}
class CommitSearch(FacetedSearch):
index = "flat-git"
fields = (
"description",
"files",
)
facets = {
"files": TermsFacet(field="files"),
"frequency": DateHistogramFacet(
field="authored_date", min_doc_count=1, **interval_kwargs
),
"deletions": RangeFacet(
field="stats.deletions",
ranges=[("ok", (None, 1)), ("good", (1, 5)), ("better", (5, None))],
),
}
return CommitSearch
@pytest.fixture
def repo_search_cls(es_version: Tuple[int, ...]) -> Type[FacetedSearch]:
interval_type = "calendar_interval" if es_version >= (7, 2) else "interval"
class RepoSearch(FacetedSearch):
index = "git"
doc_types = [Repos]
facets = {
"public": TermsFacet(field="is_public"),
"created": DateHistogramFacet(
field="created_at", **{interval_type: "month"}
),
}
def search(self) -> Search:
s = super().search()
return s.filter("term", commit_repo="repo")
return RepoSearch
@pytest.fixture
def pr_search_cls(es_version: Tuple[int, ...]) -> Type[FacetedSearch]:
interval_type = "calendar_interval" if es_version >= (7, 2) else "interval"
class PRSearch(FacetedSearch):
index = "test-prs"
doc_types = [PullRequest]
facets = {
"comments": NestedFacet(
"comments",
DateHistogramFacet(
field="comments.created_at", **{interval_type: "month"}
),
)
}
return PRSearch
@pytest.mark.sync
def test_facet_with_custom_metric(data_client: Elasticsearch) -> None:
ms = MetricSearch()
r = ms.execute()
dates = [f[1] for f in r.facets.files]
assert dates == list(sorted(dates, reverse=True))
assert dates[0] == 1399038439000
@pytest.mark.sync
def test_nested_facet(
pull_request: PullRequest, pr_search_cls: Type[FacetedSearch]
) -> None:
prs = pr_search_cls()
r = prs.execute()
assert r.hits.total.value == 1 # type: ignore[attr-defined]
assert [(datetime(2018, 1, 1, 0, 0), 1, False)] == r.facets.comments
@pytest.mark.sync
def test_nested_facet_with_filter(
pull_request: PullRequest, pr_search_cls: Type[FacetedSearch]
) -> None:
prs = pr_search_cls(filters={"comments": datetime(2018, 1, 1, 0, 0)})
r = prs.execute()
assert r.hits.total.value == 1 # type: ignore[attr-defined]
assert [(datetime(2018, 1, 1, 0, 0), 1, True)] == r.facets.comments
prs = pr_search_cls(filters={"comments": datetime(2018, 2, 1, 0, 0)})
r = prs.execute()
assert not r.hits
@pytest.mark.sync
def test_datehistogram_facet(
data_client: Elasticsearch, repo_search_cls: Type[FacetedSearch]
) -> None:
rs = repo_search_cls()
r = rs.execute()
assert r.hits.total.value == 1 # type: ignore[attr-defined]
assert [(datetime(2014, 3, 1, 0, 0), 1, False)] == r.facets.created
@pytest.mark.sync
def test_boolean_facet(
data_client: Elasticsearch, repo_search_cls: Type[FacetedSearch]
) -> None:
rs = repo_search_cls()
r = rs.execute()
assert r.hits.total.value == 1 # type: ignore[attr-defined]
assert [(True, 1, False)] == r.facets.public
value, count, selected = r.facets.public[0]
assert value is True
@pytest.mark.sync
def test_empty_search_finds_everything(
data_client: Elasticsearch,
es_version: Tuple[int, ...],
commit_search_cls: Type[FacetedSearch],
) -> None:
cs = commit_search_cls()
r = cs.execute()
assert r.hits.total.value == 52 # type: ignore[attr-defined]
assert [
("elasticsearch_dsl", 40, False),
("test_elasticsearch_dsl", 35, False),
("elasticsearch_dsl/query.py", 19, False),
("test_elasticsearch_dsl/test_search.py", 15, False),
("elasticsearch_dsl/utils.py", 14, False),
("test_elasticsearch_dsl/test_query.py", 13, False),
("elasticsearch_dsl/search.py", 12, False),
("elasticsearch_dsl/aggs.py", 11, False),
("test_elasticsearch_dsl/test_result.py", 5, False),
("elasticsearch_dsl/result.py", 3, False),
] == r.facets.files
assert [
(datetime(2014, 3, 3, 0, 0), 2, False),
(datetime(2014, 3, 4, 0, 0), 1, False),
(datetime(2014, 3, 5, 0, 0), 3, False),
(datetime(2014, 3, 6, 0, 0), 3, False),
(datetime(2014, 3, 7, 0, 0), 9, False),
(datetime(2014, 3, 10, 0, 0), 2, False),
(datetime(2014, 3, 15, 0, 0), 4, False),
(datetime(2014, 3, 21, 0, 0), 2, False),
(datetime(2014, 3, 23, 0, 0), 2, False),
(datetime(2014, 3, 24, 0, 0), 10, False),
(datetime(2014, 4, 20, 0, 0), 2, False),
(datetime(2014, 4, 22, 0, 0), 2, False),
(datetime(2014, 4, 25, 0, 0), 3, False),
(datetime(2014, 4, 26, 0, 0), 2, False),
(datetime(2014, 4, 27, 0, 0), 2, False),
(datetime(2014, 5, 1, 0, 0), 2, False),
(datetime(2014, 5, 2, 0, 0), 1, False),
] == r.facets.frequency
assert [
("ok", 19, False),
("good", 14, False),
("better", 19, False),
] == r.facets.deletions
@pytest.mark.sync
def test_term_filters_are_shown_as_selected_and_data_is_filtered(
data_client: Elasticsearch, commit_search_cls: Type[FacetedSearch]
) -> None:
cs = commit_search_cls(filters={"files": "test_elasticsearch_dsl"})
r = cs.execute()
assert 35 == r.hits.total.value # type: ignore[attr-defined]
assert [
("elasticsearch_dsl", 40, False),
("test_elasticsearch_dsl", 35, True), # selected
("elasticsearch_dsl/query.py", 19, False),
("test_elasticsearch_dsl/test_search.py", 15, False),
("elasticsearch_dsl/utils.py", 14, False),
("test_elasticsearch_dsl/test_query.py", 13, False),
("elasticsearch_dsl/search.py", 12, False),
("elasticsearch_dsl/aggs.py", 11, False),
("test_elasticsearch_dsl/test_result.py", 5, False),
("elasticsearch_dsl/result.py", 3, False),
] == r.facets.files
assert [
(datetime(2014, 3, 3, 0, 0), 1, False),
(datetime(2014, 3, 5, 0, 0), 2, False),
(datetime(2014, 3, 6, 0, 0), 3, False),
(datetime(2014, 3, 7, 0, 0), 6, False),
(datetime(2014, 3, 10, 0, 0), 1, False),
(datetime(2014, 3, 15, 0, 0), 3, False),
(datetime(2014, 3, 21, 0, 0), 2, False),
(datetime(2014, 3, 23, 0, 0), 1, False),
(datetime(2014, 3, 24, 0, 0), 7, False),
(datetime(2014, 4, 20, 0, 0), 1, False),
(datetime(2014, 4, 25, 0, 0), 3, False),
(datetime(2014, 4, 26, 0, 0), 2, False),
(datetime(2014, 4, 27, 0, 0), 1, False),
(datetime(2014, 5, 1, 0, 0), 1, False),
(datetime(2014, 5, 2, 0, 0), 1, False),
] == r.facets.frequency
assert [
("ok", 12, False),
("good", 10, False),
("better", 13, False),
] == r.facets.deletions
@pytest.mark.sync
def test_range_filters_are_shown_as_selected_and_data_is_filtered(
data_client: Elasticsearch, commit_search_cls: Type[FacetedSearch]
) -> None:
cs = commit_search_cls(filters={"deletions": "better"})
r = cs.execute()
assert 19 == r.hits.total.value # type: ignore[attr-defined]
@pytest.mark.sync
def test_pagination(
data_client: Elasticsearch, commit_search_cls: Type[FacetedSearch]
) -> None:
cs = commit_search_cls()
cs = cs[0:20]
assert 52 == cs.count()
assert 20 == len(cs.execute())
|