RSpecでwebhookのテスト方法

Question

環境

• Ruby 2.5
• Rails 5

前提・実現したいこと

WebhookでデータがPOSTされてくるメソッドのテストをしたいのですが、どのようにすればいいか全くアイデアが思いつかず、相談させていただきたいです。。

要件が整理出来ていないまま質問させていただくのは大変恐縮なのですが、
要件としてはWebhookからどのようなJSONが来ているのかさえわかればいいということなのですが、このようなWebhookのテストを経験した方はいますでしょうか？

Answer 1

外部サービスのWebhookからデータがPOSTされてきて、それを捌く処理のテストをしたい、ということですよね？
素直にやるのであれば、送られてくる想定のjsonをテストコード上からPOSTしてやる、というやり方になるかなと思います。

ただ、「何をテストしたいのか」を一度考えてみたほうがいいかもしれません。
テストしたいのは、「POSTでデータを受け取れるのか」よりも、「受け取ったデータをちゃんと捌けるのか」ではないでしょうか？前者はRailsがやってくれる部分なので。
であれば、受け取ったデータを捌いている部分をメソッド化し、それをテストする、という方法もあります。
そうすればPOSTは関係なくなり、そのメソッドにjsonを渡すだけでよくなります。

Comments

[kenny_sayama]

ご回答頂きありがとうございます！
はい外部サービスのWebhookからデータがPOSTされます。

どのようなJSONが外部サービスから返却されているかをテストで確認が出来るようにしたいのですが、この場合どのような方法がありますでしょうか？

[Kta-M]

webhookはサービスによってデータがPOSTされるトリガーが違うので、なんとも言えません。

そもそも「どのようなJSONが外部サービスから返却されているかをテストで確認が出来るようにしたい」という状況がよくわかりません。。

どのようなjsonが来るか分からないのであれば、その外部サービスの仕様書なり、実際に試してみるなりして確認するのが普通ですし、
どのようなjsonが来るか分かっていて、テストをするときにその外部サービスが想定通りのjsonを返してくれるかを確認したいのであれば、テストではなく定期的に確認する何かを作ったほうがいいと思います（真っ当な外部サービスであれば勝手にjsonを変えることはないと思うので、そもそもそんな必要はないと思いますが）。

[kenny_sayama]

ですね。。仕様を再検討してみたいと思います。回答頂きありがとうございました！！！