@@ -25,6 +25,46 @@ run it using Gradle:
25
25
./gradlew run
26
26
-------------------------------------
27
27
28
+ ==== Launching and debugging from an IDE
29
+
30
+ If you want to run Elasticsearch from your IDE, the `./gradlew run` task
31
+ supports a remote debugging option:
32
+
33
+ ---------------------------------------------------------------------------
34
+ ./gradlew run --debug-jvm
35
+ ---------------------------------------------------------------------------
36
+
37
+ ==== Distribution
38
+
39
+ By default a node is started with the zip distribution.
40
+ In order to start with a different distribution use the `-Drun.distribution` argument.
41
+
42
+ To for example start the open source distribution:
43
+
44
+ -------------------------------------
45
+ ./gradlew run -Drun.distribution=oss-zip
46
+ -------------------------------------
47
+
48
+ ==== License type
49
+
50
+ By default a node is started with the `basic` license type.
51
+ In order to start with a different license type use the `-Drun.license_type` argument.
52
+
53
+ In order to start a node with a trial license execute the following command:
54
+
55
+ -------------------------------------
56
+ ./gradlew run -Drun.license_type=trial
57
+ -------------------------------------
58
+
59
+ This enables security and other paid features and adds a superuser with the username: `elastic-admin` and
60
+ password: `elastic-password`.
61
+
62
+ ==== Other useful arguments
63
+
64
+ In order to start a node with a different max heap space add: `-Dtests.heap.size=4G`
65
+ In order to disable annotations add: `-Dtests.asserts=false`
66
+ In order to set an Elasticsearch setting, provide a setting with the following prefix: `-Dtests.es.`
67
+
28
68
=== Test case filtering.
29
69
30
70
- `tests.class` is a class-filtering shell-like glob pattern,
@@ -303,15 +343,16 @@ comma separated list of nodes to connect to (e.g. localhost:9300). A transport c
303
343
be created based on that and used for all the before|after test operations, and to extract
304
344
the http addresses of the nodes so that REST requests can be sent to them.
305
345
306
- == Testing scripts
346
+ == Testing packaging
307
347
308
- The simplest way to test scripts and the packaged distributions is to use
309
- Vagrant. You can get started by following there five easy steps:
348
+ The packaging tests use Vagrant virtual machines to verify that installing
349
+ and running elasticsearch distributions works correctly on supported operating systems.
350
+ These tests should really only be run in vagrant vms because they're destructive.
310
351
311
352
. Install Virtual Box and Vagrant.
312
353
313
- . (Optional) Install vagrant-cachier to squeeze a bit more performance out of
314
- the process:
354
+ . (Optional) Install https://github.com/fgrehm/ vagrant-cachier[vagrant-cachier] to squeeze
355
+ a bit more performance out of the process:
315
356
316
357
--------------------------------------
317
358
vagrant plugin install vagrant-cachier
@@ -325,26 +366,39 @@ vagrant plugin install vagrant-cachier
325
366
326
367
. Download and smoke test the VMs with `./gradlew vagrantSmokeTest` or
327
368
`./gradlew -Pvagrant.boxes=all vagrantSmokeTest`. The first time you run this it will
328
- download the base images and provision the boxes and immediately quit. If you
329
- you this again it'll skip the download step.
369
+ download the base images and provision the boxes and immediately quit. Downloading all
370
+ the images may take a long time. After the images are already on your machine, they won't
371
+ be downloaded again unless they have been updated to a new version.
330
372
331
373
. Run the tests with `./gradlew packagingTest`. This will cause Gradle to build
332
374
the tar, zip, and deb packages and all the plugins. It will then run the tests
333
375
on ubuntu-1404 and centos-7. We chose those two distributions as the default
334
376
because they cover deb and rpm packaging and SyvVinit and systemd.
335
377
336
- You can run on all the VMs by running `./gradlew -Pvagrant.boxes=all
337
- packagingTest`. You can run a particular VM with a command like `./gradlew
338
- -Pvagrant.boxes=oel-7 packagingTest`. See `./gradlew tasks` for a complete list
339
- of available vagrant boxes for testing. It's important to know that if you
340
- interrupt any of these Gradle commands then the boxes will remain running and
341
- you'll have to terminate them with `./gradlew stop`.
378
+ You can choose which boxes to test by setting the `-Pvagrant.boxes` project property. All of
379
+ the valid options for this property are:
380
+
381
+ * `sample` - The default, only chooses ubuntu-1404 and centos-7
382
+ * List of box names, comma separated (e.g. `oel-7,fedora-26`) - Chooses exactly the boxes listed.
383
+ * `linux-all` - All linux boxes.
384
+ * `windows-all` - All Windows boxes. If there are any Windows boxes which do not
385
+ have images available when this value is provided, the build will fail.
386
+ * `all` - All boxes we test. If there are any boxes (e.g. Windows) which do not have images
387
+ available when this value is provided, the build will fail.
388
+
389
+ For a complete list of boxes on which tests can be run, run `./gradlew :qa:vagrant:listAllBoxes`.
390
+ For a list of boxes that have images available from your configuration, run
391
+ `./gradlew :qa:vagrant:listAvailableBoxes`
392
+
393
+ Note that if you interrupt gradle in the middle of running these tasks, any boxes started
394
+ will remain running and you'll have to stop them manually with `./gradlew stop` or
395
+ `vagrant halt`.
342
396
343
397
All the regular vagrant commands should just work so you can get a shell in a
344
398
VM running trusty by running
345
399
`vagrant up ubuntu-1404 --provider virtualbox && vagrant ssh ubuntu-1404`.
346
400
347
- These are the linux flavors the Vagrantfile currently supports:
401
+ These are the linux flavors supported, all of which we provide images for
348
402
349
403
* ubuntu-1404 aka trusty
350
404
* ubuntu-1604 aka xenial
@@ -364,9 +418,42 @@ quality boxes available in vagrant atlas:
364
418
365
419
* sles-11
366
420
367
- We're missing the following because our tests are very linux/bash centric:
421
+ === Testing packaging on Windows
422
+
423
+ The packaging tests also support Windows Server 2012R2 and Windows Server 2016.
424
+ Unfortunately we're not able to provide boxes for them in open source use
425
+ because of licensing issues. Any Virtualbox image that has WinRM and Powershell
426
+ enabled for remote users should work.
427
+
428
+ Testing on Windows requires the https://github.com/criteo/vagrant-winrm[vagrant-winrm] plugin.
429
+
430
+ ------------------------------------
431
+ vagrant plugin install vagrant-winrm
432
+ ------------------------------------
433
+
434
+ Specify the image IDs of the Windows boxes to gradle with the following project
435
+ properties. They can be set in `~/.gradle/gradle.properties` like
368
436
369
- * Windows Server 2012
437
+ ------------------------------------
438
+ vagrant.windows-2012r2.id=my-image-id
439
+ vagrant.windows-2016.id=another-image-id
440
+ ------------------------------------
441
+
442
+ or passed on the command line like `-Pvagrant.windows-2012r2.id=my-image-id`
443
+ `-Pvagrant.windows-2016=another-image-id`
444
+
445
+ These properties are required for Windows support in all gradle tasks that
446
+ handle packaging tests. Either or both may be specified. Remember that to run tests
447
+ on these boxes, the project property `vagrant.boxes` still needs to be set to a
448
+ value that will include them.
449
+
450
+ If you're running vagrant commands outside of gradle, specify the Windows boxes
451
+ with the environment variables
452
+
453
+ * `VAGRANT_WINDOWS_2012R2_BOX`
454
+ * `VAGRANT_WINDOWS_2016_BOX`
455
+
456
+ === Testing VMs are disposable
370
457
371
458
It's important to think of VMs like cattle. If they become lame you just shoot
372
459
them and let vagrant reprovision them. Say you've hosed your precise VM:
@@ -399,54 +486,62 @@ vagrant destroy -f
399
486
`vagrant up` would normally start all the VMs but we've prevented that because
400
487
that'd consume a ton of ram.
401
488
402
- == Testing scripts more directly
489
+ === Iterating on packaging tests
403
490
404
- In general its best to stick to testing in vagrant because the bats scripts are
405
- destructive. When working with a single package it's generally faster to run its
406
- tests in a tighter loop than Gradle provides. In one window:
491
+ Running the packaging tests through gradle can take a while because it will start
492
+ and stop the VM each time. You can iterate faster by keeping the VM up and running
493
+ the tests directly.
407
494
408
- --------------------------------
409
- ./gradlew :distribution:packages:rpm:assemble
410
- --------------------------------
495
+ The packaging tests use a random seed to determine which past version to use for
496
+ testing upgrades. To use a single past version fix the test seed when running
497
+ the commands below (see <<Seed and repetitions.>>)
411
498
412
- and in another window:
499
+ First build the packaging tests and their dependencies
413
500
414
- ----------------------------------------------------
415
- vagrant up centos-7 --provider virtualbox && vagrant ssh centos-7
416
- cd $PACKAGING_ARCHIVES
417
- sudo -E bats $BATS_TESTS/*rpm*.bats
418
- ----------------------------------------------------
501
+ --------------------------------------------
502
+ ./gradlew :qa:vagrant:setupPackagingTest
503
+ --------------------------------------------
419
504
420
- If you wanted to retest all the release artifacts on a single VM you could:
505
+ Then choose the VM you want to test on and bring it up. For example, to bring
506
+ up Debian 9 use the gradle command below. Bringing the box up with vagrant directly
507
+ may not mount the packaging test project in the right place. Once the VM is up, ssh
508
+ into it
421
509
422
- -------------------------------------------------
423
- ./gradlew setupPackagingTest
424
- cd qa/vagrant; vagrant up ubuntu-1404 --provider virtualbox && vagrant ssh ubuntu-1404
510
+ --------------------------------------------
511
+ ./gradlew :qa:vagrant:vagrantDebian9#up
512
+ vagrant ssh debian-9
513
+ --------------------------------------------
514
+
515
+ Now inside the VM, to run the https://github.com/sstephenson/bats[bats] packaging tests
516
+
517
+ --------------------------------------------
425
518
cd $PACKAGING_ARCHIVES
426
- sudo -E bats $BATS_TESTS/*.bats
427
- -------------------------------------------------
428
519
429
- You can also use Gradle to prepare the test environment and then starts a single VM:
520
+ # runs all bats tests
521
+ sudo bats $BATS_TESTS/*.bats
430
522
431
- -------------------------------------------------
432
- ./gradlew vagrantFedora27#up
433
- -------------------------------------------------
523
+ # you can also pass specific test files
524
+ sudo bats $BATS_TESTS/20_tar_package.bats $BATS_TESTS/25_tar_plugins.bats
525
+ --------------------------------------------
434
526
435
- Or any of vagrantCentos6#up, vagrantCentos7#up, vagrantDebian8#up,
436
- vagrantDebian9#up, vagrantFedora26#up, vagrantFedora27#up, vagrantOel6#up, vagrantOel7#up,
437
- vagrantOpensuse42#up,vagrantSles12#up, vagrantUbuntu1404#up, vagrantUbuntu1604#up.
527
+ To run the Java packaging tests, again inside the VM
438
528
439
- Once up, you can then connect to the VM using SSH from the elasticsearch directory:
529
+ --------------------------------------------
530
+ bash $PACKAGING_TESTS/run-tests.sh
531
+ --------------------------------------------
440
532
441
- -------------------------------------------------
442
- vagrant ssh fedora-27
443
- -------------------------------------------------
533
+ or on Windows
444
534
445
- Or from another directory:
535
+ --------------------------------------------
536
+ powershell -File $Env:PACKAGING_TESTS/run-tests.ps1
537
+ --------------------------------------------
446
538
447
- -------------------------------------------------
448
- VAGRANT_CWD=/path/to/elasticsearch vagrant ssh fedora-27
449
- -------------------------------------------------
539
+ When you've made changes you want to test, keep the VM up and reload the tests and
540
+ distributions inside by running (on the host)
541
+
542
+ --------------------------------------------
543
+ ./gradlew :qa:vagrant:clean :qa:vagrant:setupPackagingTest
544
+ --------------------------------------------
450
545
451
546
Note: Starting vagrant VM outside of the elasticsearch folder requires to
452
547
indicates the folder that contains the Vagrantfile using the VAGRANT_CWD
@@ -517,15 +612,6 @@ as its build system. Since the switch to Gradle though, this is no longer possib
517
612
the code currently used to build Elasticsearch does not allow JaCoCo to recognize its tests.
518
613
For more information on this, see the discussion in https://github.com/elastic/elasticsearch/issues/28867[issue #28867].
519
614
520
- == Launching and debugging from an IDE
521
-
522
- If you want to run Elasticsearch from your IDE, the `./gradlew run` task
523
- supports a remote debugging option:
524
-
525
- ---------------------------------------------------------------------------
526
- ./gradlew run --debug-jvm
527
- ---------------------------------------------------------------------------
528
-
529
615
== Debugging remotely from an IDE
530
616
531
617
If you want to run Elasticsearch and be able to remotely attach the process
0 commit comments