[RORDEV-1461] Docker image patching verification fix (#1109)

Author: coutoPL

docker-image/ror-entrypoint-es6x.sh

@@ -2,7 +2,7 @@
 
 INVOKE_ROR_TOOLS="$JAVA_HOME/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar"
 
-if $INVOKE_ROR_TOOLS verify | grep -q "Elasticsearch is NOT patched"; then
+if ! $INVOKE_ROR_TOOLS verify; then
 
   if [ -n "$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING" ]; then
       CONFIRMATION="$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING"

docker-image/ror-entrypoint.sh

@@ -2,7 +2,7 @@
 
 INVOKE_ROR_TOOLS="/usr/share/elasticsearch/jdk/bin/java -jar /usr/share/elasticsearch/plugins/readonlyrest/ror-tools.jar"
 
-if $INVOKE_ROR_TOOLS verify | grep -q "Elasticsearch is NOT patched"; then
+if ! $INVOKE_ROR_TOOLS verify; then
 
   if [ -n "$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING" ]; then
       CONFIRMATION="$I_UNDERSTAND_AND_ACCEPT_ES_PATCHING"

gradle.properties

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

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

@@ -16,7 +16,6 @@
  */
 package tech.beshu.ror.tools.core.patches.base
 
-import just.semver.SemVer
 import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor.EsPatchStatus
 import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor.EsPatchStatus.*
 import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor.PatchProblem.*
@@ -56,13 +55,14 @@ final class EsPatchExecutor(rorPluginDirectory: RorPluginDirectory,
     }
   }
 
-  def verify(): Either[RorToolsError, Unit] = {
+  def verify(): Either[RorToolsError, Boolean] = {
     checkWithPatchedByFileAndEsPatch() match {
       case NotPatched =>
-        Left(EsNotPatchedError)
+        inOut.println(EsNotPatchedError.message)
+        Right(false)
       case PatchedWithCurrentRorVersion(_) =>
         inOut.println("Elasticsearch is patched! ReadonlyREST can be used")
-        Right(())
+        Right(true)
       case PatchProblemDetected(patchProblem) =>
         Left(patchProblem.rorToolsError)
     }

ror-tools/src/main/scala/tech/beshu/ror/tools/RorToolsApp.scala

@@ -21,15 +21,13 @@ import scopt.*
 import tech.beshu.ror.tools.RorTools.*
 import tech.beshu.ror.tools.core.patches.base.EsPatchExecutor
 import tech.beshu.ror.tools.core.utils.InOut.ConsoleInOut
+import tech.beshu.ror.tools.core.utils.RorToolsError.EsNotPatchedError
 import tech.beshu.ror.tools.core.utils.{EsDirectory, InOut, RorToolsError, RorToolsException}
 
 import scala.util.{Failure, Success, Try}
 
 object RorToolsApp extends RorTools {
 
-  // todo:
-  // 1. option: return success when already patched/unpatched
-  // 2. restore backup when fails to patch
   def main(args: Array[String]): Unit = {
     run(args)(ConsoleInOut) match {
       case Result.Success =>
@@ -80,10 +78,10 @@ trait RorTools {
       }
     } match {
       case Failure(ex: RorToolsException) =>
-        inOut.println(s"ERROR: ${ex.getMessage()}\n${ex.printStackTrace()}")
+        inOut.println(s"ERROR: ${ex.getMessage}\n${ex.printStackTrace()}")
         Result.Failure
       case Failure(ex: Throwable) =>
-        inOut.println(s"UNEXPECTED ERROR: ${ex.getMessage()}\n${ex.printStackTrace()}")
+        inOut.println(s"UNEXPECTED ERROR: ${ex.getMessage}\n${ex.printStackTrace()}")
         Result.Failure
       case Success(result) =>
         result
@@ -110,7 +108,10 @@ trait RorTools {
 
     private def performPatching(customESPath: Option[Path]): Result = {
       val esDirectory = esDirectoryFrom(customESPath)
-      handleResult(EsPatchExecutor.create(esDirectory).patch())
+      EsPatchExecutor.create(esDirectory).patch() match {
+        case Right(()) => Result.Success
+        case Left(error) => failureCausedByRorToolsError(error)
+      }
     }
 
     private def abortPatchingBecauseUserDidNotAcceptConsequences(): Result = {
@@ -139,32 +140,34 @@ trait RorTools {
   private class UnpatchCommandHandler(implicit inOut: InOut) {
     def handle(command: Command.Unpatch): Result = {
       val esDirectory = esDirectoryFrom(command.customEsPath)
-      handleResult(EsPatchExecutor.create(esDirectory).restore())
+      EsPatchExecutor.create(esDirectory).restore() match {
+        case Right(()) => Result.Success
+        case Left(error) => failureCausedByRorToolsError(error)
+      }
     }
   }
 
   private class VerifyCommandHandler(implicit inOut: InOut) {
     def handle(command: Command.Verify): Result = {
       val esDirectory = esDirectoryFrom(command.customEsPath)
-      handleResult(EsPatchExecutor.create(esDirectory).verify())
-    }
-  }
-
-  private def handleResult(result: Either[RorToolsError, Unit])
-                          (implicit inOut: InOut): Result = {
-    result match {
-      case Left(error) =>
-        inOut.printlnErr("ERROR: " + error.message)
-        Result.Failure
-      case Right(()) =>
-        Result.Success
+      EsPatchExecutor.create(esDirectory).verify() match {
+        case Right(true) => Result.Success
+        case Right(false) => Result.Failure
+        case Left(error) => failureCausedByRorToolsError(error)
+      }
     }
   }
 
   private def esDirectoryFrom(esPath: Option[os.Path]) = {
     esPath.map(EsDirectory.from).getOrElse(EsDirectory.default)
   }
 
+  private def failureCausedByRorToolsError(error: RorToolsError)
+                                          (implicit inOut: InOut) = {
+    inOut.printlnErr(s"ERROR: ${error.message}")
+    Result.Failure
+  }
+
   private val builder = OParser.builder[Arguments]
 
   import builder.*

ror-tools/src/test/scala/tech/beshu/ror/tools/RorToolsAppSuite.scala

@@ -280,7 +280,7 @@ class RorToolsAppSuite
       verifyResult should equal(Result.Failure)
       verifyOutput should include(
         """Checking if Elasticsearch is patched ...
-          |ERROR: Elasticsearch is NOT patched. ReadonlyREST cannot be used yet. For patching instructions see our docs: https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch"""
+          |Elasticsearch is NOT patched. ReadonlyREST cannot be used yet. For patching instructions see our docs: https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch"""
           .stripMargin
       )
     }