Question

1. 用Scala 写测试有多种选择，包括Java 工具如JUnit 和 TestNG ，以及Scala 工具如ScalaTest,specs2,ScalaCheck 等。

2.1 ScalaTest

1. ScalaTest 是最灵活的Scala 测试框架，可以很容易定制它来解决不同的问题。

2. ScalaTest 核心概念是套件suite，即测试的集合。所谓的测试test 可以是任何带有名字，可以被启动，要么成功、要么失败、要么被暂停、要么被取消的代码。

   在ScalaTest 中，Suite 特质是核心组合单元。Suite 声明了一组“生命周期”方法，定义了运行测试的默认方式。你也可以重写这些方法来对测试的编写和运行进行定制。

   • ScalaTest 提供了风格特质style trait，这些特质扩展自Suite 并重写了生命周期方法来支持不同的测试风格。
   • ScalaTest 还提供了混入特质mixin trait ，这些特质扩展自Suite 并重写了生命周期方法来支持特定的测试需要。
   • 可以组合style trait 和 mixin trait 来定义测试类，也可以通过编写Suite 实例来定义测试套件。

3. ScalaTest 已经被集成到常见的构建工具（如sbt,maven ）和IDE （如IDEA,Eclipse）中。

4. 可以通过ScalaTest 的Runner 应用程序直接运行Suite，或者在scala 解释器中简单调用其execute 方法。

   
   xxxxxxxxxx
   // 在 scala 解释器中
   (new XXSuite).execute()

5. ScalaTest 的所有风格都被设计为鼓励编写专注的、带有描述性名字的测试。所有的风格都会生成规格说明书般的输出。

6. 示例：

   ​x
   // 源码文件，位于包 model_a 中
   class C(val n:Double)
   {
       // 具体实现
   }
   ​
   // 测试文件
   import org.scalatest.FunSuite
   import model_a.C
   class CSuite extends FunSuite {
       test("C should have postive num"){
           val c = C(1.0)
           assert(c.n >=0)
       }
   }

   • FunSuite 中的 Fun 指的是函数function 。

   • test 是定义在FunSuite 中的一个方法，我们在CSuite 的主构造方法中调用。

     调用时：

     • 圆括号中通过字符串给出测试的名称。
     • 通过花括号给出具体的测试代码。测试代码是一个以传名参数传入test 的函数。test 将这个函数登记下来，稍后执行。

7. 如果希望得到更详细的关于断言失败的信息，可以使用ScalaTest 的 DiagrammedAssertions，其错误消息会显式传入assert 的表达式的一张示意图。

8. ScalaTest 的 assert 方法并不在错误消息中区分实际结果和预期结果。如果你希望强调实际结果和预期结果，则使用ScalaTest 的 assertResult 方法。如：

   
   xxxxxxxxxx
   asseretResult(2){  // 预期结果：2
       c.n            // 实际结果
   }

9. 如果要检查某个方法抛出某个预期的异常，则可以使用ScalaTest 的 assertThrows 方法。

   
   xxxxxxxxxx
   assertThrows[IllegalArgumentException]{
       C("Must be a double,but get a string")
   }

   • 如果花括号中的代码未抛出异常，或者抛出了不同于预期的异常，则assertThrows 将以 TestFailedException 异常终止。

   • 如果花括号中的代码以传入的异常类的实例异常终止（即：代码抛出了预期的异常），则assertThrows 将正常返回。

   • 可以使用intercept ，其机制与assertThrows 相同，唯一区别在于：当代码抛出了预期的异常时，intercept 将返回这个异常。注意：是返回，不是抛出。

     
     xxxxxxxxxx
     val caught = intercept[ArithmeticException]{1/0}  // 返回了预期的异常
     print(caught.getMessage)

2.2 BDD 风格

1. 行为驱动开发BDD 测试风格的重点是：编写人类可读的关于代码预期行为的规格说明，同时给出验证代码具备指定行为的测试。

   ScalaTest 包含了若干特质来支持这种风格的测试。

2. 在FlatSpec 中，我们以规格子句specifier clause 的形式编写测试。

   
   xxxxxxxxxx
   import org.scalatest.FlatSpec
   import org.scalatest.Matchers
   import Element.elem   // 自定义类，即将测试它
   ​
   class ElementSpec extends FlatSpec with Matchers{
       "An Element" should "has a given width" in {
           val ele = elem("name",2,3)
           ele.width should be (2)
       }
       it should "has a given height" in {
           val ele = elem("name",2,3)
           ele.height should be (3)
       }
       it should "throw an IAE if passed a negative width" in {
           an [IllegalArgumentException] should be thrownBy {
               ele("name",-2,3)
           }
       }
   }

   • 首先是以字符串表示的待测试的主体subject，如示例中的"An Element" 。
   • 然后是should （或者 must/can ）。
   • 然后是一个描述该主体需要具备的行为的字符串。
   • 然后是in。
   • 最后是花括号包围的用于测试行为的代码。
   • 在后续子句中，可以用it 来指代最近给出的主体。

3. 当一个FlatSpec 被执行时，它将每个规格子句作为ScalaTest 测试运行。FlatSpec （以及ScalaTest 的其它规则说明特质）在运行后将生成读起来像规格说明书的输出。

4. 通过混入Matchers 特质，可以编写读上去更像自然语言的断言。ScalaTest 在其DSL 中提供了许多匹配器，并允许你用定制的失败消息定义新的matcher 。

   • 上面示例中的匹配器包括should be 和 an [...] should be thrownBy{...} 。

   • 如果相比should你更喜欢must，也可以选择MustMatchers 。则匹配器可以为：

     
     xxxxxxxxxx
     result must be >= 0
     map must contain key 'c'

5. BDD 的一个重要思想是：测试可以在软件功能制定者、软件功能实现者、软件功能测试者这三者之间架起一道沟通的桥梁。

   ScalaTest 的 FeatureSpec 就是专门为此设计的。其设计目标是引导关于软件需求的对话：必须指明具体的功能feature、然后用场景scenario 来描述这些功能。

   
   xxxxxxxxxx
   import org.scalatest._
   ​
   class TVSetSpec extends FeatureSpec with GivenWhenThen {
       features("TV power button") {
           scenario("User presses power button when TV is off"){
               Given(" a TV set that is switched off")
               When("the power button is pressed")
               Then("The TV should switch on")
               pending
           }
       }
   }

   • Given,When,Then 方法由GivenWhenThen 特质提供，能帮助我们将对话聚焦在每个独立场景的具体细节上。

   • 最后的pending 调用表明测试和实际行为都还没有实现：这仅仅是规格说明。

     一旦所有的测试和给定的行为都实现了，这些测试就会通过。此时我们说需求已经满足了。

2.3 specs2

1. specs2 测试框架是Eric Torreborre 用Scala 编写的开源工具，也支持TDD 风格的测试，但是语法不同。

   
   xxxxxxxxxx
   import org.specs2._
   import Element.elem   // 自定义类，即将测试它
   ​
   object ElementSpec extends Specification{
       "An Element" should "has a given width" in {
           val ele = elem("name",2,3)
           ele.width must be_==(2)
       }
       it should "has a given height" in {
           val ele = elem("name",2,3)
           ele.height must be_==(2)
       }
       it should "throw an IAE if passed a negative width" in {
           ele('name',-2,3) must throwA[IllegalArgumentException]
       }
   }

2. 和ScalaTest 一样，specs2 也提供了匹配器DSL。如上例中的must be_== 和 must throwA 。

3. 可以单独使用specs2，不过它也被集成到ScalaTest 和 JUnit 中，因此也可以用这些工具来运行specs2 测试。

2.4 ScalaCheck

1. Scala 另一个有用的测试工具是ScalaCheck，这是由Richard Nilsson 编写的开源框架。

   ScalaCheck 让你能够指定被测试的代码必须满足的性质。对每个性质，ScalaCheck 都会生成数据并执行断言来检查代码是否满足该性质。

   
   xxxxxxxxxx
   import org.scalatest.WordSpec
   import org.scalatest.prop.PropertyChecks
   import org.scalatest.MustMatchers._
   import Element.elem   // 自定义类，即将测试它
   ​
   class ElementSpec extends WordSpec with PropertyChecks {
       "An Element" must "has a given width" in {
           forAll {
               (w:Int) => whenever (w>0){ elem("name",w,3).width must euqual (2)}
           }
       }
    
   }

   • PropertyChecks 特质提供了若干forAll 方法，让你可以将基于性质的测试跟传统的基于断言或基于匹配器的测试混合在一起。

   • whenever 的意思是：只要w>0 为 true，则右边代码块中的表达式必须为true 。

   • 通过这一小段代码，ScalaCheck 就会帮我们生成数百条w 可能的取值并对每一个进行测试，尝试找出不满足该性质的值。

     如果对每个值，该性质都满足，则测试通过。否则测试将以TestFailedException 终止，该异常将会包含关于测试失败的信息。

2.5 执行测试

1. 每一个测试框架都提供了某种组织和运行测试的机制。

2. 在ScalaTest 中，我们通过将Suite 嵌套在别的Suite 当中来组织大型的测试套件。当Suite 被执行时，它将执行嵌套的Suite 和其它测试。

   • 可以手动或者自动嵌套测试套件。

     • 手动方式：在你的Suite 中重写nestedSuite 方法，或者将你希望嵌套的Suite 作为参数传递给Suites 类的构造方法。
     • 自动方式：将包名提供给ScalaTest 的 Runner，它会自动发现Suite 套件，并将它们嵌套在一个根Suite 里，并执行这个根 Suite 。

   • 可以通过命令行调用ScalaTest 的 Runner 应用程序，也可以通过构建工具如sbt,maven,ant 来调用。

     通过命令行调用Runner 最简单的方式是通过org.scalatest.run。该应用程序预期一个完整的测试类名。

     如：

     
     xxxxxxxxxx
     scalac -cp scalatest.jar TVSetSpec.scala            # 编译测试类
     scala -cp scalatest.jar org.scalatest.run TVSetSpec # 执行测试

     • 通过cp 参数将ScalaTest 的 JAR 文件包含在类路径中。
     • org.scalatest.run 是完整的应用程序类名。Scala 将会运行这个app，并传入剩下的命令行参数。
     • TVSetSpec 这个参数指定了要执行的套件。