diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-14 15:09:05 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-07-14 15:09:05 +0000 |
commit | 66bd1f0fdcaf84fa3412c70d7962b49eb8a48fde (patch) | |
tree | 23f451b4e60a6e28bcc15043d7756bb27dcc2970 /spec/mailers | |
parent | 49089d4fb1f5c17328ac61c955d95a68c6d4d545 (diff) | |
download | gitlab-ce-66bd1f0fdcaf84fa3412c70d7962b49eb8a48fde.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'spec/mailers')
-rw-r--r-- | spec/mailers/emails/service_desk_spec.rb | 188 | ||||
-rw-r--r-- | spec/mailers/notify_spec.rb | 72 |
2 files changed, 260 insertions, 0 deletions
diff --git a/spec/mailers/emails/service_desk_spec.rb b/spec/mailers/emails/service_desk_spec.rb new file mode 100644 index 00000000000..842f82539cb --- /dev/null +++ b/spec/mailers/emails/service_desk_spec.rb @@ -0,0 +1,188 @@ +# frozen_string_literal: true + +require 'spec_helper' +require 'email_spec' + +RSpec.describe Emails::ServiceDesk do + include EmailSpec::Helpers + include EmailSpec::Matchers + include EmailHelpers + + include_context 'gitlab email notification' + + let_it_be(:user) { create(:user) } + let_it_be(:project) { create(:project) } + let_it_be(:issue) { create(:issue, project: project) } + let(:template) { double(content: template_content) } + + before do + stub_const('ServiceEmailClass', Class.new(ApplicationMailer)) + + ServiceEmailClass.class_eval do + include GitlabRoutingHelper + include EmailsHelper + include Emails::ServiceDesk + + helper GitlabRoutingHelper + helper EmailsHelper + + # this method is implemented in Notify class, we don't need to test it + def reply_key + 'test-key' + end + + # this method is implemented in Notify class, we don't need to test it + def sender(author_id, params = {}) + author_id + end + + # this method is implemented in Notify class + # + # We do not need to test the Notify method, it is already tested in notify_spec + def mail_new_thread(issue, options) + # we need to rewrite this in order to look up templates in the correct directory + self.class.mailer_name = 'notify' + + # this is needed for default layout + @unsubscribe_url = 'http://unsubscribe.example.com' + + mail(options) + end + alias_method :mail_answer_thread, :mail_new_thread + end + end + + shared_examples 'handle template content' do |template_key| + before do + expect(Gitlab::Template::ServiceDeskTemplate).to receive(:find) + .with(template_key, issue.project) + .and_return(template) + end + + it 'builds the email correctly' do + aggregate_failures do + is_expected.to have_referable_subject(issue, include_project: false, reply: reply_in_subject) + is_expected.to have_body_text(expected_body) + expect(subject.content_type).to include('text/html') + end + end + end + + shared_examples 'read template from repository' do |template_key| + let(:template_content) { 'custom text' } + let(:issue) { create(:issue, project: project)} + + context 'when a template is in the repository' do + let(:project) { create(:project, :custom_repo, files: { ".gitlab/service_desk_templates/#{template_key}.md" => template_content }) } + + it 'uses the text template from the template' do + is_expected.to have_body_text(template_content) + end + end + + context 'when the service_desk_templates directory does not contain correct template' do + let(:project) { create(:project, :custom_repo, files: { ".gitlab/service_desk_templates/another_file.md" => template_content }) } + + it 'uses the default template' do + is_expected.to have_body_text(default_text) + end + end + + context 'when the service_desk_templates directory does not exist' do + let(:project) { create(:project, :custom_repo, files: { "other_directory/another_file.md" => template_content }) } + + it 'uses the default template' do + is_expected.to have_body_text(default_text) + end + end + + context 'when the project does not have a repo' do + let(:project) { create(:project) } + + it 'uses the default template' do + is_expected.to have_body_text(default_text) + end + end + end + + describe '.service_desk_thank_you_email' do + let_it_be(:reply_in_subject) { true } + let_it_be(:default_text) do + "Thank you for your support request! We are tracking your request as ticket #{issue.to_reference}, and will respond as soon as we can." + end + + subject { ServiceEmailClass.service_desk_thank_you_email(issue.id) } + + it_behaves_like 'read template from repository', 'thank_you' + + context 'handling template markdown' do + context 'with a simple text' do + let(:template_content) { 'thank you, **your new issue** has been created.' } + let(:expected_body) { 'thank you, <strong>your new issue</strong> has been created.' } + + it_behaves_like 'handle template content', 'thank_you' + end + + context 'with an issue id and issue path placeholders' do + let(:template_content) { 'thank you, **your new issue:** %{ISSUE_ID}, path: %{ISSUE_PATH}' } + let(:expected_body) { "thank you, <strong>your new issue:</strong> ##{issue.iid}, path: #{project.full_path}##{issue.iid}" } + + it_behaves_like 'handle template content', 'thank_you' + end + + context 'with an issue id placeholder with whitespace' do + let(:template_content) { 'thank you, **your new issue:** %{ ISSUE_ID}' } + let(:expected_body) { "thank you, <strong>your new issue:</strong> ##{issue.iid}" } + + it_behaves_like 'handle template content', 'thank_you' + end + + context 'with unexpected placeholder' do + let(:template_content) { 'thank you, **your new issue:** %{this is issue}' } + let(:expected_body) { "thank you, <strong>your new issue:</strong> %{this is issue}" } + + it_behaves_like 'handle template content', 'thank_you' + end + end + end + + describe '.service_desk_new_note_email' do + let_it_be(:reply_in_subject) { false } + let_it_be(:note) { create(:note_on_issue, noteable: issue, project: project) } + let_it_be(:default_text) { note.note } + + subject { ServiceEmailClass.service_desk_new_note_email(issue.id, note.id) } + + it_behaves_like 'read template from repository', 'new_note' + + context 'handling template markdown' do + context 'with a simple text' do + let(:template_content) { 'thank you, **new note on issue** has been created.' } + let(:expected_body) { 'thank you, <strong>new note on issue</strong> has been created.' } + + it_behaves_like 'handle template content', 'new_note' + end + + context 'with an issue id, issue path and note placeholders' do + let(:template_content) { 'thank you, **new note on issue:** %{ISSUE_ID}, path: %{ISSUE_PATH}: %{NOTE_TEXT}' } + let(:expected_body) { "thank you, <strong>new note on issue:</strong> ##{issue.iid}, path: #{project.full_path}##{issue.iid}: #{note.note}" } + + it_behaves_like 'handle template content', 'new_note' + end + + context 'with an issue id placeholder with whitespace' do + let(:template_content) { 'thank you, **new note on issue:** %{ ISSUE_ID}: %{ NOTE_TEXT }' } + let(:expected_body) { "thank you, <strong>new note on issue:</strong> ##{issue.iid}: #{note.note}" } + + it_behaves_like 'handle template content', 'new_note' + end + + context 'with unexpected placeholder' do + let(:template_content) { 'thank you, **new note on issue:** %{this is issue}' } + let(:expected_body) { "thank you, <strong>new note on issue:</strong> %{this is issue}" } + + it_behaves_like 'handle template content', 'new_note' + end + end + end +end diff --git a/spec/mailers/notify_spec.rb b/spec/mailers/notify_spec.rb index 7c1eb66b543..5286028d9c6 100644 --- a/spec/mailers/notify_spec.rb +++ b/spec/mailers/notify_spec.rb @@ -1253,6 +1253,78 @@ RSpec.describe Notify do it_behaves_like 'appearance header and footer not enabled' end end + + context 'for service desk issues' do + before do + issue.update!(service_desk_reply_to: 'service.desk@example.com') + end + + def expect_sender(username) + sender = subject.header[:from].addrs[0] + expect(sender.display_name).to eq(username) + expect(sender.address).to eq(gitlab_sender) + end + + describe 'thank you email' do + subject { described_class.service_desk_thank_you_email(issue.id) } + + it_behaves_like 'an unsubscribeable thread' + + it 'has the correct recipient' do + is_expected.to deliver_to('service.desk@example.com') + end + + it 'has the correct subject and body' do + aggregate_failures do + is_expected.to have_referable_subject(issue, include_project: false, reply: true) + is_expected.to have_body_text("Thank you for your support request! We are tracking your request as ticket #{issue.to_reference}, and will respond as soon as we can.") + end + end + + it 'uses service bot name by default' do + expect_sender(User.support_bot.name) + end + + context 'when custom outgoing name is set' do + let_it_be(:settings) { create(:service_desk_setting, project: project, outgoing_name: 'some custom name') } + + it 'uses custom name in "from" header' do + expect_sender('some custom name') + end + end + + context 'when custom outgoing name is empty' do + let_it_be(:settings) { create(:service_desk_setting, project: project, outgoing_name: '') } + + it 'uses service bot name' do + expect_sender(User.support_bot.name) + end + end + end + + describe 'new note email' do + let_it_be(:first_note) { create(:discussion_note_on_issue, note: 'Hello world') } + + subject { described_class.service_desk_new_note_email(issue.id, first_note.id) } + + it_behaves_like 'an unsubscribeable thread' + + it 'has the correct recipient' do + is_expected.to deliver_to('service.desk@example.com') + end + + it 'uses author\'s name in "from" header' do + expect_sender(first_note.author.name) + end + + it 'has the correct subject and body' do + aggregate_failures do + is_expected.to have_referable_subject(issue, include_project: false, reply: true) + is_expected.to have_body_text(first_note.note) + end + end + end + end end context 'for a group' do |