11/20 社内勉強会資料

1. 株式会社フレクト
2014/11/20
小西俊司

2. テストがなくて辛い
しかし、仕様がころころ変わるSI案件ではテストをメン テナンスするコストが高すぎる
◦ていうか無理
◦巷間語られるテストの理想はサービスではまだしもSIでは難 しい気がする
◦ていうか仕様変わりすぎ。。。(--
なんとかして楽してテストを作りたい

3. PROTE
https://github.com/shunjikonishi/prote
プロキシーで、テストをなんとかする

4. リバースプロキシの一種
経由する全リクエスト／レスポンスをファイルに保存
◦HOST, Referer等は対象サーバに書き変えている
◦扱いやすいようにheadersとbodyは別ファイルにしている
WebSocketにも対応
同一ブラウザからのリクエストのライブモニタリングが 可能
リクエストを選択してテストをジェネる
リクエスト／レスポンスをインターセプトして一部を置 き換えることも可能

5. Proteの受けたリ クエスト／レスポン スを一部のヘッダ を書き換えて転送
Request
◦Host
◦Origin
◦Referer
Response
◦Location

6. 実装はPlay2
◦activator.jarがプロジェクトルートにあるのでJDKがあればsbtや scalaのインストールは不要
環境変数TARGET_HOSTにテスト対象のホスト名を設定
TARGET_HOSTがhttpsを必要とする場合はhttps.port の指定が必要
◦playが自動的に自己署名証明書を生成
gitclone https://github.com/shunjikonishi/prote.git
cdprote
set TARGET_HOST=xxxx.herokuapp.com
activator –Dhttps.port=9443 run

7. メッセージをローカルにファイル保存しているため 1Dynoでないとちゃんと動かない
◦当然キャプチャしたメッセージは1日(Dyno再起動)で消える
httpsはHerokuのルータがハンドルするので設定不 要
他者のセットアップしたサーバをうかつに実行しては いけない
◦Printlnを仕込むだけであっさりと全情報を盗める
herokucreate –b https://github.com/heroku/heroku-buildpack-scala
gitpush herokumaster
herokuconfig:setTARGET_HOST=xxxx.herokuapp.com

8. localhost:9000で起動している場合
http://localhost:9000/CONSOLE/mainにアクセ スしてライブモニタを起動
◦/CONSOLE/xxxxだけは対象サーバに転送されない
◦「CONSOLE」の部分は環境変数CONSOLE_CONTEXTで設 定可能
http://localhost:/9000/ など任意のパスにアクセ ス
◦対象サーバの画面が表示される
◦ライブモニタには実行されたリクエストの一覧が表示される
◦CORSで複雑なことをしていなければ問題なく動作するはず

9. 同一ブラウザからのリクエストをリアルタイムで参照

10. 各種フィルタ
◦イメージを隠す
◦Js/cssを隠す
◦パスの部分一致でフィルタリング
JSONのprettyPrint
UrlEncodedのデコード
テストの生成
リクエスト／レスポンスを同時に表示するので見やすい
WebSocketが見られるのは便利(ChromeのDevToolで は日本語が化ける)
ネットワークの見られないIE8で特に重宝する

11. 実行するリクエストを選択してテストを生成
現在はJavaScript(Mocha)のテスト生成にのみ対応

12. 選択したリクエストを順次実行し、保存したレスポンス と比較する
◦ステータスコード
◦レスポンスがJsonの場合は保存したBodyと各項目を比較
日付やオートインクリメントの項目があると、あっさり 失敗する(--
◦レコードの新規作成時のキーや作成日は毎回異なるのでそ のままでは使えない
現在WebSocketのテストには未対応
multipart/form-dataにも未対応
◦必要に迫られたら作る

13. テスト生成時にExternal Scriptを指定することで外 部スクリプトを差し込むことができる
varhttp = require("http"),
https = require("https"),
assert = require("chai").assert,
external = require("./custom.js"),
querystring = require("querystring");

14. 拡張ポイントは以下の3つ
◦buildTestData: テストデータをカスタマイズする
◦hookRequest: リクエスト（パラメータ）をカスタマイズする
◦validate: 独自のassertionを行う。Trueを返した場合はデ フォルトの検証はスキップされる
module.exports= {
buildTestData: function(request, data) { return data;},
hookRequest: function(prevResponse, request) { return request;},
validate: function(request, response) { return false;}
}

15. アイテムを新規作成後に削除
varextend = require("extend"),
IGNORE_VALUE = "__IGNORE__";
module.exports= {
buildTestData: function(request, data) {
//新規作成時はキーと日付項目を無視
if (request.path=== "/item/new") {
data = extend(data, {
"id" : IGNORE_VALUE
"updatedatetime" : IGNORE_VALUE
});
}
return data;
},
hookRequest: function(prevResponse, request) {
//削除時はパスのキー部分を変更
if (request.path.indexOf("/item/delete/") === 0) {
request.path= "/item/delete/" + prevResponse.body.newId;
}
return request;
}
}

16. RSpecやJUnit用のテストを独自に作成することが可 能
◦SourceGeneratorの実装クラスを作成し、
◦SourceGeneratorResistryに登録
ただし、Cookieのハンドリングはかなり面倒
◦ほとんどの場合なんらかのワンタイムトークンがあるのでそ れを引き回す必要がある
参考
◦MochaTest.scala.txt
◦MochaTestGenerator.scala
◦MessageWrapper.scala
PullRequestください

17. 以下のフックが可能
◦リクエストをサーバに転送せず独自のレスポンスを返す
◦リクエストをサーバに転送する前に改変
◦サーバから受けたレスポンスを改変してブラウザに返す
Interceptorの使用例
◦フロントエンド開発時にとあるレスポンスの一部だけ変更した ものが欲しいがそれ以外はオリジナルデータを使いたい
◦ログインでユーザ名、パスワードを入力するのが面倒なので 毎回同じテストユーザでログインしたい
◦開発環境のデータを使いつつCSSだけはローカルで編集した い(デザイナー向けに有用)

18. Interceptorの実装クラスを作成し、
InterceptorResistryに登録
参考: SampleInterceptor.scala
packageinterceptors
importmodels.RequestMessage
importmodels.ResponseMessage
traitInterceptor {
//リクエストのフック
//改変したリクエスト、または独自レスポンスを返す
defhookRequest(request: RequestMessage): Either[RequestMessage, ResponseMessage]
= Left(request)
//レスポンスのフック
//改変したレスポンスを返す
defhookResponse(request: RequestMessage, response: ResponseMessage): ResponseMessage
= response
}

19. FileInterceptorをInterceptorResitoryに登録
objectInterceptorRegistry{
…
private vallist: Seq[(Pattern, Interceptor)] = Seq(
"/assets/css/style.css" -> new FileInterceptor("text/css", new File(…)),
".*" -> defaultInterceptor
).map{case (s, v) => (s.r.pattern, v)}
…
}

20. テストの自動生成は思ったより難しい
◦Cookieが超絶面倒だった
◦レスポンスの検証方法は課題(JSON以外もどうにかしたいがノーア イデア)
◦Seleniumとの連携でなんかできそうな気もするがイマイチ思いつ かない
Interceptorはかなり使える
◦当初の予定にはなかったが、社内勉強会での意見を元に実装して みた
◦FLECTでは特にCSS差し替えが使えそう
◦ユースケースが見えてきたらコード編集なしでコンソールから設定 できるようにするかも
カスタマイズ可能なProxyエンジンと考えれば他にも色々 な使い道があるかも
決して悪用してはならない
◦インターネット上でやったらフィッシングです。。。(--
まだまだ発展途上