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

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

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 --

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,520评论 25 707
  • https://aws.amazon.com/cn/s3/faqs/#sia_anchor Amazon Simp...
    守望者_1065阅读 8,228评论 0 5
  • 本文是GitChat《Serverless 风格微服务的持续交付(上):架构案例》部分内容已做修改。文章聊天实录请...
    顾宇阅读 3,189评论 1 13
  • 5.整数的同余 一个固定的整数d去除整数(Zi)如果余数相同,我们则称这组整数Zi是模d同余的,例如,2,7,...
    jackjianshu阅读 843评论 0 0