have_been_performed マッチャー

have_been_performed マッチャーは、指定された ActiveJob ジョブが実行されたかどうかを確認するために使用されます。

背景

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

ジョブクラス名の確認

"spec/jobs/upload_backups_job_spec.rb" という名前のファイルがあるとします。

require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_performed
  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 performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later("users-backup.txt", "products-backup.txt")
    expect(UploadBackupsJob).to(
      have_been_performed.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 performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
    UploadBackupsJob.set(:wait_until => Date.tomorrow.noon).perform_later
    expect(UploadBackupsJob).to have_been_performed.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 performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_performed.on_queue("default")
  end
end

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

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