如何使用Specs2的Given/When/Then风格测试Play Scala项目（验收用例存于文本文件）

我来给你详细拆解怎么实现你要的这种测试方案——用Specs2的Given/When/Then风格，同时把验收用例放在独立的文本文件里（类似Jbehave的写法），还能让测试代码读取并执行这些用例。

一、先搞定项目依赖 #

首先得在你的Play项目的build.sbt里添加Specs2的必要依赖，确保测试能正常运行：

libraryDependencies ++= Seq(
  "org.specs2" %% "specs2-core" % "4.20.0" % Test,
  "org.specs2" %% "specs2-matcher-extra" % "4.20.0" % Test,
  play.sbt.PlayImport.specs2 % Test // Play项目专属的Specs2集成依赖
)

记得同步一下依赖，让sbt把这些库拉下来。

二、编写独立的验收用例文本 #

在test/resources/acceptance目录下创建你的用例文件（比如user_registration.story），用类似Jbehave的自然语言写法：

Scenario: 新用户成功完成注册
Given 系统中不存在邮箱为test@example.com的用户
When 用户提交注册信息：邮箱test@example.com，密码Password123
Then 系统应创建该用户的记录
And 用户状态标记为已激活

Scenario: 重复注册同一邮箱失败
Given 系统中已存在邮箱为test@example.com的用户
When 用户再次提交相同邮箱的注册信息
Then 系统应返回"邮箱已被使用"的错误提示

这种写法的好处是产品、测试都能看懂，不用碰代码。

三、编写Specs2测试类解析并执行用例 #

接下来创建测试类，比如test/scala/acceptance/UserRegistrationSpec.scala，核心逻辑是读取外部文本、解析步骤、绑定到测试代码：

import org.specs2.mutable.Specification
import org.specs2.specification.core.SpecStructure
import scala.io.Source

// 主测试类
class UserRegistrationSpec extends Specification {
  // 读取外部用例文件
  private val storyContent = Source.fromResource("acceptance/user_registration.story").mkString
  // 解析出所有场景和步骤
  private val scenarios = parseStoryContent(storyContent)

  // 定义测试结构
  override def is: SpecStructure = 
    s2"""
      执行用户注册模块的验收用例 $executeAllScenarios
    """

  // 遍历所有场景，逐个执行
  private def executeAllScenarios = scenarios.map { scenario =>
    scenario.name >> {
      scenario.steps.foreach {
        case Given(desc) => handleGivenStep(desc)
        case When(desc) => handleWhenStep(desc)
        case Then(desc) => handleThenStep(desc)
        case And(desc) => handleThenStep(desc) // And步骤复用Then的验证逻辑
      }
    }
  }.reduce(_ ^ _)

  // 解析文本用例的工具方法
  private def parseStoryContent(content: String): List[Scenario] = {
    val validLines = content.split("\n").filter(_.trim.nonEmpty).map(_.trim).toList
    // 把文本按Scenario分组
    val scenarioGroups = validLines.foldLeft(List.empty[List[String]]) { (acc, line) =>
      if (line.startsWith("Scenario:")) acc :+ List(line)
      else acc.init :+ (acc.last :+ line)
    }
    // 把每组转换成Scenario对象
    scenarioGroups.map { group =>
      val scenarioName = group.head.replace("Scenario:", "").trim
      val steps = group.tail.map { line =>
        line match {
          case s if s.startsWith("Given") => Given(s.replace("Given", "").trim)
          case s if s.startsWith("When") => When(s.replace("When", "").trim)
          case s if s.startsWith("Then") => Then(s.replace("Then", "").trim)
          case s if s.startsWith("And") => And(s.replace("And", "").trim)
        }
      }
      Scenario(scenarioName, steps)
    }
  }

  // 定义步骤和场景的类型
  sealed trait Step
  case class Given(description: String) extends Step
  case class When(description: String) extends Step
  case class Then(description: String) extends Step
  case class And(description: String) extends Step
  case class Scenario(name: String, steps: List[Step])

  // 存储When步骤的执行结果，供Then步骤验证用
  private var registrationResult: Option[RegistrationOutcome] = None

  // 实现Given步骤的前置逻辑
  private def handleGivenStep(description: String): Unit = description match {
    case "系统中不存在邮箱为test@example.com的用户" =>
      UserRepo.findByEmail("test@example.com").mustBeNone
    case "系统中已存在邮箱为test@example.com的用户" =>
      UserRepo.save(User("test@example.com", "Password123", Activated))
      UserRepo.findByEmail("test@example.com").mustBeSome
  }

  // 实现When步骤的业务操作
  private def handleWhenStep(description: String): Unit = description match {
    case "用户提交注册信息：邮箱test@example.com，密码Password123" =>
      registrationResult = Some(UserService.register("test@example.com", "Password123"))
    case "用户再次提交相同邮箱的注册信息" =>
      registrationResult = Some(UserService.register("test@example.com", "NewPassword456"))
  }

  // 实现Then步骤的验证逻辑
  private def handleThenStep(description: String): Unit = description match {
    case "系统应创建该用户的记录" =>
      UserRepo.findByEmail("test@example.com").mustBeSome
    case "用户状态标记为已激活" =>
      registrationResult.flatMap(_.user).map(_.status).mustBeSome(Activated)
    case "系统应返回\"邮箱已被使用\"的错误提示" =>
      registrationResult.map(_.error).mustBeSome("邮箱已被使用")
  }
}

这里的UserRepo、UserService是你项目里实际的业务类，替换成你自己的即可。

四、运行测试 #

在Play项目里，直接用sbt命令就能运行：

# 运行所有测试
sbt test

# 只运行这个验收测试类
sbt "testOnly acceptance.UserRegistrationSpec"

运行后你就能看到每个Scenario的执行结果，和普通Specs2测试一样会输出通过/失败的详细信息。

五、进阶优化小技巧 #

• 参数化用例：可以在文本用例里加占位符，比如Given 系统中不存在邮箱为${email}的用户，然后在解析时替换成不同的测试数据，实现数据驱动测试。
• 更健壮的解析：如果用例复杂，可以用正则表达式或者轻量的DSL解析库来处理，避免简单字符串匹配的脆弱性。
• 函数式上下文：可以用Specs2的Context来管理测试状态，替代上面的var，更符合Scala的函数式风格。

内容的提问来源于stack exchange，提问作者Carlos Galo Campos