[RORDEV-1435] Improved patching algorithm

azure-pipelines.yml

@@ -32,7 +32,7 @@ parameters:
     default: ' '
 
 pool:
-  vmImage: 'ubuntu-20.04'
+  vmImage: 'ubuntu-22.04'
 
 stages:
 

docker-envs/base-ror-docker/es/install-ror-es-using-api.sh

@@ -1,23 +1,40 @@
 #!/bin/bash
 
-function verlte() {
-  [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ]
+verlte() {
+  local v1="$1"
+  local v2="${2%%[-+]*}"  # Strip suffix from second argument in order to support -pre versions
+  [ "$v1" = "$(echo -e "$v1\n$v2" | sort -V | head -n1)" ]
 }
 
 if [[ -z "$ES_VERSION" ]]; then
   echo "No ES_VERSION variable is set"
   exit 1
 fi
 
-if [[ -z "$ROR_VERSION" ]]; then
-  echo "No $ROR_VERSION variable is set"
-  exit 2
+if [[ ! -v ROR_VERSION || -z "$ROR_VERSION" ]]; then
+  echo "No ROR_VERSION variable is set"
+  exit 3
 fi
 
 echo "Installing ES ROR $ROR_VERSION..."
 /usr/share/elasticsearch/bin/elasticsearch-plugin install --batch "https://api.beshu.tech/download/es?esVersion=$ES_VERSION&pluginVersion=$ROR_VERSION&email=ror-sandbox%40readonlyrest.com"
-if verlte "6.5.0" "$ES_VERSION"; then
-  echo "Patching ES ROR $ROR_VERSION..."
-  /usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch --I_UNDERSTAND_AND_ACCEPT_ES_PATCHING yes
+
+# Set Java path based on ES version
+if verlte "7.0.0" "$ES_VERSION"; then
+  JAVA_BIN_PATH="/usr/share/elasticsearch/jdk/bin/java"
+elif verlte "6.7.0" "$ES_VERSION"; then
+  JAVA_BIN_PATH="$JAVA_HOME/bin/java"
+else
+  echo "Unsupported ES version: $ES_VERSION"
+  exit 4
+fi
+
+# Set OPTIONS based on ROR version
+if verlte "1.64.0" "$ROR_VERSION"; then
+  OPTIONS="--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes"
+else
+  OPTIONS=""
 fi
+
+$JAVA_BIN_PATH -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch $OPTIONS
 echo "DONE!"

docker-envs/base-ror-docker/es/install-ror-es-using-file.sh

@@ -1,7 +1,9 @@
 #!/bin/bash
 
-function verlte() {
-  [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ]
+verlte() {
+  local v1="$1"
+  local v2="${2%%[-+]*}"  # Strip suffix from second argument in order to support -pre versions
+  [ "$v1" = "$(echo -e "$v1\n$v2" | sort -V | head -n1)" ]
 }
 
 if [[ -z "$ES_VERSION" ]]; then
@@ -11,8 +13,29 @@ fi
 
 echo "Installing ES ROR from file..."
 /usr/share/elasticsearch/bin/elasticsearch-plugin install --batch file:///tmp/ror.zip
-if verlte "6.5.0" "$ES_VERSION"; then
-  echo "Patching ES ROR..."
-  /usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch --I_UNDERSTAND_AND_ACCEPT_ES_PATCHING yes
+ROR_VERSION=$(unzip -p /tmp/ror.zip plugin-descriptor.properties | grep -oP '^version=\K.*')
+
+if [[ ! -v ROR_VERSION || -z "$ROR_VERSION" ]]; then
+  echo "No ROR_VERSION variable is set"
+  exit 3
+fi
+
+# Set Java path based on ES version
+if verlte "7.0.0" "$ES_VERSION"; then
+  JAVA_BIN_PATH="/usr/share/elasticsearch/jdk/bin/java"
+elif verlte "6.7.0" "$ES_VERSION"; then
+  JAVA_BIN_PATH="$JAVA_HOME/bin/java"
+else
+  echo "Unsupported ES version: $ES_VERSION"
+  exit 4
 fi
+
+# Set OPTIONS based on ROR version
+if verlte "1.64.0" "$ROR_VERSION"; then
+  OPTIONS="--I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes"
+else
+  OPTIONS=""
+fi
+
+$JAVA_BIN_PATH -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar patch $OPTIONS
 echo "DONE!"

docker-envs/eck/kind-cluster/ror/es.yml

@@ -17,7 +17,7 @@ spec:
                 runAsUser: 0
                 runAsGroup: 0
               env:
-                - name: I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING
+                - name: I_UNDERSTAND_AND_ACCEPT_ES_PATCHING
                   value: "yes"
                 - name: INTERNAL_USR_PASS
                   valueFrom:

docker-image/ror-entrypoint-es6x.sh

@@ -26,7 +26,7 @@ if $INVOKE_ROR_TOOLS verify | grep -q "Elasticsearch is NOT patched"; then
     echo "Elasticsearch needs to be patched to work with ReadonlyREST. You can read about patching in our documentation:" \
          "https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch. In this Docker image, the patching step" \
          "is done automatically, but you must agree to have it done for you. You can do this by setting" \
-         "I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING=yes environment variable when running the container."
+         "I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes environment variable when running the container."
     exit 2
   fi
 

docker-image/ror-entrypoint.sh

@@ -4,7 +4,15 @@ INVOKE_ROR_TOOLS="/usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elastics
 
 if $INVOKE_ROR_TOOLS verify | grep -q "Elasticsearch is NOT patched"; then
 
-  if [ -n "$I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING" ] && [[ "${I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING,,}" == *"yes"* ]]; then
+  if [ -n "$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING" ]; then
+      CONFIRMATION="$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING"
+  elif [ -n "$I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING" ]; then
+      CONFIRMATION="$I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING"
+  else
+      CONFIRMATION=""
+  fi
+
+  if [[ "${CONFIRMATION,,}" == *"yes"* ]]; then
     if [ "$(id -u)" -ne 0 ]; then
       echo "Elasticsearch needs to be patched to work with ReadonlyREST. You can read about patching in our documentation:" \
            "https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch. To patch Elasticsearch the container " \
@@ -18,7 +26,7 @@ if $INVOKE_ROR_TOOLS verify | grep -q "Elasticsearch is NOT patched"; then
     echo "Elasticsearch needs to be patched to work with ReadonlyREST. You can read about patching in our documentation:" \
          "https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch. In this Docker image, the patching step" \
          "is done automatically, but you must agree to have it done for you. You can do this by setting" \
-         "I_UNDERSTAND_IMPLICATION_OF_ES_PATCHING=yes environment variable when running the container."
+         "I_UNDERSTAND_AND_ACCEPT_ES_PATCHING=yes environment variable when running the container."
     exit 2
   fi
 

gradle.properties

@@ -1,5 +1,5 @@
 publishedPluginVersion=1.63.0
-pluginVersion=1.64.0-pre7
+pluginVersion=1.64.0-pre8
 pluginName=readonlyrest
 
 org.gradle.jvmargs=-Xmx6144m

ror-tools-core/build.gradle

@@ -54,6 +54,10 @@ dependencies {
     api group: 'org.ow2.asm',                   name: 'asm-util',                         version: '9.8'
     api group: 'io.kevinlee',                   name: 'just-semver_3',                    version: '0.5.0'
     api group: 'com.lihaoyi',                   name: 'os-lib_3',                         version: '0.11.3'
+    api group: 'com.github.pathikrit',          name: 'better-files_3',                   version: '3.9.2'
+    api group: 'io.circe',                      name: 'circe-core_3',                     version: '0.14.6'
+    api group: 'io.circe',                      name: 'circe-generic_3',                  version: '0.14.6'
+    api group: 'io.circe',                      name: 'circe-parser_3',                   version: '0.14.6'
 }
 
 java {
@@ -77,6 +81,12 @@ compileScala {
     )
 }
 
+tasks.withType(ScalaCompile).configureEach {
+    scalaCompileOptions.additionalParameters = [
+            "-Xmax-inlines", "128"
+    ]
+}
+
 shadowJar {
     configurations = [project.configurations.runtimeClasspath]
 }

ror-tools-core/src/main/scala/tech/beshu/ror/tools/core/patches/PatchingVerifier.scala

@@ -17,34 +17,42 @@
 package tech.beshu.ror.tools.core.patches
 
 import tech.beshu.ror.tools.core.patches.PatchingVerifier.Error.{CannotVerifyIfPatched, EsNotPatched}
-import tech.beshu.ror.tools.core.patches.base.EsPatch
-import tech.beshu.ror.tools.core.patches.base.EsPatch.IsPatched.{No, Yes}
+import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor
+import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor.EsPatchStatus
+import tech.beshu.ror.tools.core.utils.EsDirectory
+import tech.beshu.ror.tools.core.utils.InOut.ConsoleInOut
+import tech.beshu.ror.tools.core.utils.RorToolsError.*
 
 import scala.util.Try
 
 object PatchingVerifier {
 
   def verify(esHome: String): Either[Error, Unit] = {
     for {
-      esPatch <- createPatcher(esHome)
-      result <- esPatch.isPatched match {
-        case Yes => Right(())
-        case No(cause) => Left(EsNotPatched(cause.message))
-      }
+      esPatchExecutor <- createEsPatchExecutor(esHome)
+      result <- esPatchExecutor.isPatched match
+        case EsPatchStatus.NotPatched =>
+          Left(EsNotPatched(EsNotPatchedError.message))
+        case EsPatchStatus.PatchedWithCurrentRorVersion(_) =>
+          Right(())
+        case EsPatchStatus.PatchProblemDetected(patchProblem) =>
+          Left(EsNotPatched(patchProblem.rorToolsError.message))
     } yield result
   }
 
-  private def createPatcher(esHome: String) = {
-    Try(EsPatch.create(os.Path(esHome)))
+  private def createEsPatchExecutor(esHome: String) = {
+    Try(EsPatchExecutor.create(EsDirectory.from(os.Path(esHome)))(ConsoleInOut))
       .toEither
       .left.map { e => CannotVerifyIfPatched(e.getMessage) }
   }
 
   sealed trait Error {
     def message: String
   }
+
   object Error {
     final case class EsNotPatched(override val message: String) extends Error
+
     final case class CannotVerifyIfPatched(errorCause: String) extends Error {
       override val message: String = s"Cannot verify if the ES was patched. $errorCause"
     }