Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-44268][CORE][TEST][FOLLOWUP] Only print clue when assert doc failed #41878

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions core/src/test/scala/org/apache/spark/SparkThrowableSuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import com.fasterxml.jackson.databind.SerializationFeature
import com.fasterxml.jackson.databind.json.JsonMapper
import com.fasterxml.jackson.module.scala.DefaultScalaModule
import org.apache.commons.io.{FileUtils, IOUtils}
import org.scalatest.exceptions.TestFailedException

import org.apache.spark.SparkThrowableHelper._
import org.apache.spark.util.Utils
Expand Down Expand Up @@ -155,17 +156,24 @@ class SparkThrowableSuite extends SparkFunSuite {
.filter(_.startsWith("###")).map(s => s.replace("###", "").trim)
.filter(linkInDocRegex.findFirstMatchIn(_).isEmpty)

commonErrorsInDoc.foreach(s => assert(errors.contains(s),
def assertWithOnlyClue(condition: Boolean, clue: String): Unit = {
if (!condition) {
throw new TestFailedException(s"assertion failed: $clue", 0)
Hisoka-X marked this conversation as resolved.
Show resolved Hide resolved
}
}

commonErrorsInDoc.foreach(s => assertWithOnlyClue(errors.contains(s),
s"Error class: $s is not in error-classes.json"))

val titlePrefix = "title:"
val errorsInDoc = errorDocPaths.map(lines => {
val errorClass = lines.filter(_.startsWith(titlePrefix))
.map(s => s.replace("error class", "").replace(titlePrefix, "").trim).head
assert(errors.contains(errorClass), s"Error class: $errorClass is not in error-classes.json")
assertWithOnlyClue(errors.contains(errorClass),
s"Error class: $errorClass is not in error-classes.json")
val subClasses = lines.filter(_.startsWith("##")).map(s => s.replace("##", "").trim)
.map { s =>
assert(errors(errorClass).subClass.get.contains(s),
assertWithOnlyClue(errors(errorClass).subClass.get.contains(s),
s"Error class: $errorClass does not contain sub class: $s in error-classes.json")
s
}
Expand All @@ -177,16 +185,16 @@ class SparkThrowableSuite extends SparkFunSuite {
val errorClass = e._1
val subClasses = e._2.subClass.getOrElse(Map.empty).keys.toSeq
if (subClasses.nonEmpty) {
assert(errorsInDoc.contains(errorClass),
assertWithOnlyClue(errorsInDoc.contains(errorClass),
s"Error class: $errorClass do not have sql-error-conditions sub doc, please create it")
val subClassesInDoc = errorsInDoc(errorClass)
subClasses.foreach { s =>
assert(subClassesInDoc.contains(s),
assertWithOnlyClue(subClassesInDoc.contains(s),
s"Error class: $errorClass contains sub class: $s which is not in " +
s"sql-error-conditions sub doc")
}
} else if (!errorClass.startsWith("_LEGACY_ERROR_TEMP_")) {
assert(commonErrorsInDoc.contains(errorClass),
assertWithOnlyClue(commonErrorsInDoc.contains(errorClass),
s"Error class: $errorClass is not in sql-error-conditions.md")
}
}
Expand Down