Как показать пользовательские сообщения об ошибках в 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 не подходит для списков сlong .toString output.

См. scaladoc для получения дополнительной информации.

Answer 3

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

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

Это импортируется из Assertions класса: org.scalatest.Assertions#withClue