diff options
Diffstat (limited to 'spec/rubocop/cop/rspec/expect_gitlab_tracking_spec.rb')
-rw-r--r-- | spec/rubocop/cop/rspec/expect_gitlab_tracking_spec.rb | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/spec/rubocop/cop/rspec/expect_gitlab_tracking_spec.rb b/spec/rubocop/cop/rspec/expect_gitlab_tracking_spec.rb new file mode 100644 index 00000000000..f7adc1373df --- /dev/null +++ b/spec/rubocop/cop/rspec/expect_gitlab_tracking_spec.rb @@ -0,0 +1,65 @@ +# frozen_string_literal: true + +require 'fast_spec_helper' +require 'rubocop' +require 'rubocop/rspec/support' + +require_relative '../../../../rubocop/cop/rspec/expect_gitlab_tracking' + +RSpec.describe RuboCop::Cop::RSpec::ExpectGitlabTracking do + include CopHelper + + let(:source_file) { 'spec/foo_spec.rb' } + + subject(:cop) { described_class.new } + + good_samples = [ + 'expect_snowplow_event(category: nil, action: nil)', + 'expect_snowplow_event(category: "EventCategory", action: "event_action")', + 'expect_snowplow_event(category: "EventCategory", action: "event_action", label: "label", property: "property")', + 'expect_no_snowplow_event' + ] + + bad_samples = [ + 'expect(Gitlab::Tracking).to receive(:event)', + 'expect(Gitlab::Tracking).to_not receive(:event)', + 'expect(Gitlab::Tracking).not_to receive(:event)', + 'expect(Gitlab::Tracking).to_not receive(:event).with("EventCategory", "event_action")', + 'expect(Gitlab::Tracking).not_to receive(:event).with("EventCategory", "event_action")', + 'expect(Gitlab::Tracking).to receive(:event).with("EventCategory", "event_action", label: "label", property: "property")', + 'expect(Gitlab::Tracking).to have_received(:event).with("EventCategory", "event_action")', + 'expect(Gitlab::Tracking).to_not have_received(:event).with("EventCategory", "event_action")', + 'expect(Gitlab::Tracking).not_to have_received(:event).with("EventCategory", "event_action")', + 'allow(Gitlab::Tracking).to receive(:event).and_call_original' + ] + + good_samples.each do |good| + context "good: #{good}" do + it 'does not register an offense' do + inspect_source(good) + + expect(cop.offenses).to be_empty + end + end + end + + bad_samples.each do |bad| + context "bad: #{bad}" do + it 'registers an offense', :aggregate_failures do + inspect_source(bad, source_file) + + expect(cop.offenses.size).to eq(1) + expect(cop.offenses.map(&:line)).to eq([1]) + expect(cop.highlights).to eq([bad]) + + msg = cop.offenses.first.message + + expect(msg).to match( + /Do not expect directly on `Gitlab::Tracking#event`/ + ) + expect(msg).to match(/add the `snowplow` annotation/) + expect(msg).to match(/use `expect_snowplow_event` instead/) + end + end + end +end |