Merge branch 'nicolasdular/use-snowplow-helper' into 'master'

Replace all snowplow mocks with the spec helper

See merge request gitlab-org/gitlab!46695

.rubocop_todo.yml

@@ -183,19 +183,6 @@ RSpec/ContextWording:
 RSpec/ExpectChange:
   Enabled: false
 
-# Offense count: 47
-RSpec/ExpectGitlabTracking:
-  Exclude:
-    - 'spec/controllers/projects/registry/repositories_controller_spec.rb'
-    - 'spec/controllers/projects/registry/tags_controller_spec.rb'
-    - 'spec/controllers/projects/settings/operations_controller_spec.rb'
-    - 'spec/lib/api/helpers_spec.rb'
-    - 'spec/requests/api/project_container_repositories_spec.rb'
-    - 'spec/support/shared_examples/controllers/trackable_shared_examples.rb'
-    - 'spec/support/shared_examples/requests/api/discussions_shared_examples.rb'
-    - 'spec/support/shared_examples/requests/api/packages_shared_examples.rb'
-    - 'spec/support/shared_examples/requests/api/tracking_shared_examples.rb'
-
 # Offense count: 751
 RSpec/ExpectInHook:
   Enabled: false

spec/controllers/projects/registry/repositories_controller_spec.rb

@@ -50,18 +50,17 @@ RSpec.describe Projects::Registry::RepositoriesController do
                                          tags: %w[rc1 latest])
           end
 
-          it 'successfully renders container repositories' do
-            expect(Gitlab::Tracking).not_to receive(:event)
-
+          it 'successfully renders container repositories', :snowplow do
             go_to_index
 
+            expect_no_snowplow_event
             expect(response).to have_gitlab_http_status(:ok)
           end
 
-          it 'tracks the event' do
-            expect(Gitlab::Tracking).to receive(:event).with(anything, 'list_repositories')
-
+          it 'tracks the event', :snowplow do
             go_to_index(format: :json)
+
+            expect_snowplow_event(category: anything, action: 'list_repositories')
           end
 
           it 'creates a root container repository' do
@@ -132,11 +131,12 @@ RSpec.describe Projects::Registry::RepositoriesController do
           expect(response).to have_gitlab_http_status(:no_content)
         end
 
-        it 'tracks the event' do
-          expect(Gitlab::Tracking).to receive(:event).with(anything, 'delete_repository')
+        it 'tracks the event', :snowplow do
           allow(DeleteContainerRepositoryWorker).to receive(:perform_async).with(user.id, repository.id)
 
           delete_repository(repository)
+
+          expect_snowplow_event(category: anything, action: 'delete_repository')
         end
       end
     end

spec/controllers/projects/registry/tags_controller_spec.rb

@@ -39,10 +39,10 @@ RSpec.describe Projects::Registry::TagsController do
         expect(response).to include_pagination_headers
       end
 
-      it 'tracks the event' do
-        expect(Gitlab::Tracking).to receive(:event).with(anything, 'list_tags')
-
+      it 'tracks the event', :snowplow do
         get_tags
+
+        expect_snowplow_event(category: anything, action: 'list_tags')
       end
     end
 
@@ -148,11 +148,11 @@ RSpec.describe Projects::Registry::TagsController do
           bulk_destroy_tags(tags)
         end
 
-        it 'tracks the event' do
+        it 'tracks the event', :snowplow do
           expect_delete_tags(tags)
-          expect(Gitlab::Tracking).to receive(:event).with(anything, 'delete_tag_bulk')
-
           bulk_destroy_tags(tags)
+
+          expect_snowplow_event(category: anything, action: 'delete_tag_bulk')
         end
       end
     end

spec/controllers/projects/settings/operations_controller_spec.rb

@@ -166,23 +166,22 @@ RSpec.describe Projects::Settings::OperationsController do
       context 'updating each incident management setting' do
         let(:new_incident_management_settings) { {} }
 
-        shared_examples 'a gitlab tracking event' do |params, event_key|
-          it "creates a gitlab tracking event #{event_key}" do
+        shared_examples 'a gitlab tracking event' do |params, event_key, **args|
+          it "creates a gitlab tracking event #{event_key}", :snowplow do
             new_incident_management_settings = params
 
-            expect(Gitlab::Tracking).to receive(:event)
-              .with('IncidentManagement::Settings', event_key, any_args)
-
             patch :update, params: project_params(project, incident_management_setting_attributes: new_incident_management_settings)
 
             project.reload
+
+            expect_snowplow_event(category: 'IncidentManagement::Settings', action: event_key, **args)
           end
         end
 
         it_behaves_like 'a gitlab tracking event', { create_issue: '1' }, 'enabled_issue_auto_creation_on_alerts'
         it_behaves_like 'a gitlab tracking event', { create_issue: '0' }, 'disabled_issue_auto_creation_on_alerts'
-        it_behaves_like 'a gitlab tracking event', { issue_template_key: 'template' }, 'enabled_issue_template_on_alerts'
-        it_behaves_like 'a gitlab tracking event', { issue_template_key: nil }, 'disabled_issue_template_on_alerts'
+        it_behaves_like 'a gitlab tracking event', { issue_template_key: 'template' }, 'enabled_issue_template_on_alerts', label: "Template name", property: "template"
+        it_behaves_like 'a gitlab tracking event', { issue_template_key: nil }, 'disabled_issue_template_on_alerts', label: "Template name", property: ""
         it_behaves_like 'a gitlab tracking event', { send_email: '1' }, 'enabled_sending_emails'
         it_behaves_like 'a gitlab tracking event', { send_email: '0' }, 'disabled_sending_emails'
         it_behaves_like 'a gitlab tracking event', { pagerduty_active: '1' }, 'enabled_pagerduty_webhook'

spec/lib/api/helpers_spec.rb

@@ -176,10 +176,10 @@ RSpec.describe API::Helpers do
   end
 
   describe '#track_event' do
-    it "creates a gitlab tracking event" do
-      expect(Gitlab::Tracking).to receive(:event).with('foo', 'my_event')
-
+    it "creates a gitlab tracking event", :snowplow do
       subject.track_event('my_event', category: 'foo')
+
+      expect_snowplow_event(category: 'foo', action: 'my_event')
     end
 
     it "logs an exception" do

spec/requests/api/project_container_repositories_spec.rb

@@ -299,7 +299,7 @@ RSpec.describe API::ProjectContainerRepositories do
     it_behaves_like 'rejected container repository access', :reporter, :forbidden
     it_behaves_like 'rejected container repository access', :anonymous, :not_found
 
-    context 'for developer' do
+    context 'for developer', :snowplow do
       let(:api_user) { developer }
 
       context 'when there are multiple tags' do
@@ -310,11 +310,11 @@ RSpec.describe API::ProjectContainerRepositories do
         it 'properly removes tag' do
           expect(service).to receive(:execute).with(root_repository) { { status: :success } }
           expect(Projects::ContainerRepository::DeleteTagsService).to receive(:new).with(root_repository.project, api_user, tags: %w[rootA]) { service }
-          expect(Gitlab::Tracking).to receive(:event).with(described_class.name, 'delete_tag')
 
           subject
 
           expect(response).to have_gitlab_http_status(:ok)
+          expect_snowplow_event(category: described_class.name, action: 'delete_tag')
         end
       end
 
@@ -326,11 +326,11 @@ RSpec.describe API::ProjectContainerRepositories do
         it 'properly removes tag' do
           expect(service).to receive(:execute).with(root_repository) { { status: :success } }
           expect(Projects::ContainerRepository::DeleteTagsService).to receive(:new).with(root_repository.project, api_user, tags: %w[rootA]) { service }
-          expect(Gitlab::Tracking).to receive(:event).with(described_class.name, 'delete_tag')
 
           subject
 
           expect(response).to have_gitlab_http_status(:ok)
+          expect_snowplow_event(category: described_class.name, action: 'delete_tag')
         end
       end
     end

spec/support/shared_examples/controllers/trackable_shared_examples.rb

 # frozen_string_literal: true
 
 RSpec.shared_examples 'a Trackable Controller' do
-  describe '#track_event' do
+  describe '#track_event', :snowplow do
     before do
       sign_in user
     end
@@ -14,9 +14,10 @@ RSpec.shared_examples 'a Trackable Controller' do
         end
       end
 
-      it 'tracks the action name' do
-        expect(Gitlab::Tracking).to receive(:event).with('AnonymousController', 'index')
+      it 'tracks the action name', :snowplow do
         get :index
+
+        expect_snowplow_event(category: 'AnonymousController', action: 'index')
       end
     end
 
@@ -29,8 +30,9 @@ RSpec.shared_examples 'a Trackable Controller' do
       end
 
       it 'tracks with the specified param' do
-        expect(Gitlab::Tracking).to receive(:event).with('SomeCategory', 'some_event', label: 'errorlabel')
         get :index
+
+        expect_snowplow_event(category: 'SomeCategory', action: 'some_event', label: 'errorlabel')
       end
     end
   end

spec/support/shared_examples/requests/api/discussions_shared_examples.rb

@@ -128,10 +128,10 @@ RSpec.shared_examples 'discussions API' do |parent_type, noteable_type, id_name,
         stub_feature_flags(notes_create_service_tracking: false)
       end
 
-      it 'does not track any events' do
-        expect(Gitlab::Tracking).not_to receive(:event)
-
+      it 'does not track any events', :snowplow do
         post api("/#{parent_type}/#{parent.id}/#{noteable_type}/#{noteable[id_name]}/discussions"), params: { body: 'hi!' }
+
+        expect_no_snowplow_event
       end
     end
 

spec/support/shared_examples/requests/api/packages_shared_examples.rb

@@ -132,9 +132,9 @@ RSpec.shared_examples 'a package tracking event' do |category, action|
     stub_feature_flags(collect_package_events: true)
   end
 
-  it "creates a gitlab tracking event #{action}" do
-    expect(Gitlab::Tracking).to receive(:event).with(category, action)
-
+  it "creates a gitlab tracking event #{action}", :snowplow do
     expect { subject }.to change { Packages::Event.count }.by(1)
+
+    expect_snowplow_event(category: category, action: action)
   end
 end

spec/support/shared_examples/requests/api/tracking_shared_examples.rb

 # frozen_string_literal: true
 
 RSpec.shared_examples 'a gitlab tracking event' do |category, action|
-  it "creates a gitlab tracking event #{action}" do
-    expect(Gitlab::Tracking).to receive(:event).with(category, action)
-
+  it "creates a gitlab tracking event #{action}", :snowplow do
     subject
+
+    expect_snowplow_event(category: category, action: action)
   end
 end