Rspec トランザクション処理を失敗させたテストを書きたい

Question

先輩エンジニアの皆様質問失礼致します。

updateアクションにリクエストが送られてきたら、agreement.stateと、room.consensusをupdate_attributeしています。この2つの一貫性を保つためにもトランザクション処理をしているのですが、何らかが原因でupdate_attributeが失敗したときのresponseをテストしたいです。

テスト内でどのようにすればトランザクションの中のupdate_attributeを失敗させればいいか分かりません。
ご教授お願い致します。

#agreements_controller.rb

def update
    agreement = Agreement.find(params[:id])
    room = agreement.room
    if (api_user_signed_in? && current_api_user = agreement.user) || (api_host_signed_in? && current_api_host = agreement.host)
      if agreement.start_time > 24.hours.since
##############トランザクション##############
        begin
          ActiveRecord::Base.transaction do
            agreement.update_attribute(:state, "変更申請中")
            room.update_attribute(:consensus, "交渉中")
          end
          obj = {agreement: agreement, room: room}
          render json: obj, status: 200
        rescue => error
          render json: {error: error}, status: 400
        end
###########################################
      else
        render body: nil, status: 400
      end
    else
      render body: nil, status: 403
    end
  end

Answer 1

この場合、update_attributeで変更する値は、定数ですね。ならば、agreementのカラム値の組合わせによっては、その定数でupdateすることが失敗する可能性が存在しますか?
もし、存在するならば、テストにおいて、そのような組合わせのデータのagreementを作って、それに対してupdateを実行させれば、失敗させられます。
それが正攻法です。

---

もしそのような組合わせが存在せず、よほど奇妙な事態(たとえば、Databaseへの接続が物理的に突然絶たれるなど)でない限りは失敗するはずがない場合は、敢えてエラーを起こすのは容易ではないと思います。
力技でよければ、以下の方法が考えつきました。

端的には、test環境におけるある特定の条件において、陽に失敗させます。たとえば、begin文の後もしくはagreement.update_attributeの直前に、次の一行を加えます。

raise 'my-error' if Rails.env.test? && 0 == params[:id].to_i

そして、テストの時、ID=0のデータをDBに作って、そのIDをテストの時に呼びます。そうすると、RuntimeErrorで失敗します。あるいは、IF文中でagreement = nilとすればNoMethodError例外によりupdate_attributeが失敗しますし、agreement.freezeにすればFrozenError 例外が出て失敗します。

なお、成功をテストする場合にはID=0 になることはあり得ない、ことを保証するよう、気をつけましょう(Rails用のDBのデフォルト設定では、IDは1から始まるのでこの条件は満たされているでしょう)。

現実には、このようにテストのそれも特定の条件の時だけ呼ばれる行を、実際の Controllerのコードの中に含ませることはあまりよいpracticeとは言えないかも知れませんが。
それを避けるためには、たとえばそのようなtestsを一度実行して期待通りの挙動であることを確認した後、ソースコードの中から該当行をコメントアウトする(必要ならばテストコードからもコメントアウトする)、ようにした方がいいかもしれませんか。

開発のcoding policy次第でしょう。

Comments

[IRIESS]

ご回答ありがとうございます。
勉強になりました。
そもそも失敗する可能性が考えにくい場合はテストする必要もないということですね。
ならばそもそもトランザクション処理にする必要もないのですかね。。。
力技で失敗させる方法も勉強になりました！ありがとうございました！

[MasaSakano]

updateを二つ入れるならば、transactionで囲むのはとてもよい習慣だと思います。
特に、商用サーバーで一秒間に千回のアクセスがあり得る場合とかならば、必須かもしれませんね。

失敗の場合をちゃんとテストするのもとてもよい習慣だと思います。ただし、本番環境では全く使わないどころか邪魔なだけの文を残すかどうかは別問題ですか。

なお、テスト環境に限るという条件をつける常套手段を思い出したので、回答編集しておきました。