web-dev-qa-db-ja.com

Rspecを使用してActiveJobのキューにあるものを確認する方法

Rails APIアプリ。このエンドポイントがヒットすると、ActiveJobがキューに入れられ、マンドリル（トランザクションメールクライアント）へのリクエストを実行します。 m現在、テストを記述して、コントローラーエンドポイントがヒットしたときにActiveJobが正しくキューに入れられるようにします。

def reset_password
  @user = User.find_by(email: params[:user][:email])
  @user.send_reset_password_instructions
end

Send_reset_password_instructionsは、以下のコードであるActiveJobを作成する前に、いくつかのURLなどを作成します。

class SendEmailJob < ActiveJob::Base
  queue_as :default

  def perform(message)
    mandrill = Mandrill::API.new
    mandrill.messages.send_template "reset-password", [], message
  rescue Mandrill::Error => e
    puts "A mandrill error occurred: #{e.class} - #{e.message}"
    raise
  end
end

現時点では、ActiveJobにアダプターを使用していないため、ActiveSpecがキューに入っていることをRspecで確認したいだけです。

現在、私のテストは次のようになっています（ファクトリーガールを使用してユーザーを作成しています）。

require 'active_job/test_helper'

describe '#reset_password' do
  let(:user) { create :user }

  it 'should create an ActiveJob to send the reset password email' do
    expect(enqueued_jobs.size).to eq 0
    post :reset_password, user: { email: user.email }
    expect(enqueued_jobs.size).to eq 1
  end
end

すべてが実際に機能します。テストを作成するだけです！

Ruby 2.1.2およびRails 4.1.6。

これをテストする方法について、ウェブ上のどこにもドキュメントやヘルプを見ることができないので、どんな助けでも大歓迎です！

ruby-on-railsrubyrspecrails-activejob
33
mylescc

受け入れられた答えはもはや私には役に立たないので、私はコメントでMichael H.の提案を試してみました。

describe 'whatever' do
  include ActiveJob::TestHelper

  after do
    clear_enqueued_jobs
  end  

  it 'should email' do
    expect(enqueued_jobs.size).to eq(1)
  end
end
44
Josh Smith

ActiveJobの機能を実際にテストする必要はありません。コードをスタブして適切に呼び出すことをテストするだけです

 expect(MyJob).to receive(:perform_later).once 
 post :reset_password, user: { email: user.email }

ActiveJobの作成者は、ユニットテストにも同じ手法を使用しています。 GridJob Testobject を参照してください

テストでtestmock GridJobを作成し、performメソッドをオーバーライドします。これにより、カスタム配列にジョブを追加するだけで、 JobBuffer を呼び出します。最後に、バッファにジョブがエンキューされているかどうかをテストします

ただし、完全な統合テストの実行を止めることができない場合は。 ActiveJob test_helper.rb は、rspecではなくminitestで使用されることになっています。そのため、機能を再構築する必要があります。あなたはただ電話することができます

expect(ActiveJob::Base.queue_adapter.enqueued_jobs).to eq 1

何も必要とせずに

更新1：コメントに記載されているとおり。 ActiveJob::Base.queue_adapter.enqueued_jobsは、queue_adapterをテストモードに設定することによってのみ機能します。

# either within config/environment/test.rb
config.active_job.queue_adapter = :test

# or within a test setup
ActiveJob::Base.queue_adapter = :test
34
dre-hh

Rspec 3.4 に have_enqueued_job が追加されました。これにより、テストがはるかに簡単になります。

it "enqueues a YourJob" do
  expect {
    get :your_action, {}
  }.to have_enqueued_job(YourJob)
end

have_enqueued_jobには他にも便利な機能があり、引数とキューに入れるべき回数を確認できます。

16
tirdadc

テストRails RSpecを使用したActiveJob

class MyJob < ActiveJob::Base
  queue_as :urgent

  rescue_from(NoResultsError) do
    retry_job wait: 5.minutes, queue: :default
  end

  def perform(*args)
    MyService.call(*args)
  end
end

require 'Rails_helper'

RSpec.describe MyJob, type: :job do
  include ActiveJob::TestHelper

  subject(:job) { described_class.perform_later(123) }

  it 'queues the job' do
    expect { job }
      .to change(ActiveJob::Base.queue_adapter.enqueued_jobs, :size).by(1)
  end

  it 'is in urgent queue' do
    expect(MyJob.new.queue_name).to eq('urgent')
  end

  it 'executes perform' do
    expect(MyService).to receive(:call).with(123)
    perform_enqueued_jobs { job }
  end

  it 'handles no results error' do
    allow(MyService).to receive(:call).and_raise(NoResultsError)

    perform_enqueued_jobs do
      expect_any_instance_of(MyJob)
        .to receive(:retry_job).with(wait: 10.minutes, queue: :default)

      job
    end
  end

  after do
    clear_enqueued_jobs
    clear_performed_jobs
  end
end
9
CharlesJHardy

新しい rspec拡張 があり、これにより作業が楽になります。

require 'Rails_helper'

RSpec.describe MyController do
  let(:user) { FactoryGirl.create(:user) }
  let(:params) { { user_id: user.id } }
  subject(:make_request) { described_class.make_request(params) }

  it { expect { make_request }.to enqueue_a(RequestMaker).with(global_id(user)) }
end
8
KARASZI István

ActiveJob :: TestHelperを含めなかったためか、いくつかの問題がありましたが、これでうまくいきました...

まず、上記の回答が示すように、キューアダプタを:testに設定していることを確認してください。

何らかの理由でafterブロック内のclear_enqueued_jobsジョブは機能しませんでしたが、 source は次のことができることを示しています：enqueued_jobs.clear

require 'Rails_helper'
include RSpec::Rails::Matchers

RSpec.describe "my_rake_task", type: :rake do

  after do
    ActiveJob::Base.queue_adapter.enqueued_jobs.clear
  end  


  context "when #all task is run" do
    it "enqueues jobs which have been enabled" do
      enabled_count = get_enabled_count
      subject.execute
      expect(ActiveJob::Base.queue_adapter.enqueued_jobs.size).to eq(enabled_count)
    end

    it "doesn't enqueues jobs which have been disabled" do
      enabled_count = get_enabled_count
      subject.execute
      expect(ActiveJob::Base.queue_adapter.enqueued_jobs.size).to eq(enabled_count)
    end
  end

end
2
Archernar