rspec-rails 3.9.1 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/Capybara.md +5 -54
- data/Changelog.md +207 -77
- data/README.md +27 -21
- data/lib/generators/rspec.rb +0 -6
- data/lib/generators/rspec/channel/channel_generator.rb +12 -0
- data/lib/generators/rspec/{observer/templates/observer_spec.rb → channel/templates/channel_spec.rb.erb} +1 -1
- data/lib/generators/rspec/controller/controller_generator.rb +22 -5
- data/lib/generators/rspec/controller/templates/request_spec.rb +19 -0
- data/lib/generators/rspec/controller/templates/routing_spec.rb +13 -0
- data/lib/generators/rspec/feature/feature_generator.rb +2 -2
- data/lib/generators/rspec/{generators → generator}/generator_generator.rb +2 -2
- data/lib/generators/rspec/{generators → generator}/templates/generator_spec.rb +0 -0
- data/lib/generators/rspec/helper/helper_generator.rb +1 -1
- data/lib/generators/rspec/install/install_generator.rb +4 -4
- data/lib/generators/rspec/install/templates/spec/rails_helper.rb +17 -16
- data/lib/generators/rspec/integration/integration_generator.rb +3 -3
- data/lib/generators/rspec/mailbox/mailbox_generator.rb +14 -0
- data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb +7 -0
- data/lib/generators/rspec/mailer/mailer_generator.rb +2 -1
- data/lib/generators/rspec/mailer/templates/mailer_spec.rb +2 -2
- data/lib/generators/rspec/mailer/templates/preview.rb +1 -1
- data/lib/generators/rspec/model/model_generator.rb +5 -4
- data/lib/generators/rspec/model/templates/fixtures.yml +1 -1
- data/lib/generators/rspec/request/request_generator.rb +1 -1
- data/lib/generators/rspec/scaffold/scaffold_generator.rb +29 -19
- data/lib/generators/rspec/scaffold/templates/api_controller_spec.rb +0 -36
- data/lib/generators/rspec/scaffold/templates/api_request_spec.rb +131 -0
- data/lib/generators/rspec/scaffold/templates/controller_spec.rb +0 -48
- data/lib/generators/rspec/scaffold/templates/edit_spec.rb +1 -5
- data/lib/generators/rspec/scaffold/templates/index_spec.rb +2 -2
- data/lib/generators/rspec/scaffold/templates/new_spec.rb +1 -5
- data/lib/generators/rspec/scaffold/templates/request_spec.rb +137 -0
- data/lib/generators/rspec/scaffold/templates/routing_spec.rb +8 -10
- data/lib/generators/rspec/scaffold/templates/show_spec.rb +1 -1
- data/lib/generators/rspec/system/system_generator.rb +14 -16
- data/lib/generators/rspec/view/view_generator.rb +2 -2
- data/lib/rspec-rails.rb +13 -16
- data/lib/rspec/rails/adapters.rb +11 -76
- data/lib/rspec/rails/configuration.rb +81 -37
- data/lib/rspec/rails/example.rb +2 -0
- data/lib/rspec/rails/example/channel_example_group.rb +93 -0
- data/lib/rspec/rails/example/controller_example_group.rb +4 -4
- data/lib/rspec/rails/example/feature_example_group.rb +6 -26
- data/lib/rspec/rails/example/helper_example_group.rb +2 -9
- data/lib/rspec/rails/example/mailbox_example_group.rb +80 -0
- data/lib/rspec/rails/example/mailer_example_group.rb +2 -2
- data/lib/rspec/rails/example/rails_example_group.rb +1 -1
- data/lib/rspec/rails/example/request_example_group.rb +1 -4
- data/lib/rspec/rails/example/system_example_group.rb +29 -12
- data/lib/rspec/rails/example/view_example_group.rb +38 -27
- data/lib/rspec/rails/extensions/active_record/proxy.rb +5 -10
- data/lib/rspec/rails/feature_check.rb +12 -29
- data/lib/rspec/rails/file_fixture_support.rb +9 -11
- data/lib/rspec/rails/fixture_file_upload_support.rb +33 -17
- data/lib/rspec/rails/fixture_support.rb +34 -32
- data/lib/rspec/rails/matchers.rb +9 -0
- data/lib/rspec/rails/matchers/action_cable.rb +65 -0
- data/lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb +170 -0
- data/lib/rspec/rails/matchers/action_cable/have_streams.rb +58 -0
- data/lib/rspec/rails/matchers/action_mailbox.rb +73 -0
- data/lib/rspec/rails/matchers/active_job.rb +169 -21
- data/lib/rspec/rails/matchers/base_matcher.rb +5 -10
- data/lib/rspec/rails/matchers/have_enqueued_mail.rb +52 -28
- data/lib/rspec/rails/matchers/have_http_status.rb +11 -7
- data/lib/rspec/rails/matchers/have_rendered.rb +1 -0
- data/lib/rspec/rails/matchers/relation_match_array.rb +1 -1
- data/lib/rspec/rails/matchers/routing_matchers.rb +12 -12
- data/lib/rspec/rails/tasks/rspec.rake +7 -17
- data/lib/rspec/rails/vendor/capybara.rb +10 -15
- data/lib/rspec/rails/version.rb +1 -1
- data/lib/rspec/rails/view_path_builder.rb +1 -1
- data/lib/rspec/rails/view_rendering.rb +15 -4
- metadata +47 -35
- metadata.gz.sig +0 -0
- data/lib/generators/rspec/observer/observer_generator.rb +0 -13
data/lib/rspec/rails/matchers.rb
CHANGED
@@ -20,7 +20,16 @@ require 'rspec/rails/matchers/be_a_new'
|
|
20
20
|
require 'rspec/rails/matchers/relation_match_array'
|
21
21
|
require 'rspec/rails/matchers/be_valid'
|
22
22
|
require 'rspec/rails/matchers/have_http_status'
|
23
|
+
|
23
24
|
if RSpec::Rails::FeatureCheck.has_active_job?
|
24
25
|
require 'rspec/rails/matchers/active_job'
|
25
26
|
require 'rspec/rails/matchers/have_enqueued_mail'
|
26
27
|
end
|
28
|
+
|
29
|
+
if RSpec::Rails::FeatureCheck.has_action_cable_testing?
|
30
|
+
require 'rspec/rails/matchers/action_cable'
|
31
|
+
end
|
32
|
+
|
33
|
+
if RSpec::Rails::FeatureCheck.has_action_mailbox?
|
34
|
+
require 'rspec/rails/matchers/action_mailbox'
|
35
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
require "rspec/rails/matchers/action_cable/have_broadcasted_to"
|
2
|
+
|
3
|
+
module RSpec
|
4
|
+
module Rails
|
5
|
+
module Matchers
|
6
|
+
# Namespace for various implementations of ActionCable features
|
7
|
+
#
|
8
|
+
# @api private
|
9
|
+
module ActionCable
|
10
|
+
end
|
11
|
+
|
12
|
+
# @api public
|
13
|
+
# Passes if a message has been sent to a stream/object inside a block.
|
14
|
+
# May chain `at_least`, `at_most` or `exactly` to specify a number of times.
|
15
|
+
# To specify channel from which message has been broadcasted to object use `from_channel`.
|
16
|
+
#
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# expect {
|
20
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
21
|
+
# }.to have_broadcasted_to("messages")
|
22
|
+
#
|
23
|
+
# expect {
|
24
|
+
# SomeChannel.broadcast_to(user)
|
25
|
+
# }.to have_broadcasted_to(user).from_channel(SomeChannel)
|
26
|
+
#
|
27
|
+
# # Using alias
|
28
|
+
# expect {
|
29
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
30
|
+
# }.to broadcast_to("messages")
|
31
|
+
#
|
32
|
+
# expect {
|
33
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
34
|
+
# ActionCable.server.broadcast "all", text: 'Hi!'
|
35
|
+
# }.to have_broadcasted_to("messages").exactly(:once)
|
36
|
+
#
|
37
|
+
# expect {
|
38
|
+
# 3.times { ActionCable.server.broadcast "messages", text: 'Hi!' }
|
39
|
+
# }.to have_broadcasted_to("messages").at_least(2).times
|
40
|
+
#
|
41
|
+
# expect {
|
42
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
43
|
+
# }.to have_broadcasted_to("messages").at_most(:twice)
|
44
|
+
#
|
45
|
+
# expect {
|
46
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
47
|
+
# }.to have_broadcasted_to("messages").with(text: 'Hi!')
|
48
|
+
def have_broadcasted_to(target = nil)
|
49
|
+
check_action_cable_adapter
|
50
|
+
|
51
|
+
ActionCable::HaveBroadcastedTo.new(target, channel: described_class)
|
52
|
+
end
|
53
|
+
alias_method :broadcast_to, :have_broadcasted_to
|
54
|
+
|
55
|
+
private
|
56
|
+
|
57
|
+
# @private
|
58
|
+
def check_action_cable_adapter
|
59
|
+
return if ::ActionCable::SubscriptionAdapter::Test === ::ActionCable.server.pubsub
|
60
|
+
|
61
|
+
raise StandardError, "To use ActionCable matchers set `adapter: test` in your cable.yml"
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
@@ -0,0 +1,170 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
module ActionCable
|
5
|
+
# rubocop: disable Metrics/ClassLength
|
6
|
+
# @private
|
7
|
+
class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
|
8
|
+
def initialize(target, channel:)
|
9
|
+
@target = target
|
10
|
+
@channel = channel
|
11
|
+
@block = proc { }
|
12
|
+
@data = nil
|
13
|
+
set_expected_number(:exactly, 1)
|
14
|
+
end
|
15
|
+
|
16
|
+
def with(data = nil, &block)
|
17
|
+
@data = data
|
18
|
+
@data = @data.with_indifferent_access if @data.is_a?(Hash)
|
19
|
+
@block = block if block
|
20
|
+
self
|
21
|
+
end
|
22
|
+
|
23
|
+
def exactly(count)
|
24
|
+
set_expected_number(:exactly, count)
|
25
|
+
self
|
26
|
+
end
|
27
|
+
|
28
|
+
def at_least(count)
|
29
|
+
set_expected_number(:at_least, count)
|
30
|
+
self
|
31
|
+
end
|
32
|
+
|
33
|
+
def at_most(count)
|
34
|
+
set_expected_number(:at_most, count)
|
35
|
+
self
|
36
|
+
end
|
37
|
+
|
38
|
+
def times
|
39
|
+
self
|
40
|
+
end
|
41
|
+
|
42
|
+
def once
|
43
|
+
exactly(:once)
|
44
|
+
end
|
45
|
+
|
46
|
+
def twice
|
47
|
+
exactly(:twice)
|
48
|
+
end
|
49
|
+
|
50
|
+
def thrice
|
51
|
+
exactly(:thrice)
|
52
|
+
end
|
53
|
+
|
54
|
+
def failure_message
|
55
|
+
"expected to broadcast #{base_message}".tap do |msg|
|
56
|
+
if @unmatching_msgs.any?
|
57
|
+
msg << "\nBroadcasted messages to #{stream}:"
|
58
|
+
@unmatching_msgs.each do |data|
|
59
|
+
msg << "\n #{data}"
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
def failure_message_when_negated
|
66
|
+
"expected not to broadcast #{base_message}"
|
67
|
+
end
|
68
|
+
|
69
|
+
def message_expectation_modifier
|
70
|
+
case @expectation_type
|
71
|
+
when :exactly then "exactly"
|
72
|
+
when :at_most then "at most"
|
73
|
+
when :at_least then "at least"
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
def supports_block_expectations?
|
78
|
+
true
|
79
|
+
end
|
80
|
+
|
81
|
+
def matches?(proc)
|
82
|
+
raise ArgumentError, "have_broadcasted_to and broadcast_to only support block expectations" unless Proc === proc
|
83
|
+
|
84
|
+
original_sent_messages_count = pubsub_adapter.broadcasts(stream).size
|
85
|
+
proc.call
|
86
|
+
in_block_messages = pubsub_adapter.broadcasts(stream).drop(original_sent_messages_count)
|
87
|
+
|
88
|
+
check(in_block_messages)
|
89
|
+
end
|
90
|
+
|
91
|
+
def from_channel(channel)
|
92
|
+
@channel = channel
|
93
|
+
self
|
94
|
+
end
|
95
|
+
|
96
|
+
private
|
97
|
+
|
98
|
+
def stream
|
99
|
+
@stream ||= if @target.is_a?(String)
|
100
|
+
@target
|
101
|
+
else
|
102
|
+
check_channel_presence
|
103
|
+
@channel.broadcasting_for(@target)
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
def check(messages)
|
108
|
+
@matching_msgs, @unmatching_msgs = messages.partition do |msg|
|
109
|
+
decoded = ActiveSupport::JSON.decode(msg)
|
110
|
+
decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
|
111
|
+
|
112
|
+
if @data.nil? || @data === decoded
|
113
|
+
@block.call(decoded)
|
114
|
+
true
|
115
|
+
else
|
116
|
+
false
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
@matching_msgs_count = @matching_msgs.size
|
121
|
+
|
122
|
+
case @expectation_type
|
123
|
+
when :exactly then @expected_number == @matching_msgs_count
|
124
|
+
when :at_most then @expected_number >= @matching_msgs_count
|
125
|
+
when :at_least then @expected_number <= @matching_msgs_count
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
def set_expected_number(relativity, count)
|
130
|
+
@expectation_type = relativity
|
131
|
+
@expected_number =
|
132
|
+
case count
|
133
|
+
when :once then 1
|
134
|
+
when :twice then 2
|
135
|
+
when :thrice then 3
|
136
|
+
else Integer(count)
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
140
|
+
def base_message
|
141
|
+
"#{message_expectation_modifier} #{@expected_number} messages to #{stream}".tap do |msg|
|
142
|
+
msg << " with #{data_description(@data)}" unless @data.nil?
|
143
|
+
msg << ", but broadcast #{@matching_msgs_count}"
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
def data_description(data)
|
148
|
+
if data.is_a?(RSpec::Matchers::Composable)
|
149
|
+
data.description
|
150
|
+
else
|
151
|
+
data
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
def pubsub_adapter
|
156
|
+
::ActionCable.server.pubsub
|
157
|
+
end
|
158
|
+
|
159
|
+
def check_channel_presence
|
160
|
+
return if @channel.present? && @channel.respond_to?(:channel_name)
|
161
|
+
|
162
|
+
error_msg = "Broadcasting channel can't be infered. Please, specify it with `from_channel`"
|
163
|
+
raise ArgumentError, error_msg
|
164
|
+
end
|
165
|
+
end
|
166
|
+
# rubocop: enable Metrics/ClassLength
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
module ActionCable
|
5
|
+
# @api private
|
6
|
+
# Provides the implementation for `have_stream`, `have_stream_for`, and `have_stream_from`.
|
7
|
+
# Not intended to be instantiated directly.
|
8
|
+
class HaveStream < RSpec::Matchers::BuiltIn::BaseMatcher
|
9
|
+
# @api private
|
10
|
+
# @return [String]
|
11
|
+
def failure_message
|
12
|
+
"expected to have #{base_message}"
|
13
|
+
end
|
14
|
+
|
15
|
+
# @api private
|
16
|
+
# @return [String]
|
17
|
+
def failure_message_when_negated
|
18
|
+
"expected not to have #{base_message}"
|
19
|
+
end
|
20
|
+
|
21
|
+
# @api private
|
22
|
+
# @return [Boolean]
|
23
|
+
def matches?(subscription)
|
24
|
+
raise(ArgumentError, "have_streams is used for negated expectations only") if no_expected?
|
25
|
+
|
26
|
+
match(subscription)
|
27
|
+
end
|
28
|
+
|
29
|
+
# @api private
|
30
|
+
# @return [Boolean]
|
31
|
+
def does_not_match?(subscription)
|
32
|
+
!match(subscription)
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
def match(subscription)
|
38
|
+
case subscription
|
39
|
+
when ::ActionCable::Channel::Base
|
40
|
+
@actual = subscription.streams
|
41
|
+
no_expected? ? actual.any? : actual.any? { |i| expected === i }
|
42
|
+
else
|
43
|
+
raise ArgumentError, "have_stream, have_stream_from and have_stream_from support expectations on subscription only"
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def base_message
|
48
|
+
no_expected? ? "any stream started" : "stream #{expected_formatted} started, but have #{actual_formatted}"
|
49
|
+
end
|
50
|
+
|
51
|
+
def no_expected?
|
52
|
+
!defined?(@expected)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,73 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
# Namespace for various implementations of ActionMailbox features
|
5
|
+
#
|
6
|
+
# @api private
|
7
|
+
module ActionMailbox
|
8
|
+
# @private
|
9
|
+
class Base < RSpec::Rails::Matchers::BaseMatcher
|
10
|
+
private
|
11
|
+
|
12
|
+
def create_inbound_email(message)
|
13
|
+
RSpec::Rails::MailboxExampleGroup.create_inbound_email(message)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
# @private
|
18
|
+
class ReceiveInboundEmail < Base
|
19
|
+
def initialize(message)
|
20
|
+
super()
|
21
|
+
|
22
|
+
@inbound_email = create_inbound_email(message)
|
23
|
+
end
|
24
|
+
|
25
|
+
if defined?(::ApplicationMailbox) && ::ApplicationMailbox.router.respond_to?(:mailbox_for)
|
26
|
+
def matches?(mailbox)
|
27
|
+
@mailbox = mailbox
|
28
|
+
@receiver = ApplicationMailbox.router.mailbox_for(inbound_email)
|
29
|
+
|
30
|
+
@receiver == @mailbox
|
31
|
+
end
|
32
|
+
else
|
33
|
+
def matches?(mailbox)
|
34
|
+
@mailbox = mailbox
|
35
|
+
@receiver = ApplicationMailbox.router.send(:match_to_mailbox, inbound_email)
|
36
|
+
|
37
|
+
@receiver == @mailbox
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def failure_message
|
42
|
+
"expected #{describe_inbound_email} to route to #{mailbox}".tap do |msg|
|
43
|
+
if receiver
|
44
|
+
msg << ", but routed to #{receiver} instead"
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
def failure_message_when_negated
|
50
|
+
"expected #{describe_inbound_email} not to route to #{mailbox}"
|
51
|
+
end
|
52
|
+
|
53
|
+
private
|
54
|
+
|
55
|
+
attr_reader :inbound_email, :mailbox, :receiver
|
56
|
+
|
57
|
+
def describe_inbound_email
|
58
|
+
"mail to #{inbound_email.mail.to.to_sentence}"
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# @api public
|
64
|
+
# Passes if the given inbound email would be routed to the subject inbox.
|
65
|
+
#
|
66
|
+
# @param message [Hash, Mail::Message] a mail message or hash of
|
67
|
+
# attributes used to build one
|
68
|
+
def receive_inbound_email(message)
|
69
|
+
ActionMailbox::ReceiveInboundEmail.new(message)
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
@@ -8,14 +8,14 @@ module RSpec
|
|
8
8
|
#
|
9
9
|
# @api private
|
10
10
|
module ActiveJob
|
11
|
-
# rubocop: disable
|
11
|
+
# rubocop: disable Metrics/ClassLength
|
12
12
|
# @private
|
13
13
|
class Base < RSpec::Rails::Matchers::BaseMatcher
|
14
14
|
def initialize
|
15
15
|
@args = []
|
16
16
|
@queue = nil
|
17
17
|
@at = nil
|
18
|
-
@block =
|
18
|
+
@block = proc { }
|
19
19
|
set_expected_number(:exactly, 1)
|
20
20
|
end
|
21
21
|
|
@@ -26,12 +26,16 @@ module RSpec
|
|
26
26
|
end
|
27
27
|
|
28
28
|
def on_queue(queue)
|
29
|
-
@queue = queue
|
29
|
+
@queue = queue.to_s
|
30
30
|
self
|
31
31
|
end
|
32
32
|
|
33
|
-
def at(
|
34
|
-
|
33
|
+
def at(time_or_date)
|
34
|
+
case time_or_date
|
35
|
+
when Time then @at = Time.at(time_or_date.to_f)
|
36
|
+
else
|
37
|
+
@at = time_or_date
|
38
|
+
end
|
35
39
|
self
|
36
40
|
end
|
37
41
|
|
@@ -67,7 +71,7 @@ module RSpec
|
|
67
71
|
end
|
68
72
|
|
69
73
|
def failure_message
|
70
|
-
"expected to
|
74
|
+
"expected to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}".tap do |msg|
|
71
75
|
if @unmatching_jobs.any?
|
72
76
|
msg << "\nQueued jobs:"
|
73
77
|
@unmatching_jobs.each do |job|
|
@@ -78,7 +82,7 @@ module RSpec
|
|
78
82
|
end
|
79
83
|
|
80
84
|
def failure_message_when_negated
|
81
|
-
"expected not to
|
85
|
+
"expected not to #{self.class::FAILURE_MESSAGE_EXPECTATION_ACTION} #{base_message}"
|
82
86
|
end
|
83
87
|
|
84
88
|
def message_expectation_modifier
|
@@ -97,7 +101,7 @@ module RSpec
|
|
97
101
|
|
98
102
|
def check(jobs)
|
99
103
|
@matching_jobs, @unmatching_jobs = jobs.partition do |job|
|
100
|
-
if arguments_match?(job) &&
|
104
|
+
if job_match?(job) && arguments_match?(job) && queue_match?(job) && at_match?(job)
|
101
105
|
args = deserialize_arguments(job)
|
102
106
|
@block.call(*args)
|
103
107
|
true
|
@@ -119,7 +123,7 @@ module RSpec
|
|
119
123
|
msg << " with #{@args}," if @args.any?
|
120
124
|
msg << " on queue #{@queue}," if @queue
|
121
125
|
msg << " at #{@at.inspect}," if @at
|
122
|
-
msg << " but
|
126
|
+
msg << " but #{self.class::MESSAGE_EXPECTATION_ACTION} #{@matching_jobs_count}"
|
123
127
|
end
|
124
128
|
end
|
125
129
|
|
@@ -134,29 +138,54 @@ module RSpec
|
|
134
138
|
end
|
135
139
|
end
|
136
140
|
|
141
|
+
def job_match?(job)
|
142
|
+
@job ? @job == job[:job] : true
|
143
|
+
end
|
144
|
+
|
137
145
|
def arguments_match?(job)
|
138
146
|
if @args.any?
|
147
|
+
args = serialize_and_deserialize_arguments(@args)
|
139
148
|
deserialized_args = deserialize_arguments(job)
|
140
|
-
RSpec::Mocks::ArgumentListMatcher.new(
|
149
|
+
RSpec::Mocks::ArgumentListMatcher.new(*args).args_match?(*deserialized_args)
|
141
150
|
else
|
142
151
|
true
|
143
152
|
end
|
144
153
|
end
|
145
154
|
|
146
|
-
def
|
147
|
-
|
155
|
+
def queue_match?(job)
|
156
|
+
return true unless @queue
|
157
|
+
|
158
|
+
@queue == job[:queue]
|
148
159
|
end
|
149
160
|
|
150
|
-
def
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
161
|
+
def at_match?(job)
|
162
|
+
return true unless @at
|
163
|
+
return job[:at].nil? if @at == :no_wait
|
164
|
+
return false unless job[:at]
|
165
|
+
|
166
|
+
scheduled_at = Time.at(job[:at])
|
167
|
+
values_match?(@at, scheduled_at) || check_for_inprecise_value(scheduled_at)
|
156
168
|
end
|
157
169
|
|
158
|
-
def
|
159
|
-
|
170
|
+
def check_for_inprecise_value(scheduled_at)
|
171
|
+
return unless Time === @at && values_match?(@at.change(usec: 0), scheduled_at)
|
172
|
+
|
173
|
+
RSpec.warn_with((<<-WARNING).gsub(/^\s+\|/, '').chomp)
|
174
|
+
|[WARNING] Your expected `at(...)` value does not match the job scheduled_at value
|
175
|
+
|unless microseconds are removed. This precision error often occurs when checking
|
176
|
+
|values against `Time.current` / `Time.now` which have usec precision, but Rails
|
177
|
+
|uses `n.seconds.from_now` internally which has a usec count of `0`.
|
178
|
+
|
|
179
|
+
|Use `change(usec: 0)` to correct these values. For example:
|
180
|
+
|
|
181
|
+
|`Time.current.change(usec: 0)`
|
182
|
+
|
|
183
|
+
|Note: RSpec cannot do this for you because jobs can be scheduled with usec
|
184
|
+
|precision and we do not know wether it is on purpose or not.
|
185
|
+
|
|
186
|
+
|
|
187
|
+
WARNING
|
188
|
+
false
|
160
189
|
end
|
161
190
|
|
162
191
|
def set_expected_number(relativity, count)
|
@@ -169,6 +198,13 @@ module RSpec
|
|
169
198
|
end
|
170
199
|
end
|
171
200
|
|
201
|
+
def serialize_and_deserialize_arguments(args)
|
202
|
+
serialized = ::ActiveJob::Arguments.serialize(args)
|
203
|
+
::ActiveJob::Arguments.deserialize(serialized)
|
204
|
+
rescue ::ActiveJob::SerializationError
|
205
|
+
args
|
206
|
+
end
|
207
|
+
|
172
208
|
def deserialize_arguments(job)
|
173
209
|
::ActiveJob::Arguments.deserialize(job[:args])
|
174
210
|
rescue ::ActiveJob::DeserializationError
|
@@ -179,10 +215,13 @@ module RSpec
|
|
179
215
|
::ActiveJob::Base.queue_adapter
|
180
216
|
end
|
181
217
|
end
|
182
|
-
# rubocop: enable
|
218
|
+
# rubocop: enable Metrics/ClassLength
|
183
219
|
|
184
220
|
# @private
|
185
221
|
class HaveEnqueuedJob < Base
|
222
|
+
FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
|
223
|
+
MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
|
224
|
+
|
186
225
|
def initialize(job)
|
187
226
|
super()
|
188
227
|
@job = job
|
@@ -207,6 +246,9 @@ module RSpec
|
|
207
246
|
|
208
247
|
# @private
|
209
248
|
class HaveBeenEnqueued < Base
|
249
|
+
FAILURE_MESSAGE_EXPECTATION_ACTION = 'enqueue'.freeze
|
250
|
+
MESSAGE_EXPECTATION_ACTION = 'enqueued'.freeze
|
251
|
+
|
210
252
|
def matches?(job)
|
211
253
|
@job = job
|
212
254
|
check(queue_adapter.enqueued_jobs)
|
@@ -218,6 +260,38 @@ module RSpec
|
|
218
260
|
!matches?(proc)
|
219
261
|
end
|
220
262
|
end
|
263
|
+
|
264
|
+
# @private
|
265
|
+
class HavePerformedJob < Base
|
266
|
+
FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
|
267
|
+
MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
|
268
|
+
|
269
|
+
def initialize(job)
|
270
|
+
super()
|
271
|
+
@job = job
|
272
|
+
end
|
273
|
+
|
274
|
+
def matches?(proc)
|
275
|
+
raise ArgumentError, "have_performed_job only supports block expectations" unless Proc === proc
|
276
|
+
|
277
|
+
original_performed_jobs_count = queue_adapter.performed_jobs.count
|
278
|
+
proc.call
|
279
|
+
in_block_jobs = queue_adapter.performed_jobs.drop(original_performed_jobs_count)
|
280
|
+
|
281
|
+
check(in_block_jobs)
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# @private
|
286
|
+
class HaveBeenPerformed < Base
|
287
|
+
FAILURE_MESSAGE_EXPECTATION_ACTION = 'perform'.freeze
|
288
|
+
MESSAGE_EXPECTATION_ACTION = 'performed'.freeze
|
289
|
+
|
290
|
+
def matches?(job)
|
291
|
+
@job = job
|
292
|
+
check(queue_adapter.performed_jobs)
|
293
|
+
end
|
294
|
+
end
|
221
295
|
end
|
222
296
|
|
223
297
|
# @api public
|
@@ -305,11 +379,85 @@ module RSpec
|
|
305
379
|
ActiveJob::HaveBeenEnqueued.new
|
306
380
|
end
|
307
381
|
|
382
|
+
# @api public
|
383
|
+
# Passes if a job has been performed inside block. May chain at_least, at_most or exactly to specify a number of times.
|
384
|
+
#
|
385
|
+
# @example
|
386
|
+
# expect {
|
387
|
+
# perform_jobs { HeavyLiftingJob.perform_later }
|
388
|
+
# }.to have_performed_job
|
389
|
+
#
|
390
|
+
# expect {
|
391
|
+
# perform_jobs {
|
392
|
+
# HelloJob.perform_later
|
393
|
+
# HeavyLiftingJob.perform_later
|
394
|
+
# }
|
395
|
+
# }.to have_performed_job(HelloJob).exactly(:once)
|
396
|
+
#
|
397
|
+
# expect {
|
398
|
+
# perform_jobs { 3.times { HelloJob.perform_later } }
|
399
|
+
# }.to have_performed_job(HelloJob).at_least(2).times
|
400
|
+
#
|
401
|
+
# expect {
|
402
|
+
# perform_jobs { HelloJob.perform_later }
|
403
|
+
# }.to have_performed_job(HelloJob).at_most(:twice)
|
404
|
+
#
|
405
|
+
# expect {
|
406
|
+
# perform_jobs {
|
407
|
+
# HelloJob.perform_later
|
408
|
+
# HeavyLiftingJob.perform_later
|
409
|
+
# }
|
410
|
+
# }.to have_performed_job(HelloJob).and have_performed_job(HeavyLiftingJob)
|
411
|
+
#
|
412
|
+
# expect {
|
413
|
+
# perform_jobs {
|
414
|
+
# HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
|
415
|
+
# }
|
416
|
+
# }.to have_performed_job.with(42).on_queue("low").at(Date.tomorrow.noon)
|
417
|
+
def have_performed_job(job = nil)
|
418
|
+
check_active_job_adapter
|
419
|
+
ActiveJob::HavePerformedJob.new(job)
|
420
|
+
end
|
421
|
+
alias_method :perform_job, :have_performed_job
|
422
|
+
|
423
|
+
# @api public
|
424
|
+
# Passes if a job has been performed. May chain at_least, at_most or exactly to specify a number of times.
|
425
|
+
#
|
426
|
+
# @example
|
427
|
+
# before do
|
428
|
+
# ActiveJob::Base.queue_adapter.performed_jobs.clear
|
429
|
+
# ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
|
430
|
+
# ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
|
431
|
+
# end
|
432
|
+
#
|
433
|
+
# HeavyLiftingJob.perform_later
|
434
|
+
# expect(HeavyLiftingJob).to have_been_performed
|
435
|
+
#
|
436
|
+
# HelloJob.perform_later
|
437
|
+
# HeavyLiftingJob.perform_later
|
438
|
+
# expect(HeavyLiftingJob).to have_been_performed.exactly(:once)
|
439
|
+
#
|
440
|
+
# 3.times { HelloJob.perform_later }
|
441
|
+
# expect(HelloJob).to have_been_performed.at_least(2).times
|
442
|
+
#
|
443
|
+
# HelloJob.perform_later
|
444
|
+
# HeavyLiftingJob.perform_later
|
445
|
+
# expect(HelloJob).to have_been_performed
|
446
|
+
# expect(HeavyLiftingJob).to have_been_performed
|
447
|
+
#
|
448
|
+
# HelloJob.set(wait_until: Date.tomorrow.noon, queue: "low").perform_later(42)
|
449
|
+
# expect(HelloJob).to have_been_performed.with(42).on_queue("low").at(Date.tomorrow.noon)
|
450
|
+
def have_been_performed
|
451
|
+
check_active_job_adapter
|
452
|
+
ActiveJob::HaveBeenPerformed.new
|
453
|
+
end
|
454
|
+
|
308
455
|
private
|
309
456
|
|
310
457
|
# @private
|
311
458
|
def check_active_job_adapter
|
312
459
|
return if ::ActiveJob::QueueAdapters::TestAdapter === ::ActiveJob::Base.queue_adapter
|
460
|
+
|
313
461
|
raise StandardError, "To use ActiveJob matchers set `ActiveJob::Base.queue_adapter = :test`"
|
314
462
|
end
|
315
463
|
end
|