LocalStack: 本机 Mock AWS 服务利器

如果代码中需要与 AWS 服务(比如 S3)交互, 如何写单元测试?

0x00 mock API

既然是调用 AWS 的 API, 那么可以从 AWS SDK 入手, 通过开发语言级别的 Mock framework, 拦截 API 调用. 以 Java 访问 S3 为例, 使用 Unitils 框架, Mock AmazonS3Client 类.

// 通过 mock AmazonS3Client 
private Mock<AmazonS3Client> mockS3Client = null;

// 约定 API 返回内容
this.mockS3Client.returns(objectListingResult).listObjects(request);

这种做法有几个缺点:

需要开发语言支持, 如果选择了 Go, 我也不知道怎么动态 Mock
需要自己写的代码容易传入 Mock 过的 client 代码, 比如一个静态变量的 AmazonS3Client 怎办, 咳咳
没有真正通过 API 请求服务, 如果 mock 逻辑错误, 没有达到测试的目的

0x01 LocalStack:

LocalStack 是开发 JIRA 的公司 Atlassian 开发的, 用 Python "山寨"了 AWS 的 API, 通过 REST API 提供跟 AWS 一模一样的服务. 使用起来也非常简单, 直接 docker pull atlassianlabs/localstack 就完成了安装. 启动也足够简单,

# 8080 端口是 web 使用
# SERVICES 环境变量用于指定启动的服务
# 4560-4582 是各个服务使用的端口
docker run -p 8080:8080 -p 4560-4582:4560-4582 --name localstack -e SERVICES='s3,web' atlassianlabs/localstack

各个服务使用的端口如下:

API Gateway at http://localhost:4567
Kinesis at http://localhost:4568
DynamoDB at http://localhost:4569
DynamoDB Streams at http://localhost:4570
Elasticsearch at http://localhost:4571
S3 at http://localhost:4572
Firehose at http://localhost:4573
Lambda at http://localhost:4574
SNS at http://localhost:4575
SQS at http://localhost:4576
Redshift at http://localhost:4577
ES (Elasticsearch Service) at http://localhost:4578
SES at http://localhost:4579
Route53 at http://localhost:4580
CloudFormation at http://localhost:4581
CloudWatch at http://localhost:4582

AWS 的 cli/SDK 都提供一个 endpoint-url(也就是 AWS API server 的 url) 的 hook, 方便的让我们使用 Localstack. 例如, aws cli 中使用本地的 S3:

# 创建 bucket
aws s3api --endpoint http://localhost:4572  create-bucket --bucket test-bucket

# 执行 ls 操作
aws s3 --endpoint http://localhost:4572 ls s3://test-bucket/

为了与 Java/JUnit 集成, LocalStack 还提供了 LocalstackTestRunner, 参见官方示例:

@RunWith(LocalstackTestRunner.class)
public class MyCloudAppTest {

  @Test
  public void testLocalS3API() {
    AmazonS3 s3 = new AmazonS3Client(...);
    s3.setEndpoint(LocalstackTestRunner.getEndpointS3());
    List<Bucket> buckets = s3.listBuckets();
    ...
  }
}

不过值得提醒的是, 这个 LocalstackTestRunner 从 github 上下载最新的 localstack 并且在本机安装, 作为天朝码农你懂的, 因此还是建议使用 docker 方式运行 localstack, 非常便捷.

LocalStack 与 gitlab CI 的集成也非常简单, 仅需要在前置的 stage 的 services 中定义 localstack 的 image 即可.

LocalStack 的好处也非常明显:

真正的 REST API 调用, 不用代码级别 Mock SDK, 因此也做到了所有语言通吃
错误注入, 比如通过 KINESIS_ERROR_PROBABILITY 环境变量的值指定多大概率扔出 ProvisionedThroughputExceededException 异常. 不过这种设计在 gitlab CI 中就不是很容易集成进来, 毕竟这个环境变量是 Localstack 进程全局的, 如果想同时测试正常情况和异常情况, 还是要动动脑筋

总结

再也没有借口不写 AWS 服务相关的测试代码了, 不是么.....

-- EOF --