Skip to content

Commit 0ac0781

Browse files
committed
Docs: Remove duplicate test setup
The range docs had an introductory section that described how to set up and index *and* a test setup section in `docs/build.gradle` that duplicated that section. This is bad because these section can (and do) drift from one another. This change removes the setup in build.gradle and marks the introductor snippet with `// TESTSETUP` so it is used on all the snippets.
1 parent b9aed0b commit 0ac0781

File tree

3 files changed

+10
-31
lines changed

3 files changed

+10
-31
lines changed

docs/README.asciidoc

+5-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ for its modifiers:
3434
reason why the test shouldn't be run.
3535
* `// TEST[setup:name]`: Run some setup code before running the snippet. This
3636
is useful for creating and populating indexes used in the snippet. The setup
37-
code is defined in `docs/build.gradle`.
37+
code is defined in `docs/build.gradle`. See `// TESTSETUP` below for a
38+
similar feature.
3839
* `// TEST[warning:some warning]`: Expect the response to include a `Warning`
3940
header. If the response doesn't include a `Warning` header with the exact
4041
text then the test fails. If the response includes `Warning` headers that
@@ -66,7 +67,9 @@ for its modifiers:
6667
a test that runs the setup snippet first. See the "painless" docs for a file
6768
that puts this to good use. This is fairly similar to `// TEST[setup:name]`
6869
but rather than the setup defined in `docs/build.gradle` the setup is defined
69-
right in the documentation file.
70+
right in the documentation file. In general, we should prefer `// TESTSETUP`
71+
over `// TEST[setup:name]` because it makes it more clear what steps have to
72+
be taken before the examples will work.
7073
7174
Any place you can use json you can use elements like `$body.path.to.thing`
7275
which is replaced on the fly with the contents of the thing at `path.to.thing`

docs/build.gradle

-25
Original file line numberDiff line numberDiff line change
@@ -215,31 +215,6 @@ buildRestTests.doFirst {
215215
buildRestTests.setups['bank'].replace('#bank_data#', accounts)
216216
}
217217

218-
buildRestTests.setups['range_index'] = '''
219-
- do :
220-
indices.create:
221-
index: range_index
222-
body:
223-
settings:
224-
number_of_shards: 2
225-
number_of_replicas: 1
226-
mappings:
227-
_doc:
228-
properties:
229-
expected_attendees:
230-
type: integer_range
231-
time_frame:
232-
type: date_range
233-
format: yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis
234-
- do:
235-
bulk:
236-
index: range_index
237-
type: _doc
238-
refresh: true
239-
body: |
240-
{"index":{"_id": 1}}
241-
{"expected_attendees": {"gte": 10, "lte": 20}, "time_frame": {"gte": "2015-10-31 12:00:00", "lte": "2015-11-01"}}'''
242-
243218
// Used by index boost doc
244219
buildRestTests.setups['index_boost'] = '''
245220
- do:

docs/reference/mapping/types/range.asciidoc

+5-4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Below is an example of configuring a mapping with various range fields followed
1818
--------------------------------------------------
1919
PUT range_index
2020
{
21+
"settings": {
22+
"number_of_shards": 2
23+
},
2124
"mappings": {
2225
"_doc": {
2326
"properties": {
@@ -33,7 +36,7 @@ PUT range_index
3336
}
3437
}
3538
36-
PUT range_index/_doc/1
39+
PUT range_index/_doc/1?refresh
3740
{
3841
"expected_attendees" : { <2>
3942
"gte" : 10,
@@ -46,6 +49,7 @@ PUT range_index/_doc/1
4649
}
4750
--------------------------------------------------
4851
//CONSOLE
52+
// TESTSETUP
4953

5054
<1> `date_range` types accept the same field parameters defined by the <<date, `date`>> type.
5155
<2> Example indexing a meeting with 10 to 20 attendees.
@@ -68,7 +72,6 @@ GET range_index/_search
6872
}
6973
--------------------------------------------------
7074
// CONSOLE
71-
// TEST[setup:range_index]
7275

7376
The result produced by the above query.
7477

@@ -125,7 +128,6 @@ GET range_index/_search
125128
}
126129
--------------------------------------------------
127130
// CONSOLE
128-
// TEST[setup:range_index]
129131

130132
<1> Range queries work the same as described in <<query-dsl-range-query, range query>>.
131133
<2> Range queries over range <<mapping-types, fields>> support a `relation` parameter which can be one of `WITHIN`, `CONTAINS`,
@@ -191,7 +193,6 @@ PUT range_index/_doc/2
191193
}
192194
--------------------------------------------------
193195
// CONSOLE
194-
// TEST[setup:range_index]
195196

196197
[[range-params]]
197198
==== Parameters for range fields

0 commit comments

Comments
 (0)