have_been_enqueued マッチャー

have_been_enqueued マッチャーは、指定された ActiveJob ジョブがエンキューされたかどうかを確認するために使用されます。

背景

アクティブなジョブが利用可能であることが前提です。

ジョブクラス名の確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルが以下の内容であるとします:

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued
  end
end

rspec spec/jobs/upload_backups_job_spec.rb を実行すると、

すべての例がパスするはずです。

ジョブに渡された引数の確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルが以下の内容であるとします:

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later("users-backup.txt", "products-backup.txt")
    expect(UploadBackupsJob).to(
      have_been_enqueued.with("users-backup.txt", "products-backup.txt")
    )
  end
end

rspec spec/jobs/upload_backups_job_spec.rb を実行すると、

すべての例がパスするはずです。

ジョブのエンキュー時刻の確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルが以下の内容であるとします:

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.set(:wait_until => Date.tomorrow.noon).perform_later
    expect(UploadBackupsJob).to have_been_enqueued.at(Date.tomorrow.noon)
  end
end

rspec spec/jobs/upload_backups_job_spec.rb を実行すると、

すべての例がパスするはずです。

ジョブの待機なしでのエンキューの確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルが以下の内容であるとします:

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued.at(:no_wait)
  end
end

rspec spec/jobs/upload_backups_job_spec.rb を実行すると、

すべての例がパスするはずです。

ジョブキュー名の確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルが以下の内容であるとします:

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued.on_queue("default")
  end
end

rspec spec/jobs/upload_backups_job_spec.rb を実行すると、

すべての例がパスするはずです。