Refs #17684: Enhances rdoc for ActiveJob assert_performed assertions

[fabiolnm]

No description provided.

[rafaelfranca]

I think we could just tell about the condition but not show how to enable. This code for example will change the global state of the tests and will make test order dependent.

[fabiolnm]

You're right about the global state change, but not showing how to enable is little help.

My feeling is that something like this is missing, maybe in test_helper:

def perform_enqueued_jobs
  @old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
  queue_adapter.perform_enqueued_jobs = true
  yield
ensure
  queue_adapter.perform_enqueued_jobs = @old_perform_enqueued_jobs
end

Maybe this may be placed in test_adapter.

So one can code this test:

perform_enqueued_jobs do
  assert_performed_jobs 1 do
    # ...
  end
end

[rafaelfranca]

Yeah, but I'd make it the default value of assert_performed_jobs

[fabiolnm]

It seems a good approach, too...
How do we proceed now?

[rafaelfranca]

You can add a new commit to this PR adding support to enable perform_enqueued_jobs by default in the block version of assert_performed_jobs

[fabiolnm]

@rafaelfranca Do you agree the following lines

rails/activejob/test/cases/test_helper_test.rb

Line 9 in 0172940

setup { queue_adapter.perform_enqueued_at_jobs = true }

and

rails/activejob/test/cases/test_helper_test.rb

Line 119 in 0172940

setup { queue_adapter.perform_enqueued_jobs = true }

are potentially dangerous, as they change queue_adapter state?

[rafaelfranca]

Yeah, they should have a after block too.

[rafaelfranca]

Squashed and merged at 0bc04ce...d886a27