92

ScalaTestでカスタム失敗メッセージを表示する方法を知っている人はいますか？

例えば：

NumberOfElements() should equal (5)

失敗すると、次のメッセージが表示されます。

10は5と等しくありませんでした

しかし、私は次のようなより説明的なメッセージが必要です。

NumberOfElementsは5である必要があります。

4

3 に答える 3

110

あなたはそのような機能を求める最初の人です。これを実現する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:")
于 2011-06-23T10:01:58.723 に答える
13

2011年以来の新しい方法：MatchersそしてAppendedClue1つの特徴。また、コレクションサイズについては、いくつかのデフォルトメッセージがあります。

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を参照してください。

1特性はこの質問に触発されたと思います、受け入れられた答えのビル・ベナーズAppendedCluesはこの特性の作者です。

于 2018-04-18T01:25:45.503 に答える
2

withClue何もインポートしたり、テストクラスに追加したりせずに使用することもできます。

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

Assertionsこれはクラスからインポートされます：org.scalatest.Assertions#withClue

于 2019-03-15T15:38:39.170 に答える