Merge branch 'rs-notify-mailer-specs' into 'master'

Cleanup Notify spec and combine multiple examples into one

See merge request !10129

spec/mailers/emails/profile_spec.rb

@@ -5,6 +5,16 @@ describe Notify do
   include EmailSpec::Matchers
   include_context 'gitlab email notification'
 
+  shared_examples 'a new user email' do
+    it 'is sent to the new user with the correct subject and body' do
+      aggregate_failures do
+        is_expected.to deliver_to new_user_address
+        is_expected.to have_subject(/^Account was created for you$/i)
+        is_expected.to have_body_text(new_user_address)
+      end
+    end
+  end
+
   describe 'profile notifications' do
     describe 'for new users, the email' do
       let(:example_site_path) { root_path }

spec/support/notify_shared_examples.rb

@@ -27,25 +27,15 @@ shared_examples 'a multiple recipients email' do
 end
 
 shared_examples 'an email sent from GitLab' do
-  it 'is sent from GitLab' do
+  it 'has the characteristics of an email sent from GitLab' do
     sender = subject.header[:from].addrs[0]
+    reply_to = subject.header[:reply_to].addresses
+
+    aggregate_failures do
       expect(sender.display_name).to eq(gitlab_sender_display_name)
       expect(sender.address).to eq(gitlab_sender)
-  end
-
-  it 'has a Reply-To address' do
-    reply_to = subject.header[:reply_to].addresses
       expect(reply_to).to eq([gitlab_sender_reply_to])
     end
-
-  context 'when custom suffix for email subject is set' do
-    before do
-      stub_config_setting(email_subject_suffix: 'A Nice Suffix')
-    end
-
-    it 'ends the subject with the suffix' do
-      is_expected.to have_subject /\ \| A Nice Suffix$/
-    end
   end
 end
 
@@ -56,43 +46,40 @@ shared_examples 'an email that contains a header with author username' do
 end
 
 shared_examples 'an email with X-GitLab headers containing project details' do
-  it 'has X-GitLab-Project* headers' do
-    is_expected.to have_header 'X-GitLab-Project', /#{project.name}/
-    is_expected.to have_header 'X-GitLab-Project-Id', /#{project.id}/
-    is_expected.to have_header 'X-GitLab-Project-Path', /#{project.path_with_namespace}/
+  it 'has X-GitLab-Project headers' do
+    aggregate_failures do
+      is_expected.to have_header('X-GitLab-Project', /#{project.name}/)
+      is_expected.to have_header('X-GitLab-Project-Id', /#{project.id}/)
+      is_expected.to have_header('X-GitLab-Project-Path', /#{project.path_with_namespace}/)
+    end
   end
 end
 
 shared_examples 'a new thread email with reply-by-email enabled' do
-  let(:regex) { /\A<reply\-(.*)@#{Gitlab.config.gitlab.host}>\Z/ }
+  it 'has the characteristics of a threaded email' do
+    host = Gitlab.config.gitlab.host
+    route_key = "#{model.class.model_name.singular_route_key}_#{model.id}"
 
-  it 'has a Message-ID header' do
-    is_expected.to have_header 'Message-ID', "<#{model.class.model_name.singular_route_key}_#{model.id}@#{Gitlab.config.gitlab.host}>"
+    aggregate_failures do
+      is_expected.to have_header('Message-ID', "<#{route_key}@#{host}>")
+      is_expected.to have_header('References', /\A<reply\-.*@#{host}>\Z/ )
     end
-
-  it 'has a References header' do
-    is_expected.to have_header 'References', regex
   end
 end
 
 shared_examples 'a thread answer email with reply-by-email enabled' do
   include_examples 'an email with X-GitLab headers containing project details'
-  let(:regex) { /\A<#{model.class.model_name.singular_route_key}_#{model.id}@#{Gitlab.config.gitlab.host}> <reply\-(.*)@#{Gitlab.config.gitlab.host}>\Z/ }
 
-  it 'has a Message-ID header' do
-    is_expected.to have_header 'Message-ID', /\A<(.*)@#{Gitlab.config.gitlab.host}>\Z/
-  end
-
-  it 'has a In-Reply-To header' do
-    is_expected.to have_header 'In-Reply-To', "<#{model.class.model_name.singular_route_key}_#{model.id}@#{Gitlab.config.gitlab.host}>"
-  end
+  it 'has the characteristics of a threaded reply' do
+    host = Gitlab.config.gitlab.host
+    route_key = "#{model.class.model_name.singular_route_key}_#{model.id}"
 
-  it 'has a References header' do
-    is_expected.to have_header 'References', regex
+    aggregate_failures do
+      is_expected.to have_header('Message-ID', /\A<.*@#{host}>\Z/)
+      is_expected.to have_header('In-Reply-To', "<#{route_key}@#{host}>")
+      is_expected.to have_header('References',  /\A<#{route_key}@#{host}> <reply\-.*@#{host}>\Z/ )
+      is_expected.to have_subject(/^Re: /)
     end
-
-  it 'has a subject that begins with Re: ' do
-    is_expected.to have_subject /^Re: /
   end
 end
 
@@ -136,80 +123,77 @@ shared_examples 'an answer to an existing thread with reply-by-email enabled' do
   end
 end
 
-shared_examples 'a new user email' do
-  it 'is sent to the new user' do
-    is_expected.to deliver_to new_user_address
-  end
-
-  it 'has the correct subject' do
-    is_expected.to have_subject /^Account was created for you$/i
+shared_examples 'it should have Gmail Actions links' do
+  it do
+    aggregate_failures do
+      is_expected.to have_body_text('<script type="application/ld+json">')
+      is_expected.to have_body_text('ViewAction')
     end
-
-  it 'contains the new user\'s login name' do
-    is_expected.to have_body_text /#{new_user_address}/
   end
 end
 
-shared_examples 'it should have Gmail Actions links' do
-  it { is_expected.to have_body_text '<script type="application/ld+json">' }
-  it { is_expected.to have_body_text /ViewAction/ }
-end
-
 shared_examples 'it should not have Gmail Actions links' do
-  it { is_expected.not_to have_body_text '<script type="application/ld+json">' }
-  it { is_expected.not_to have_body_text /ViewAction/ }
+  it do
+    aggregate_failures do
+      is_expected.not_to have_body_text('<script type="application/ld+json">')
+      is_expected.not_to have_body_text('ViewAction')
+    end
+  end
 end
 
 shared_examples 'it should show Gmail Actions View Issue link' do
   it_behaves_like 'it should have Gmail Actions links'
 
-  it { is_expected.to have_body_text /View Issue/ }
+  it { is_expected.to have_body_text('View Issue') }
 end
 
 shared_examples 'it should show Gmail Actions View Merge request link' do
   it_behaves_like 'it should have Gmail Actions links'
 
-  it { is_expected.to have_body_text /View Merge request/ }
+  it { is_expected.to have_body_text('View Merge request') }
 end
 
 shared_examples 'it should show Gmail Actions View Commit link' do
   it_behaves_like 'it should have Gmail Actions links'
 
-  it { is_expected.to have_body_text /View Commit/ }
+  it { is_expected.to have_body_text('View Commit') }
 end
 
 shared_examples 'an unsubscribeable thread' do
   it_behaves_like 'an unsubscribeable thread with incoming address without %{key}'
 
-  it 'has a List-Unsubscribe header in the correct format' do
-    is_expected.to have_header 'List-Unsubscribe', /unsubscribe/
-    is_expected.to have_header 'List-Unsubscribe', /mailto/
-    is_expected.to have_header 'List-Unsubscribe', /^<.+,.+>$/
+  it 'has a List-Unsubscribe header in the correct format, and a body link' do
+    aggregate_failures do
+      is_expected.to have_header('List-Unsubscribe', /unsubscribe/)
+      is_expected.to have_header('List-Unsubscribe', /mailto/)
+      is_expected.to have_header('List-Unsubscribe', /^<.+,.+>$/)
+      is_expected.to have_body_text('unsubscribe')
+    end
   end
-
-  it { is_expected.to have_body_text /unsubscribe/ }
 end
 
 shared_examples 'an unsubscribeable thread with incoming address without %{key}' do
   include_context 'reply-by-email is enabled with incoming address without %{key}'
 
-  it 'has a List-Unsubscribe header in the correct format' do
-    is_expected.to have_header 'List-Unsubscribe', /unsubscribe/
-    is_expected.not_to have_header 'List-Unsubscribe', /mailto/
-    is_expected.to have_header 'List-Unsubscribe', /^<[^,]+>$/
+  it 'has a List-Unsubscribe header in the correct format, and a body link' do
+    aggregate_failures do
+      is_expected.to have_header('List-Unsubscribe', /unsubscribe/)
+      is_expected.not_to have_header('List-Unsubscribe', /mailto/)
+      is_expected.to have_header('List-Unsubscribe', /^<[^,]+>$/)
+      is_expected.to have_body_text('unsubscribe')
+    end
   end
-
-  it { is_expected.to have_body_text /unsubscribe/ }
 end
 
 shared_examples 'a user cannot unsubscribe through footer link' do
-  it 'does not have a List-Unsubscribe header' do
-    is_expected.not_to have_header 'List-Unsubscribe', /unsubscribe/
+  it 'does not have a List-Unsubscribe header or a body link' do
+    aggregate_failures do
+      is_expected.not_to have_header('List-Unsubscribe', /unsubscribe/)
+      is_expected.not_to have_body_text('unsubscribe')
+    end
   end
-
-  it { is_expected.not_to have_body_text /unsubscribe/ }
 end
 
 shared_examples 'an email with a labels subscriptions link in its footer' do
-  it { is_expected.to have_body_text /label subscriptions/ }
+  it { is_expected.to have_body_text('label subscriptions') }
 end