外部APIが絡むテストをちょっといい感じに書く/a-little-nice-writing-external-api-testing

1. 外部API が絡む テストを ちょっといい感じに 書く 森塚 真年(@sanfrecce_osaka) 2025/02/26 Kyobashi.rb#5 #kyobashirb
2. 自己紹介 森塚 真年 GitHub: @sanfrecce-osaka Twitter(X) ・Qiita: @sanfrecce_osaka 趣味: コミュニティ・勉強会 Machida.rb(next: 2/7( 金)) Hirakata.rb(next: 1/26( 日)) 株式会社GMO エンペイ Ruby3.3.6/Rails7.1( 次は3 月末までに 7.2 に上げ るぞ) Node.js v18/Vue.js 3.3/Vuetify 3.4
3. 本編
4. 外部API 絡むテスト
5. どのように 書いてますか？
6. stub_request(:post, 'https://example.com/') .to_return_json(body: { id: 1, foo: 'bar', baz: true })
7. 1 箇所だけなら まだいいけど…
8. stub_request(:post, 'https://example.com/') .to_return_json(body: { id: 1, foo: 'bar', baz: true }) # ... stub_request(:post, 'https://example.com/') .to_return_json(body: { id: 1, foo: 'piyo', baz: true }) # ... stub_request(:post, 'https://example.com/') .to_return_json(body: { id: 1, foo: 'bar', baz: false }) .to_return_json(body: { error_code: 'EE01' })
9. つらい😇
10. 中には
11. レスポンスが JSON じゃない API
12. stub_request(:post, 'https://example.com/') .to_return(body: URI.encode_www_form( ID: 1, Foo: 'bar', Baz # ... stub_request(:post, 'https://example.com/') .to_return(body: URI.encode_www_form( ID: 1, Foo: 'piyo', Ba # ... stub_request(:post, 'https://example.com/') .to_return(body: URI.encode_www_form( ID: 1, Foo: 'bar', Baz .to_return(body: URI.encode_www_form( ErrorCode: 'EE01' ))
13. つらい😇
14. そこで
15. FactoryBot
16. FactoryBot.define do factory :foo_bar_response, class: Hash do id { 1 } foo { 'bar' } bar { true } initialize_with { attributes.stringify_keys } end end
17. FactoryBot.define do factory :foo_bar_response, class: Hash, traits: %i[success] trait :success do id { 1 } foo { 'bar' } bar { true } end trait :error do transient do id { nil } foo { nil } bar { nil } end
18. stub_request(:post, 'https://example.com/') .to_return_json(body: build(:foo_bar_response)) # ... stub_request(:post, 'https://example.com/') .to_return_json(body: build(:foo_bar_response, foo: 'piyo' } # ... stub_request(:post, 'https://example.com/') .to_return_json(body: build(:foo_bar_response, baz: false }) .to_return_json(body: build(:foo_bar_response, :error, error
19. FactoryBot.define do factory :foo_bar_response, class: 'String', traits: %i[succe trait :success do self.ID { 1 } self.Foo { 'bar' } self.Bar { true } end trait :error do transient do self.ID { nil } self.Foo { nil } self.Bar { nil } end
20. stub_request(:post, 'https://example.com/') .to_return(body: build(:foo_bar_response)) # ... stub_request(:post, 'https://example.com/') .to_return(body: build(:foo_bar_response, Foo: 'piyo' }) # ... stub_request(:post, 'https://example.com/') .to_return(body: build(:foo_bar_response, Baz: false }) .to_return(body: build(:foo_bar_response, :error, ErrorCode:
21. 文字列じゃなくて Hash が欲しい場合 attributes_for(:foo_bar_response) => { ID: id, Foo: foo, Bar:
22. module ExternalApiStubHelper module Hoge module Fuga def mock_hoge_fuga(stub_hoge_fuga: nil, hoge_fuga_respon hoge_fuga_request = stub_request(:post, 'https://examp stub_hoge_fuga ? stub_hoge_fuga.call(hoge_fuga_request end end end end
23. # frozen_string_literal: true module ExternalApiStubHelper include Hoge end
24. vcr
25. こんなことない？ 外部に実際にリクエストしていて CI が遅い どこで呼ばれているかわからない外部 API のリク エスト 最近見つけたやつ: カード情報を消すための trait
26. RSpec.describe 'Foo', type: :request do # ちょっとでも外部の API 叩くなら vcr を true にする # WebMock で stub する前提でもとりあえず true にする describe 'GET xxx', vcr: true do # ... end end
27. VCR.configure do |c| # ... c.default_cassette_options = { # CI では cassette を生成しないようにする record: ENV['CI'] ? :none : :new_episodes, # ... } end
28. ご清聴 ありがとうございました。