Como mostrar mensagens de falha personalizadas no ScalaTest?

Question 1

Alguém sabe como mostrar uma mensagem de falha personalizada no ScalaTest?

Por exemplo:

NumberOfElements() should equal (5)

Mostra a seguinte mensagem quando falha:

10 não era igual a 5

Mas eu quero uma mensagem mais descritiva como:

NumberOfElements deve ser 5.

Question 2

Você é o primeiro a solicitar esse recurso. Uma maneira de conseguir isso é com withClue. Algo como:

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

Isso deve gerar esta mensagem de erro:

NumberOfElements: 10 não era igual a 5

Se você deseja controlar a mensagem completamente, pode escrever um matcher personalizado. Ou você pode usar uma afirmação, como esta:

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

Você pode explicar qual é o seu caso de uso? Por que 10 não é igual a 5 não está à altura, e quantas vezes você já teve essa necessidade?

Aqui está o tipo de coisa que você está solicitando:

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)

Assim, você pode escrever:

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

Question 3

Nova forma desde 2011: Matcherse AppendedCluetraços. Além disso, para tamanhos de coleção, existem algumas mensagens padrão.

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
      }
    }
  }
}

A saída fica assim:

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)

Observe que o Listtamanho da mensagem não é ótimo para listas com .toStringsaída longa .

Veja o scaladoc para mais informações.

Question 4

Você também pode usar withCluesem importar nada ou adicioná-lo à classe de teste:

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

Isso é importado da Assertionsclasse:org.scalatest.Assertions#withClue