Ruby on Rails6 [Devise, Rspec] コントローラのテストでupdateアクションのパラメータをわたせない

Question

実現したいこと

・パスワード再設定のメールを送信し、メール内のリンクから新たなパスワードを再設定できるようにしたい
・その機能を実装するために、まずはRspecでコントローラのテストをしたい

発生している問題

ブラウザ上でパスワードが再設定できることを確認したのですが、
その流れを再現したコントローラのテストでエラーが出ました。

エラー内容

パスワードの変更を試みたが実際は反映されておらず、
期待した値を返していないという内容(だと思います)。

     Failure/Error: expect(user.valid_password?("12345678")).to eq(true)
     
       expected: true
            got: false
     
       (compared using ==)
     
       Diff:
       @@ -1 +1 @@
       -true
       +false
       
     # ./spec/controllers/passwords_controller_spec.rb:43:in `block (4 levels) in <main>'

テストの内容と試してみたこと

テスト内容とテストデータは下記のとおりです。

user.reload の下に binding.pry を差し込んだところ、変更が反映されていなかったので、
その前の　put :update　に問題があると思ったのですが、原因を特定できませんでした。

require 'rails_helper'

RSpec.describe Users::PasswordsController, type: :controller do
  let(:user) { create(:user) }

  describe "updateアクション" do
    context "パスワード再設定に成功する場合" do
      it "ルートにリダイレクトする" do
        @request.env["devise.mapping"] = Devise.mappings[:user]
        user.confirm
        put :update, params: { id: user.id, user: { password: "12345678", password_confirmation: "12345678" } }
        user.reload
        # ここに binding.pry を入れました
        expect(user.valid_password?("12345678")).to eq(true)
        expect(response).to have_http_status "302"
        expect(response).to redirect_to root_path
      end
    end
  end

end

FactoryBot.define do

  factory :user, class: User do
    name { 'user' }
    email { '[e-mail]' }
    password { '1234567' }
  end

end

pryで　user.password　と入力すると、変更前のパスワードである "1234567" が返ってくる状態です。

routes.rb

                               Prefix Verb   URI Pattern                                                                              Controller#Action
                                 root GET    /                                                                                        static_pages#home
                                 help GET    /help(.:format)                                                                          static_pages#help
                                about GET    /about(.:format)                                                                         static_pages#about
                              contact GET    /contact(.:format)                                                                       static_pages#contact
                     new_user_session GET    /users/sign_in(.:format)                                                                 users/sessions#new
                         user_session POST   /users/sign_in(.:format)                                                                 users/sessions#create
                 destroy_user_session DELETE /users/sign_out(.:format)                                                                users/sessions#destroy
                    new_user_password GET    /users/password/new(.:format)                                                            users/passwords#new
                   edit_user_password GET    /users/password/edit(.:format)                                                           users/passwords#edit
                        user_password PATCH  /users/password(.:format)                                                                users/passwords#update
                                      PUT    /users/password(.:format)                                                                users/passwords#update
                                      POST   /users/password(.:format)                                                                users/passwords#create
             cancel_user_registration GET    /users/cancel(.:format)                                                                  users/registrations#cancel
                new_user_registration GET    /users/sign_up(.:format)                                                                 users/registrations#new
               edit_user_registration GET    /users/edit(.:format)                                                                    users/registrations#edit
                    user_registration PATCH  /users(.:format)                                                                         users/registrations#update
                                      PUT    /users(.:format)                                                                         users/registrations#update
                                      DELETE /users(.:format)                                                                         users/registrations#destroy
                                      POST   /users(.:format)                                                                         users/registrations#create
                new_user_confirmation GET    /users/confirmation/new(.:format)                                                        users/confirmations#new
                    user_confirmation GET    /users/confirmation(.:format)                                                            users/confirmations#show
                                      POST   /users/confirmation(.:format)                                                            users/confirmations#create
                              sign_in GET    /sign_in(.:format)                                                                       users/sessions#new
                             sign_out DELETE /sign_out(.:format)                                                                      users/sessions#destroy

該当のcontroller

# frozen_string_literal: true

class Users::PasswordsController < Devise::PasswordsController

  def new
    super
  end

  def create
    super
  end

  def edit
    super
  end

  def update
    super
  end

  protected
  
  def after_sending_reset_password_instructions_path_for(resource_name)
    super(resource_name)
  end

  def after_resetting_password_path_for(resource)
    super(resource)
  end

end

該当のview

<% provide(:title, "パスワード再設定") %>

<h3>新しいパスワードを設定してください</h3>

<%= form_for(resource, as: resource_name, url: password_path(resource_name), html: { method: :put }) do |f| %>
  <%= render "devise/shared/error_messages", resource: resource %>
  <%= f.hidden_field :reset_password_token %>

  <div class="field">
    <%= f.label :password, "新しいパスワード" %><br />
    <% if @minimum_password_length %>
      <em>パスワードは<%= @minimum_password_length %>文字以上です</em><br />
    <% end %>
    <%= f.password_field :password, autofocus: true, autocomplete: "new-password" %>
  </div>

  <div class="field">
    <%= f.label :password_confirmation, "確認用パスワード" %><br />
    <%= f.password_field :password_confirmation, autocomplete: "new-password" %>
  </div>

  <div class="actions">
    <%= f.submit "保存" %>
  </div>
<% end %>

<%= render "devise/shared/links" %>

確認したこと

controllerとviewはデフォルトで使用しており、またブラウザでは正常に作動したので
単にテストの update アクションで値を正しく渡せていないだけだと思ったのですが、
本当の原因がわかりませんでした。

テストの書き方は、こちらのサイトを参考にしています。

質問に不備がある場合は遠慮なく伝えていただけると幸いです。
どうぞよろしくお願いします。

補足情報（FW/ツールのバージョンなど）

ruby 2.7.1
Rails 6.0.3.2

Answer 1

自己解決できたので、その方法を記載します。

今回のテストがパスしない原因は、やはりトークンがパラメータとして渡されていないからで、
そこを定義すればパスしました。

上記のテスト内に、下記のトークンを定義し、
@raw = user.send_reset_password_instructions

下記のように値を渡してあげるとパスします。
put :update, params: { user: { reset_password_token: @raw, password: "12345678", password_confirmation: "12345678" } }

そもそも今回の問題の一番の原因は、
私がGithubのtestに関する部分を確認していなかったことにあります^^;
もっとソースコードを注意して読まないとだめですね。勉強になりました。

ご協力いただいたwinterboumさん、この度はどうもありがとうございました！
これにて質問を閉めさせていただきます。

Answer 2

user.password　で値が返ってくるのが不思議です。
database users テーブルに password カラムが作られていたりしてませんか。

Comments

[退会済みユーザー]

早速のご返信ありがとうございます！
rails consoleからカラムを調べたのですが、下記の通りpasswordカラムはありませんでした。
[1] pry(main)> User.column_names
=> ["id",
"name",
"profile",
"email",
"encrypted_password",
"reset_password_token",
"reset_password_sent_at",
"remember_created_at",
"sign_in_count",
"current_sign_in_at",
"last_sign_in_at",
"current_sign_in_ip",
"last_sign_in_ip",
"confirmation_token",
"confirmed_at",
"confirmation_sent_at",
"unconfirmed_email",
"created_at",
"updated_at"]

ちなみにpasswordだけでなくencrypted_passwordも出せます。
[1] pry(#<RSpec::ExampleGroups::UsersPasswordsController::Update::Nested_2>)> user.password
=> "1234567"
[2] pry(#<RSpec::ExampleGroups::UsersPasswordsController::Update::Nested_2>)> user.encrypted_password
=> "$2a$04$3n2pNfzAfp78nL.rRQCiduFNRdldmhh/CaVtlnRCAxcnpiMRRuKJi"

この現象も何か関係していると考えられるでしょうか？

[winterboum]

user.encrypted_password はでて良いのですが、それupdateの前後で変わっているかなぁ、、、
controllerの方にpry仕掛けて、paramsなど確認してみてください。

[退会済みユーザー]

winterboumさん
ご返信ありがとうございます。

調べた結果ですが、対象のユーザーを検索できていないのが原因かもしれません。
というのもupdateアクションが開始される際に、パスワード再設定のメールに仕込んだトークンを使ってユーザーを検索しているのですが、pryでその処理の後を確認してみると、ユーザーを検索できていなかったからです。
ブラウザ上とテストで更新の結果が異なるのは、テストではトークンをわたす処理を再現できていないからかもしれません。

まだ確認段階ですが、わかったことがあればまた追記します。

[退会済みユーザー]

自己解決できたので、その方法を記載します。

今回のテストがパスしない原因は、やはりトークンがパラメータとして渡されていないからで、
そこを定義すればパスしました。

上記のテスト内に、下記のトークンを定義し、
@raw = user.send_reset_password_instructions

下記のように値を渡してあげるとパスします。
put :update, params: { user: { reset_password_token: @raw, password: "12345678", password_confirmation: "12345678" } }

そもそも今回の問題の一番の原因は、
私がGithubのtestに関する部分を確認していなかったことにあります^^;
もっとソースコードを注意して読まないとだめですね。勉強になりました。

ご協力いただいたwinterboumさん、この度はどうもありがとうございました！
これにて質問を閉めさせていただきます