API通信周りの継続的なテストの仕組みについて、DevOps懇親会というイベントでLTした際の資料です。

1. © 2015 Actcat, Inc. 1
API通信周りの継続的なテストの仕組み
SideCIでの実践
β

2. [Confidential] © 2013 Actcat, Inc.
軽く自己紹介
すみ です
n 「SideCI」というサービスを
開発しているエンジニアです。
言語歴:
Ruby
>
Obj-­‐C
>
Java
>
PHP,
etc…
n Twitter:
@sumyapp
Facebook:
sumyapp
2

3. [Confidential] © 2013 Actcat, Inc.
What is SideCI?
Integration:
Open
Source
Software
+
Docker
+
GitHub
>
Automated
Code
Review
and
Test
and
Delivery
3

4. [Confidential] © 2013 Actcat, Inc.
How does it works?
4
hook

5. [Confidential] © 2013 Actcat, Inc. 5
GitHub上にSideCIがインラインコメント
プログラムとコラボした開発が出来る

6. [Confidential] © 2013 Actcat, Inc.
Jenkinsなどを使っている方に朗報！
6
Test
and
Deploy

7. [Confidential] © 2013 Actcat, Inc. 7
使ってみてね！

8. [Confidential] © 2013 Actcat, Inc. 8
本題 API通信周りの継続的なテストの仕組み

9. [Confidential] © 2013 Actcat, Inc.
サービス構築にはAPIを作るのが一般的
9
API
API
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
"type":
"integer"
},
"firstName":
{
"type":
"string”
役割毎にサーバ
分離パターン
Server-­‐Client
パターン
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
"type":
"integer"
},
"firstName":
{
"type":
"string”

10. [Confidential] © 2013 Actcat, Inc.
APIのレスポンス値を変更すると…
10
API
API
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
“min”:9,
"type":
"integer"
},
"firstName":
{
"type":
"string”
役割毎にサーバ
分離パターン
Server-­‐Client
パターン
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
“min”:9,
"type":
"integer"
},
"firstName":
{
"type":
"string”
APIのデータ
のkeyを変更。
短い方が良い
よね！

11. [Confidential] © 2013 Actcat, Inc.
APIのレスポンス値を変更すると…
11
API
API
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
“min”:9,
"type":
"integer"
},
"firstName":
{
"type":
"string”
役割毎にサーバ
分離パターン
Server-­‐Client
パターン
{
"properties":
{
"age":
{
"description":
"Age
in
years",
"minimum":
0,
“min”:9,
"type":
"integer"
},
"firstName":
{
"type":
"string”
え、いきなり
動かなくなっ
たんだけど…

12. [Confidential] © 2013 Actcat, Inc. 12
SOLUTION

13. [Confidential] © 2013 Actcat, Inc.
簡単な3 Step と CI で問題発生を防止
1. API仕様を固める（JSONも）
2. サーバとアプリでテスト通信、
通信時のリクエスト・レスポンスを
ファイルに記録する
3. 記録したファイルを使った
テストコードをサーバ側に書く
+
上記のテストをCIでまわす
13

14. [Confidential] © 2013 Actcat, Inc.
1. API仕様を固める（JSONも）
SideCI内での一例:
n URL:
l POST
"/task/register"
n Header:
l 指定なし
n Body:
l JSONで下記を送付する
l id:
タスクID（タスク識別用）
l type:
タスクタイプ（rubocop,
rails_best_practice,
brakeman,
bundle_outdated）
14

15. [Confidential] © 2013 Actcat, Inc.
2. サーバとアプリでテスト通信、
通信時のリクエスト・レスポンスを
ファイルに記録する
1. サーバをローカルで起動(本番でも可)
2. アプリからのリクエストをログ等で確認
3. Header,
Request
Bodyなどを記録
4. Responseなどを記録
15

16. [Confidential] © 2013 Actcat, Inc.
記録した一例
(SideCI<-GitHub)
{
"sha":
"4e73f2ef6d3534b45bbdf220f060d2628c5952e5",
"commit":
{
"author":
{
"name":
”Koichiro
Sumi",
"email":
”koichiro.sumi@actcat.co.jp",
"date":
"2014-­‐02-­‐14T09:46:50Z"
},
"committer":
{
"name":
"Koichiro
Sumi",
"email":
"koichiro.sumi@actcat.co.jp",
"date":
"2014-­‐02-­‐14T09:46:50Z”,
16
JSONファイルとして保存

17. [Confidential] © 2013 Actcat, Inc.
記録した一例
(SideCI<-GitHub)
request.url
"/api/v1/github_repositories/hook/”
request.headers['X-­‐GitHub-­‐Event']
=
'pull_request’
request.headers['X-­‐GitHub-­‐Delivery']
=
'cd36a080-­‐
b5a8-­‐11e4-­‐9e0d-­‐q1024663ce0’
request.headers['User-­‐Agent']
=
'GitHub-­‐Hookshot/e9dfd89’
request.headers['content-­‐type']
=
'application/x-­‐www-­‐form-­‐
urlencoded’
17
Requestをメモしておく。Responseも

18. [Confidential] © 2013 Actcat, Inc.
記録したファイルを使った
テストコードをサーバ側に書く
n APIはおそらくController？なので、その
Controllerのテストコードを書こう
n リクエストに先ほどメモしたリクエストヘッ
ダーやボディを設定、クライアントを装って
Controllerにリクエストを送るコード
n そのレスポンスが、サーバ・アプリ間で動作
確認を行った、正しく動作するレスポンスと
同一であることを確認する
18

19. [Confidential] © 2013 Actcat, Inc.
Rspecでどう書くか？
SideCIの一例
let(:params)
{
{
"payload"
=>
payload_basic
}
}
let(:headers)
{
{
"User-­‐Agent"
=>
"GitHub-­‐Hookshot/2e7s9",
"Content-­‐Type"
=>
"application/x-­‐www-­‐form-­‐urlencoded",
"Content-­‐Length"
=>
"10163",
"X-­‐GitHub-­‐Event"
=>
"push"
}
}
let(:payload_basic
)
{
File.open('spec/basic.json').read
}
describe
"POST
'hook'"
do
…(一部省略)…
19

20. [Confidential] © 2013 Actcat, Inc.
テストをCIでまわす
n 作ったテストはデプロイ前にかならずテ
スト実行。面倒だったらCIで回しましょう
n CIサービスの一例
l Jenkins…はセットアップが面倒なので,
l SideCI,
CircleCI,
Wercker,
Shippable,
CodeShip,
TravisCI,
etc…
20

21. © 2015 Actcat, Inc. 21
CIサービスならGitHub上でテストステータスを確
認、安心してマージ出来ます

22. © 2015 Actcat, Inc.
+ 可能ならコードレビューも
最後に頼りになるのは人力
n API変更時にはコードをプルリクエストでAPI
通信を行う先の担当のエンジニアにもレ
ビューして貰いましょう
n うかつなAPI変更による障害防止には
l 仕様をしっかり決めて、APIを変えられなく
する
l 変えるとテストがFailedして気づくようにす
る
l テスト・実装共変えた場合は人力レビュー
この３つの手段がおすすめだと思います
22

23. © 2015 Actcat, Inc.
SideCI Customers
GitHub
+
Railsな開発体制のプロジェクトで
ご利用頂いております
n 50以上のプロジェクトが毎週ご利用
n 1週間に500~1000回、SideCIがユーザの
プロジェクトのコードにコメント
23

24. © 2015 Actcat, Inc. 24
https://www.sideci.com/