Как показать пользовательские сообщения об ошибках в ScalaTest?

кто-нибудь знает, как показать пользовательское сообщение об ошибке в ScalaTest?

например:

NumberOfElements() should equal (5)

показывает следующее сообщение при сбое:

10 не равно 5

но я хочу более описательное сообщение типа:

NumberOfElements должно быть 5.

2 71
scala scalatest matcher

2 ответа:

вы первый, кто попросил такую функцию. Один из способов добиться этого-с помощью 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:")
83

новый способ с 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 для получения дополнительной информации.

6