如何用ScalaTest验证类内部私有方法的自定义区域参数？

问题背景 #

我正在编写单元测试，需要验证methodToTest中传入的自定义区域是否被正确传递到私有方法getCustomSettings，并最终应用到S3Settings中。相关代码如下：

待测试的公开方法：

def methodToTest(bucket: String, key: Path, customRegion) {
    S3.download(bucket, key, None, None, None)
      .withAttributes(S3Attributes.settings.getCustomSettings(s3Settings, customRegion))
      // 其他逻辑
}

私有工具方法：

private def getCustomSettings(s3Settings: S3Settings, customRegion: String): S3Settings = {
    settings.withS3RegionProvider(new AWSRegionProvider { 
             override def getRegion: Region = Region.of(customRegion)        
    })
}

补充：S3Settings是final类，无法通过mock[S3Settings]进行Mock。

解决方案 #

方案1：测试公开方法的行为（推荐）

单元测试的核心是验证公开方法的行为而非实现细节，因此我们可以通过捕获withAttributes方法接收的S3Attributes，从中提取S3Settings并验证区域是否正确。

使用ScalaTest + Mockito的示例代码：

import org.scalatest.BeforeAndAfterEach
import org.scalatest.matchers.should.Matchers
import org.scalatest.wordspec.AnyWordSpec
import org.mockito.Mockito._
import org.mockito.ArgumentCaptor
import software.amazon.awssdk.regions.Region
import java.nio.file.Paths

class YourClassSpec extends AnyWordSpec with Matchers with BeforeAndAfterEach {
  // 替换为你的类名和实际的S3Settings初始化方式
  private val testS3Settings = S3Settings.default
  private val yourClass = new YourClass(testS3Settings)
  // 替换为S3.download实际返回的类型
  private val mockS3DownloadResult = mock(classOf[S3DownloadResult])
  private val s3AttributesCaptor = ArgumentCaptor.forClass(classOf[S3Attributes])

  override def beforeEach(): Unit = {
    reset(mockS3DownloadResult)
    // Mock S3.download，让它返回预设的mock对象
    when(S3.download(anyString(), any[Path](), any(), any(), any())).thenReturn(mockS3DownloadResult)
  }

  "methodToTest" should {
    "apply the specified custom region to S3Settings" in {
      val testBucket = "test-bucket"
      val testKey = Paths.get("test/object-key")
      val targetRegionStr = "us-west-2"
      val expectedRegion = Region.of(targetRegionStr)

      // 调用待测试方法
      yourClass.methodToTest(testBucket, testKey, targetRegionStr)

      // 捕获传入withAttributes的S3Attributes实例
      verify(mockS3DownloadResult).withAttributes(s3AttributesCaptor.capture())
      val capturedAttrs = s3AttributesCaptor.getValue

      // 提取S3Settings并验证区域
      val actualRegion = capturedAttrs.settings.s3RegionProvider().getRegion()
      actualRegion shouldBe expectedRegion
    }
  }
}

方案2：通过反射测试私有方法（不推荐）

如果确实需要直接验证私有方法的逻辑，可以使用Scala反射调用私有方法，但这种方式耦合度高，后续代码重构容易导致测试失败。

示例代码：

import org.scalatest.matchers.should.Matchers
import org.scalatest.wordspec.AnyWordSpec
import scala.reflect.runtime.universe._
import software.amazon.awssdk.regions.Region

class YourClassSpec extends AnyWordSpec with Matchers {
  private val testS3Settings = S3Settings.default
  private val yourClass = new YourClass(testS3Settings)

  "getCustomSettings" should {
    "return S3Settings with the correct custom region" in {
      val customRegionStr = "eu-central-1"
      val expectedRegion = Region.of(customRegionStr)

      // 通过反射获取并调用私有方法
      val mirror = runtimeMirror(yourClass.getClass.getClassLoader)
      val instanceMirror = mirror.reflect(yourClass)
      val methodSymbol = typeOf[YourClass].decl(TermName("getCustomSettings")).asMethod
      val method = instanceMirror.reflectMethod(methodSymbol)

      val resultSettings = method(testS3Settings, customRegionStr).asInstanceOf[S3Settings]
      val actualRegion = resultSettings.s3RegionProvider().getRegion()

      actualRegion shouldBe expectedRegion
    }
  }
}

注意事项 #

• 优先选择方案1，因为测试公开方法的行为更符合单元测试的设计原则，不受实现细节变更的影响。
• 方案2仅作为临时验证手段，不建议长期使用，一旦私有方法的签名或逻辑调整，测试就会失效。

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