cloud-fan commented on a change in pull request #29270: URL: https://github.com/apache/spark/pull/29270#discussion_r461592500
########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r Review comment: nit: it can be one line ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r + + dir.listFiles().filter(_.getName.contains("simplified")).map { file => + val rgx(numStr) = file.getName + numStr.toInt + } + } + + private def getNextVariantNumber(name: String): Int = { + val existingVariants = getExistingVariants(name) + if (existingVariants.isEmpty) { + 0 + } else { + existingVariants.max + 1 + } + } + + private def getDirForTest(name: String): File = { + new File(goldenFilePath, s"$name") Review comment: `s"$name"` -> `name` ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") Review comment: `s"$name"` -> `name` ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r + + dir.listFiles().filter(_.getName.contains("simplified")).map { file => + val rgx(numStr) = file.getName + numStr.toInt + } + } + + private def getNextVariantNumber(name: String): Int = { + val existingVariants = getExistingVariants(name) + if (existingVariants.isEmpty) { + 0 + } else { + existingVariants.max + 1 + } + } + + private def getDirForTest(name: String): File = { + new File(goldenFilePath, s"$name") + } + + private def isApproved(name: String, plan: SparkPlan): Boolean = { + val dir = getDirForTest(name) + if (!dir.exists()) { + false + } else { + val existingVariants = getExistingVariants(name) + val actual = getSimplifiedPlan(plan) + existingVariants.exists { variant => + val file = new File(dir, s"$variant.simplified.txt") + val approved = FileUtils.readFileToString(file) + approved == actual + } + } + } + + /** + * Serialize and save this [[org.apache.spark.sql.execution.SparkPlan]]. Review comment: `org.apache.spark.sql.execution.SparkPlan` -> `SparkPlan` ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r + + dir.listFiles().filter(_.getName.contains("simplified")).map { file => + val rgx(numStr) = file.getName + numStr.toInt + } + } + + private def getNextVariantNumber(name: String): Int = { + val existingVariants = getExistingVariants(name) + if (existingVariants.isEmpty) { + 0 + } else { + existingVariants.max + 1 + } + } + + private def getDirForTest(name: String): File = { + new File(goldenFilePath, s"$name") + } + + private def isApproved(name: String, plan: SparkPlan): Boolean = { Review comment: This method has 2 callers, and both of them need to get the simplified plan of `plan` again. To avoid repeated work, I think it's better to let this method takes the simplified plan as input. ########## File path: sql/core/src/test/scala/org/apache/spark/sql/TPCDSSchema.scala ########## @@ -17,7 +17,9 @@ package org.apache.spark.sql -trait TPCDSSchema { +import org.apache.spark.sql.test.SharedSparkSession + +trait TPCDSSchema extends SharedSparkSession { Review comment: nit: one space between `extends SharedSparkSession` ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r + + dir.listFiles().filter(_.getName.contains("simplified")).map { file => + val rgx(numStr) = file.getName + numStr.toInt + } + } + + private def getNextVariantNumber(name: String): Int = { + val existingVariants = getExistingVariants(name) + if (existingVariants.isEmpty) { + 0 + } else { + existingVariants.max + 1 + } + } + + private def getDirForTest(name: String): File = { + new File(goldenFilePath, s"$name") + } + + private def isApproved(name: String, plan: SparkPlan): Boolean = { + val dir = getDirForTest(name) + if (!dir.exists()) { + false + } else { + val existingVariants = getExistingVariants(name) + val actual = getSimplifiedPlan(plan) + existingVariants.exists { variant => + val file = new File(dir, s"$variant.simplified.txt") + val approved = FileUtils.readFileToString(file) + approved == actual + } + } + } + + /** + * Serialize and save this [[org.apache.spark.sql.execution.SparkPlan]]. + * The resulting file is used by [[checkWithApproved]] to check stability. + * + * @param plan the [[SparkPlan]] + * @param name the name of the query + * @param variant if false, this plan will become the only approved plan, otherwise + * it will be added as an additional approved plan. + * @param explain the full explain output; this is saved to help debug later as the simplified + * plan is not too useful for debugging + */ + private def approvePlan( + plan: SparkPlan, + name: String, + variant: Boolean, + explain: String): Unit = { + val foundMatch = isApproved(name, plan) + val dir = getDirForTest(name) + + if (!foundMatch) { + if (!variant) { + FileUtils.deleteDirectory(dir) + assert(dir.mkdirs()) + } + val simplified = getSimplifiedPlan(plan) + val nextVariant = getNextVariantNumber(name) + val file = new File(dir, s"$nextVariant.simplified.txt") + FileUtils.writeStringToFile(file, simplified) + val fileOriginalPlan = new File(dir, s"$nextVariant.explain.txt") + FileUtils.writeStringToFile(fileOriginalPlan, explain) + logWarning(s"APPROVED: ${file} ${fileOriginalPlan}") + } + } + + private def checkWithApproved(plan: SparkPlan, name: String, explain: String): Unit = { + val dir = getDirForTest(name) + val tempDir = FileUtils.getTempDirectory + val existingVariants = getExistingVariants(name) + val foundMatch = isApproved(name, plan) + + if (!foundMatch) { + // show diff with last approved + val approvedSimplifiedFile = new File(dir, s"${existingVariants.max}.simplified.txt") + val approvedExplainFile = new File(dir, s"${existingVariants.max}.explain.txt") + + val actualSimplifiedFile = new File(tempDir, s"${name}.actual.simplified.txt") + val actualExplainFile = new File(tempDir, s"${name}.actual.explain.txt") + + val approved = FileUtils.readFileToString(approvedSimplifiedFile) + // write out for debugging + val actual = getSimplifiedPlan(plan) + FileUtils.writeStringToFile(actualSimplifiedFile, actual) + FileUtils.writeStringToFile(actualExplainFile, explain) + + val header = + s""" + |Plans did not match: + |last approved plan: ${approvedSimplifiedFile.getAbsolutePath} + |last explain: ${approvedExplainFile.getAbsolutePath} + |actual plan: ${actualSimplifiedFile.getAbsolutePath} + |actual explain: ${actualExplainFile.getAbsolutePath} + """.stripMargin + val msg = + s""" + |$header + |${sideBySide(approved.linesIterator.toSeq, actual.linesIterator.toSeq).mkString("\n")} + """.stripMargin + fail(msg) + } + } + + private def getSimplifiedPlan(plan: SparkPlan): String = { + val exchangeIdMap = new mutable.HashMap[Int, Int]() + val subqueriesMap = new mutable.HashMap[Int, Int]() + + def getId(plan: SparkPlan): Int = plan match { + case exchange: Exchange => exchangeIdMap.getOrElseUpdate(exchange.id, exchangeIdMap.size + 1) + case ReusedExchangeExec(_, exchange) => + exchangeIdMap.getOrElseUpdate(exchange.id, exchangeIdMap.size + 1) + case subquery: SubqueryExec => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case subquery: SubqueryBroadcastExec => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case ReusedSubqueryExec(subquery) => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case _ => -1 + } + + /** + * Some expression names have ExprId in them due to using things such as + * "sum(sr_return_amt#14)", so we remove all of these using regex + */ + def cleanUpReferences(references: AttributeSet): String = { + val rgxId = "#\\d+".r + rgxId.replaceAllIn(references.toSeq.map(_.name).sorted.mkString(","), "") + } + + /** + * Generate a simplified plan as a string + * Example output: + * TakeOrderedAndProject [c_customer_id] + * WholeStageCodegen + * Project [c_customer_id] + */ + def getSimplifiedPlan(node: SparkPlan, depth: Int): String = { + val padding = " " * depth + var thisNode = node.nodeName + if (node.references.nonEmpty) { + thisNode += s" [${cleanUpReferences(node.references)}]" + } + if (node.producedAttributes.nonEmpty) { + thisNode += s" [${cleanUpReferences(node.producedAttributes)}]" + } + val id = getId(node) + if (id > 0) { + thisNode += s" #$id" + } + val childrenSimplified = node.children.map(getSimplifiedPlan(_, depth + 1)) + val subqueriesSimplified = node.subqueries.map(getSimplifiedPlan(_, depth + 1)) + s"$padding$thisNode\n${subqueriesSimplified.mkString("")}${childrenSimplified.mkString("")}" + } + + getSimplifiedPlan(plan, 0) + } + + private def normalizeIds(query: String): String = { + val regex = "#\\d+L?".r + val map = new mutable.HashMap[String, String]() + regex.findAllMatchIn(query).map(_.toString) + .foreach(map.getOrElseUpdate(_, (map.size + 1).toString)) + regex.replaceAllIn(query, regexMatch => s"#${map(regexMatch.toString)}") + } + + /** + * Test a TPC-DS query. Depending of the settings this test will either check if the plan matches + * a golden file or it will create a new golden file. It also checks if DynamicPruning expressions + * reuse their broadcasts. + */ + protected def testQuery(tpcdsGroup: String, query: String): Unit = { + val queryString = resourceToString(s"$tpcdsGroup/$query.sql", + classLoader = Thread.currentThread().getContextClassLoader) + val qe = sql(queryString).queryExecution + val plan = qe.executedPlan + val explain = normalizeIds(qe.toString) + + if (regenerateGoldenFiles) { + approvePlan(plan, query, variant = false, explain) + } else { + checkWithApproved(plan, query, explain) + } + } +} + +class TPCDSV1_4_PlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-v1_4").getAbsolutePath + + tpcdsQueries.foreach { q => + test(s"check simplified (tpcds-v1.4/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { + testQuery("tpcds", q) + } + } + } +} + +class TPCDSV2_7_PlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-v2_7").getAbsolutePath + + tpcdsQueriesV2_7_0.foreach { q => + test(s"check simplified (tpcds-v2.7.0/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { + testQuery("tpcds-v2.7.0", q) + } + } + } +} + +class TPCDSModifiedPlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-modified").getAbsolutePath + + modifiedTPCDSQueries.foreach { q => + test(s"check simplified (tpcds-modifiedQueries/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { Review comment: can we set this conf in `PlanStabilitySuite`? ########## File path: sql/core/src/test/scala/org/apache/spark/sql/PlanStabilitySuite.scala ########## @@ -0,0 +1,304 @@ +/* + * 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.spark.sql + +import java.io.File + +import scala.collection.mutable + +import org.apache.commons.io.FileUtils + +import org.apache.spark.sql.catalyst.expressions.AttributeSet +import org.apache.spark.sql.catalyst.util._ +import org.apache.spark.sql.execution._ +import org.apache.spark.sql.execution.adaptive.DisableAdaptiveExecutionSuite +import org.apache.spark.sql.execution.exchange.{Exchange, ReusedExchangeExec} +import org.apache.spark.sql.internal.SQLConf + +/** + * Check that TPCDS SparkPlans don't change. + * If there is a regression, the error message looks like this: + * Plans did not match: + * last approved plan: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.simplified.txt + * last explain: /path/to/tpcds-plan-stability/approved-plans-xxx/q1/0.explain.txt + * actual plan: /path/to/tmp/q1.actual.simplified.txt + * actual explain: /path/to/tmp/q1.actual.explain.txt + * [side by side plan diff] + * The explain files are saved to help debug later, they are not checked. Only the simplified + * plans are checked (by string comparison). + * + * Approving new plans: + * IF the plan change is intended then re-running the test + * with environ var SPARK_GENERATE_GOLDEN_FILES=1 will make the new plan canon. + * This should be done only for the queries that need it, to avoid unnecessary diffs in the + * other approved plans. + * This can be done by running sbt test-only *PlanStabilitySuite* -- -z "(q31)" + * The new plan files should be part of the PR and reviewed. + * + * Multiple approved plans: + * It's possible that a query has multiple correct plans. This should be decided as part of the + * review. In this case, change the call to approvePlans and set variant=true. + */ +trait PlanStabilitySuite extends TPCDSBase with DisableAdaptiveExecutionSuite { + + private val regenerateGoldenFiles: Boolean = System.getenv("SPARK_GENERATE_GOLDEN_FILES") == "1" + + protected val baseResourcePath = { + // If regenerateGoldenFiles is true, we must be running this in SBT and we use hard-coded + // relative path. Otherwise, we use classloader's getResource to find the location. + if (regenerateGoldenFiles) { + java.nio.file.Paths.get("src", "test", "resources", "tpcds-plan-stability").toFile + } else { + val res = getClass.getClassLoader.getResource("tpcds-plan-stability") + new File(res.getFile) + } + } + + def goldenFilePath: String + + private def getExistingVariants(name: String): Array[Int] = { + val dir = new File(goldenFilePath, s"$name") + // file paths are the form ../q3/2.simplified.txt + val rgx = + """(\d+).simplified.txt""".r + + dir.listFiles().filter(_.getName.contains("simplified")).map { file => + val rgx(numStr) = file.getName + numStr.toInt + } + } + + private def getNextVariantNumber(name: String): Int = { + val existingVariants = getExistingVariants(name) + if (existingVariants.isEmpty) { + 0 + } else { + existingVariants.max + 1 + } + } + + private def getDirForTest(name: String): File = { + new File(goldenFilePath, s"$name") + } + + private def isApproved(name: String, plan: SparkPlan): Boolean = { + val dir = getDirForTest(name) + if (!dir.exists()) { + false + } else { + val existingVariants = getExistingVariants(name) + val actual = getSimplifiedPlan(plan) + existingVariants.exists { variant => + val file = new File(dir, s"$variant.simplified.txt") + val approved = FileUtils.readFileToString(file) + approved == actual + } + } + } + + /** + * Serialize and save this [[org.apache.spark.sql.execution.SparkPlan]]. + * The resulting file is used by [[checkWithApproved]] to check stability. + * + * @param plan the [[SparkPlan]] + * @param name the name of the query + * @param variant if false, this plan will become the only approved plan, otherwise + * it will be added as an additional approved plan. + * @param explain the full explain output; this is saved to help debug later as the simplified + * plan is not too useful for debugging + */ + private def approvePlan( + plan: SparkPlan, + name: String, + variant: Boolean, + explain: String): Unit = { + val foundMatch = isApproved(name, plan) + val dir = getDirForTest(name) + + if (!foundMatch) { + if (!variant) { + FileUtils.deleteDirectory(dir) + assert(dir.mkdirs()) + } + val simplified = getSimplifiedPlan(plan) + val nextVariant = getNextVariantNumber(name) + val file = new File(dir, s"$nextVariant.simplified.txt") + FileUtils.writeStringToFile(file, simplified) + val fileOriginalPlan = new File(dir, s"$nextVariant.explain.txt") + FileUtils.writeStringToFile(fileOriginalPlan, explain) + logWarning(s"APPROVED: ${file} ${fileOriginalPlan}") + } + } + + private def checkWithApproved(plan: SparkPlan, name: String, explain: String): Unit = { + val dir = getDirForTest(name) + val tempDir = FileUtils.getTempDirectory + val existingVariants = getExistingVariants(name) + val foundMatch = isApproved(name, plan) + + if (!foundMatch) { + // show diff with last approved + val approvedSimplifiedFile = new File(dir, s"${existingVariants.max}.simplified.txt") + val approvedExplainFile = new File(dir, s"${existingVariants.max}.explain.txt") + + val actualSimplifiedFile = new File(tempDir, s"${name}.actual.simplified.txt") + val actualExplainFile = new File(tempDir, s"${name}.actual.explain.txt") + + val approved = FileUtils.readFileToString(approvedSimplifiedFile) + // write out for debugging + val actual = getSimplifiedPlan(plan) + FileUtils.writeStringToFile(actualSimplifiedFile, actual) + FileUtils.writeStringToFile(actualExplainFile, explain) + + val header = + s""" + |Plans did not match: + |last approved plan: ${approvedSimplifiedFile.getAbsolutePath} + |last explain: ${approvedExplainFile.getAbsolutePath} + |actual plan: ${actualSimplifiedFile.getAbsolutePath} + |actual explain: ${actualExplainFile.getAbsolutePath} + """.stripMargin + val msg = + s""" + |$header + |${sideBySide(approved.linesIterator.toSeq, actual.linesIterator.toSeq).mkString("\n")} + """.stripMargin + fail(msg) + } + } + + private def getSimplifiedPlan(plan: SparkPlan): String = { + val exchangeIdMap = new mutable.HashMap[Int, Int]() + val subqueriesMap = new mutable.HashMap[Int, Int]() + + def getId(plan: SparkPlan): Int = plan match { + case exchange: Exchange => exchangeIdMap.getOrElseUpdate(exchange.id, exchangeIdMap.size + 1) + case ReusedExchangeExec(_, exchange) => + exchangeIdMap.getOrElseUpdate(exchange.id, exchangeIdMap.size + 1) + case subquery: SubqueryExec => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case subquery: SubqueryBroadcastExec => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case ReusedSubqueryExec(subquery) => + subqueriesMap.getOrElseUpdate(subquery.id, subqueriesMap.size + 1) + case _ => -1 + } + + /** + * Some expression names have ExprId in them due to using things such as + * "sum(sr_return_amt#14)", so we remove all of these using regex + */ + def cleanUpReferences(references: AttributeSet): String = { + val rgxId = "#\\d+".r + rgxId.replaceAllIn(references.toSeq.map(_.name).sorted.mkString(","), "") + } + + /** + * Generate a simplified plan as a string + * Example output: + * TakeOrderedAndProject [c_customer_id] + * WholeStageCodegen + * Project [c_customer_id] + */ + def getSimplifiedPlan(node: SparkPlan, depth: Int): String = { + val padding = " " * depth + var thisNode = node.nodeName + if (node.references.nonEmpty) { + thisNode += s" [${cleanUpReferences(node.references)}]" + } + if (node.producedAttributes.nonEmpty) { + thisNode += s" [${cleanUpReferences(node.producedAttributes)}]" + } + val id = getId(node) + if (id > 0) { + thisNode += s" #$id" + } + val childrenSimplified = node.children.map(getSimplifiedPlan(_, depth + 1)) + val subqueriesSimplified = node.subqueries.map(getSimplifiedPlan(_, depth + 1)) + s"$padding$thisNode\n${subqueriesSimplified.mkString("")}${childrenSimplified.mkString("")}" + } + + getSimplifiedPlan(plan, 0) + } + + private def normalizeIds(query: String): String = { + val regex = "#\\d+L?".r + val map = new mutable.HashMap[String, String]() + regex.findAllMatchIn(query).map(_.toString) + .foreach(map.getOrElseUpdate(_, (map.size + 1).toString)) + regex.replaceAllIn(query, regexMatch => s"#${map(regexMatch.toString)}") + } + + /** + * Test a TPC-DS query. Depending of the settings this test will either check if the plan matches + * a golden file or it will create a new golden file. It also checks if DynamicPruning expressions + * reuse their broadcasts. + */ + protected def testQuery(tpcdsGroup: String, query: String): Unit = { + val queryString = resourceToString(s"$tpcdsGroup/$query.sql", + classLoader = Thread.currentThread().getContextClassLoader) + val qe = sql(queryString).queryExecution + val plan = qe.executedPlan + val explain = normalizeIds(qe.toString) + + if (regenerateGoldenFiles) { + approvePlan(plan, query, variant = false, explain) + } else { + checkWithApproved(plan, query, explain) + } + } +} + +class TPCDSV1_4_PlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-v1_4").getAbsolutePath + + tpcdsQueries.foreach { q => + test(s"check simplified (tpcds-v1.4/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { + testQuery("tpcds", q) + } + } + } +} + +class TPCDSV2_7_PlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-v2_7").getAbsolutePath + + tpcdsQueriesV2_7_0.foreach { q => + test(s"check simplified (tpcds-v2.7.0/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { + testQuery("tpcds-v2.7.0", q) + } + } + } +} + +class TPCDSModifiedPlanStabilitySuite extends PlanStabilitySuite { + override val goldenFilePath: String = + new File(baseResourcePath, s"approved-plans-modified").getAbsolutePath + + modifiedTPCDSQueries.foreach { q => + test(s"check simplified (tpcds-modifiedQueries/$q)") { + withSQLConf(SQLConf.MAX_TO_STRING_FIELDS.key -> "100") { Review comment: set it in `beforeAll` and reset it in `afterAll` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
