如何在Scala中Mock含工具函数的object文件？测试新手求指导

作为Scala测试新手，碰到这种单例工具类（object）的测试问题太正常了——因为Scala的object是全局单例，没法直接mock，所以我们需要先做一点点小重构，把工具类的行为抽象成trait，这样就能顺利用ScalaMock来写测试了。下面我会一步步带你搞定整个流程：

1. 补全SBT依赖配置 #

你提到的ScalaMock依赖没写完，针对Scala 2.11和SBT，完整的依赖配置应该是这样的（注意版本适配，Scala 2.11对应ScalaMock 3.6.0左右版本）：

libraryDependencies ++= Seq(
  "org.scalatest" %% "scalatest" % "3.0.5" % Test,
  "org.scalamock" %% "scalamock-scalatest-support" % "3.6.0" % Test
)

这里同时引入了ScalaTest（FlatSpec属于它）和ScalaMock的ScalaTest支持包，这样就能在测试里同时使用FlatSpec和MockFactory了。

2. 重构工具类，抽象出Trait #

你的原始utility是个object，我们先把它的方法签名抽象成一个trait，再让原object实现这个trait：

// 抽象出Trait，定义工具类的所有方法签名
trait UtilityTrait {
  def abc(a: String, b: Int): String
  def bcd(): Int
}

// 让原来的object实现这个Trait
object utility extends UtilityTrait {
  override def abc(a: String, b: Int): String = {
    // 这里是你的实际业务逻辑，比如示例实现：
    s"$a-$b"
  }

  override def bcd(): Int = {
    // 示例实现：
    42
  }
}

这样做的核心目的是打破对单例utility的强依赖，让我们在测试中可以灵活mock这个Trait。

3. 编写单元测试用例 #

现在我们可以用FlatSpec和MockFactory来写测试了，这里分两种常见场景：

场景1：直接测试真实工具类实现 #

如果只是想验证utility的实际业务逻辑，直接写测试即可：

import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers

class UtilitySpec extends AnyFlatSpec with Matchers {

  "utility.abc" should "return formatted string with input values" in {
    val result = utility.abc("test", 123)
    result shouldBe "test-123" // 替换成你的实际预期结果
  }

  "utility.bcd" should "return the expected integer" in {
    val result = utility.bcd()
    result shouldBe 42 // 替换成你的实际预期值
  }
}

场景2：使用Mock测试依赖UtilityTrait的类 #

如果你的代码里有其他类依赖UtilityTrait，我们可以mock这个Trait来隔离测试目标类：

import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers
import org.scalamock.scalatest.MockFactory

// 假设我们有一个依赖UtilityTrait的业务类
class MyBusinessService(utility: UtilityTrait) {
  def processInput(input: String): String = {
    val num = utility.bcd()
    utility.abc(input, num)
  }
}

// 测试MyBusinessService，用Mock隔离UtilityTrait
class MyBusinessServiceSpec extends AnyFlatSpec with Matchers with MockFactory {

  "MyBusinessService.processInput" should "use mocked utility methods correctly" in {
    // 创建Mock的UtilityTrait实例
    val mockUtility = mock[UtilityTrait]

    // 设定Mock行为：调用bcd()时返回100
    (mockUtility.bcd _).expects().returning(100)
    // 设定Mock行为：调用abc("hello", 100)时返回"hello-100-mocked"
    (mockUtility.abc _).expects("hello", 100).returning("hello-100-mocked")

    // 初始化业务类，传入Mock实例
    val service = new MyBusinessService(mockUtility)
    val result = service.processInput("hello")

    // 断言结果符合预期
    result shouldBe "hello-100-mocked"
  }
}

4. 运行测试 #

在SBT控制台中，你可以直接执行test命令运行所有测试，或者用testOnly *UtilitySpec来单独运行某个测试类。

内容的提问来源于stack exchange，提问作者Kunal Trivedi