[HUDI-4079] Supports showing table comment for hudi with spark3 (#5546)

hudi-spark-datasource/hudi-spark/src/test/scala/org/apache/spark/sql/hudi/TestCreateTable.scala

@@ -18,6 +18,7 @@
 package org.apache.spark.sql.hudi
 
 import org.apache.hudi.DataSourceWriteOptions._
+import org.apache.hudi.HoodieSparkUtils
 import org.apache.hudi.common.model.HoodieRecord
 import org.apache.hudi.common.table.{HoodieTableConfig, HoodieTableMetaClient}
 import org.apache.hudi.config.HoodieWriteConfig
@@ -641,4 +642,26 @@ class TestCreateTable extends HoodieSparkSqlTestBase {
          |""".stripMargin
     )
   }
+
+  if (HoodieSparkUtils.gteqSpark3_2) {
+    test("Test create table with comment") {
+      val tableName = generateTableName
+      spark.sql(
+        s"""
+           | create table $tableName (
+           |  id int,
+           |  name string,
+           |  price double,
+           |  ts long
+           | ) using hudi
+           | comment "This is a simple hudi table"
+           | tblproperties (
+           |   primaryKey = 'id',
+           |   preCombineField = 'ts'
+           | )
+       """.stripMargin)
+      val shown = spark.sql(s"show create table $tableName").head.getString(0)
+      assertResult(true)(shown.contains("COMMENT 'This is a simple hudi table'"))
+    }
+  }
 }