モデル単体テスト時の MySQL クライアントエラーへの対処法

問題の概要

モデルの単体テスト中に、ActiveRecord::StatementInvalid: Mysql2::Error: MySQL client is not connected というエラーが発生するケースがあります。このエラーは、FactoryBot.build の直後にMySQLクライアントが正常に接続されていないことが原因です。

エラーの原因

このエラーは、DB接続が確立されるまでのタイミングに依存しているため、特定の条件下でMySQLクライアントが正常に接続されていない可能性があります。

解決策

問題を解決するために、簡単な待機処理を導入することで、DB接続の確立までの時間を確保します。FactoryBot.build の直後に sleep(0.1) などの待機処理を追加することで、DB接続が完了するまでのウェイトを持たせます。

以下に、コード例を示します。

# テストコードの一部
before do
  @user = FactoryBot.create(:user)
  @item = FactoryBot.create(:item)
  
  # FactoryBotのbuild後に少し待機することで、DB接続を確立する
  @order_address = FactoryBot.build(:order_address, user_id: @user.id, item_id: @item.id)
  sleep(0.1) # 待機処理の挿入
end

上記のように、短い待機処理を追加することで、テストのDB接続関連の問題を回避できます。ただし、待機時間が長すぎるとテストのパフォーマンスに影響を与える可能性があるため、短い時間を設定することが重要です。

これにより、モデルの単体テスト時に発生する MySQL クライアントエラーを回避し、テストの正確性と安定性を確保できます。

まとめ

このように、FactoryBot.build 後に短い待機処理を挿入することで、モデル単体テスト中のMySQLクライアントエラーを解決することができます。