RSpecでコメント投稿機能をテスト

Question

##実現したいこと
コメント機能のテストを実現したいです。
２日間、調べて修正しましたが実現できませんでした。
お手数をおかけ致しますがご理解がある方はヒントでもあれば、
お教えをお願い致します。

前提

作成された掲示板にコメントを投稿致します。
しかし、
コメントデータの設定ができず、下記のエラーメッセージが発生致しました。

発生している問題・エラーメッセージ

Failure/Error:
params.require(:comment).permit(:board_id, :name, :comment)     
ActionController::ParameterMissing:
param is missing or the value is empty: comment
# ./app/controllers/comments_controller.rb:23:in `comment_params'
# ./app/controllers/comments_controller.rb:3:in `create'
# /usr/local/bundle/gems/rails-controller-testing-1.0.5/lib/rails/controller/testing/template_assertions.rb:62:in `process'
# /usr/local/bundle/gems/rails-controller-testing-1.0.5/lib/rails/controller/testing/integration.rb:16:in `block (2 levels) in <module:Integration>'
# ./spec/controllers/comments_controller_spec.rb:7:in `block (4 levels) in <top (required)>'

該当のソースコード

#####コメント投稿テストコード[comments_controller_spec.rb]

require 'rails_helper'

RSpec.describe CommentsController, type: :controller do
  describe 'comment#create' do
    context 'コメントを投稿が成功した場合' do
      before do
        post(:create, params: {
          board: {
            name: 'tanaka',
            title: 'Ruby on Rails 5',
            body: 'Hello Rails',
          }
        })

        @comment = FactoryBot.build(:comment)
        post comments_path, params: {
            board_id: @comment.board_id,
            name: @comment.name,
            comment: @comment.comment,
        }
      end

      it '掲示板のコメント欄にリダイクトされること' do
        expect(response).to redirect_to @comment.board
      end
    end
  end
end

#####コメント投稿機能[comments_controller.rb]

class CommentsController < ApplicationController
  def create
    comment = Comment.new(comment_params)
    if comment.save
      flash[:notice] = 'コメントを投稿しました。'
      redirect_to comment.board
    else
      flash[:comment] = comment
      flash[:error_messages] = comment.errors.full_messages
      redirect_back fallback_location: comment.board
    end
  end

  def destroy
    comment = Comment.find(params[:id])
    comment.delete
    redirect_to comment.board, flash: { notice: 'コメントが削除されました。' }
  end

  private

    def comment_params
      params.require(:comment).permit(:board_id, :name, :comment)
    end
end

#####掲示板関連機能[boards_controller.rb]

class BoardsController < ApplicationController
  # 各アクション実行前に動作、onlyの配列の順序に注意
  before_action :set_target_board, only: %i[show edit update destroy]

  def index
    @boards = params[:tag_id].present? ? Tag.find(params[:tag_id]).boards : Board.all
    @boards = @boards.page(params[:page])
  end

  def new
    @board = Board.new
  end

  def create
    board = Board.new(board_params)
    if board.save
      flash[:notice] = '「#{board.title}」の掲示板を作成しました。'
      redirect_to board
    else
      redirect_to new_board_path, flash: {
        board: board,
        error_messages: board.errors.full_messages
      }
    end
  end

  def show
    @comment = Comment.new(board_id: @board.id)
  end

  def edit
    @board.attributes = flash[:board] if flash[:board]
  end

  def update
    if @board.update(board_params)
      redirect_to @board # オブジェクトで記述すると、id指定で表示されるため。
    else
      redirect_to :back, flash: {
        board: @board,
        error_messages: @board.errors.full_messages
      }
    end
  end

  def destroy
    @board.destroy
    redirect_to boards_path, flash: { notice: '「#{@board.title}」の掲示板が削除されました。' }
  end

  private
    def board_params
      # strongparameterで取得
      params.require(:board).permit(:name, :title, :body, tag_ids: [])
    end

    # １件分のレコードを取得
    def set_target_board
      @board = Board.find(params[:id])
    end
end

#####rails routesの結果

mypage GET /mypage(.:format) users#me

login POST /login(.:format) sessions#create

logout DELETE /logout(.:format) sessions#destroy

root GET / home#index

users POST /users(.:format) users#create

new_user GET /users/new(.:format) users#new

boards GET /boards(.:format) boards#index

POST /boards(.:format) boards#create

new_board GET /boards/new(.:format) boards#new

edit_board GET /boards/:id/edit(.:format) boards#edit

board GET /boards/:id(.:format) boards#show

PATCH /boards/:id(.:format) boards#update

PUT /boards/:id(.:format) boards#update

DELETE /boards/:id(.:format) boards#destroy

comments POST /comments(.:format) comments#create

comment DELETE /comments/:id(.:format) comments#destroy

試したこと

エラーメッセージの内容の通りに、テストコードのパラメータの内容が不足していると思い、
直接内容を記述。下記コード内容から修正作業を開始。

post(:create, params: {
　comment: { 
    board_id: 1,
　  name: 'tanaka',
　  comment: 'こんにちは,
  }
})

続いて、ルートで実施。

post comments_path, params: {
　board_id: 1,
　name: 'tanaka',
　comment: 'こんにちは,
}

しかし、上記のテストコードの様に
FactoryBotでテストデータを作成後、実施するもエラーメッセージは同じ内容で失敗。

参考にした記事の一例
https://teratail.com/questions/271147

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

[作業環境]
macOS BigSur 11.2
Docker 20.10
Ruby 2.4.5
Rails 5.2.2
RSpec 3.9.0

Comments

[suama]

テストだけうまく行かない状態ですね？
通常の画面からの投稿はうまく登録できている状態であれば、specでのパラメータを直せば良さそうですね。

[退会済みユーザー]

suama　様
いつもお世話になっております。
今回も宜しくお願い致します。

はい、おしゃる通りでございます。
作成したテストのみ通らないです。
関連すると予想したファイルを元に上記の試したことを行いました。
ですが、どのようにパラメータを修正すれば、
良いかで止まってしまいました。

comment.rb[commentのモデルファイル]
# == Schema Information
#
# Table name: comments
#
# id :integer not null, primary key
# comment :text(65535) not null
# name :string(255) not null
# created_at :datetime not null
# updated_at :datetime not null
# board_id :integer
#
# Indexes
#
# index_comments_on_board_id (board_id)
#
# Foreign Keys
#
# fk_rails_... (board_id => boards.id)
#
class Comment < ApplicationRecord
　belongs_to :board
　validates :name, presence: true, length: { maximum: 10 }
　validates :comment, presence: true, length: { maximum: 1000 }
end

[suama]

ありがとうございます！
手順としては、おそらく、before do ... end のところで、先にBoadのデータを登録し、その後にBoadの値を使ってCommentのコントローラにPOSTしてCommentを作りたいということですよね？
すでに回答が1つありますが、わたしも添えてみますね。

[退会済みユーザー]

suama 様
お忙しい中、ご対応頂きありがとうございます！
おしゃる通りです。
Boardのデータ登録後、
そのBoard値を使用してCommentを作成するのが実現したいことです。

[suama]

基本的に、Rspecのテストというのは、***_spec.rb 1つの実行に対して、実行し終わったらデータをクリアにします。
なので、別のspecで作ったデータを、別のspecに利用するというのは、あまり行いません。自動テストの時にゴミデータになってしまうからです。

Boad.rb のモデルのソースを貼っていただけたら、ひとまず回答は追記できますが、それも現場でメンターしているわけではないので、参考程度にしてくださいませ。

[退会済みユーザー]

suama 様
ご返信ありがとうございます。
そのような方法流れが基本なのですね。
大変勉強になりありがとうございます。
また、
ご指示の通り、モデルのソースを記述致しました。
ご確認をお願い致します。
今回もRSpecに関する事を、
ご指摘とご教授してくださり大変助かります！

Answer 1

こんばんは。質問へのお答え、ありがとうございます。
パラメータの件ではなくて、Specで書いている流れを見て、ちょっとエスパーして回答してみます。

このspecで想定している処理の流れは？

• まず、BoardsController#create を呼び出してBoardのデータを1つ作りたい
• つぎに、そのBoardの値を使って、FactoryBot.build(:comment)　した comment用のデータにboardのIDを紐づけたい
• そして、パラメータを作って、CommentsController#create に送信して、commentデータを正しくデータベースに登録したい

こんな処理でしょうか？
特に、「まず、BoardsController#create を呼び出してBoardのデータを1つ作りたい」という点、あっていますでしょうか？

想定している処理に対して実際出ているエラーは？

ですがエラーで ./spec/controllers/comments_controller_spec.rb:7 と出ていますよね。

specの7行目の処理は、確かに post(:create, params: {board:.... として、BoardsController#createにデータを送信したいように見えます。

でも、このデータは、実際は　CommentsController#create に送られてしまっています。
そのため、 ./app/controllers/comments_controller.rb:23:in `comment_params' というメッセージ通り、CommentsController#create　側で「パラメータが合っていないよ！」と怒られているわけです。

また、このspecは RSpec.describe CommentsController, type: :controller do と宣言されています。
なので、 post(...) や get と記載した時には、宛先は必ず CommentsControllerになります。

パラメータだけ直せばうまくいく？

ここに関しては、どういう処理をしたいかによります。

もし、CommentのデータにはBoardデータは必須であるとか、存在するBoardに関連付けしないといけないとかの制限があれば、何にしてもBoardのデータを1つ用意しないといけませんね。

この時、

• A. BoardController#create経由で作る
• B. あるいはFactoryBotや直接Board.create(...)で作る

かで方法は変わります。
もしBoardとCommentのモデルのコードが分かれば、Bの方法でテストの中でBoardのデータを用意することもできます。

B案でやってみる

モデルの情報をいただきましたので、手元で動かせてるわけではないですが、参考までに書いてみます。
エラーが出るかもしれませんが、あとは1つ1つ確認しながら進めてみてください。

require "rails_helper"

# ここで「CommentsControllerについてのテストだよ！」と宣言してます
RSpec.describe CommentsController, type: :controller do
  describe "comment#create" do
    context "コメントを投稿が成功した場合" do
      before do
        # まずBoardのデータを作る

        # この方法はダメ！
        # post(:create, params: {
        #  board: {
        #    name: 'tanaka',
        #    title: 'Ruby on Rails 5',
        #    body: 'Hello Rails',
        #  }
        # })

        # CommentsControllerのspecなので、BoardsController#createを呼び出せません
        # なので、ここで BoardsController#create中でやっているのと同じことを書いて、直に掲示板の
        # データを作成します
        board_params = {
          name: "tanaka",
          title: "Ruby on Rails 5",
          body: "Hello Rails",
        }
        # new -> saveを同時に処理しています
        @board = Board.create!(board_params)

        # ここからがCommentsController#create　への本来のPOST
        # postのあとにパラメータを添えるだけでよいです
        # パラメータは入れ子になるので注意
        @comment = FactoryBot.build(:comment)
        post :create, params: {
                        comment: {
                          board_id: @board.id,
                          name: @comment.name,
                          comment: @comment.comment,
                        },
                      }
      end

      it "掲示板のコメント欄にリダイクトされること" do
        # @comment.board は、実際はコメントに紐付けた@boardと同じになるはず
        # redirect_to のあとは実際のパスの形式でないと多分ダメ
        # これは多分エラー
        # expect(response).to redirect_to @comment.board
        expect(response).to redirect_to "/boards/#{@board.id}"
      end
    end
  end
end

Comments

[退会済みユーザー]

suama 様
ありがとうございます。
suama 様の想定している内容通りでございます。
また、エラーの原因が理解ができて大変勉強になりました。
呼ばれているコントローラーが、
そもそも違うのに気づいておりませんでした。

お手数をおかけしますが、
Bの方法をお教え願えますでしょうか？

下記がモデルのコードになります。
Boardのモデル[board.rb]
# == Schema Information
#
# Table name: boards
#
# id :integer not null, primary key
# body :text(65535)
# name :string(255)
# title :string(255)
# created_at :datetime not null
# updated_at :datetime not null
#
class Board < ApplicationRecord
　has_many :comments, dependent: :delete_all
　has_many :board_tag_relations, dependent: :delete_all
　has_many :tags, through: :board_tag_relations

　validates :name, presence: true, length: { maximum: 10 }
　validates :title, presence: true, length: { maximum: 30 }
　validates :body, presence: true, length: { maximum: 1000 }
end

Commentのモデル[comment.rb]
# == Schema Information
#
# Table name: comments
#
# id :integer not null, primary key
# comment :text(65535) not null
# name :string(255) not null
# created_at :datetime not null
# updated_at :datetime not null
# board_id :integer
#
# Indexes
#
# index_comments_on_board_id (board_id)
#
# Foreign Keys
#
# fk_rails_... (board_id => boards.id)
#
class Comment < ApplicationRecord
　belongs_to :board

　validates :name, presence: true, length: { maximum: 10 }
　validates :comment, presence: true, length: { maximum: 1000 }
end

[退会済みユーザー]

suama 様
無事、テストが成功しました！
ありがとうございます！
コメントも記述して頂き、勉強になります。

また、機会がありましたらその際は宜しくお願い致します。

Answer 2

期待しているのはparams.require(:comment).permit(:board_id, :name, :comment)
なのにspecでは1params: { board: { name: 'tanaka', title: 'Ruby on Rails 5', body: 'Hello Rails', }
全く違うじゃないですか。params: { comment: { board_id: ***, name: 'Ruby on Rails 5', comment: 'Hello Rails', }
としてみて。　*** は　この実行前に Boadを作成して、そのidね。