blob: fbc0f4a887a8e7bc1e7759cd77a0242e50f66b4a (
plain)
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
|
#!/usr/bin/env bats
# This file is used to test the installation and removal
# of plugins after Elasticsearch has been installed with tar.gz,
# rpm, and deb.
# WARNING: This testing file must be executed as root and can
# dramatically change your system. It removes the 'elasticsearch'
# user/group and also many directories. Do not execute this file
# unless you know exactly what you are doing.
# The test case can be executed with the Bash Automated
# Testing System tool available at https://github.com/sstephenson/bats
# Thanks to Sam Stephenson!
# Licensed to Elasticsearch under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch 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.
##################################
# Common test cases for both tar and rpm/deb based plugin tests
##################################
# This file is symlinked to both 25_tar_plugins.bats and 50_modules_and_plugins.bats so its
# executed twice - once to test plugins using the tar distribution and once to
# test files using the rpm distribution or the deb distribution, whichever the
# system uses.
# Load test utilities
load packaging_test_utils
load modules
load plugins
setup() {
# The rules on when we should clean an reinstall are complex - all the
# jvm-example tests need cleaning because they are rough on the filesystem.
# The first and any tests that find themselves without an ESHOME need to
# clean as well.... this is going to mostly only happen on the first
# non-jvm-example-plugin-test _and_ any first test if you comment out the
# other tests. Commenting out lots of test cases seems like a reasonably
# common workflow.
if [ $BATS_TEST_NUMBER == 1 ] ||
[[ $BATS_TEST_NAME =~ install_jvm.*example ]] ||
[ ! -d "$ESHOME" ]; then
clean_before_test
install
fi
}
if [[ "$BATS_TEST_FILENAME" =~ 25_tar_plugins.bats$ ]]; then
load tar
GROUP='TAR PLUGINS'
install() {
install_archive
verify_archive_installation
}
export ESHOME=/tmp/elasticsearch
export_elasticsearch_paths
export ESPLUGIN_COMMAND_USER=elasticsearch
else
load os_package
if is_rpm; then
GROUP='RPM PLUGINS'
elif is_dpkg; then
GROUP='DEB PLUGINS'
fi
export_elasticsearch_paths
export ESPLUGIN_COMMAND_USER=root
install() {
install_package
verify_package_installation
}
fi
@test "[$GROUP] install jvm-example plugin with a custom CONFIG_FILE and check failure" {
local relativePath=${1:-$(readlink -m jvm-example-*.zip)}
CONF_FILE="$ESCONFIG/elasticsearch.yml" run sudo -E -u $ESPLUGIN_COMMAND_USER "$ESHOME/bin/elasticsearch-plugin" install "file://$relativePath"
# this should fail because CONF_FILE is no longer supported
[ $status = 1 ]
CONF_FILE="$ESCONFIG/elasticsearch.yml" run sudo -E -u $ESPLUGIN_COMMAND_USER "$ESHOME/bin/elasticsearch-plugin" remove jvm-example
echo "status is $status"
[ $status = 1 ]
}
@test "[$GROUP] start elasticsearch with a custom CONFIG_FILE and check failure" {
local CONF_FILE="$ESCONFIG/elasticsearch.yml"
if is_dpkg; then
echo "CONF_FILE=$CONF_FILE" >> /etc/default/elasticsearch;
elif is_rpm; then
echo "CONF_FILE=$CONF_FILE" >> /etc/sysconfig/elasticsearch;
fi
run_elasticsearch_service 1 -Ees.default.config="$CONF_FILE"
# remove settings again otherwise cleaning up before next testrun will fail
if is_dpkg ; then
sudo sed -i '/CONF_FILE/d' /etc/default/elasticsearch
elif is_rpm; then
sudo sed -i '/CONF_FILE/d' /etc/sysconfig/elasticsearch
fi
}
@test "[$GROUP] install jvm-example plugin with a symlinked plugins path" {
# Clean up after the last time this test was run
rm -rf /tmp/plugins.*
rm -rf /tmp/old_plugins.*
rm -rf "$ESPLUGINS"
local es_plugins=$(mktemp -d -t 'plugins.XXXX')
chown -R elasticsearch:elasticsearch "$es_plugins"
ln -s "$es_plugins" "$ESPLUGINS"
install_jvm_example
start_elasticsearch_service
# check that symlinked plugin was actually picked up
curl -s localhost:9200/_cat/configured_example | sed 's/ *$//' > /tmp/installed
echo "foo" > /tmp/expected
diff /tmp/installed /tmp/expected
stop_elasticsearch_service
remove_jvm_example
unlink "$ESPLUGINS"
}
@test "[$GROUP] install jvm-example plugin with a custom CONFIG_DIR" {
# Clean up after the last time we ran this test
rm -rf /tmp/config.*
move_config
CONF_DIR="$ESCONFIG" install_jvm_example
CONF_DIR="$ESCONFIG" start_elasticsearch_service
diff <(curl -s localhost:9200/_cat/configured_example | sed 's/ //g') <(echo "foo")
stop_elasticsearch_service
CONF_DIR="$ESCONFIG" remove_jvm_example
}
@test "[$GROUP] install jvm-example plugin from a directory with a space" {
rm -rf "/tmp/plugins with space"
mkdir -p "/tmp/plugins with space"
local zip=$(ls jvm-example-*.zip)
cp $zip "/tmp/plugins with space"
install_jvm_example "/tmp/plugins with space/$zip"
remove_jvm_example
}
@test "[$GROUP] install jvm-example plugin to elasticsearch directory with a space" {
[ "$GROUP" == "TAR PLUGINS" ] || skip "Test case only supported by TAR PLUGINS"
move_elasticsearch "/tmp/elastic search"
install_jvm_example
remove_jvm_example
}
@test "[$GROUP] fail if java executable is not found" {
[ "$GROUP" == "TAR PLUGINS" ] || skip "Test case only supported by TAR PLUGINS"
local JAVA=$(which java)
sudo chmod -x $JAVA
run "$ESHOME/bin/elasticsearch-plugin"
sudo chmod +x $JAVA
[ "$status" -eq 1 ]
[[ "$output" == *"Could not find any executable java binary. Please install java in your PATH or set JAVA_HOME"* ]]
}
# Note that all of the tests from here to the end of the file expect to be run
# in sequence and don't take well to being run one at a time.
@test "[$GROUP] install jvm-example plugin" {
install_jvm_example
}
@test "[$GROUP] install icu plugin" {
install_and_check_plugin analysis icu icu4j-*.jar
}
@test "[$GROUP] install kuromoji plugin" {
install_and_check_plugin analysis kuromoji
}
@test "[$GROUP] install phonetic plugin" {
install_and_check_plugin analysis phonetic commons-codec-*.jar
}
@test "[$GROUP] install smartcn plugin" {
install_and_check_plugin analysis smartcn
}
@test "[$GROUP] install stempel plugin" {
install_and_check_plugin analysis stempel
}
@test "[$GROUP] install ukrainian plugin" {
install_and_check_plugin analysis ukrainian morfologik-fsa-*.jar morfologik-stemming-*.jar
}
@test "[$GROUP] install gce plugin" {
install_and_check_plugin discovery gce google-api-client-*.jar
}
@test "[$GROUP] install discovery-azure-classic plugin" {
install_and_check_plugin discovery azure-classic azure-core-*.jar
}
@test "[$GROUP] install discovery-ec2 plugin" {
install_and_check_plugin discovery ec2 aws-java-sdk-core-*.jar
}
@test "[$GROUP] install discovery-file plugin" {
install_and_check_plugin discovery file
}
@test "[$GROUP] install ingest-attachment plugin" {
# we specify the version on the poi-3.15.jar so that the test does
# not spuriously pass if the jar is missing but the other poi jars
# are present
install_and_check_plugin ingest attachment bcprov-jdk15on-*.jar tika-core-*.jar pdfbox-*.jar poi-3.15.jar poi-ooxml-3.15.jar poi-ooxml-schemas-*.jar poi-scratchpad-*.jar
}
@test "[$GROUP] install ingest-geoip plugin" {
install_and_check_plugin ingest geoip geoip2-*.jar jackson-annotations-*.jar jackson-databind-*.jar maxmind-db-*.jar
}
@test "[$GROUP] install ingest-user-agent plugin" {
install_and_check_plugin ingest user-agent
}
@test "[$GROUP] check ingest-common module" {
check_module ingest-common jcodings-*.jar joni-*.jar
}
@test "[$GROUP] check lang-expression module" {
# we specify the version on the asm-5.0.4.jar so that the test does
# not spuriously pass if the jar is missing but the other asm jars
# are present
check_secure_module lang-expression antlr4-runtime-*.jar asm-5.0.4.jar asm-commons-*.jar asm-tree-*.jar lucene-expressions-*.jar
}
@test "[$GROUP] check lang-groovy module" {
check_secure_module lang-groovy groovy-*-indy.jar
}
@test "[$GROUP] check lang-mustache module" {
check_secure_module lang-mustache compiler-*.jar
}
@test "[$GROUP] check lang-painless module" {
check_secure_module lang-painless antlr4-runtime-*.jar asm-debug-all-*.jar
}
@test "[$GROUP] install javascript plugin" {
install_and_check_plugin lang javascript rhino-*.jar
}
@test "[$GROUP] install python plugin" {
install_and_check_plugin lang python jython-standalone-*.jar
}
@test "[$GROUP] install murmur3 mapper plugin" {
install_and_check_plugin mapper murmur3
}
@test "[$GROUP] check reindex module" {
check_module reindex
}
@test "[$GROUP] install repository-hdfs plugin" {
install_and_check_plugin repository hdfs hadoop-client-*.jar hadoop-common-*.jar hadoop-annotations-*.jar hadoop-auth-*.jar hadoop-hdfs-*.jar htrace-core-*.jar guava-*.jar protobuf-java-*.jar commons-logging-*.jar commons-cli-*.jar commons-collections-*.jar commons-configuration-*.jar commons-io-*.jar commons-lang-*.jar servlet-api-*.jar slf4j-api-*.jar
}
@test "[$GROUP] install size mapper plugin" {
install_and_check_plugin mapper size
}
@test "[$GROUP] install repository-azure plugin" {
install_and_check_plugin repository azure azure-storage-*.jar
}
@test "[$GROUP] install repository-gcs plugin" {
install_and_check_plugin repository gcs google-api-services-storage-*.jar
}
@test "[$GROUP] install repository-s3 plugin" {
install_and_check_plugin repository s3 aws-java-sdk-core-*.jar
}
@test "[$GROUP] install store-smb plugin" {
install_and_check_plugin store smb
}
@test "[$GROUP] check the installed plugins can be listed with 'plugins list' and result matches the list of plugins in plugins pom" {
"$ESHOME/bin/elasticsearch-plugin" list | cut -d'@' -f1 > /tmp/installed
compare_plugins_list "/tmp/installed" "'plugins list'"
}
@test "[$GROUP] start elasticsearch with all plugins installed" {
start_elasticsearch_service
}
@test "[$GROUP] check the installed plugins matches the list of build plugins" {
curl -s localhost:9200/_cat/plugins?h=c | sed 's/ *$//' > /tmp/installed
compare_plugins_list "/tmp/installed" "_cat/plugins"
}
@test "[$GROUP] stop elasticsearch" {
stop_elasticsearch_service
}
@test "[$GROUP] remove jvm-example plugin" {
remove_jvm_example
}
@test "[$GROUP] remove icu plugin" {
remove_plugin analysis-icu
}
@test "[$GROUP] remove kuromoji plugin" {
remove_plugin analysis-kuromoji
}
@test "[$GROUP] remove phonetic plugin" {
remove_plugin analysis-phonetic
}
@test "[$GROUP] remove smartcn plugin" {
remove_plugin analysis-smartcn
}
@test "[$GROUP] remove stempel plugin" {
remove_plugin analysis-stempel
}
@test "[$GROUP] remove ukrainian plugin" {
remove_plugin analysis-ukrainian
}
@test "[$GROUP] remove gce plugin" {
remove_plugin discovery-gce
}
@test "[$GROUP] remove discovery-azure-classic plugin" {
remove_plugin discovery-azure-classic
}
@test "[$GROUP] remove discovery-ec2 plugin" {
remove_plugin discovery-ec2
}
@test "[$GROUP] remove discovery-file plugin" {
remove_plugin discovery-file
}
@test "[$GROUP] remove ingest-attachment plugin" {
remove_plugin ingest-attachment
}
@test "[$GROUP] remove ingest-geoip plugin" {
remove_plugin ingest-geoip
}
@test "[$GROUP] remove ingest-user-agent plugin" {
remove_plugin ingest-user-agent
}
@test "[$GROUP] remove javascript plugin" {
remove_plugin lang-javascript
}
@test "[$GROUP] remove python plugin" {
remove_plugin lang-python
}
@test "[$GROUP] remove murmur3 mapper plugin" {
remove_plugin mapper-murmur3
}
@test "[$GROUP] remove size mapper plugin" {
remove_plugin mapper-size
}
@test "[$GROUP] remove repository-azure plugin" {
remove_plugin repository-azure
}
@test "[$GROUP] remove repository-gcs plugin" {
remove_plugin repository-gcs
}
@test "[$GROUP] remove repository-hdfs plugin" {
remove_plugin repository-hdfs
}
@test "[$GROUP] remove repository-s3 plugin" {
remove_plugin repository-s3
}
@test "[$GROUP] remove store-smb plugin" {
remove_plugin store-smb
}
@test "[$GROUP] start elasticsearch with all plugins removed" {
start_elasticsearch_service
}
@test "[$GROUP] check that there are now no plugins installed" {
curl -s localhost:9200/_cat/plugins > /tmp/installed
local installedCount=$(cat /tmp/installed | wc -l)
[ "$installedCount" == "0" ] || {
echo "Expected all plugins to be removed but found $installedCount:"
cat /tmp/installed
false
}
}
@test "[$GROUP] stop elasticsearch" {
stop_elasticsearch_service
}
@test "[$GROUP] install jvm-example with different logging modes and check output" {
local relativePath=${1:-$(readlink -m jvm-example-*.zip)}
sudo -E -u $ESPLUGIN_COMMAND_USER "$ESHOME/bin/elasticsearch-plugin" install "file://$relativePath" > /tmp/plugin-cli-output
# exclude progress line
local loglines=$(cat /tmp/plugin-cli-output | grep -v "^[[:cntrl:]]" | wc -l)
if [ "$GROUP" == "TAR PLUGINS" ]; then
# tar extraction does not create the plugins directory so the plugin tool will print an additional line that the directory will be created
[ "$loglines" -eq "3" ] || {
echo "Expected 3 lines excluding progress bar but the output had $loglines lines and was:"
cat /tmp/plugin-cli-output
false
}
else
[ "$loglines" -eq "2" ] || {
echo "Expected 2 lines excluding progress bar but the output had $loglines lines and was:"
cat /tmp/plugin-cli-output
false
}
fi
remove_jvm_example
local relativePath=${1:-$(readlink -m jvm-example-*.zip)}
sudo -E -u $ESPLUGIN_COMMAND_USER ES_JAVA_OPTS="-Des.logger.level=DEBUG" "$ESHOME/bin/elasticsearch-plugin" install "file://$relativePath" > /tmp/plugin-cli-output
local loglines=$(cat /tmp/plugin-cli-output | grep -v "^[[:cntrl:]]" | wc -l)
if [ "$GROUP" == "TAR PLUGINS" ]; then
[ "$loglines" -gt "3" ] || {
echo "Expected more than 3 lines excluding progress bar but the output had $loglines lines and was:"
cat /tmp/plugin-cli-output
false
}
else
[ "$loglines" -gt "2" ] || {
echo "Expected more than 2 lines excluding progress bar but the output had $loglines lines and was:"
cat /tmp/plugin-cli-output
false
}
fi
remove_jvm_example
}
@test "[$GROUP] test java home with space" {
# preserve JAVA_HOME
local java_home=$JAVA_HOME
# create a JAVA_HOME with a space
local java=$(which java)
local temp=`mktemp -d --suffix="java home"`
mkdir -p "$temp/bin"
ln -s "$java" "$temp/bin/java"
export JAVA_HOME="$temp"
# this will fail if the elasticsearch-plugin script does not
# properly handle JAVA_HOME with spaces
"$ESHOME/bin/elasticsearch-plugin" list
rm -rf "$temp"
# restore JAVA_HOME
export JAVA_HOME=$java_home
}
@test "[$GROUP] test ES_JAVA_OPTS" {
# preserve ES_JAVA_OPTS
local es_java_opts=$ES_JAVA_OPTS
export ES_JAVA_OPTS="-XX:+PrintFlagsFinal"
# this will fail if ES_JAVA_OPTS is not passed through
"$ESHOME/bin/elasticsearch-plugin" list | grep MaxHeapSize
# restore ES_JAVA_OPTS
export ES_JAVA_OPTS=$es_java_opts
}
|