如何使用ScalaMock模拟AWS SDK测试Scala业务代码

核心思路 #

要避免真实AWS调用，首先得解耦业务代码与AWS客户端的强依赖——你当前的私有AWS客户端无法直接替换为mock对象，通过「依赖注入+抽象接口」的方式，就能让测试时轻松替换真实客户端为mock实例。

步骤1：抽象AWS客户端调用逻辑 #

定义一个trait，把你用到的AWS客户端特定方法抽象出来，不用关心AWS SDK的具体实现：

trait AwsServiceClient {
  def sendData(target: String, partition: String, payload: String): Boolean
}

这里的sendData对应你实际调用的AWS方法，参数和返回值可根据真实业务调整（如果原方法返回异步类型如Future，同步修改即可）。

步骤2：重构业务代码 #

把原来的私有AWS客户端替换为依赖注入的AwsServiceClient实例。假设你的post函数属于某个类，重构后如下：

import cats.effect.IO

class DataPoster(awsClient: AwsServiceClient) {
  def post(target: String, partition: String, payload: String): IO[Boolean] = {
    // 凭证设置逻辑可移到真实客户端实现类中，业务代码只关注核心流程
    IO.delay(awsClient.sendData(target, partition, payload))
  }
}

步骤3：编写真实AWS客户端实现 #

生产环境中，实现上述trait，封装真实的AWS SDK调用：

class RealAwsServiceClient extends AwsServiceClient {
  // 初始化真实AWS客户端（包含凭证、区域等配置）
  private val realClient = {
    // 例如：AmazonSNSClientBuilder.standard().withCredentials(...)
  }

  override def sendData(target: String, partition: String, payload: String): Boolean = {
    // 调用真实AWS客户端方法，处理参数并执行调用
    // 例如：realClient.publish(...)，返回是否成功的布尔值
    true // 替换为真实业务逻辑
  }
}

步骤4：用ScalaMock编写测试 #

现在可以直接mockAwsServiceClient，验证业务逻辑而不发起真实调用：

import org.scalamock.scalatest.MockFactory
import org.scalatest.flatspec.AnyFlatSpec
import cats.effect.unsafe.implicits.global

class DataPosterSpec extends AnyFlatSpec with MockFactory {
  "DataPoster.post" should "call AWS client with correct parameters" in {
    // 创建mock客户端实例
    val mockAwsClient = mock[AwsServiceClient]
    val dataPoster = new DataPoster(mockAwsClient)

    val testTarget = "test-topic"
    val testPartition = "test-partition"
    val testPayload = "{\"key\":\"value\"}"

    // 设置预期：调用sendData时传入指定参数，返回true
    (mockAwsClient.sendData _)
      .expects(testTarget, testPartition, testPayload)
      .returning(true)

    // 执行测试并验证结果
    val result = dataPoster.post(testTarget, testPartition, testPayload).unsafeRunSync()
    assert(result == true)
  }

  it should "propagate AWS client failure" in {
    val mockAwsClient = mock[AwsServiceClient]
    val dataPoster = new DataPoster(mockAwsClient)

    // 设置预期：任意参数调用sendData都返回false
    (mockAwsClient.sendData _)
      .expects(*, *, *)
      .returning(false)

    val result = dataPoster.post("any-target", "any-partition", "any-payload").unsafeRunSync()
    assert(result == false)
  }
}

关键注意点 #

• 不要直接mock AWS SDK的具体类（如AmazonSNSClient），这类类多为final或有复杂初始化逻辑，mock成本高，用抽象trait的方式更灵活。
• 如果AWS调用是异步类型（如Future），只需同步调整trait方法的返回值，ScalaMock完全支持异步方法的mock。

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