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

Question 1

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

Например:

NumberOfElements() should equal (5)

В случае сбоя отображает следующее сообщение:

10 не равно 5

Но я хочу более информативное сообщение, например:

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

Question 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:")

Question 3

Новый образ с 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 .

Question 4

Вы также можете использовать, withClueничего не импортируя и не добавляя в тестовый класс:

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

Это импортировано из Assertionsкласса:org.scalatest.Assertions#withClue