Move spec/mailers/shared/notify.rb to spec/support

1 files changed, 200 insertions, 0 deletions

diff --git a/spec/support/notify_shared_examples.rb b/spec/support/notify_shared_examples.rb
new file mode 100644
index 00000000000..3956d05060b
--- /dev/null
+++ b/spec/support/notify_shared_examples.rb
@@ -0,0 +1,200 @@
+shared_context 'gitlab email notification' do
+  let(:gitlab_sender_display_name) { Gitlab.config.gitlab.email_display_name }
+  let(:gitlab_sender) { Gitlab.config.gitlab.email_from }
+  let(:gitlab_sender_reply_to) { Gitlab.config.gitlab.email_reply_to }
+  let(:recipient) { create(:user, email: 'recipient@example.com') }
+  let(:project) { create(:project) }
+  let(:new_user_address) { 'newguy@example.com' }
+
+  before do
+    ActionMailer::Base.deliveries.clear
+    email = recipient.emails.create(email: "notifications@example.com")
+    recipient.update_attribute(:notification_email, email.email)
+    stub_incoming_email_setting(enabled: true, address: "reply+%{key}@#{Gitlab.config.gitlab.host}")
+  end
+end
+
+shared_context 'reply-by-email is enabled with incoming address without %{key}' do
+  before do
+    stub_incoming_email_setting(enabled: true, address: "reply@#{Gitlab.config.gitlab.host}")
+  end
+end
+
+shared_examples 'a multiple recipients email' do
+  it 'is sent to the given recipient' do
+    is_expected.to deliver_to recipient.notification_email
+  end
+end
+
+shared_examples 'an email sent from GitLab' do
+  it 'is sent from GitLab' do
+    sender = subject.header[:from].addrs[0]
+    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
+
+shared_examples 'an email that contains a header with author username' do
+  it 'has X-GitLab-Author header containing author\'s username' do
+    is_expected.to have_header 'X-GitLab-Author', user.username
+  end
+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}/
+  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 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}>"
+  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 a References header' do
+    is_expected.to have_header 'References', regex
+  end
+
+  it 'has a subject that begins with Re: ' do
+    is_expected.to have_subject /^Re: /
+  end
+end
+
+shared_examples 'an email starting a new thread with reply-by-email enabled' do
+  include_examples 'an email with X-GitLab headers containing project details'
+  include_examples 'a new thread email with reply-by-email enabled'
+
+  context 'when reply-by-email is enabled with incoming address with %{key}' do
+    it 'has a Reply-To header' do
+      is_expected.to have_header 'Reply-To', /<reply+(.*)@#{Gitlab.config.gitlab.host}>\Z/
+    end
+  end
+
+  context 'when reply-by-email is enabled with incoming address without %{key}' do
+    include_context 'reply-by-email is enabled with incoming address without %{key}'
+    include_examples 'a new thread email with reply-by-email enabled'
+
+    it 'has a Reply-To header' do
+      is_expected.to have_header 'Reply-To', /<reply@#{Gitlab.config.gitlab.host}>\Z/
+    end
+  end
+end
+
+shared_examples 'an answer to an existing thread with reply-by-email enabled' do
+  include_examples 'an email with X-GitLab headers containing project details'
+  include_examples 'a thread answer email with reply-by-email enabled'
+
+  context 'when reply-by-email is enabled with incoming address with %{key}' do
+    it 'has a Reply-To header' do
+      is_expected.to have_header 'Reply-To', /<reply+(.*)@#{Gitlab.config.gitlab.host}>\Z/
+    end
+  end
+
+  context 'when reply-by-email is enabled with incoming address without %{key}' do
+    include_context 'reply-by-email is enabled with incoming address without %{key}'
+    include_examples 'a thread answer email with reply-by-email enabled'
+
+    it 'has a Reply-To header' do
+      is_expected.to have_header 'Reply-To', /<reply@#{Gitlab.config.gitlab.host}>\Z/
+    end
+  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
+  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/ }
+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/ }
+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/ }
+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/ }
+end
+
+shared_examples 'an unsubscribeable thread' do
+  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', /^<.+>$/
+  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/
+  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/ }
+end