pact-goを使ってCDC testingを書いてみた

1. GoでCDC Testingしてみた

2. 自己紹介
山田 大二朗
SNS: @dorako321
Site: http://yamada.daiji.ro/
技術書典でSVGアニメーション本出しました
https://gyaopan.booth.pm/items/830469
Goは趣味で嗜む程度

3. 趣味：電子工作

4. ところで
皆さん

5. テストは書かれてますか？

6. _,,;' '" '' ゛''" ゛' ';;,,
（rヽ,;''"""''゛゛゛'';, ﾉｒ）
,;'゛ i ＿ 、＿ iヽ゛';,
,;'" ''| ヽ・〉 〈・ノ |ﾞ゛ `';,
,;'' "| ▼ |ﾞ゛ `';,
,;'' ヽ＿人＿ / ,;'_
／ｼ、 ヽ⌒⌒ / ﾘ ＼
| "ｒ,, ｀"'''ﾞ´ ,,ﾐ゛ |
| ﾘ、 ,ﾘ |
| i ゛ｒ、ﾉ,,ｒ" i _|
| ｀ー――----┴ ⌒´ ）
（ヽ ＿＿＿＿＿＿ ,, ＿´）
（_⌒ ＿＿＿＿＿＿ ,, ィ
丁 |
| |

7. 別サービスとやり取りする部分は
どうテストしていますか？

8. スタブを使っている

9. テストも問題なかったのに
リリースしたら動かなくなった！
おい！？
APIの仕様すこし変えましたよ
API担当
サービス
担当
• 上みたいなのが頻発するとアレ
• APIに破壊的変更が発生すると該当箇所を洗い出してスタブを作り直す必要がある

10. E2Eテスト

11. シンプルな頃はよかった

12. 世は正にマイクロサービス時代
• 環境用意が大変（DBの用意とか、テスト失敗したときの挙動とか）
• 何も変更を加えてないのにテストが落ちた
• もう一度走らせたら成功した（？
• ピタゴラスイッチすぎて良くわからないことになる

13. というわけでCDC testingしてみました

14. CDCテストとは
• CDCとはConsumer-Driven Contract testing (CDC testing)
• CDC testing では、API利用側（Consumer）が期待している
APIの動きを書いておいて、API提供側に「期待する振る舞い」
(Contract)渡します。
• API提供側(Provider)は渡された「期待する振る舞いのデータ」
を満たしていることを検証することで破壊的変更が無いことを
確認できます。
Consumer Provider
Contract
Contract通りの振る舞
いを出来てるかテスト
します！！
どのAPIのどの要素を
使っているか、どうい
う振る舞いが望ましい
かをContractに書いた
からね！！

15. Pact
PactとはCDC testing を実現するためのライブラリです。
各種言語(ruby, php, node, jvm, js, python, go…)が用意されています。
https://github.com/pact-foundation

16. Contractファイルはどのように渡すか

17. Pact Broker
契約ファイルのやり取りを仲介する
どのサービスがどのAPIを実行しているのか契約ベースで可視化できる

18. pact-goを使ってCDC testingを書いてみた
• pact-goは2018年5月にv1.0.0となった
• 現状はサンプルがが古い記述のままなのかそのままでは動作し
ない。。
（Go合宿中にslackで問い合わせたら直してくれました！）
• 古いサンプルを参考に書き直した

19. 今回作ったサンプル
Response: text
そうだね！
サーバルちゃんだね！
Response: json
{
id: 1,
name: serval
}
Request:
GET /api/v1/animal/1
Request:
GET /animal/1
ProviderConsumer
https://github.com/dorako321/pact-go-simple-example

20. comsumer_test.go

21. Contract ( pact file )

22. provider_test.go

23. • pact.go:314: Verifying a pact between MyConsumer and MyProvider Given
Serval exists A request to get serval info with GET /api/v1/animal/1 returns a
response which has status code 200
• pact.go:314: Verifying a pact between MyConsumer and MyProvider Given
Serval exists A request to get serval info with GET /api/v1/animal/1 returns a
response which has a matching body
• pact.go:314: Verifying a pact between MyConsumer and MyProvider Given
Serval exists A request to get serval info with GET /api/v1/animal/1 returns a
response which includes headers "Content-Type" which is an instance of String

24. • pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A
request to get serval info with GET /api/v1/animal/1 returns a response which has status code
200
• pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A
request to get serval info with GET /api/v1/animal/1 returns a response which has a matching
body
• pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A
request to get serval info with GET /api/v1/animal/1 returns a response which includes headers
"Content-Type" which is an instance of String

25. pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A request to get serval info with GET
/api/v1/animal/1 returns a response which has status code 200
pact.go:316: Verifying a pact between MyConsumer and MyProvider Given Serval exists A request to get serval info with GET
/api/v1/animal/1 returns a response which has a matching body
Actual: {"id":1,"real_name":"サーバル"}
Diff
--------------------------------------
Key: - is expected
+ is actual
Matching keys and values are not shown
{
- "name": "サーバル"
}
Description of differences
--------------------------------------
* Could not find key "name" (keys present are: id, real_name) at $
pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A request to get serval info with GET
/api/v1/animal/1 returns a response which has a matching body
pact.go:314: Verifying a pact between MyConsumer and MyProvider Given Serval exists A request to get serval info with GET
/api/v1/animal/1 returns a response which includes headers "Content-Type" which is an instance of String

26. まとめ
• CDC testingでAPIの仕様変更により影響を受けるサービス・箇
所を判断できるようになる。
• GoでもpactでCDC testingできそう
• APIのレスポンスを破壊的変更するときは
利用側と十分に調整しましょう