aakhmerov / elasticsearch-maven-plugin

A Maven plugin to run a single node Elasticsearch cluster during the integration test phase of a build

Elasticsearch Maven Plugin

A Maven plugin to run instances of Elasticsearch version 5+ during the integration test phase of a build. Instances are started in forked processes using the runforked goal. They are terminated using the stop goal and, for extra peace of mind, using a JVM shutdown hook.

Each instance is installed in ${project.build.directory}/elasticsearch${instanceIndex}.

For Elasticsearch version 1.x.x and 2.x.x support, see version 1.x and 2.x of this plugin.

Usage

The Elasticsearch behaviour and properties can be configured through the following plugin configuration parameters:

• instanceCount [defaultValue=1]

  how many Elasticsearch instances to start (all within the same cluster)

• skip [defaultValue=false]

  whether to skip the plugin execution or not

• clusterName [defaultValue="test"]

  the name of the cluster to create

• version [defaultValue="5.0.0"]

  the version of Elasticsearch to install

• httpPort [defaultValue=9200]

  the port to configure Elasticsearch to listen to HTTP traffic to; when configuring multiple instances, they will be assigned subsequent HTTP ports starting with this value (mind the conflicts with the transport ports)

• transportPort [defaultValue=9300]

  the port for the Elasticsearch node to node communication; when configuring multiple instances, they will be assigned subsequent transport ports starting with this value (mind the conflicts with the HTTP ports)

• pathConf [defaultValue=""] (note: common to all instances !!!)

  the absolute path (or relative to the maven project) of the custom directory containing configuration files, to be copied to Elasticsearch instances

• pathData [defaultValue=""] - work in progress (note: per instance !!!)

  the custom data directory to configure in Elasticsearch

• pathLogs [defaultValue=""] - work in progress (note: per instance !!!)

  the custom logs directory to configure in Elasticsearch

• pathScripts [defaultValue=""]

  the absolute path (or relative to the maven project) of the custom directory containing file-based scripts, to be used in Elasticsearch

• pathInitScript [defaultValue=""]

  the path of the initialization script (see the Initialization script section for details)

• keepExistingData [defaultValue=false] - work in progress

  whether to keep the data and log directories if they already exist

• timeout [defaultValue=30]

  how long to wait (in seconds) for each Elasticsearch instance to start up

• setAwait [defaultValue=false]

  whether to block the execution once all Elasticsearch instances have started, so that the maven build will not proceed to the next step; use CTRL+C to abort the process

• autoCreateIndex [defaultValue=true]

  configuration of automatic index creation represented by action.auto_create_index setting

• logLevel [defaultValue=INFO]

  the log level to be used by the console logger; the valid values are defined in AbstractElasticsearchBaseMojo.getMavenLogLevel() and they are: DEBUG, INFO, WARN, ERROR, FATAL, DISABLED.

To use the plugin, include the following in your pom.xml file and modify the configuration as needed:

    <plugin>
	    <groupId>com.github.alexcojocaru</groupId>
	    <artifactId>elasticsearch-maven-plugin</artifactId>
		<!-- REPLACE THE FOLLOWING WITH THE PLUGIN VERSION YOU NEED -->
	    <version>5.0</version>
	    <configuration>
			<clusterName>test</clusterName>
			<tcpPort>9300</tcpPort>
			<httpPort>9200</httpPort>
	    </configuration>
	    <executions>
	        <!--
				The elasticsearch maven plugin goals are by default bound to the
				pre-integration-test and post-integration-test phases
			-->
	        <execution>
	            <id>start-elasticsearch</id>
	            <phase>pre-integration-test</phase>
	            <goals>
	                <goal>runforked</goal>
	            </goals>
	        </execution>
	        <execution>
	            <id>stop-elasticsearch</id>
	            <phase>post-integration-test</phase>
	            <goals>
	                <goal>stop</goal>
	            </goals>
	        </execution>
	    </executions>
	</plugin>

Initialization script

An initialization script file can be provided using the pathInitScript parameter of the plugin, in which case it will be executed against the local Elasticsearch cluster.

Empty lines are ignored, as well as lines starting with the '#' sign.

Each command has three parts, separated by colon.

• the request method: one of PUT, POST, DELETE

  the name (in uppercase) of the request method to be used for the current command

• the path part of the URL (should not start with slash)

  will be appended to the protocol, hostname and port parts when the full URL is constructed

• the JSON to send to Elasticsearch; for DELETE commands it should be empty for a DELETE

Examples (see the src/it/runforked-with-init-script/init.script file for a more complete example):

• To send a POST request to http://localhost:9200/test\_index/test\_type/\_mapping:

POST:test_index/test_type/_mapping:{ "test_type" : { "properties" : { "name" : { "type" : "string" }, "lastModified" : { "type" : "date" } } } }

• To send a DELETE request to http://localhost:9200/test\_index/test\_type/1 without content; note the colon at the end, for there is no JSON data in case of a DELETE.

DELETE:test_index/test_type/1: