如何在ScalaTest中显示自定义失败消息？

Question

有谁知道如何在ScalaTest中显示自定义失败消息？

例如：

NumberOfElements() should equal (5)

失败时显示以下消息：

10不等于5

但我想要更多描述性的消息，如：

NumberOfElements应为5。

Answer 1

你是第一个要求这样一个功能的人。实现这一目标的一种方法是使用withClue。就像是：

withClue("NumberOfElements: ") { NumberOfElements() should be (5) }

这应该会给你这个错误信息：

NumberOfElements：10不等于5

如果要完全控制消息，可以编写自定义匹配器。或者您可以使用断言，如下所示：

assert(NumberOfElements() == 5, "NumberOfElements should be 5")

你能详细说明你的用例是什么吗？为什么10不等于5不符合鼻烟，你有多少经常有这种需要？

这是你要求的东西：

scala> import org.scalatest.matchers.ShouldMatchers._
import org.scalatest.matchers.ShouldMatchers._

scala> withClue ("Hi:") { 1 + 1 should equal (3) }
org.scalatest.TestFailedException: Hi: 2 did not equal 3
at org.scalatest.matchers.Matchers$class.newTestFailedException(Matchers.scala:150)
at org.scalatest.matchers.ShouldMatchers$.newTestFailedException(ShouldMatchers.scala:2331)


scala> class AssertionHolder(f: => Any) {
     |   def withMessage(s: String) {
     |     withClue(s) { f }
     |   }
     | }
defined class AssertionHolder

scala> implicit def convertAssertion(f: => Any) = new AssertionHolder(f)
convertAssertion: (f: => Any)AssertionHolder

scala> { 1 + 1 should equal (3) } withMessage ("Ho:")
org.scalatest.TestFailedException: Ho: 2 did not equal 3
at org.scalatest.matchers.Matchers$class.newTestFailedException(Matchers.scala:150)
at org.scalatest.matchers.ShouldMatchers$.newTestFailedException(ShouldMatchers.scala:2331)

所以这样你就可以写：

{ NumberOfElements() should be (5) } withMessage ("NumberOfElements:")

Answer 2

自2011年以来的新方式：Matchers和AppendedClue特征。此外，对于集合大小，还有一些默认消息。

import org.scalatest.{AppendedClues, Matchers, WordSpec}

class SomeTest extends WordSpec with Matchers with AppendedClues {

  "Clues" should {
    "not be appended" when {
      "assertions pass" in {
        "hi" should equal ("hi") withClue "Greetings scala tester!"
      }
    }
    "be appended" when {
      "assertions fail"  in {
        1 + 1 should equal (3) withClue ", not even for large values of 1!"
      }
    }
    "not be needed" when {
      "looking at collection sizes" in {
        val list = List(1, 2, 3)
        list should have size 5
      }
    }
  }
}

输出如下：

SomeTest:
Clues
  should not be appended
  - when assertions pass
  should be appended
  - when assertions fail *** FAILED ***
    2 did not equal 3, not even for large values of 1! (SomeTest.scala:15)
  should not be needed
  - when looking at collection sizes *** FAILED ***
    List(1, 2, 3) had size 3 instead of expected size 5 (SomeTest.scala:21)

请注意，对于长List输出的列表，.toString大小消息不是很好。

有关更多信息，请参阅scaladoc。

Answer 3

您也可以使用withClue而不导入任何内容或将其添加到测试类：

withClue(s"Expecting distinct elements: ${elements.toList}") { elements.length shouldBe 3 }

这是从Assertions类导入的：org.scalatest.Assertions#withClue