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
|
# 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.
"""
Dynamically generated set of TestCases based on set of yaml files describing
some integration tests. These files are shared among all official Elasticsearch
clients.
"""
import inspect
import json
import warnings
import pytest
import pytest_asyncio
from elasticsearch import ElasticsearchWarning, RequestError
from ...test_server.test_rest_api_spec import (
API_PARAMS_RENAMES,
IMPLEMENTED_FEATURES,
PARAMS_RENAMES,
RUN_ASYNC_REST_API_TESTS,
YAML_TEST_SPECS,
YamlRunner,
)
from ...utils import parse_version
pytestmark = pytest.mark.asyncio
XPACK_FEATURES = None
ES_VERSION = None
async def await_if_coro(x):
if inspect.iscoroutine(x):
return await x
return x
class AsyncYamlRunner(YamlRunner):
async def setup(self):
# Pull skips from individual tests to not do unnecessary setup.
skip_code = []
for action in self._run_code:
assert len(action) == 1
action_type, _ = list(action.items())[0]
if action_type == "skip":
skip_code.append(action)
else:
break
if self._setup_code or skip_code:
self.section("setup")
if skip_code:
await self.run_code(skip_code)
if self._setup_code:
await self.run_code(self._setup_code)
async def teardown(self):
if self._teardown_code:
self.section("teardown")
await self.run_code(self._teardown_code)
async def es_version(self):
global ES_VERSION
if ES_VERSION is None:
version_string = (await self.client.info())["version"]["number"]
if "." not in version_string:
return ()
version = version_string.strip().split(".")
ES_VERSION = tuple(int(v) if v.isdigit() else 999 for v in version)
return ES_VERSION
def section(self, name):
print(("=" * 10) + " " + name + " " + ("=" * 10))
async def run(self):
try:
await self.setup()
self.section("test")
await self.run_code(self._run_code)
finally:
try:
await self.teardown()
except Exception:
pass
async def run_code(self, test):
"""Execute an instruction based on it's type."""
for action in test:
assert len(action) == 1
action_type, action = list(action.items())[0]
print(action_type, action)
if hasattr(self, "run_" + action_type):
await await_if_coro(getattr(self, "run_" + action_type)(action))
else:
raise RuntimeError(f"Invalid action type {action_type!r}")
async def run_do(self, action):
api = self.client
headers = action.pop("headers", None)
catch = action.pop("catch", None)
warn = action.pop("warnings", ())
allowed_warnings = action.pop("allowed_warnings", ())
assert len(action) == 1
# Remove the x_pack_rest_user authentication
# if it's given via headers. We're already authenticated
# via the 'elastic' user.
if (
headers
and headers.get("Authorization", None)
== "Basic eF9wYWNrX3Jlc3RfdXNlcjp4LXBhY2stdGVzdC1wYXNzd29yZA=="
):
headers.pop("Authorization")
method, args = list(action.items())[0]
if headers:
args["headers"] = headers
# locate api endpoint
for m in method.split("."):
if not hasattr(api, m):
pytest.skip("This API isn't implemented yet")
api = getattr(api, m)
# Sometimes the 'body' parameter is encoded as a string instead of raw.
if "body" in args:
try:
args["body"] = json.loads(args["body"])
except (TypeError, ValueError):
pass
if isinstance(args["body"], dict):
# Detect when there are duplicate options that aren't the same value.
# In this case the test isn't testing the client, it's testing Elasticsearch
# and its ability to reject multiple values so we either combine
# like values or skip the test entirely as unnecessary for the client.
duplicate_args = set(args["body"]).intersection(args)
if duplicate_args:
for arg in list(duplicate_args):
if args["body"][arg] == args[arg]:
args["body"].pop(arg)
else:
pytest.skip(
"Contains a duplicate parameter with a different value"
)
# some parameters had to be renamed to not clash with python builtins,
# compensate
renames = PARAMS_RENAMES.copy()
renames.update(API_PARAMS_RENAMES.get(method, {}))
for k in renames:
if k in args:
args[renames[k]] = args.pop(k)
# resolve vars
for k in args:
args[k] = self._resolve(args[k])
warnings.simplefilter("always", category=ElasticsearchWarning)
with warnings.catch_warnings(record=True) as caught_warnings:
try:
self.last_response = (await api(**args)).body
except Exception as e:
self._skip_intentional_type_errors(e)
if not catch:
raise
self.run_catch(catch, e)
else:
if catch:
raise AssertionError(
f"Failed to catch {catch!r} in {self.last_response!r}."
)
# Filter out warnings raised by other components.
caught_warnings = [
str(w.message)
for w in caught_warnings
if w.category == ElasticsearchWarning
and str(w.message) not in allowed_warnings
]
# Sorting removes the issue with order raised. We only care about
# if all warnings are raised in the single API call.
if warn and sorted(warn) != sorted(caught_warnings):
raise AssertionError(
"Expected warnings not equal to actual warnings: expected=%r actual=%r"
% (warn, caught_warnings)
)
async def run_skip(self, skip):
if "features" in skip:
features = skip["features"]
if not isinstance(features, (tuple, list)):
features = [features]
for feature in features:
if feature in IMPLEMENTED_FEATURES:
continue
pytest.skip(f"feature '{feature}' is not supported")
if "version" in skip:
version, reason = skip["version"], skip["reason"]
if version == "all":
pytest.skip(reason)
min_version, _, max_version = version.partition("-")
min_version = parse_version(min_version.strip()) or (0,)
max_version = parse_version(max_version.strip()) or (999,)
if min_version <= (await self.es_version()) <= max_version:
pytest.skip(reason)
async def _feature_enabled(self, name):
global XPACK_FEATURES
if XPACK_FEATURES is None:
try:
xinfo = await self.client.xpack.info()
XPACK_FEATURES = {
f for f in xinfo["features"] if xinfo["features"][f]["enabled"]
}
IMPLEMENTED_FEATURES.add("xpack")
except RequestError:
XPACK_FEATURES = set()
IMPLEMENTED_FEATURES.add("no_xpack")
return name in XPACK_FEATURES
@pytest_asyncio.fixture(scope="function")
def async_runner(async_client_factory):
return AsyncYamlRunner(async_client_factory)
if RUN_ASYNC_REST_API_TESTS:
@pytest.mark.parametrize("test_spec", YAML_TEST_SPECS)
async def test_rest_api_spec(test_spec, async_runner):
if test_spec.get("fail", False):
pytest.xfail("Manually marked as failing in 'FAILING_TESTS'")
elif test_spec.get("skip", False):
pytest.xfail("Manually skipped")
async_runner.use_spec(test_spec)
await async_runner.run()
|
