Merge branch '32351-refactor-request-specs' into 'master'

Move common request specs into shared_examples

See merge request gitlab-org/gitlab!22428

spec/requests/self_monitoring_project_spec.rb

@@ -22,44 +22,9 @@ describe 'Self-Monitoring project requests' do
       end
 
       context 'with feature flag enabled' do
-        it 'returns sidekiq job_id of expected length' do
-          subject
-
-          job_id = json_response['job_id']
-
-          aggregate_failures do
-            expect(job_id).to be_present
-            expect(job_id.length).to be <= Admin::ApplicationSettingsController::PARAM_JOB_ID_MAX_SIZE
-          end
-        end
-
-        it 'triggers async worker' do
-          expect(worker_class).to receive(:perform_async)
-
-          subject
-        end
-
-        it 'returns accepted response' do
-          subject
-
-          aggregate_failures do
-            expect(response).to have_gitlab_http_status(:accepted)
-            expect(json_response.keys).to contain_exactly('job_id', 'monitor_status')
-            expect(json_response).to include(
-              'monitor_status' => status_create_self_monitoring_project_admin_application_settings_path
-            )
-          end
-        end
-
-        it 'returns job_id' do
-          fake_job_id = 'b5b28910d97563e58c2fe55f'
-          expect(worker_class).to receive(:perform_async).and_return(fake_job_id)
+        let(:status_api) { status_create_self_monitoring_project_admin_application_settings_path }
 
-          subject
-          response_job_id = json_response['job_id']
-
-          expect(response_job_id).to eq fake_job_id
-        end
+        it_behaves_like 'triggers async worker, returns sidekiq job_id with response accepted'
       end
     end
   end
@@ -85,15 +50,32 @@ describe 'Self-Monitoring project requests' do
       end
 
       context 'with feature flag enabled' do
-        context 'with invalid job_id' do
-          it 'returns bad_request if job_id too long' do
-            get status_create_self_monitoring_project_admin_application_settings_path,
-              params: { job_id: 'a' * 51 }
+        it_behaves_like 'handles invalid job_id'
+
+        context 'when job is in progress' do
+          before do
+            allow(worker_class).to receive(:in_progress?)
+              .with(job_id)
+              .and_return(true)
+          end
+
+          it_behaves_like 'sets polling header and returns accepted' do
+            let(:in_progress_message) { 'Job is in progress' }
+          end
+        end
+
+        context 'when self-monitoring project and job do not exist' do
+          let(:job_id) { nil }
+
+          it 'returns bad_request' do
+            subject
 
             aggregate_failures do
               expect(response).to have_gitlab_http_status(:bad_request)
-              expect(json_response).to eq('message' => 'Parameter "job_id" cannot ' \
-                "exceed length of #{Admin::ApplicationSettingsController::PARAM_JOB_ID_MAX_SIZE}")
+              expect(json_response).to eq(
+                'message' => 'Self-monitoring project does not exist. Please check logs ' \
+                  'for any error messages'
+              )
             end
           end
         end
@@ -118,7 +100,7 @@ describe 'Self-Monitoring project requests' do
             end
           end
 
-          it 'returns success' do
+          it 'returns success with job_id' do
             subject
 
             aggregate_failures do
@@ -130,45 +112,6 @@ describe 'Self-Monitoring project requests' do
             end
           end
         end
-
-        context 'when job is in progress' do
-          before do
-            allow(worker_class).to receive(:in_progress?)
-              .with(job_id)
-              .and_return(true)
-          end
-
-          it 'sets polling header' do
-            expect(::Gitlab::PollingInterval).to receive(:set_header)
-
-            subject
-          end
-
-          it 'returns accepted' do
-            subject
-
-            aggregate_failures do
-              expect(response).to have_gitlab_http_status(:accepted)
-              expect(json_response).to eq('message' => 'Job is in progress')
-            end
-          end
-        end
-
-        context 'when self-monitoring project and job do not exist' do
-          let(:job_id) { nil }
-
-          it 'returns bad_request' do
-            subject
-
-            aggregate_failures do
-              expect(response).to have_gitlab_http_status(:bad_request)
-              expect(json_response).to eq(
-                'message' => 'Self-monitoring project does not exist. Please check ' \
-                  'logs for any error messages'
-              )
-            end
-          end
-        end
       end
     end
   end

spec/support/shared_examples/requests/self_monitoring_shared_examples.rb

@@ -39,3 +39,94 @@ RSpec.shared_examples 'not accessible to non-admin users' do
     end
   end
 end
+
+# Requires subject and worker_class and status_api to be defined
+#   let(:worker_class) { SelfMonitoringProjectCreateWorker }
+#   let(:status_api) { status_create_self_monitoring_project_admin_application_settings_path }
+#   subject { post create_self_monitoring_project_admin_application_settings_path }
+RSpec.shared_examples 'triggers async worker, returns sidekiq job_id with response accepted' do
+  it 'returns sidekiq job_id of expected length' do
+    subject
+
+    job_id = json_response['job_id']
+
+    aggregate_failures do
+      expect(job_id).to be_present
+      expect(job_id.length).to be <= Admin::ApplicationSettingsController::PARAM_JOB_ID_MAX_SIZE
+    end
+  end
+
+  it 'triggers async worker' do
+    expect(worker_class).to receive(:perform_async)
+
+    subject
+  end
+
+  it 'returns accepted response' do
+    subject
+
+    aggregate_failures do
+      expect(response).to have_gitlab_http_status(:accepted)
+      expect(json_response.keys).to contain_exactly('job_id', 'monitor_status')
+      expect(json_response).to include(
+        'monitor_status' => status_api
+      )
+    end
+  end
+
+  it 'returns job_id' do
+    fake_job_id = 'b5b28910d97563e58c2fe55f'
+    allow(worker_class).to receive(:perform_async).and_return(fake_job_id)
+
+    subject
+
+    expect(json_response).to include('job_id' => fake_job_id)
+  end
+end
+
+# Requires job_id and subject to be defined
+#   let(:job_id) { 'job_id' }
+#   subject do
+#     get status_create_self_monitoring_project_admin_application_settings_path,
+#       params: { job_id: job_id }
+#   end
+RSpec.shared_examples 'handles invalid job_id' do
+  context 'with invalid job_id' do
+    let(:job_id) { 'a' * 51 }
+
+    it 'returns bad_request if job_id too long' do
+      subject
+
+      aggregate_failures do
+        expect(response).to have_gitlab_http_status(:bad_request)
+        expect(json_response).to eq('message' => 'Parameter "job_id" cannot ' \
+          "exceed length of #{Admin::ApplicationSettingsController::PARAM_JOB_ID_MAX_SIZE}")
+      end
+    end
+  end
+end
+
+# Requires in_progress_message and subject to be defined
+#   let(:in_progress_message) { 'Job to create self-monitoring project is in progress' }
+#   subject do
+#     get status_create_self_monitoring_project_admin_application_settings_path,
+#       params: { job_id: job_id }
+#   end
+RSpec.shared_examples 'sets polling header and returns accepted' do
+  it 'sets polling header' do
+    expect(::Gitlab::PollingInterval).to receive(:set_header)
+
+    subject
+  end
+
+  it 'returns accepted' do
+    subject
+
+    aggregate_failures do
+      expect(response).to have_gitlab_http_status(:accepted)
+      expect(json_response).to eq(
+        'message' => in_progress_message
+      )
+    end
+  end
+end