[KYUUBI #2863] Unify the logic of tpch and tpcds to generate golden file

### _Why are the changes needed?_

fix #2863

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2864 from jiaoqingbo/kyuubi-2863.

Closes #2863

9d11495 [jiaoqingbo] [KYUUBI #2863] Unify the logic of tpch and tpcds to generate golden file

Authored-by: jiaoqingbo <1178404354@qq.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>

Author: jiaoqingbo

extensions/spark/kyuubi-spark-connector-common/src/test/scala/org/apache/kyuubi/spark/connector/common/GoldenFileUtils.scala

@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.kyuubi.spark.connector.common
+
+import java.nio.charset.StandardCharsets
+import java.nio.file.{Files, Path, Paths}
+
+object GoldenFileUtils {
+
+  val LICENSE_HEADER: String =
+    """/*
+      | * Licensed to the Apache Software Foundation (ASF) under one or more
+      | * contributor license agreements.  See the NOTICE file distributed with
+      | * this work for additional information regarding copyright ownership.
+      | * The ASF licenses this file to You under the Apache License, Version 2.0
+      | * (the "License"); you may not use this file except in compliance with
+      | * the License.  You may obtain a copy of the License at
+      | *
+      | *    http://www.apache.org/licenses/LICENSE-2.0
+      | *
+      | * Unless required by applicable law or agreed to in writing, software
+      | * distributed under the License is distributed on an "AS IS" BASIS,
+      | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      | * See the License for the specific language governing permissions and
+      | * limitations under the License.
+      | */""".stripMargin + "\n\n"
+
+  private val regenerateGoldenFiles: Boolean = sys.env.get("KYUUBI_UPDATE").contains("1")
+
+  private val baseResourcePath: Path =
+    Paths.get("src", "main", "resources")
+
+  private def fileToString(file: Path): String = {
+    new String(Files.readAllBytes(file), StandardCharsets.UTF_8)
+  }
+
+  def generateGoldenFiles(
+      dirctory: String,
+      sqlName: String,
+      schema: String,
+      sumHash: String): (String, String) = {
+    val goldenSchemaFile = Paths.get(
+      baseResourcePath.toFile.getAbsolutePath,
+      dirctory,
+      s"${sqlName.stripSuffix(".sql")}.output.schema")
+
+    val goldenHashFile = Paths.get(
+      baseResourcePath.toFile.getAbsolutePath,
+      dirctory,
+      s"${sqlName.stripSuffix(".sql")}.output.hash")
+    if (regenerateGoldenFiles) {
+      Files.write(goldenSchemaFile, schema.getBytes)
+      Files.write(goldenHashFile, sumHash.getBytes)
+    }
+    val expectedSchema = fileToString(goldenSchemaFile)
+    val expectedHash = fileToString(goldenHashFile)
+    (expectedSchema, expectedHash)
+  }
+
+}

extensions/spark/kyuubi-spark-connector-tpcds/src/test/scala/org/apache/kyuubi/spark/connector/tpcds/TPCDSQuerySuite.scala

@@ -17,16 +17,14 @@
 
 package org.apache.kyuubi.spark.connector.tpcds
 
-import java.nio.charset.StandardCharsets
-import java.nio.file.{Files, Path, Paths}
-
 import scala.collection.JavaConverters._
 import scala.io.{Codec, Source}
 
 import org.apache.spark.SparkConf
 import org.apache.spark.sql.SparkSession
 
 import org.apache.kyuubi.KyuubiFunSuite
+import org.apache.kyuubi.spark.connector.common.GoldenFileUtils._
 import org.apache.kyuubi.spark.connector.common.LocalSparkSession.withSparkSession
 import org.apache.kyuubi.spark.connector.common.SparkUtils
 
@@ -50,37 +48,10 @@ import org.apache.kyuubi.spark.connector.common.SparkUtils
 
 class TPCDSQuerySuite extends KyuubiFunSuite {
 
-  private val regenerateGoldenFiles = sys.env.get("KYUUBI_UPDATE").contains("1")
-
-  private val licenseHeader =
-    """/*
-      | * Licensed to the Apache Software Foundation (ASF) under one or more
-      | * contributor license agreements.  See the NOTICE file distributed with
-      | * this work for additional information regarding copyright ownership.
-      | * The ASF licenses this file to You under the Apache License, Version 2.0
-      | * (the "License"); you may not use this file except in compliance with
-      | * the License.  You may obtain a copy of the License at
-      | *
-      | *    http://www.apache.org/licenses/LICENSE-2.0
-      | *
-      | * Unless required by applicable law or agreed to in writing, software
-      | * distributed under the License is distributed on an "AS IS" BASIS,
-      | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-      | * See the License for the specific language governing permissions and
-      | * limitations under the License.
-      | */""".stripMargin + "\n\n"
-
-  val baseResourcePath: Path =
-    Paths.get("src", "main", "resources")
-
   val queries: Set[String] = (1 to 99).map(i => s"q$i").toSet -
     ("q14", "q23", "q24", "q39") +
     ("q14a", "q14b", "q23a", "q23b", "q24a", "q24b", "q39a", "q39b")
 
-  private def fileToString(file: Path): String = {
-    new String(Files.readAllBytes(file), StandardCharsets.UTF_8)
-  }
-
   test("run query on tiny") {
     assume(SparkUtils.isSparkVersionEqualTo("3.2"))
     val viewSuffix = "view";
@@ -100,28 +71,13 @@ class TPCDSQuerySuite extends KyuubiFunSuite {
         try {
           val result = spark.sql(sql).collect()
           val schema = spark.sql(sql).schema
-          val schemaDDL = licenseHeader + schema.toDDL + "\n"
+          val schemaDDL = LICENSE_HEADER + schema.toDDL + "\n"
           spark.createDataFrame(result.toList.asJava, schema).createTempView(s"$name$viewSuffix")
-          val sumHashResult = licenseHeader + spark.sql(
+          val sumHashResult = LICENSE_HEADER + spark.sql(
             s"select sum(hash(*)) from $name$viewSuffix").collect().head.get(0) + "\n"
-
-          val goldenSchemaFile = Paths.get(
-            baseResourcePath.toFile.getAbsolutePath,
-            "tpcds_3.2",
-            s"${name.stripSuffix(".sql")}.output.schema")
-
-          val goldenHashFile = Paths.get(
-            baseResourcePath.toFile.getAbsolutePath,
-            "tpcds_3.2",
-            s"${name.stripSuffix(".sql")}.output.hash")
-          if (regenerateGoldenFiles) {
-            Files.write(goldenSchemaFile, schemaDDL.getBytes)
-            Files.write(goldenHashFile, sumHashResult.getBytes)
-          }
-          val expectedSchema = fileToString(goldenSchemaFile)
-          val expectedHash = fileToString(goldenHashFile)
-          assert(schemaDDL == expectedSchema)
-          assert(sumHashResult == expectedHash)
+          val tuple = generateGoldenFiles("tpcds_3.2", name, schemaDDL, sumHashResult)
+          assert(schemaDDL == tuple._1)
+          assert(sumHashResult == tuple._2)
         } catch {
           case cause: Throwable =>
             fail(name, cause)

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q1.output.hash

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+-2130215201

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q1.output.schema

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+`l_returnflag` STRING,`l_linestatus` STRING,`sum_qty` DOUBLE,`sum_base_price` DOUBLE,`sum_disc_price` DOUBLE,`sum_charge` DOUBLE,`avg_qty` DOUBLE,`avg_price` DOUBLE,`avg_disc` DOUBLE,`count_order` BIGINT NOT NULL

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/sql/q1.sql renamed to extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q1.sql

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+-4090660469

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q10.output.hash

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+`c_custkey` BIGINT,`c_name` STRING,`revenue` DOUBLE,`c_acctbal` DOUBLE,`n_name` STRING,`c_address` STRING,`c_phone` STRING,`c_comment` STRING

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q10.output.schema

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+-21773379672

extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/sql/q10.sql renamed to extensions/spark/kyuubi-spark-connector-tpch/src/main/resources/tpch/q10.sql

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+`ps_partkey` BIGINT,`value` DOUBLE