Як показати власні повідомлення про помилки в ScalaTest?


86

Хтось знає, як показати власне повідомлення про помилку в ScalaTest?

Наприклад:

NumberOfElements() should equal (5)

Показує таке повідомлення, коли воно не вдається:

10 не дорівнювало 5

Але я хочу більше описового повідомлення на зразок:

NumberOfElements має бути 5.

Відповіді:


101

Ви першими попросили таку функцію. Один із способів досягти цього - за допомогою 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:")

1
Бувають ситуації, коли мені доводилося вказувати більше одного твердження в тесті it (), і є більше ніж одне ціле порівняння. Не зрозуміло, переглядаючи журнали, твердження яких не вдалося.
Удаякумар Раяла

Але спосіб вказівки withClue не читається. Хіба немає способу вказати повідомлення в кінці?
Удаякумар Раяла

1
Зрештою це неможливо виконати з DSL збігу, але ви можете написати метод, який поміщає параметри withClue у зворотному порядку. До відповіді додам приклад.
Білл Веннерс

12

Новий шлях з 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 .


3

Ви також можете використовувати, withClueнічого не імпортуючи та не додаючи до тестового класу:

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

Це імпортовано з Assertionsкласу:org.scalatest.Assertions#withClue

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.