จะแสดงข้อความล้มเหลวแบบกำหนดเองใน ScalaTest ได้อย่างไร?

ไม่มีใครรู้วิธีแสดงข้อความล้มเหลวแบบกำหนดเองใน ScalaTest?

ตัวอย่างเช่น:

NumberOfElements() should equal (5)

แสดงข้อความต่อไปนี้เมื่อล้มเหลว:

10 ไม่เท่ากับ 5

แต่ฉันต้องการข้อความอธิบายเพิ่มเติมเช่น:

NumberOfElements ควรเป็น 5

คุณเป็นคนแรกที่ขอคุณสมบัติดังกล่าว วิธีหนึ่งในการบรรลุเป้าหมายนี้คือด้วย Clue สิ่งที่ต้องการ:

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: 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สำหรับข้อมูลเพิ่มเติม

¹ฉันเดาว่าAppendedCluesลักษณะนี้ได้รับแรงบันดาลใจจากคำถามนี้ Bill Venners จากคำตอบที่ยอมรับคือผู้เขียนลักษณะนี้

คุณยังสามารถใช้ได้withClueโดยไม่ต้องนำเข้าอะไรหรือเพิ่มลงในคลาสทดสอบ:

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

สิ่งนี้นำเข้าจากAssertionsชั้นเรียน:org.scalatest.Assertions#withClue