Downloaded 19 times
![io.codearte.accurest.dsl.GroovyDsl.make { request { method 'GET' urlPath '/foos' } response { status 200 body("""[ { "value" : 42 }, { "value" : 100 } ]""") headers { header('Content-Type': 'application/json;charset=UTF-8') }}} Contract DSL](https://image.slidesharecdn.com/2016-06-08m3-tech-meetupconsumer-driven-contracts-160608114453/75/Consumer-Driven-Contracts-REST-API-m3tech-23-2048.jpg)
![{ "uuid" : "d0c6c40b-47a8-4504-967d-b470f382d820", "request" : { "urlPath" : "/foos", "method" : "GET" }, "response" : { "status" : 200, "body" : "[{¥"value¥":42},{¥"value¥":100}]", "headers" : { "Content-Type" : "application/json;charset=UTF-8" } } } WireMock形式に変換Consumer側](https://image.slidesharecdn.com/2016-06-08m3-tech-meetupconsumer-driven-contracts-160608114453/75/Consumer-Driven-Contracts-REST-API-m3tech-28-2048.jpg)
Consumer Driven Contractsで REST API/マイクロサービスをテスト #m3tech
- 1. Consumer Driven Contractsで RESTAPI/マイクロサービスをテスト Toshiaki Maki (@making) Sr. Solutions Architect @Pivotal 2016-06-08 M3 Tech Meetup
- 2. Who am I? •Toshiaki Maki (@making) •https://blog.ik.am •Sr. Solutions Architect •Spring Framework enthusiast Spring Framework 徹底⼊⾨ (Coming Soon?) パーフェクト Java EE (Coming Soon?)
- 3.
- 4.
- 5.
- 6.
- 7.
- 8.
- 9.
- 10. Team BTeam A 現実世界（とあるトイレでの会話） 😕😗 おたくのチームのAPI 使ってテストするの に時間かかったよ〜
- 11. Team BTeam A 現実世界（とあるトイレでの会話） 😕😗 おたくのチームのAPI 使ってテストするの に時間かかったよ〜 お、いいね。 でも、さっきAPI変え ちゃったよ。
- 12. Team BTeam A 現実世界（とあるトイレでの会話） 😕😗 おたくのチームのAPI 使ってテストするの に時間かかったよ〜 お、いいね。 でも、さっきAPI変え ちゃったよ。 😡 あの💢
- 13.
- 14. Consumer Driven Contract (CDC) •http://martinfowler.com/articles/consumerDrivenContracts.html •アーキテクチャレベルのTDD •"Contract"を通じて、ConsumerがProviderに期待内 容を共有する •ProviderのContract違反をProvider側のテストで検出 Consumer ProviderContract
- 15. CDCの流れ 1. Consumerは期待するリクエスト/レスポンスをContractと して定義 (DSLなどを利⽤) 2. ProviderはConsumerとContractを合意 (PullRequestなどを利⽤) 3. ProviderはContractが守られていることを⽰すテストを実施 ConsumerはContractを前提にモック化してテストを実施
- 16. CDC⽤ライブラリ • Pact-JVM • https://github.com/DiUS/pact-jvm •Pactは多⾔語(Ruby, .NET, Go, JS, Swift, etc)に対応 • Accurest • https://github.com/Codearte/accurest • Spring MVC向け • Eureka, Spring Integration, Spring Cloud Streamにも対応している • 今後Spring Cloud Contractという名前になるかも？
- 17.
- 18. Accurest • DSLにGroovyを使⽤ • Provider向けにRestAssuredとJSON Assertを使ったテストを⽣成 (JUnitor Spock) • Consumer向けにWireMock⽤のスタブ ファイルを⽣成 • Consumerのテストにスタブサーバーを 組み込める 図は http://codearte.github.io/accurest より
- 19.
- 20. Contract DSL テスト ケース スタブ ファイル Consumer Provider RestAssured +JSON Assertなコード⽣成 WireMock⽤のスタブ ファイルを⽣成
- 21. Contract DSL テスト ケース スタブ ファイル Consumer Provider RestAssured +JSON Assertなコード⽣成 WireMock⽤のスタブ ファイルを⽣成 Providerの破壊的な変更によ るContract違反を検出可能
- 22. Accurest Maven Plugin $mvn accurest:convert $ mvn accurest:generateTests $ mvn accurest:run $ mvn accurest:generateStubs Provider向け Consumer向け テストコードを⽣成 WireMock形式に変換 モックサーバーを起動 モックのjarを⽣成
- 23. io.codearte.accurest.dsl.GroovyDsl.make { request { method'GET' urlPath '/foos' } response { status 200 body("""[ { "value" : 42 }, { "value" : 100 } ]""") headers { header('Content-Type': 'application/json;charset=UTF-8') }}} Contract DSL
- 24. public class AccurestTestextends MvcTest{ @Test public void validate_requestForFoos() throws Exception { MockMvcRequestSpecification request = given(); ResponseOptions response = given().spec(request).get("/foos"); assertThat(response.statusCode()).isEqualTo(200); assertThat(response.header("Content-Type")) .isEqualTo("application/json;charset=UTF-8"); DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); assertThatJson(parsedJson).array().contains("value") .isEqualTo(42); assertThatJson(parsedJson).hasSize(2); assertThatJson(parsedJson).array().contains("value") .isEqualTo(100); }} テストコードを⽣成Provider側
- 25. public class AccurestTestextends MvcTest{ @Test public void validate_requestForFoos() throws Exception { MockMvcRequestSpecification request = given(); ResponseOptions response = given().spec(request).get("/foos"); assertThat(response.statusCode()).isEqualTo(200); assertThat(response.header("Content-Type")) .isEqualTo("application/json;charset=UTF-8"); DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); assertThatJson(parsedJson).array().contains("value") .isEqualTo(42); assertThatJson(parsedJson).hasSize(2); assertThatJson(parsedJson).array().contains("value") .isEqualTo(100); }} テストコードを⽣成 親クラスを 指定可能 Provider側
- 26. public class MvcTest{ @Before public void setup() { RestAssuredMockMvc .standaloneSetup( new FooController()); } } テストコードを⽣成Provider側
- 27. public class MvcTest{ @Before public void setup() { RestAssuredMockMvc .standaloneSetup( new FooController()); } } テストコードを⽣成Provider側 MockMVCでも 組み込みサーバーでも可
- 28. { "uuid" : "d0c6c40b-47a8-4504-967d-b470f382d820", "request": { "urlPath" : "/foos", "method" : "GET" }, "response" : { "status" : 200, "body" : "[{¥"value¥":42},{¥"value¥":100}]", "headers" : { "Content-Type" : "application/json;charset=UTF-8" } } } WireMock形式に変換Consumer側
- 29. $ mvn accurest:convertaccurest:run Consumer側
- 30. $ mvn accurest:generateStubsinstall or deploy Consumer側 myprovider-0.0.1-SNAPSHOT-stubs.jarが Mavenレポジトリにデプロイされる
- 31.
- 32.
- 33.
- 34.
- 35.
- 36. CDCのメリット • クライアントが求めているリクエスト/レスポンスを知れる • Contractに違反があれば(APIの互換性が崩れたら)テスト が失敗する •テストが⾃動⽣成されるためメンテナンスしやすい • 新しいAPIが追加されればすぐにモックサーバーに反映で きる
- 37. CDC(Accurest)のデメリット • Consumer側のテストが、 WireMock起動のため重くなり やすい →テストがちょっと億劫に •まだ開発途上で、時々⽣成されたコードが壊れている →issueをあげよう
- 38. References • Consumer DrivenContractsについて • http://martinfowler.com/articles/consumerDrivenContracts.html • http://www.slideshare.net/MarcinGrzejszczak/stick-to-the- rules-consumer-driven-contracts-201507-confitura • http://toomuchcoding.com/blog/2016/04/30/accurest-and- stub-runner-1-dot-1-0-dot-m3/ • CDC⽤ライブラリ • http://codearte.github.io/accurest/ • サンプル • https://github.com/making/microservices-accurest • https://github.com/Codearte/accurest-samples
- 39. Announce http://pivotal-japan.connpass.com Pivotal Japan TechnicalMeetup 2016/06/29(Wed) 18:30-