メインコンテンツまでスキップ

have_enqueued_job マッチャー

have_enqueued_job（または enqueue_job としてもエイリアスされる）マッチャーは、指定された 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
    expect {
      UploadBackupsJob.perform_later
    }.to have_enqueued_job(UploadBackupsJob)
  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
    expect {
      UploadBackupsJob.perform_later("users-backup.txt", "products-backup.txt")
    }.to have_enqueued_job.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
    expect {
      UploadBackupsJob.perform_later('backups.txt', rand(100), 'uninteresting third argument')
    }.to have_enqueued_job.with { |file_name, seed|
      expect(file_name).to eq 'backups.txt'
      expect(seed).to be < 100
    }
  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
    expect {
      UploadBackupsJob.set(:wait_until => Date.tomorrow.noon).perform_later
    }.to have_enqueued_job.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
    expect {
      UploadBackupsJob.perform_later
    }.to have_enqueued_job.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
    expect {
      UploadBackupsJob.perform_later
    }.to have_enqueued_job.on_queue("default")
  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
    expect {
      UploadBackupsJob.perform_later
    }.to enqueue_job(UploadBackupsJob)
  end
end

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

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