forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathassertions.html
458 lines (440 loc) · 14.5 KB
/
assertions.html
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>Assertions | Elasticsearch Guide [2.0] | Elastic</title>
<meta class="elastic" name="content" content="Assertions | Elasticsearch Guide [2.0]">
<link rel="home" href="index.html" title="Elasticsearch Guide [2.0]"/>
<link rel="up" href="testing-framework.html" title="Java Testing Framework"/>
<link rel="prev" href="randomized-testing.html" title="Randomized testing"/>
<link rel="next" href="glossary.html" title="Glossary of terms"/>
<meta class="elastic" name="product_version" content="2.0"/>
<meta class="elastic" name="product_name" content="Elasticsearch"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/2.0"/>
<meta name="DC.subject" content="Elasticsearch"/>
<meta name="DC.identifier" content="2.0"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles.css" />
</head>
<!--© 2015-2022 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
<p>
<strong>WARNING</strong>: Version 2.0 of Elasticsearch has passed its
<a href="https://www.elastic.co/support/eol">EOL date</a>.
</p>
<p>
This documentation is no longer being maintained and may be removed.
If you are running this version, we strongly advise you to upgrade.
For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</p>
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [2.0]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="testing.html">Testing</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="testing-framework.html">Java Testing Framework</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="randomized-testing.html">« Randomized testing</a>
</span>
<span class="next">
<a href="glossary.html">Glossary of terms »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="assertions"></a>Assertions<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/2.0/docs/reference/testing/testing-framework.asciidoc">edit</a></h2>
</div></div></div>
<p>As many elasticsearch tests are checking for a similar output, like the amount of hits or the first hit or special highlighting, a couple of predefined assertions have been created. Those have been put into the <code class="literal">ElasticsearchAssertions</code> class. There is also a specific geo assertions in <code class="literal">ElasticsearchGeoAssertions</code>.</p>
<div class="informaltable">
<table border="0" cellpadding="4px">
<colgroup>
<col/>
<col/>
</colgroup>
<tbody valign="top">
<tr>
<td valign="top">
<p>
<code class="literal">assertHitCount()</code>
</p>
</td>
<td valign="top">
<p>
Checks hit count of a search or count request
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertAcked()</code>
</p>
</td>
<td valign="top">
<p>
Ensure the a request has been acknowledged by the master
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertSearchHits()</code>
</p>
</td>
<td valign="top">
<p>
Asserts a search response contains specific ids
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertMatchCount()</code>
</p>
</td>
<td valign="top">
<p>
Asserts a matching count from a percolation response
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertFirstHit()</code>
</p>
</td>
<td valign="top">
<p>
Asserts the first hit hits the specified matcher
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertSecondHit()</code>
</p>
</td>
<td valign="top">
<p>
Asserts the second hit hits the specified matcher
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertThirdHit()</code>
</p>
</td>
<td valign="top">
<p>
Asserts the third hits hits the specified matcher
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertSearchHit()</code>
</p>
</td>
<td valign="top">
<p>
Assert a certain element in a search response hits the specified matcher
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertNoFailures()</code>
</p>
</td>
<td valign="top">
<p>
Asserts that no shard failures have occurred in the response
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertFailures()</code>
</p>
</td>
<td valign="top">
<p>
Asserts that shard failures have happened during a search request
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertHighlight()</code>
</p>
</td>
<td valign="top">
<p>
Assert specific highlights matched
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertSuggestion()</code>
</p>
</td>
<td valign="top">
<p>
Assert for specific suggestions
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertSuggestionSize()</code>
</p>
</td>
<td valign="top">
<p>
Assert for specific suggestion count
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">assertThrows()</code>
</p>
</td>
<td valign="top">
<p>
Assert a specific exception has been thrown
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>Common matchers</p>
<div class="informaltable">
<table border="0" cellpadding="4px">
<colgroup>
<col/>
<col/>
</colgroup>
<tbody valign="top">
<tr>
<td valign="top">
<p>
<code class="literal">hasId()</code>
</p>
</td>
<td valign="top">
<p>
Matcher to check for a search hit id
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">hasType()</code>
</p>
</td>
<td valign="top">
<p>
Matcher to check for a search hit type
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">hasIndex()</code>
</p>
</td>
<td valign="top">
<p>
Matcher to check for a search hit index
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">hasScore()</code>
</p>
</td>
<td valign="top">
<p>
Matcher to check for a certain score of a hit
</p>
</td>
</tr>
<tr>
<td valign="top">
<p>
<code class="literal">hasStatus()</code>
</p>
</td>
<td valign="top">
<p>
Matcher to check for a certain <code class="literal">RestStatus</code> of a response
</p>
</td>
</tr>
</tbody>
</table>
</div>
<p>Usually, you would combine assertions and matchers in your test like this</p>
<div class="pre_wrapper lang-java">
<pre class="programlisting prettyprint lang-java">SearchResponse seearchResponse = client().prepareSearch() ...;
assertHitCount(searchResponse, 4);
assertFirstHit(searchResponse, hasId("4"));
assertSearchHits(searchResponse, "1", "2", "3", "4");</pre>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="randomized-testing.html">« Randomized testing</a>
</span>
<span class="next">
<a href="glossary.html">Glossary of terms »</a>
</span>
</div>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>