Merge pull request #23 from opendatasoft/7.17

Release version 7.17.0.0

Author: benj-moreau

README.md

@@ -15,11 +15,31 @@ This is a multi bucket aggregation.
 Installation
 ------------
 
-`bin/plugin --install path_hierarchy --url "https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.6.0.0/pathhierarchy-aggregation-7.6.0.0.zip"`
+`bin/plugin --install path_hierarchy --url "https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.17.0.0/pathhierarchy-aggregation-7.17.0.0.zip"`
 
 Build
 -----
-Requires Java 12
+Compatible with Java version from 15 to 17
+
+Development Environment Setup
+------------
+
+Build the plugin using gradle:
+
+`./gradlew build`
+
+OR
+
+`./gradlew assemble` (to avoid tests)
+
+Then the following command will start a dockerized ES and will install the previously built plugin:
+
+`
+docker-compose up
+`
+
+
+> NOTE: In `docker-compose.yml` you can uncomment the debug env and attach a REMOTE JVM on `*:5005` to debug the plugin.
 
 Path hierarchy aggregation
 --------------------------
@@ -291,6 +311,7 @@ GET /calendar/_search?size=0
   "aggs": {
     "tree": {
       "date_hierarchy": {
+        "field": "date",
         "interval": "days",
         "order": {
           "_key": "asc"
@@ -305,12 +326,10 @@ GET /calendar/_search?size=0
 Installation
 ------------
 
-Plugin versions are available for (at least) all minor versions of Elasticsearch since 6.0.
-
 The first 3 digits of plugin version is Elasticsearch versioning. The last digit is used for plugin versioning under an elasticsearch version.
 
 To install it, launch this command in Elasticsearch directory replacing the url by the correct link for your Elasticsearch version (see table)
-`./bin/elasticsearch-plugin install https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.6.0.0/pathhierarchy-aggregation-7.6.0.0.zip`
+`./bin/elasticsearch-plugin install https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.17.0.0/pathhierarchy-aggregation-7.17.0.0.zip`
 
 | elasticsearch version | plugin version | plugin url |
 | --------------------- | -------------- | ---------- |
@@ -330,7 +349,9 @@ To install it, launch this command in Elasticsearch directory replacing the url
 | 7.4.2 | 7.4.2.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.4.2.0/pathhierarchy-aggregation-7.4.2.0.zip |
 | 7.5.1 | 7.5.1.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.5.1.0/pathhierarchy-aggregation-7.5.1.0.zip |
 | 7.6.0 | 7.6.0.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.6.0.0/pathhierarchy-aggregation-7.6.0.0.zip |
-
+| 7.10.2 | 7.10.2.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.10.2.0/pathhierarchy-aggregation-7.10.2.0.zip |
+| 7.16.3 | 7.16.3.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.16.3.0/pathhierarchy-aggregation-7.16.3.0.zip |
+| 7.17.0 | 7.17.0.0 | https://github.com/opendatasoft/elasticsearch-aggregation-pathhierarchy/releases/download/v7.17.0.0/pathhierarchy-aggregation-7.17.0.0.zip |
 
 License
 -------

build.gradle

@@ -2,25 +2,25 @@ buildscript {
     repositories {
         mavenLocal()
         mavenCentral()
-        jcenter()
     }
 
     dependencies {
         classpath "org.elasticsearch.gradle:build-tools:${es_version}"
     }
 }
 
+repositories {
+    mavenLocal()
+    mavenCentral()
+}
+
 group = 'org.elasticsearch.plugin'
 version = "${plugin_version}"
 
 apply plugin: 'java'
 apply plugin: 'idea'
 apply plugin: 'elasticsearch.esplugin'
-
-// license of this project
-licenseFile = rootProject.file('LICENSE')
-noticeFile = rootProject.file('README.md')
-
+apply plugin: 'elasticsearch.yaml-rest-test'
 
 esplugin {
     name 'pathhierarchy-aggregation'
@@ -31,15 +31,7 @@ esplugin {
 }
 
 dependencies {
-    compile "org.elasticsearch:elasticsearch:${es_version}"
-}
-
-// Skip license headers check
-licenseHeaders.enabled = false
-
-// Use elasticsearch checkstyle rules
-checkstyleTest.enabled = true
-
-dependencyLicenses.enabled = true
-
-thirdPartyAudit.enabled = true
+    implementation "org.elasticsearch:elasticsearch:${es_version}"
+    yamlRestTestImplementation "org.elasticsearch.test:framework:${es_version}"
+    yamlRestTestImplementation "org.apache.logging.log4j:log4j-core:2.17.1"
+}

docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.7"
+
+services:
+  elasticsearch-plugin-debug:
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+      target: elasticsearch-plugin-debug
+    environment:
+      - discovery.type=single-node
+      # NO DEBUG
+      # - ES_JAVA_OPTS=-Xms512m -Xmx512m
+      # DEBUG
+      - ES_JAVA_OPTS=-Xms512m -Xmx512m -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005
+    ports:
+      - "9200:9200"
+      # DEBUG
+      - "5005:5005"

docker/Dockerfile

@@ -0,0 +1,4 @@
+FROM docker.elastic.co/elasticsearch/elasticsearch:7.17.0 AS elasticsearch-plugin-debug
+
+COPY /build/distributions/pathhierarchy-aggregation-7.17.0.0.zip /tmp/pathhierarchy-aggregation-7.17.0.0.zip
+RUN ./bin/elasticsearch-plugin install file:/tmp/pathhierarchy-aggregation-7.17.0.0.zip

gradle.properties

@@ -1,2 +1,2 @@
-es_version = 7.6.0
-plugin_version = 7.6.0.0
+es_version = 7.17.0
+plugin_version = 7.17.0.0

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -82,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -129,6 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath

gradlew

@@ -29,6 +29,9 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
@@ -37,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -51,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -61,28 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell

gradlew.bat

@@ -1,34 +1,34 @@
 package org.opendatasoft.elasticsearch.plugin;
 
-import java.util.ArrayList;
 import org.elasticsearch.plugins.Plugin;
 import org.elasticsearch.plugins.SearchPlugin;
-import org.opendatasoft.elasticsearch.search.aggregations.bucket.PathHierarchyAggregationBuilder;
 import org.opendatasoft.elasticsearch.search.aggregations.bucket.DateHierarchyAggregationBuilder;
-import org.opendatasoft.elasticsearch.search.aggregations.bucket.InternalPathHierarchy;
 import org.opendatasoft.elasticsearch.search.aggregations.bucket.InternalDateHierarchy;
+import org.opendatasoft.elasticsearch.search.aggregations.bucket.InternalPathHierarchy;
+import org.opendatasoft.elasticsearch.search.aggregations.bucket.PathHierarchyAggregationBuilder;
+
+import java.util.ArrayList;
 
 public class PathHierarchyAggregation extends Plugin implements SearchPlugin {
     @Override
     public ArrayList<SearchPlugin.AggregationSpec> getAggregations() {
         ArrayList<SearchPlugin.AggregationSpec> r = new ArrayList<>();
-
         r.add(
                 new AggregationSpec(
                         PathHierarchyAggregationBuilder.NAME,
                         PathHierarchyAggregationBuilder::new,
-                        PathHierarchyAggregationBuilder::parse)
-                .addResultReader(InternalPathHierarchy::new)
+                        PathHierarchyAggregationBuilder.PARSER)
+                        .addResultReader(InternalPathHierarchy::new)
+                        .setAggregatorRegistrar(PathHierarchyAggregationBuilder::registerAggregators)
         );
-
         r.add(
                 new AggregationSpec(
                         DateHierarchyAggregationBuilder.NAME,
                         DateHierarchyAggregationBuilder::new,
-                        DateHierarchyAggregationBuilder::parse)
+                        DateHierarchyAggregationBuilder.PARSER)
                         .addResultReader(InternalDateHierarchy::new)
+                        .setAggregatorRegistrar(DateHierarchyAggregationBuilder::registerAggregators)
         );
-
         return r;
     }
 }