Wie werden benutzerdefinierte Fehlermeldungen in ScalaTest angezeigt?

86

Weiß jemand, wie eine benutzerdefinierte Fehlermeldung in ScalaTest angezeigt wird?

Beispielsweise:

NumberOfElements() should equal (5)

Zeigt die folgende Meldung an, wenn dies fehlschlägt:

10 war nicht gleich 5

Aber ich möchte eine aussagekräftigere Botschaft wie:

NumberOfElements sollte 5 sein.

scala scalatest matcher Udayakumar Rayala
quelle

Antworten:

99

Sie sind der erste, der nach einer solchen Funktion fragt. Eine Möglichkeit, dies zu erreichen, ist withClue. Etwas wie:

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

Das sollte Ihnen diese Fehlermeldung bringen:

NumberOfElements: 10 war nicht gleich 5

Wenn Sie die Nachricht vollständig steuern möchten, können Sie einen benutzerdefinierten Matcher schreiben. Oder Sie könnten eine Behauptung wie diese verwenden:

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

Können Sie näher auf Ihren Anwendungsfall eingehen? Warum ist 10 nicht gleich 5 ist nicht bis zum Schnupftabak, und wie oft hatten Sie dieses Bedürfnis?

Folgendes fordern Sie an:

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)

So können Sie schreiben:

{ NumberOfElements() should be (5) } withMessage ("NumberOfElements:")
Bill Venners
quelle
1
Es gibt Situationen, in denen ich mehr als eine Behauptung in einen it () -Test einfügen musste, und es gibt mehr als einen ganzzahligen Vergleich. Anhand der Protokolle wird nicht klar, welche Behauptung fehlgeschlagen ist.
Udayakumar Rayala
Die withClue-Methode zur Angabe ist jedoch nicht lesbar. Gibt es keine Möglichkeit, die Nachricht am Ende anzugeben?
Udayakumar Rayala
1
Am Ende ist dies mit dem DSL des Matchers nicht möglich, aber Sie können eine Methode schreiben, mit der die withClue-Parameter in die entgegengesetzte Reihenfolge gebracht werden. Ich werde der Antwort ein Beispiel hinzufügen.
Bill Venners
12

Neuer Weg seit 2011: Matchersund AppendedClueEigenschaften. Für Sammlungsgrößen gibt es außerdem einige Standardnachrichten.

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

Die Ausgabe sieht folgendermaßen aus:

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)

Beachten Sie, dass die ListGrößenmeldung für Listen mit langer .toStringAusgabe nicht geeignet ist .

Weitere Informationen finden Sie im Scaladoc .

Tilde
quelle
2

Sie können auch verwenden, withClueohne etwas zu importieren oder zur Testklasse hinzuzufügen:

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

Dies wird aus der AssertionsKlasse importiert :org.scalatest.Assertions#withClue

Shubham Chaudhary
quelle