Project: RSpec Rails 4.1

Publisher: RSpec

have_been_enqueued matcher

The have_been_enqueued matcher is used to check if given ActiveJob job was enqueued.

Background

Given: active job is available

Scenarios

Checking job class name
Checking passed arguments to job
Checking job enqueued time
Checking job enqueued with no wait
Checking job queue name

Checking job class name

Given

a file named "spec/jobs/upload_backups_job_spec.rb" with:

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

When

I run rspec spec/jobs/upload_backups_job_spec.rb

Then

the examples should all pass

Checking passed arguments to job

Given

a file named "spec/jobs/upload_backups_job_spec.rb" with:

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

When

I run rspec spec/jobs/upload_backups_job_spec.rb

Then

the examples should all pass

Checking job enqueued time

Given

a file named "spec/jobs/upload_backups_job_spec.rb" with:

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

When

I run rspec spec/jobs/upload_backups_job_spec.rb

Then

the examples should all pass

Checking job enqueued with no wait

Given

a file named "spec/jobs/upload_backups_job_spec.rb" with:

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

When

I run rspec spec/jobs/upload_backups_job_spec.rb

Then

the examples should all pass

Checking job queue name

Given

a file named "spec/jobs/upload_backups_job_spec.rb" with:

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

When

I run rspec spec/jobs/upload_backups_job_spec.rb

Then

the examples should all pass

Last published almost 2 years ago by Jon Rowe.

have_been_enqueued matcher

RSpec Rails settings