Spring Bootで作成したAPIテストのコスパを高めよう！

JJUC CCC 2024 Spring

APIを作った際、curlコマンドやgrpcurlコマンドを使って動作確認をしていました。しかし、OpenAPIやgRPCを利用してAPIを作っている場合においてシナリオテストを導入すると、とても素早くしかもコマンドで確認するより正確なテストができました。

このセッションでは、OpenAPIまたはProtocol BuffersをつかったgRPCをSpring Bootで実装されたAPIに対してどのようにシナリオテストを行うのか、シナリオテストによって得られるメリット・デメリットについてお話しします。

Transcript

1. SpringBootͰ࡞੒ͨ͠ APIςετͷίεύΛߴΊΑ͏ʂ 2024/06/16 JJUG CCC 2024 Spring ݀Ҫ ྯ(Satoshi Anai)
2. ࣗݾ঺հ • ݀Ҫ ྯ(͞ͱ͠) • ෱Ԭ͔Βདྷ·ͨ͠ʢॳࢀՃͰ͢ʣ • X(چTwitter): @gorou_178 • Bluesky: gorou178.bsky.social • ۚ༥ܥͰEMͯ͠·͢ • εΩϧ: GCP/Java/Kotlin/PHP/AWS • ίʔώʔ/ϓϦϯ/θϧμ/ϥϯχϯά
3. ͸͡ΊΔલʹ • ͜ͷεϥΠυ͸͢Ͱʹެ։͍ͯ͠·͢ • X(چTwitter)ͷϋογϡλάʹͯӾཡ͍ͩ͘͞ • ίʔυ͸ҎԼϦϙδτϦʹެ։͍ͯ͠·͢ • gorou-178/petapi - GitHub • gorou-178/grpc-springboot-example - GitHub • ϑΟʔυόοΫ͍͚ͨͩΔͱ͏Ε͍͠Ͱ͢ʂʂ
4. ΰʔϧ • APIΛrunnίϚϯυͰγφϦΦςετ͢Δํ๏͕ཧղͰ͖Δ • APIͷγφϦΦςετ͸ɺΧόϨοδܭଌͱܕνΣοΫͰςετ ͷίεύΛߴΊΒΕΔ
5. Noΰʔϧ • OpenAPI΍gRPCͷٕज़తͳৄࡉ • ࡉ͔ͳςετख๏ʹ͍ͭͯ
6. E2Eςετ͍ͯ͠·͔͢ʁ🙋
7. E2Eςετ • ४උ͕େมͰͰ͖͍ͯͳ͍ • ΍Γ͍͚ͨͲͰ͖͍ͯͳ͍ • ݱঢ়ͷςετͰे෼ػೳ͍ͯ͠Δ • ͲͷΑ͏ʹಋೖ͢΂͖͔Θ͔Βͳ͍
9. ίετ͕ߴ͍
10. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=45
11. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=47
12. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=34
13. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=34 ͜ͷ͋ͨΓͷςετΛ
14. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=34 ͜͜ʹ࣋ͬͯ
    ߦ͖͍ͨʂ
15. ίεύͷྑ͍ςετ • খ͍͞γεςϜʹରͯ͠
16. ίεύͷྑ͍ςετ • খ͍͞γεςϜʹରͯ͠ • ୯ҰϚγϯͰ؆୯ʹಈ͔ͤ
17. ίεύͷྑ͍ςετ • খ͍͞γεςϜʹରͯ͠ • ୯ҰϚγϯͰ؆୯ʹಈ͔ͤ • ςετ͕࡞Γ΍͍͢
18. ίεύͷྑ͍ςετ • খ͍͞γεςϜʹରͯ͠ • ୯ҰϚγϯͰ؆୯ʹಈ͔ͤ • ςετ͕࡞Γ΍͍͢ • ࣗಈతʹςετ͕࣮ߦ͞ΕΔ
19. ςετ͕؆୯Ͱ͖Ε͹Α͍ʁ
20. ςετ͕؆୯Ͱ͖Ε͹Α͍ʁ ੈͷதͦΜͳʹ؁͘ͳ͍
21. αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ https://speakerdeck.com/twada/automated-test-knowledge-from-savanna-202305-edition?slide=34
22. ৴པෆೳੑʹཱͪ޲͔͏ • ςετͷ৴པੑ͕େࣄ 
 →͢͹΍͍ϑΟʔυόοΫϧʔϓΛ·ΘͤΔ 
 →؆୯ʹ࣮ߦͰ͖Δ͜ͱ΍ࣗಈԽ͸ͱͯ΋େࣄ
23. ίεύͷྑ͍ςετʢ࠶ܝʣ • খ͍͞γεςϜʹରͯ͠ • ୯ҰϚγϯͰ؆୯ʹಈ͔ͤ • ςετ͕࡞Γ΍͍͢ • ࣗಈతʹςετ͕࣮ߦ͞ΕΔ
24. ίεύͷྑ͍ςετʢ࠶ܝʣ • খ͍͞γεςϜʹରͯ͠ → API • ୯ҰϚγϯͰ؆୯ʹಈ͔ͤ • ςετ͕࡞Γ΍͍͢ • ࣗಈతʹςετ͕࣮ߦ͞ΕΔ
25. APIͷςετ
26. APIͷςετ • Postman • JMeter • locust • K6 • Cypress • etc…
27. APIͷςετ • Postman → ಠࣗUI(JSON) • JMeter → ಠࣗUI(jmxϑΝΠϧ) • locust → Python • K6 → JavaScript(goja) • Cypress → JavaScript • etc…
28. πʔϧ࡞੒ͷͨΊʹݴޠґଘ͕͋Δ →Ұఆͷֶशίετ͕͔͔Δ
29. APIͷςετ • curl΍grpcurlΛར༻
30. APIͷςετ • curl΍grpcurlΛར༻ 
 →ύϥϝʔλଟͯ͘ࢦఆ໘౗
31. APIͷςετ • curl΍grpcurlΛར༻ 
 →ύϥϝʔλଟͯ͘ࢦఆ໘౗ 
 →OSʹΑͬͯΤεέʔϓจࣈ͕ҟͳΓେม
32. APIͷςετ • curl΍grpcurlΛར༻ 
 →ύϥϝʔλଟͯ͘ࢦఆ໘౗ 
 →OSʹΑͬͯΤεέʔϓจࣈ͕ҟͳΓେม • खಈςετʢେมʣ
33. ΋ͬͱαΫοͱ࡞Γ͍ͨʂʂ
35. runnίϚϯυ • ಡΈํʮϥϯΤψʯ • ΦϖϨʔγϣϯࣗಈԽπʔϧ k1LoW/runn - GitHub • γφϦΦϑΝΠϧΛyamlܗࣜͰॻ͍ͯγφϦΦΛ࣮ߦͰ͖Δ • HTTPϦΫΤετɺgRPCϦΫΤετɺ೚ҙͷίϚϯυ࣮ߦ… • ͍ΖΜͳػೳ͕͋Δ
36. runnίϚϯυ • γφϦΦςετ͚ͩͰ͸ͳ͍ • ΧόϨοδܭଌ • ෛՙςετ΋Մೳ
37. Ϣʔεέʔε঺հ
38. 1. SpringBoot + OpenAPI
39. 1. SpringBoot + OpenAPI • SpringBoot(Java)ͱOpenAPIΛར༻ͯ͠APIΛ࡞੒ • Swagger(yaml)ΛϕʔεʹrunnͰςετͰ͖ΔΑ͏ʹ͢Δ
40. ެࣜαϯϓϧʮPetstore SampleʯΛ׆༻ OpenAPI(Swagger)Λ४උ
41. openapi-generator-cliΛdocker͔Βར༻ͯ͠ 
 OpenAPI͔Βιʔείʔυੜ੒ OpenAPI͔Βιʔείʔυੜ੒ docker run --rm \ -v "${PWD}/build/openapi:/out" \ openapitools/openapi-generator-cli:v7.3.0 generate \ --generator-name spring \ --input-spec "${PWD}/petstore.yaml" \ --output /out
42. ੜ੒ͨ͠ίʔυΛར༻ͯ͠APIΛ࣮૷ APIΛ࣮૷ @Controller @RequestMapping("/pet") public class PetController implements PetApi { @PostMapping("/") @Override public ResponseEntity<Pet> addPet(Pet pet) { return ResponseEntity.ok(new Pet("addDog", Collections.emptyList())); } @DeleteMapping("/") @Override public ResponseEntity<Void> deletePet(Long petId, String apiKey) { return ResponseEntity.ok().build(); }
43. ҎԼͷ༷ͳγφϦΦΛ࡞੒(pet-api-runn.yml) runnͷrunnbook(γφϦΦϑΝΠϧ)࡞੒ desc: "pet api test" runners: req: endpoint: http://localhost:8080 openapi3: ./petstore.yaml steps: getPets: req: /pet/123: get: headers: Accept: application/json body: null test: steps.getPets.res.status == 200
44. ໰୊ͳ͚Ε͹ҎԼͷ༷ʹͳΔ runnͷγφϦΦ࣮ߦʢςετʣ $ runn run pet-api-runn.yml . 1 scenario, 0 skipped, 0 failures
45. APIυΩϡϝϯτͷΧόϨοδΛදࣔ 
 ͲͷAPI͕ςετͰ͖͍ͯͳ͍͔͸ "—long" ΦϓγϣϯͰදࣔՄ runn coverage $ runn coverage pet-api-runn.yml Spec Coverage -------------------------------------- Total 5.0% OpenAPI Petstore:1.0.0 5.0%
46. APIυΩϡϝϯτͷϨεϙϯε࢓༷ͱҟͳΔϨεϙϯεΛ 
 ฦͨ͠৔߹ɺΤϥʔʹͳͬͯৄࡉ͕දࣔ͞ΕΔ runn OpenAPI3 check $ runn run pet-api-runn.yml F 1) pet-api-runn.yml xxxxxxxxxxxxxxxx Failure/Error: http request failed on "pet api test".steps.getPets: openapi3 validation error: response body doesn't match schema #/components/schemas/Pet: Error at "/tags": Value is not nullable
47. 2. SpringBoot + gRPC
48. 2. SpringBoot + gRPC • SpringBoot(Kotlin) + gRPCͰAPIΛ࡞੒ • ProtocolBufferΛར༻ͯ͠runnͰςετ͢Δ • Buf CLIΛར༻ͯ͠ίʔυੜ੒
49. Buf CLI • Buf͕࡞ͬͨprotobufͷ։ൃΛࢧԉ͢Δπʔϧ • Ͱ͖Δ͜ͱ • protobufͷlint • protobufͷഁյతมߋݕ஌ • protobuf͔Βͷίʔυੜ੒ • etc
50. protobufΛ࡞੒ syntax = "proto3"; option java_package = "com.example.grpc.server.greeter"; option java_outer_classname = "Greeter"; message HelloRequest { string name = 1; } message HelloReply { string message = 1; } service GreeterService { rpc SayHello (HelloRequest) returns (HelloReply) {} }
51. gRPC Code Generate • Buf CLIͰgRPCίʔυੜ੒ • KotlinͰಈ͔͢৔߹ɺJavaίʔυͱkotlinίʔυͷੜ੒͕ඞཁ
52. buf.ymlΛ࡞੒ version: v1 breaking: use: - FILE lint: use: - DEFAULT allow_comment_ignores: true
53. buf.gen.ymlΛ࡞੒ protocolbuffers͸͋͑ͯv25.1Λࢦఆ(ഁյతมߋ͕͋ΔͨΊ) version: v1 plugins: - plugin: buf.build/grpc/java out: src/main/java - plugin: buf.build/grpc/kotlin out: src/main/kotlin - plugin: buf.build/protocolbuffers/java:v25.1 out: src/main/java - plugin: buf.build/protocolbuffers/kotlin:v25.1 out: src/main/kotlin
54. gRPCίʔυΛੜ੒ • buf.gen.ymlͷઃఆͰίʔυΛੜ੒ • ࠓճ͸Javaͱkotlinίʔυ͕ੜ੒͞ΕΔ $ buf generate
55. ੜ੒͞Εͨίʔυ ੜ੒͞Εͨ Javaͱkotlinίʔυ
56. gRPCαʔϏεΛ࡞੒ • ੜ੒͞ΕͨίʔυΛܧঝͯ͠த਎Λ࣮૷ class GreeterService : GreeterServiceGrpc.GreeterServiceImplBase() { override fun sayHello( request: Greeter.HelloRequest, responseObserver: StreamObserver<Greeter.HelloReply>) { val reply = Greeter.HelloReply.newBuilder().apply { message = "Hello ${request.name}" }.build() responseObserver.onNext(reply) responseObserver.onCompleted() } }
57. runnγφϦΦϑΝΠϧΛ࡞੒ ϦΫΤετ/Ϩεϙϯε͔Βੜ੒Ͱ͖Δ runn newίϚϯυ 
 localhostͩͱTLSΤϥʔ͕ग़ΔͨΊ —grpc-no-tlsΛ෇༩ $ runn new —grpc-no-tls --out test-runn.yml -- grpcurl \ -d '{"name": "abc"}' localhost:9090 GreeterService/SayHello $ cat test-runn.yml desc: Generated by `runn new` runners: greq: grpc://localhost:9090 steps: - greq: GreeterService/SayHello: message: name: abc
58. γφϦΦςετ΋ࣗಈੜ੒ • runn new —and-run Ͱඞཁ࠷௿ݶͳςετ΋ग़ྗ $ runn new --and-run --grpc-no-tls --out test-runn.yml \ -- grpcurl -d '{"name": "test"}' localhost:9090 GreeterService/SayHello $ cat test-runn.yml desc: Generated by `runn new` runners: greq: grpc://localhost:9090 steps: - greq: GreeterService/SayHello: message: name: abc test: | current.res.headers["content-type"][0] == "application/grpc" && current.res.headers["grpc-accept-encoding"][0] == "gzip" && compare(current.res.message, {"message":"Hello abc"}) && current.res.status == 0
59. γφϦΦͷ࣮ߦ runn runͰγφϦΦͷ࣮ߦ͕Ͱ͖Δ 
 γϯάϧόΠφϦʔͳͷͰCI΁ͷ૊ΈࠐΈ΋ָ $ runn run --grpc-no-tls test-runn.yml . 1 scenario, 0 skipped, 0 failures
60. runnΛར༻͢Δ͜ͱͰ • Spec(OpenAPI/Protocol Buffer)Λ࡞੒ • ίʔυੜ੒ͯ͠ͻͱ·ͣಈ͘ঢ়ଶʹ͢ΔʢΤϥʔঢ়ଶͰΑ͍ʣ • runn newͰγφϦΦςετΛ࡞Δ • ࣮૷ͱςετͱϦϑΝΫλϦϯάΛ܁Γฦ͢ 
 →ϑΟʔυόοΫϧʔϓΛճͤΔ
61. runnͷϝϦοτ • ݴޠඇґଘ(yamlϑΝΠϧͰಈ͔ͤΔ) • ఆٛϑΝΠϧͱͷ੔߹ੑΛอͯΔ • खܰ͞ʢ࠷௿ݶͷγφϦΦΛૉૣ͘࡞ΕΔʣ • ࡉ͔͍νΣοΫ͸ޙͰϝϯς͍ͯ͜͠͏ • ࣗಈԽͷ͠΍͢͞ʢγϯάϧόΠφϦʔʣ
62. runnͷσϝϦοτ • ձࣾɺνʔϜͰར༻͍ͯ͠Δςετπʔϧ͕͢Ͱʹ͋Γɺ৐Γ ׵͑Δͷ͕େม • ෳ਺ͷίϯϙʔωϯτͷґଘؔ܎͕͋Δ৔߹ɺϞοΫ΍ελϒ Λ४උ͢Δඞཁ͕͋Δ
63. runnҎ֎ͷબ୒ࢶ • ձࣾɾνʔϜͷن໛ʹΑͬͯςετࣗಈԽαʔϏεಋೖΛݕ౼ • ελϒͷ४උ·Ͱͯ͘͠ΕΔπʔϧΛબͿ • ͳͲͳͲʢঢ়گʹΑΔʣ
64. ·ͱΊ
65. ·ͱΊ • E2EͷಋೖίετΛԼ͛ɺ؆୯ʹςετ͕Ͱ͖ΔrunnίϚϯυ • ݴޠඇґଘͰCIϑϨϯυϦʔ • ΧόϨοδͷܭଌɺܕνΣοΫͰϑΟʔυόοΫϧʔϓΛૣ͘ ճ͠΍͍͢ 
 →ίεύ͕ྑ͍
66. ΰʔϧ • APIΛrunnίϚϯυͰγφϦΦςετ͢Δํ๏͕ཧղͰ͖Δ • APIͷγφϦΦςετ͸ɺΧόϨοδܭଌͱܕνΣοΫͰςετ ͷίεύΛߴΊΒΕΔ 
 →APIͷϑΟʔυόοΫαΠΫϧ͕ૣ͘ͳΔ͜ͱΛظ଴
67. ͋Γ͕ͱ͏͍͟͝·ͨ͠🐶
68. ࢀߟURL • k1LoW/runn - GitHub • runnΫοΫϒοΫ • Quick Start Kotlin - gRPC • BufͱProtobufͰ࢝ΊΔϞμϯgRPC։ൃ • αόϯφศΓʙࣗಈςετʹؔ͢Δ࿈ࡌͰಘΒΕͨ஌ݟͷ·ͱΊʢ2023೥5݄൛ʣ • Buf CLI • https://circleci.com/blog/testing-pyramid/ • https://github.com/bufbuild/protovalidate • Protocol Buffers v26.0 ͷഁյతมߋ - qiita