use Iterable as data type of process builder's commands

bowenliang123 · bowenliang123 · commit d2d0fe26ecb3 · 2023-11-24T11:38:28.000+08:00
diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/Utils.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/Utils.scala
@@ -340,7 +340,7 @@ object Utils extends Logging {
 
   private val PATTERN_FOR_KEY_VALUE_ARG = "(.+?)=(.+)".r
 
-  def redactCommandLineArgs(conf: KyuubiConf, commands: Array[String]): Array[String] = {
+  def redactCommandLineArgs(conf: KyuubiConf, commands: Iterable[String]): Iterable[String] = {
     val redactionPattern = conf.get(SERVER_SECRET_REDACTION_PATTERN)
     var nextKV = false
     commands.map {
diff --git a/kyuubi-common/src/test/scala/org/apache/kyuubi/UtilsSuite.scala b/kyuubi-common/src/test/scala/org/apache/kyuubi/UtilsSuite.scala
@@ -167,7 +167,7 @@ class UtilsSuite extends KyuubiFunSuite {
     buffer += "--conf"
     buffer += "kyuubi.regular.property2=regular_value"
 
-    val commands = buffer.toArray
+    val commands = buffer
 
     // Redact sensitive information
     val redactedCmdArgs = Utils.redactCommandLineArgs(conf, commands)
@@ -183,7 +183,7 @@ class UtilsSuite extends KyuubiFunSuite {
     expectBuffer += "--conf"
     expectBuffer += "kyuubi.regular.property2=regular_value"
 
-    assert(expectBuffer.toArray === redactedCmdArgs)
+    assert(expectBuffer === redactedCmdArgs)
   }
 
   test("redact sensitive information") {
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/ProcBuilder.scala
@@ -99,7 +99,7 @@ trait ProcBuilder {
 
   protected def proxyUser: String
 
-  protected val commands: Array[String]
+  protected val commands: Iterable[String]
 
   def conf: KyuubiConf
 
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/chat/ChatProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/chat/ChatProcessBuilder.scala
@@ -59,7 +59,7 @@ class ChatProcessBuilder(
    */
   override protected def mainClass: String = "org.apache.kyuubi.engine.chat.ChatEngine"
 
-  override protected val commands: Array[String] = {
+  override protected val commands: Iterable[String] = {
     val buffer = new ArrayBuffer[String]()
     buffer += executable
 
@@ -98,7 +98,7 @@ class ChatProcessBuilder(
       buffer += "--conf"
       buffer += s"$k=$v"
     }
-    buffer.toArray
+    buffer
   }
 
   override def toString: String = {
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/flink/FlinkProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/flink/FlinkProcessBuilder.scala
@@ -77,7 +77,7 @@ class FlinkProcessBuilder(
     ApplicationManagerInfo(clusterManager())
   }
 
-  override protected val commands: Array[String] = {
+  override protected val commands: Iterable[String] = {
     KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)
     // unset engine credentials because Flink doesn't support them at the moment
     conf.unset(KyuubiReservedKeys.KYUUBI_ENGINE_CREDENTIALS_KEY)
@@ -143,7 +143,7 @@ class FlinkProcessBuilder(
           }
         }
 
-        buffer.toArray
+        buffer
 
       case _ =>
         val buffer = new ArrayBuffer[String]()
@@ -211,7 +211,7 @@ class FlinkProcessBuilder(
           buffer += "--conf"
           buffer += s"$k=$v"
         }
-        buffer.toArray
+        buffer
     }
   }
 
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/hive/HiveProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/hive/HiveProcessBuilder.scala
@@ -52,7 +52,7 @@ class HiveProcessBuilder(
 
   override protected def mainClass: String = "org.apache.kyuubi.engine.hive.HiveSQLEngine"
 
-  override protected val commands: Array[String] = {
+  override protected val commands: Iterable[String] = {
     KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)
     val buffer = new ArrayBuffer[String]()
     buffer += executable
@@ -113,7 +113,7 @@ class HiveProcessBuilder(
       buffer += "--conf"
       buffer += s"$k=$v"
     }
-    buffer.toArray
+    buffer
   }
 
   override def shortName: String = "hive"
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/jdbc/JdbcProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/jdbc/JdbcProcessBuilder.scala
@@ -59,7 +59,7 @@ class JdbcProcessBuilder(
    */
   override protected def mainClass: String = "org.apache.kyuubi.engine.jdbc.JdbcSQLEngine"
 
-  override protected val commands: Array[String] = {
+  override protected val commands: Iterable[String] = {
     require(
       conf.get(ENGINE_JDBC_CONNECTION_URL).nonEmpty,
       s"Jdbc server url can not be null! Please set ${ENGINE_JDBC_CONNECTION_URL.key}")
@@ -101,7 +101,7 @@ class JdbcProcessBuilder(
       buffer += "--conf"
       buffer += s"$k=$v"
     }
-    buffer.toArray
+    buffer
   }
 
   override def toString: String = {
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/spark/SparkBatchProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/spark/SparkBatchProcessBuilder.scala
@@ -36,7 +36,7 @@ class SparkBatchProcessBuilder(
   extends SparkProcessBuilder(proxyUser, conf, batchId, extraEngineLog) {
   import SparkProcessBuilder._
 
-  override protected lazy val commands: Array[String] = {
+  override protected lazy val commands: Iterable[String] = {
     val buffer = new ArrayBuffer[String]()
     buffer += executable
     Option(mainClass).foreach { cla =>
@@ -66,7 +66,7 @@ class SparkBatchProcessBuilder(
 
     batchArgs.foreach { arg => buffer += arg }
 
-    buffer.toArray
+    buffer
   }
 
   private def sparkAppNameConf(): Map[String, String] = {
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/spark/SparkProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/spark/SparkProcessBuilder.scala
@@ -122,7 +122,7 @@ class SparkProcessBuilder(
     file.isDirectory && r.findFirstMatchIn(file.getName).isDefined
   }
 
-  override protected lazy val commands: Array[String] = {
+  override protected lazy val commands: Iterable[String] = {
     // complete `spark.master` if absent on kubernetes
     completeMasterUrl(conf)
 
@@ -149,7 +149,7 @@ class SparkProcessBuilder(
 
     mainResource.foreach { r => buffer += r }
 
-    buffer.toArray
+    buffer
   }
 
   override protected def module: String = "kyuubi-spark-sql-engine"
diff --git a/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/trino/TrinoProcessBuilder.scala b/kyuubi-server/src/main/scala/org/apache/kyuubi/engine/trino/TrinoProcessBuilder.scala
@@ -50,7 +50,7 @@ class TrinoProcessBuilder(
 
   override protected def mainClass: String = "org.apache.kyuubi.engine.trino.TrinoSqlEngine"
 
-  override protected val commands: Array[String] = {
+  override protected val commands: Iterable[String] = {
     KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)
     require(
       conf.get(ENGINE_TRINO_CONNECTION_URL).nonEmpty,
@@ -104,7 +104,7 @@ class TrinoProcessBuilder(
       buffer += "--conf"
       buffer += s"$k=$v"
     }
-    buffer.toArray
+    buffer
   }
 
   override def shortName: String = "trino"
diff --git a/kyuubi-server/src/test/scala/org/apache/kyuubi/engine/spark/SparkProcessBuilderSuite.scala b/kyuubi-server/src/test/scala/org/apache/kyuubi/engine/spark/SparkProcessBuilderSuite.scala
@@ -427,5 +427,5 @@ class SparkProcessBuilderSuite extends KerberizedTestHelper with MockitoSugar {
 
 class FakeSparkProcessBuilder(config: KyuubiConf)
   extends SparkProcessBuilder("fake", config) {
-  override protected lazy val commands: Array[String] = Array("ls")
+  override protected lazy val commands: Iterable[String] = Seq("ls")
 }

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ class ChatProcessBuilder(`
`59`	`59`	`*/`
`60`	`60`	`override protected def mainClass: String = "org.apache.kyuubi.engine.chat.ChatEngine"`
`61`	`61`
`62`		`- override protected val commands: Array[String] = {`
	`62`	`+ override protected val commands: Iterable[String] = {`
`63`	`63`	`val buffer = new ArrayBuffer[String]()`
`64`	`64`	`buffer += executable`
`65`	`65`
`@@ -98,7 +98,7 @@ class ChatProcessBuilder(`
`98`	`98`	`buffer += "--conf"`
`99`	`99`	`buffer += s"$k=$v"`
`100`	`100`	`}`
`101`		`- buffer.toArray`
	`101`	`+ buffer`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`override def toString: String = {`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ class FlinkProcessBuilder(`
`77`	`77`	`ApplicationManagerInfo(clusterManager())`
`78`	`78`	`}`
`79`	`79`
`80`		`- override protected val commands: Array[String] = {`
	`80`	`+ override protected val commands: Iterable[String] = {`
`81`	`81`	`KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)`
`82`	`82`	`// unset engine credentials because Flink doesn't support them at the moment`
`83`	`83`	`conf.unset(KyuubiReservedKeys.KYUUBI_ENGINE_CREDENTIALS_KEY)`
`@@ -143,7 +143,7 @@ class FlinkProcessBuilder(`
`143`	`143`	`}`
`144`	`144`	`}`
`145`	`145`
`146`		`- buffer.toArray`
	`146`	`+ buffer`
`147`	`147`
`148`	`148`	`case _ =>`
`149`	`149`	`val buffer = new ArrayBuffer[String]()`
`@@ -211,7 +211,7 @@ class FlinkProcessBuilder(`
`211`	`211`	`buffer += "--conf"`
`212`	`212`	`buffer += s"$k=$v"`
`213`	`213`	`}`
`214`		`- buffer.toArray`
	`214`	`+ buffer`
`215`	`215`	`}`
`216`	`216`	`}`
`217`	`217`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class HiveProcessBuilder(`
`52`	`52`
`53`	`53`	`override protected def mainClass: String = "org.apache.kyuubi.engine.hive.HiveSQLEngine"`
`54`	`54`
`55`		`- override protected val commands: Array[String] = {`
	`55`	`+ override protected val commands: Iterable[String] = {`
`56`	`56`	`KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)`
`57`	`57`	`val buffer = new ArrayBuffer[String]()`
`58`	`58`	`buffer += executable`
`@@ -113,7 +113,7 @@ class HiveProcessBuilder(`
`113`	`113`	`buffer += "--conf"`
`114`	`114`	`buffer += s"$k=$v"`
`115`	`115`	`}`
`116`		`- buffer.toArray`
	`116`	`+ buffer`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`override def shortName: String = "hive"`
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ class SparkProcessBuilder(`
`122`	`122`	`file.isDirectory && r.findFirstMatchIn(file.getName).isDefined`
`123`	`123`	`}`
`124`	`124`
`125`		`- override protected lazy val commands: Array[String] = {`
	`125`	`+ override protected lazy val commands: Iterable[String] = {`
`126`	`126`	// complete `spark.master` if absent on kubernetes
`127`	`127`	`completeMasterUrl(conf)`
`128`	`128`
`@@ -149,7 +149,7 @@ class SparkProcessBuilder(`
`149`	`149`
`150`	`150`	`mainResource.foreach { r => buffer += r }`
`151`	`151`
`152`		`- buffer.toArray`
	`152`	`+ buffer`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`override protected def module: String = "kyuubi-spark-sql-engine"`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class TrinoProcessBuilder(`
`50`	`50`
`51`	`51`	`override protected def mainClass: String = "org.apache.kyuubi.engine.trino.TrinoSqlEngine"`
`52`	`52`
`53`		`- override protected val commands: Array[String] = {`
	`53`	`+ override protected val commands: Iterable[String] = {`
`54`	`54`	`KyuubiApplicationManager.tagApplication(engineRefId, shortName, clusterManager(), conf)`
`55`	`55`	`require(`
`56`	`56`	`conf.get(ENGINE_TRINO_CONNECTION_URL).nonEmpty,`
`@@ -104,7 +104,7 @@ class TrinoProcessBuilder(`
`104`	`104`	`buffer += "--conf"`
`105`	`105`	`buffer += s"$k=$v"`
`106`	`106`	`}`
`107`		`- buffer.toArray`
	`107`	`+ buffer`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`override def shortName: String = "trino"`