Redmine/test/unit/mailer_test.rb

769 lines
26 KiB
Ruby

# Redmine - project management software
# Copyright (C) 2006-2014 Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
require File.expand_path('../../test_helper', __FILE__)
class MailerTest < ActiveSupport::TestCase
include Redmine::I18n
include ActionDispatch::Assertions::SelectorAssertions
fixtures :projects, :enabled_modules, :issues, :users, :members,
:member_roles, :roles, :documents, :attachments, :news,
:tokens, :journals, :journal_details, :changesets,
:trackers, :projects_trackers,
:issue_statuses, :enumerations, :messages, :boards, :repositories,
:wikis, :wiki_pages, :wiki_contents, :wiki_content_versions,
:versions,
:comments
def setup
ActionMailer::Base.deliveries.clear
Setting.host_name = 'mydomain.foo'
Setting.protocol = 'http'
Setting.plain_text_mail = '0'
end
def test_generated_links_in_emails
Setting.default_language = 'en'
Setting.host_name = 'mydomain.foo'
Setting.protocol = 'https'
journal = Journal.find(3)
assert Mailer.deliver_issue_edit(journal)
mail = last_email
assert_not_nil mail
assert_select_email do
# link to the main ticket
assert_select 'a[href=?]',
'https://mydomain.foo/issues/2#change-3',
:text => 'Feature request #2: Add ingredients categories'
# link to a referenced ticket
assert_select 'a[href=?][title=?]',
'https://mydomain.foo/issues/1',
"#{ESCAPED_UCANT} print recipes (New)",
:text => '#1'
# link to a changeset
assert_select 'a[href=?][title=?]',
'https://mydomain.foo/projects/ecookbook/repository/revisions/2',
'This commit fixes #1, #2 and references #1 &amp; #3',
:text => 'r2'
# link to a description diff
assert_select 'a[href=?][title=?]',
'https://mydomain.foo/journals/diff/3?detail_id=4',
'View differences',
:text => 'diff'
# link to an attachment
assert_select 'a[href=?]',
'https://mydomain.foo/attachments/download/4/source.rb',
:text => 'source.rb'
end
end
def test_generated_links_with_prefix
Setting.default_language = 'en'
relative_url_root = Redmine::Utils.relative_url_root
Setting.host_name = 'mydomain.foo/rdm'
Setting.protocol = 'http'
journal = Journal.find(3)
assert Mailer.deliver_issue_edit(journal)
mail = last_email
assert_not_nil mail
assert_select_email do
# link to the main ticket
assert_select 'a[href=?]',
'http://mydomain.foo/rdm/issues/2#change-3',
:text => 'Feature request #2: Add ingredients categories'
# link to a referenced ticket
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/issues/1',
"#{ESCAPED_UCANT} print recipes (New)",
:text => '#1'
# link to a changeset
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2',
'This commit fixes #1, #2 and references #1 &amp; #3',
:text => 'r2'
# link to a description diff
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/journals/diff/3?detail_id=4',
'View differences',
:text => 'diff'
# link to an attachment
assert_select 'a[href=?]',
'http://mydomain.foo/rdm/attachments/download/4/source.rb',
:text => 'source.rb'
end
end
def test_issue_edit_should_generate_url_with_hostname_for_relations
journal = Journal.new(:journalized => Issue.find(1), :user => User.find(1), :created_on => Time.now)
journal.details << JournalDetail.new(:property => 'relation', :prop_key => 'label_relates_to', :value => 2)
Mailer.deliver_issue_edit(journal)
assert_not_nil last_email
assert_select_email do
assert_select 'a[href=?]', 'http://mydomain.foo/issues/2', :text => 'Feature request #2'
end
end
def test_generated_links_with_prefix_and_no_relative_url_root
Setting.default_language = 'en'
relative_url_root = Redmine::Utils.relative_url_root
Setting.host_name = 'mydomain.foo/rdm'
Setting.protocol = 'http'
Redmine::Utils.relative_url_root = nil
journal = Journal.find(3)
assert Mailer.deliver_issue_edit(journal)
mail = last_email
assert_not_nil mail
assert_select_email do
# link to the main ticket
assert_select 'a[href=?]',
'http://mydomain.foo/rdm/issues/2#change-3',
:text => 'Feature request #2: Add ingredients categories'
# link to a referenced ticket
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/issues/1',
"#{ESCAPED_UCANT} print recipes (New)",
:text => '#1'
# link to a changeset
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/projects/ecookbook/repository/revisions/2',
'This commit fixes #1, #2 and references #1 &amp; #3',
:text => 'r2'
# link to a description diff
assert_select 'a[href=?][title=?]',
'http://mydomain.foo/rdm/journals/diff/3?detail_id=4',
'View differences',
:text => 'diff'
# link to an attachment
assert_select 'a[href=?]',
'http://mydomain.foo/rdm/attachments/download/4/source.rb',
:text => 'source.rb'
end
ensure
# restore it
Redmine::Utils.relative_url_root = relative_url_root
end
def test_email_headers
issue = Issue.find(1)
Mailer.deliver_issue_add(issue)
mail = last_email
assert_not_nil mail
assert_equal 'OOF', mail.header['X-Auto-Response-Suppress'].to_s
assert_equal 'auto-generated', mail.header['Auto-Submitted'].to_s
assert_equal '<redmine.example.net>', mail.header['List-Id'].to_s
end
def test_email_headers_should_include_sender
issue = Issue.find(1)
Mailer.deliver_issue_add(issue)
mail = last_email
assert_equal issue.author.login, mail.header['X-Redmine-Sender'].to_s
end
def test_plain_text_mail
Setting.plain_text_mail = 1
journal = Journal.find(2)
Mailer.deliver_issue_edit(journal)
mail = last_email
assert_equal "text/plain; charset=UTF-8", mail.content_type
assert_equal 0, mail.parts.size
assert !mail.encoded.include?('href')
end
def test_html_mail
Setting.plain_text_mail = 0
journal = Journal.find(2)
Mailer.deliver_issue_edit(journal)
mail = last_email
assert_equal 2, mail.parts.size
assert mail.encoded.include?('href')
end
def test_from_header
with_settings :mail_from => 'redmine@example.net' do
Mailer.test_email(User.find(1)).deliver
end
mail = last_email
assert_equal 'redmine@example.net', mail.from_addrs.first
end
def test_from_header_with_phrase
with_settings :mail_from => 'Redmine app <redmine@example.net>' do
Mailer.test_email(User.find(1)).deliver
end
mail = last_email
assert_equal 'redmine@example.net', mail.from_addrs.first
assert_equal 'Redmine app <redmine@example.net>', mail.header['From'].to_s
end
def test_should_not_send_email_without_recipient
news = News.first
user = news.author
# Remove members except news author
news.project.memberships.each {|m| m.destroy unless m.user == user}
user.pref.no_self_notified = false
user.pref.save
User.current = user
Mailer.news_added(news.reload).deliver
assert_equal 1, last_email.bcc.size
# nobody to notify
user.pref.no_self_notified = true
user.pref.save
User.current = user
ActionMailer::Base.deliveries.clear
Mailer.news_added(news.reload).deliver
assert ActionMailer::Base.deliveries.empty?
end
def test_issue_add_message_id
issue = Issue.find(2)
Mailer.deliver_issue_add(issue)
mail = last_email
assert_match /^redmine\.issue-2\.20060719190421\.[a-f0-9]+@example\.net/, mail.message_id
assert_include "redmine.issue-2.20060719190421@example.net", mail.references
end
def test_issue_edit_message_id
journal = Journal.find(3)
journal.issue = Issue.find(2)
Mailer.deliver_issue_edit(journal)
mail = last_email
assert_match /^redmine\.journal-3\.\d+\.[a-f0-9]+@example\.net/, mail.message_id
assert_include "redmine.issue-2.20060719190421@example.net", mail.references
assert_select_email do
# link to the update
assert_select "a[href=?]",
"http://mydomain.foo/issues/#{journal.journalized_id}#change-#{journal.id}"
end
end
def test_message_posted_message_id
message = Message.find(1)
Mailer.message_posted(message).deliver
mail = last_email
assert_match /^redmine\.message-1\.\d+\.[a-f0-9]+@example\.net/, mail.message_id
assert_include "redmine.message-1.20070512151532@example.net", mail.references
assert_select_email do
# link to the message
assert_select "a[href=?]",
"http://mydomain.foo/boards/#{message.board.id}/topics/#{message.id}",
:text => message.subject
end
end
def test_reply_posted_message_id
message = Message.find(3)
Mailer.message_posted(message).deliver
mail = last_email
assert_match /^redmine\.message-3\.\d+\.[a-f0-9]+@example\.net/, mail.message_id
assert_include "redmine.message-1.20070512151532@example.net", mail.references
assert_select_email do
# link to the reply
assert_select "a[href=?]",
"http://mydomain.foo/boards/#{message.board.id}/topics/#{message.root.id}?r=#{message.id}#message-#{message.id}",
:text => message.subject
end
end
test "#issue_add should notify project members" do
issue = Issue.find(1)
assert Mailer.deliver_issue_add(issue)
assert last_email.bcc.include?('dlopper@somenet.foo')
end
test "#issue_add should not notify project members that are not allow to view the issue" do
issue = Issue.find(1)
Role.find(2).remove_permission!(:view_issues)
assert Mailer.deliver_issue_add(issue)
assert !last_email.bcc.include?('dlopper@somenet.foo')
end
test "#issue_add should notify issue watchers" do
issue = Issue.find(1)
user = User.find(9)
# minimal email notification options
user.pref.no_self_notified = '1'
user.pref.save
user.mail_notification = false
user.save
Watcher.create!(:watchable => issue, :user => user)
assert Mailer.deliver_issue_add(issue)
assert last_email.bcc.include?(user.mail)
end
test "#issue_add should not notify watchers not allowed to view the issue" do
issue = Issue.find(1)
user = User.find(9)
Watcher.create!(:watchable => issue, :user => user)
Role.non_member.remove_permission!(:view_issues)
assert Mailer.deliver_issue_add(issue)
assert !last_email.bcc.include?(user.mail)
end
def test_issue_add_should_include_enabled_fields
Setting.default_language = 'en'
issue = Issue.find(2)
assert Mailer.deliver_issue_add(issue)
assert_mail_body_match '* Target version: 1.0', last_email
assert_select_email do
assert_select 'li', :text => 'Target version: 1.0'
end
end
def test_issue_add_should_not_include_disabled_fields
Setting.default_language = 'en'
issue = Issue.find(2)
tracker = issue.tracker
tracker.core_fields -= ['fixed_version_id']
tracker.save!
assert Mailer.deliver_issue_add(issue)
assert_mail_body_no_match 'Target version', last_email
assert_select_email do
assert_select 'li', :text => /Target version/, :count => 0
end
end
# test mailer methods for each language
def test_issue_add
issue = Issue.find(1)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.deliver_issue_add(issue)
end
end
def test_issue_edit
journal = Journal.find(1)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.deliver_issue_edit(journal)
end
end
def test_issue_edit_should_send_private_notes_to_users_with_permission_only
journal = Journal.find(1)
journal.private_notes = true
journal.save!
Role.find(2).add_permission! :view_private_notes
Mailer.deliver_issue_edit(journal)
assert_equal %w(dlopper@somenet.foo jsmith@somenet.foo), ActionMailer::Base.deliveries.last.bcc.sort
Role.find(2).remove_permission! :view_private_notes
Mailer.deliver_issue_edit(journal)
assert_equal %w(jsmith@somenet.foo), ActionMailer::Base.deliveries.last.bcc.sort
end
def test_issue_edit_should_send_private_notes_to_watchers_with_permission_only
Issue.find(1).set_watcher(User.find_by_login('someone'))
journal = Journal.find(1)
journal.private_notes = true
journal.save!
Role.non_member.add_permission! :view_private_notes
Mailer.deliver_issue_edit(journal)
assert_include 'someone@foo.bar', ActionMailer::Base.deliveries.last.bcc.sort
Role.non_member.remove_permission! :view_private_notes
Mailer.deliver_issue_edit(journal)
assert_not_include 'someone@foo.bar', ActionMailer::Base.deliveries.last.bcc.sort
end
def test_issue_edit_should_mark_private_notes
journal = Journal.find(2)
journal.private_notes = true
journal.save!
with_settings :default_language => 'en' do
Mailer.deliver_issue_edit(journal)
end
assert_mail_body_match '(Private notes)', last_email
end
def test_issue_edit_with_relation_should_notify_users_who_can_see_the_related_issue
issue = Issue.generate!
private_issue = Issue.generate!(:is_private => true)
IssueRelation.create!(:issue_from => issue, :issue_to => private_issue, :relation_type => 'relates')
issue.reload
assert_equal 1, issue.journals.size
journal = issue.journals.first
ActionMailer::Base.deliveries.clear
Mailer.deliver_issue_edit(journal)
last_email.bcc.each do |email|
user = User.find_by_mail(email)
assert private_issue.visible?(user), "Issue was not visible to #{user}"
end
end
def test_document_added
document = Document.find(1)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.document_added(document).deliver
end
end
def test_attachments_added
attachements = [ Attachment.find_by_container_type('Document') ]
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.attachments_added(attachements).deliver
end
end
def test_version_file_added
attachements = [ Attachment.find_by_container_type('Version') ]
assert Mailer.attachments_added(attachements).deliver
assert_not_nil last_email.bcc
assert last_email.bcc.any?
assert_select_email do
assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
end
end
def test_project_file_added
attachements = [ Attachment.find_by_container_type('Project') ]
assert Mailer.attachments_added(attachements).deliver
assert_not_nil last_email.bcc
assert last_email.bcc.any?
assert_select_email do
assert_select "a[href=?]", "http://mydomain.foo/projects/ecookbook/files"
end
end
def test_news_added
news = News.first
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.news_added(news).deliver
end
end
def test_news_added_should_notify_project_news_watchers
user1 = User.generate!
user2 = User.generate!
news = News.find(1)
news.project.enabled_module('news').add_watcher(user1)
Mailer.news_added(news).deliver
assert_include user1.mail, last_email.bcc
assert_not_include user2.mail, last_email.bcc
end
def test_news_comment_added
comment = Comment.find(2)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.news_comment_added(comment).deliver
end
end
def test_message_posted
message = Message.first
recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author}
recipients = recipients.compact.uniq
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert Mailer.message_posted(message).deliver
end
end
def test_wiki_content_added
content = WikiContent.find(1)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert_difference 'ActionMailer::Base.deliveries.size' do
assert Mailer.wiki_content_added(content).deliver
assert_select_email do
assert_select 'a[href=?]',
'http://mydomain.foo/projects/ecookbook/wiki/CookBook_documentation',
:text => 'CookBook documentation'
end
end
end
end
def test_wiki_content_updated
content = WikiContent.find(1)
valid_languages.each do |lang|
Setting.default_language = lang.to_s
assert_difference 'ActionMailer::Base.deliveries.size' do
assert Mailer.wiki_content_updated(content).deliver
assert_select_email do
assert_select 'a[href=?]',
'http://mydomain.foo/projects/ecookbook/wiki/CookBook_documentation',
:text => 'CookBook documentation'
end
end
end
end
def test_account_information
user = User.find(2)
valid_languages.each do |lang|
user.update_attribute :language, lang.to_s
user.reload
assert Mailer.account_information(user, 'pAsswORd').deliver
end
end
def test_lost_password
token = Token.find(2)
valid_languages.each do |lang|
token.user.update_attribute :language, lang.to_s
token.reload
assert Mailer.lost_password(token).deliver
end
end
def test_register
token = Token.find(1)
Setting.host_name = 'redmine.foo'
Setting.protocol = 'https'
valid_languages.each do |lang|
token.user.update_attribute :language, lang.to_s
token.reload
ActionMailer::Base.deliveries.clear
assert Mailer.register(token).deliver
mail = last_email
assert_select_email do
assert_select "a[href=?]",
"https://redmine.foo/account/activate?token=#{token.value}",
:text => "https://redmine.foo/account/activate?token=#{token.value}"
end
end
end
def test_test
user = User.find(1)
valid_languages.each do |lang|
user.update_attribute :language, lang.to_s
assert Mailer.test_email(user).deliver
end
end
def test_reminders
Mailer.reminders(:days => 42)
assert_equal 1, ActionMailer::Base.deliveries.size
mail = last_email
assert mail.bcc.include?('dlopper@somenet.foo')
assert_mail_body_match 'Bug #3: Error 281 when updating a recipe', mail
assert_equal '1 issue(s) due in the next 42 days', mail.subject
end
def test_reminders_should_not_include_closed_issues
with_settings :default_language => 'en' do
Issue.create!(:project_id => 1, :tracker_id => 1, :status_id => 5,
:subject => 'Closed issue', :assigned_to_id => 3,
:due_date => 5.days.from_now,
:author_id => 2)
ActionMailer::Base.deliveries.clear
Mailer.reminders(:days => 42)
assert_equal 1, ActionMailer::Base.deliveries.size
mail = last_email
assert mail.bcc.include?('dlopper@somenet.foo')
assert_mail_body_no_match 'Closed issue', mail
end
end
def test_reminders_for_users
Mailer.reminders(:days => 42, :users => ['5'])
assert_equal 0, ActionMailer::Base.deliveries.size # No mail for dlopper
Mailer.reminders(:days => 42, :users => ['3'])
assert_equal 1, ActionMailer::Base.deliveries.size # No mail for dlopper
mail = last_email
assert mail.bcc.include?('dlopper@somenet.foo')
assert_mail_body_match 'Bug #3: Error 281 when updating a recipe', mail
end
def test_reminder_should_include_issues_assigned_to_groups
with_settings :default_language => 'en' do
group = Group.generate!
group.users << User.find(2)
group.users << User.find(3)
Issue.create!(:project_id => 1, :tracker_id => 1, :status_id => 1,
:subject => 'Assigned to group', :assigned_to => group,
:due_date => 5.days.from_now,
:author_id => 2)
ActionMailer::Base.deliveries.clear
Mailer.reminders(:days => 7)
assert_equal 2, ActionMailer::Base.deliveries.size
assert_equal %w(dlopper@somenet.foo jsmith@somenet.foo), ActionMailer::Base.deliveries.map(&:bcc).flatten.sort
ActionMailer::Base.deliveries.each do |mail|
assert_mail_body_match 'Assigned to group', mail
end
end
end
def test_mailer_should_not_change_locale
Setting.default_language = 'en'
# Set current language to italian
set_language_if_valid 'it'
# Send an email to a french user
user = User.find(1)
user.language = 'fr'
Mailer.account_activated(user).deliver
mail = last_email
assert_mail_body_match 'Votre compte', mail
assert_equal :it, current_language
end
def test_with_deliveries_off
Mailer.with_deliveries false do
Mailer.test_email(User.find(1)).deliver
end
assert ActionMailer::Base.deliveries.empty?
# should restore perform_deliveries
assert ActionMailer::Base.perform_deliveries
end
def test_layout_should_include_the_emails_header
with_settings :emails_header => "*Header content*" do
with_settings :plain_text_mail => 0 do
assert Mailer.test_email(User.find(1)).deliver
assert_select_email do
assert_select ".header" do
assert_select "strong", :text => "Header content"
end
end
end
with_settings :plain_text_mail => 1 do
assert Mailer.test_email(User.find(1)).deliver
mail = last_email
assert_not_nil mail
assert_include "*Header content*", mail.body.decoded
end
end
end
def test_layout_should_not_include_empty_emails_header
with_settings :emails_header => "", :plain_text_mail => 0 do
assert Mailer.test_email(User.find(1)).deliver
assert_select_email do
assert_select ".header", false
end
end
end
def test_layout_should_include_the_emails_footer
with_settings :emails_footer => "*Footer content*" do
with_settings :plain_text_mail => 0 do
assert Mailer.test_email(User.find(1)).deliver
assert_select_email do
assert_select ".footer" do
assert_select "strong", :text => "Footer content"
end
end
end
with_settings :plain_text_mail => 1 do
assert Mailer.test_email(User.find(1)).deliver
mail = last_email
assert_not_nil mail
assert_include "\n-- \n", mail.body.decoded
assert_include "*Footer content*", mail.body.decoded
end
end
end
def test_layout_should_not_include_empty_emails_footer
with_settings :emails_footer => "" do
with_settings :plain_text_mail => 0 do
assert Mailer.test_email(User.find(1)).deliver
assert_select_email do
assert_select ".footer", false
end
end
with_settings :plain_text_mail => 1 do
assert Mailer.test_email(User.find(1)).deliver
mail = last_email
assert_not_nil mail
assert_not_include "\n-- \n", mail.body.decoded
end
end
end
def test_should_escape_html_templates_only
Issue.generate!(:project_id => 1, :tracker_id => 1, :subject => 'Subject with a <tag>')
mail = last_email
assert_equal 2, mail.parts.size
assert_include '<tag>', text_part.body.encoded
assert_include '&lt;tag&gt;', html_part.body.encoded
end
def test_should_raise_delivery_errors_when_raise_delivery_errors_is_true
mail = Mailer.test_email(User.find(1))
mail.delivery_method.stubs(:deliver!).raises(Exception.new("delivery error"))
ActionMailer::Base.raise_delivery_errors = true
assert_raise Exception, "delivery error" do
mail.deliver
end
ensure
ActionMailer::Base.raise_delivery_errors = false
end
def test_should_log_delivery_errors_when_raise_delivery_errors_is_false
mail = Mailer.test_email(User.find(1))
mail.delivery_method.stubs(:deliver!).raises(Exception.new("delivery error"))
Rails.logger.expects(:error).with("Email delivery error: delivery error")
ActionMailer::Base.raise_delivery_errors = false
assert_nothing_raised do
mail.deliver
end
end
def test_mail_should_return_a_mail_message
assert_kind_of ::Mail::Message, Mailer.test_email(User.find(1))
end
private
def last_email
mail = ActionMailer::Base.deliveries.last
assert_not_nil mail
mail
end
def text_part
last_email.parts.detect {|part| part.content_type.include?('text/plain')}
end
def html_part
last_email.parts.detect {|part| part.content_type.include?('text/html')}
end
end