MatcherWords

This method enables the following syntax:

result should equal (7)
             ^

The left should equal (right) syntax works by calling == on the left value, passing in the right value, on every type except arrays. If both left and right are arrays, deep will be invoked on both left and right before comparing them with ==. Thus, even though this expression will yield false, because Array's equals method compares object identity:

Array(1, 2) == Array(1, 2) // yields false

The following expression will not result in a TestFailedException, because ScalaTest will compare the two arrays structurally, taking into consideration the equality of the array's contents:

Array(1, 2) should equal (Array(1, 2)) // succeeds (i.e., does not throw TestFailedException)

If you ever do want to verify that two arrays are actually the same object (have the same identity), you can use the be theSameInstanceAs syntax.

This field enables the following syntax:

noException should be thrownBy
^

This field enables syntax such as the following:

obj should (be theSameInstanceAs (string) and be theSameInstanceAs (string))
           ^

This field enables the following syntax:

"val a: String = 1" shouldNot compile
                             ^

This field enables syntax such as the following:

list should (contain ('a') and have length (7))
            ^

This field enables the following syntax:

seq should be (defined)
             ^

This field enables the following syntax:

list should be (empty)
               ^

This field enables syntax such as the following:

string should (endWith ("ago") and include ("score"))
              ^

This field enables the following syntax:

file should exist
           ^

This field enables syntax such as the following:

string should (fullyMatch regex ("Hel*o, wor.d") and not have length (99))
              ^

This field enables syntax such as the following:

list should (have length (3) and not contain ('a'))
            ^

This field enables syntax such as the following:

string should (include ("hope") and not startWith ("no"))
              ^

This field enables the following syntax:

"hi" should not have length (3)
                    ^

This field enables the following syntax:

result should matchPattern { case Person("Bob", _) => }
             ^

This field enables syntax like the following:

myFile should (not be an (directory) and not have ('name ("foo.bar")))
              ^

This field enables the following syntax:

file should be (readable)
               ^

This field enables the following syntax:

set should not have size (3)
                   ^

This field enables the following syntax:

seq should be (sorted)
             ^

This field enables syntax such as the following:

string should (startWith ("Four") and include ("year"))
              ^

This field enables the following syntax:

"val a: String = 1" shouldNot typeCheck
                             ^

This field enables the following syntax:

file should be (writable)
               ^