[RORDEV-1807] Fix ror-tools behavior when consent environement flag is present (#1171)

Author: mgoworko

gradle.properties

@@ -1,5 +1,5 @@
 publishedPluginVersion=1.67.0
-pluginVersion=1.67.0
+pluginVersion=1.68.0-pre1
 pluginName=readonlyrest
 
 org.gradle.jvmargs=-Xmx6144m

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

@@ -233,15 +233,17 @@ trait RorTools {
  .action((_, c) => c.copy(command = Some(Command.Unpatch(None))))
  .text("unpatch is a command that reverts modifications done by patching")
  .children(
- esPathOption.action((p, args) => modifyCommand(args, _.asInstanceOf[Command.Unpatch].copy(customEsPath = Some(os.Path(p)))))
+ esPathOption.action((p, args) => modifyCommand(args, _.asInstanceOf[Command.Unpatch].copy(customEsPath = Some(os.Path(p))))),
+ patchingConsentDefinition.hidden(), // Accepts patching consent argument, for example passed as env variable, but does not require or use it
  )
 
  private lazy val verifyCommand =
  cmd("verify")
  .action((_, c) => c.copy(command = Some(Command.Verify(None))))
  .text("verify is a command that verifies if ES installation is patched")
  .children(
- esPathOption.action((p, args) => modifyCommand(args, _.asInstanceOf[Command.Verify].copy(customEsPath = Some(os.Path(p)))))
+ esPathOption.action((p, args) => modifyCommand(args, _.asInstanceOf[Command.Verify].copy(customEsPath = Some(os.Path(p))))),
+ patchingConsentDefinition.hidden(), // Accepts patching consent argument, for example passed as env variable, but does not require or use it
  )
 
  private lazy val esPathOption =
@@ -255,9 +257,7 @@ trait RorTools {
  }
 
  private lazy val patchingConsent =
- opt[String](consentFlagName)
- .unbounded()
- .valueName("<yes/no>")
+ patchingConsentDefinition
  .validate { value =>
  value.toLowerCase match {
  case "yes" => success
@@ -273,6 +273,11 @@ trait RorTools {
  }
  .text("Optional, when provided with value 'yes', it confirms that the user understands and accepts the implications of ES patching. The patching can therefore be performed. When not provided, user will be asked for confirmation in interactive mode. You can read about patching in our documentation: https://docs.readonlyrest.com/elasticsearch#id-3.-patch-elasticsearch.")
 
+ private lazy val patchingConsentDefinition =
+ opt[String](consentFlagName)
+ .unbounded()
+ .valueName("<yes/no>")
+
  private def addPatchingConsentValue(scriptArguments: ScriptArguments, patchingConsent: PatchingConsent) = {
  modifyPatchCommand(scriptArguments, patch => patch.copy(patchingConsentValues = patch.patchingConsentValues ::: patchingConsent :: Nil))
  }

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

@@ -311,9 +311,10 @@ class RorToolsAppSuite
  patchMetadataFile.delete()
  patchMetadataFile.exists() should be(false)
 
- val (unpatchResult, unpatchOutput) = captureResultAndOutput {
- RorToolsTestApp.run(Array("unpatch", "--es-path", esLocalPath.toString))(_, _)
- }
+ val (unpatchResult, unpatchOutput) = captureResultAndOutput(
+ RorToolsTestApp.run(Array("unpatch", "--es-path", esLocalPath.toString))(_, _),
+ mockedEnvs = Map("I_UNDERSTAND_AND_ACCEPT_ES_PATCHING" -> "yes") // Additionally verifies, that `unpatch` can be executed when env consent is present
+ )
  unpatchResult should equal(Result.Failure)
  unpatchOutput.replace("\r\n", "\n") should include(
  """Checking if Elasticsearch is patched ...
@@ -342,9 +343,10 @@ class RorToolsAppSuite
  }
  "Verify correctly recognizes that patch is not applied" in {
  patchMetadataFile.exists() should be(false)
- val (verifyResult, verifyOutput) = captureResultAndOutput {
- RorToolsTestApp.run(Array("verify", "--es-path", esLocalPath.toString))(_, _)
- }
+ val (verifyResult, verifyOutput) = captureResultAndOutput(
+ RorToolsTestApp.run(Array("verify", "--es-path", esLocalPath.toString))(_, _),
+ mockedEnvs = Map("I_UNDERSTAND_AND_ACCEPT_ES_PATCHING" -> "yes") // Additionally verifies, that `verify` can be executed when env consent is present
+ )
  verifyResult should equal(Result.Failure)
  verifyOutput should include(
  """Checking if Elasticsearch is patched ...