mirror of
https://github.com/discourse/discourse.git
synced 2024-11-25 23:43:43 +08:00
671 lines
21 KiB
Ruby
671 lines
21 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe Admin::EmailController do
|
|
fab!(:admin) { Fabricate(:admin) }
|
|
fab!(:moderator) { Fabricate(:moderator) }
|
|
fab!(:user) { Fabricate(:user) }
|
|
fab!(:email_log) { Fabricate(:email_log) }
|
|
|
|
describe "#index" do
|
|
context "when logged in as an admin" do
|
|
before do
|
|
sign_in(admin)
|
|
Admin::EmailController
|
|
.any_instance
|
|
.expects(:action_mailer_settings)
|
|
.returns(username: "username", password: "secret")
|
|
end
|
|
|
|
it "does not include the password in the response" do
|
|
get "/admin/email.json"
|
|
mail_settings = response.parsed_body["settings"]
|
|
|
|
expect(mail_settings.select { |setting| setting["name"] == "password" }).to be_empty
|
|
end
|
|
end
|
|
|
|
shared_examples "email settings inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
get "/admin/email.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["settings"]).to be_nil
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "email settings inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "email settings inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#sent" do
|
|
fab!(:post) { Fabricate(:post) }
|
|
fab!(:email_log) { Fabricate(:email_log, post: post) }
|
|
|
|
let(:post_reply_key) { Fabricate(:post_reply_key, post: post, user: email_log.user) }
|
|
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "should return the right response" do
|
|
email_log
|
|
get "/admin/email/sent.json"
|
|
|
|
expect(response.status).to eq(200)
|
|
log = response.parsed_body.first
|
|
expect(log["id"]).to eq(email_log.id)
|
|
expect(log["reply_key"]).to eq(nil)
|
|
|
|
post_reply_key
|
|
|
|
get "/admin/email/sent.json"
|
|
|
|
expect(response.status).to eq(200)
|
|
log = response.parsed_body.first
|
|
expect(log["id"]).to eq(email_log.id)
|
|
expect(log["reply_key"]).to eq(post_reply_key.reply_key)
|
|
end
|
|
|
|
it "should be able to filter by reply key" do
|
|
email_log_2 = Fabricate(:email_log, post: post)
|
|
|
|
post_reply_key_2 =
|
|
Fabricate(
|
|
:post_reply_key,
|
|
post: post,
|
|
user: email_log_2.user,
|
|
reply_key: "2d447423-c625-4fb9-8717-ff04ac60eee8",
|
|
)
|
|
|
|
%w[17ff04 2d447423c6254fb98717ff04ac60eee8].each do |reply_key|
|
|
get "/admin/email/sent.json", params: { reply_key: reply_key }
|
|
|
|
expect(response.status).to eq(200)
|
|
|
|
logs = response.parsed_body
|
|
|
|
expect(logs.size).to eq(1)
|
|
expect(logs.first["reply_key"]).to eq(post_reply_key_2.reply_key)
|
|
end
|
|
end
|
|
|
|
it "should be able to filter by smtp_transaction_response" do
|
|
email_log_2 = Fabricate(:email_log, smtp_transaction_response: <<~RESPONSE)
|
|
250 Ok: queued as pYoKuQ1aUG5vdpgh-k2K11qcpF4C1ZQ5qmvmmNW25SM=@mailhog.example
|
|
RESPONSE
|
|
|
|
get "/admin/email/sent.json", params: { smtp_transaction_response: "pYoKu" }
|
|
|
|
expect(response.status).to eq(200)
|
|
|
|
logs = response.parsed_body
|
|
|
|
expect(logs.size).to eq(1)
|
|
expect(logs.first["smtp_transaction_response"]).to eq(email_log_2.smtp_transaction_response)
|
|
end
|
|
end
|
|
|
|
shared_examples "sent emails inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
get "/admin/email/sent.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "sent emails inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "sent emails inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#skipped" do
|
|
# fab!(:user) { Fabricate(:user) }
|
|
fab!(:log1) { Fabricate(:skipped_email_log, user: user, created_at: 20.minutes.ago) }
|
|
fab!(:log2) { Fabricate(:skipped_email_log, created_at: 10.minutes.ago) }
|
|
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "succeeds" do
|
|
get "/admin/email/skipped.json"
|
|
|
|
expect(response.status).to eq(200)
|
|
|
|
logs = response.parsed_body
|
|
|
|
expect(logs.first["id"]).to eq(log2.id)
|
|
expect(logs.last["id"]).to eq(log1.id)
|
|
end
|
|
|
|
context "when filtered by username" do
|
|
it "should return the right response" do
|
|
get "/admin/email/skipped.json", params: { user: user.username }
|
|
|
|
expect(response.status).to eq(200)
|
|
|
|
logs = response.parsed_body
|
|
|
|
expect(logs.count).to eq(1)
|
|
expect(logs.first["id"]).to eq(log1.id)
|
|
end
|
|
end
|
|
end
|
|
|
|
shared_examples "skipped emails inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
get "/admin/email/skipped.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "skipped emails inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "skipped emails inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#test" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "raises an error without the email parameter" do
|
|
post "/admin/email/test.json"
|
|
expect(response.status).to eq(400)
|
|
end
|
|
|
|
context "with an email address" do
|
|
it "enqueues a test email job" do
|
|
post "/admin/email/test.json", params: { email_address: "eviltrout@test.domain" }
|
|
|
|
expect(response.status).to eq(200)
|
|
expect(ActionMailer::Base.deliveries.map(&:to).flatten).to include(
|
|
"eviltrout@test.domain",
|
|
)
|
|
end
|
|
end
|
|
|
|
context "with SiteSetting.disable_emails" do
|
|
fab!(:eviltrout) { Fabricate(:evil_trout) }
|
|
fab!(:admin) { Fabricate(:admin) }
|
|
|
|
it 'bypasses disable when setting is "yes"' do
|
|
SiteSetting.disable_emails = "yes"
|
|
post "/admin/email/test.json", params: { email_address: admin.email }
|
|
|
|
expect(ActionMailer::Base.deliveries.first.to).to contain_exactly(admin.email)
|
|
|
|
incoming = response.parsed_body
|
|
expect(incoming["sent_test_email_message"]).to eq(I18n.t("admin.email.sent_test"))
|
|
end
|
|
|
|
it 'bypasses disable when setting is "non-staff"' do
|
|
SiteSetting.disable_emails = "non-staff"
|
|
|
|
post "/admin/email/test.json", params: { email_address: eviltrout.email }
|
|
|
|
expect(ActionMailer::Base.deliveries.first.to).to contain_exactly(eviltrout.email)
|
|
|
|
incoming = response.parsed_body
|
|
expect(incoming["sent_test_email_message"]).to eq(I18n.t("admin.email.sent_test"))
|
|
end
|
|
|
|
it 'works when setting is "no"' do
|
|
SiteSetting.disable_emails = "no"
|
|
|
|
post "/admin/email/test.json", params: { email_address: eviltrout.email }
|
|
|
|
expect(ActionMailer::Base.deliveries.first.to).to contain_exactly(eviltrout.email)
|
|
|
|
incoming = response.parsed_body
|
|
expect(incoming["sent_test_email_message"]).to eq(I18n.t("admin.email.sent_test"))
|
|
end
|
|
end
|
|
end
|
|
|
|
shared_examples "email tests not allowed" do
|
|
it "prevents email tests with a 404 response" do
|
|
post "/admin/email/test.json", params: { email_address: "eviltrout@test.domain" }
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "email tests not allowed"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "email tests not allowed"
|
|
end
|
|
end
|
|
|
|
describe "#preview_digest" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "raises an error without the last_seen_at parameter" do
|
|
get "/admin/email/preview-digest.json"
|
|
expect(response.status).to eq(400)
|
|
end
|
|
|
|
it "returns the right response when username is invalid" do
|
|
get "/admin/email/preview-digest.json",
|
|
params: {
|
|
last_seen_at: 1.week.ago,
|
|
username: "somerandomeusername",
|
|
}
|
|
|
|
expect(response.status).to eq(400)
|
|
end
|
|
|
|
it "previews the digest" do
|
|
get "/admin/email/preview-digest.json",
|
|
params: {
|
|
last_seen_at: 1.week.ago,
|
|
username: admin.username,
|
|
}
|
|
expect(response.status).to eq(200)
|
|
end
|
|
end
|
|
|
|
shared_examples "preview digest inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
get "/admin/email/preview-digest.json",
|
|
params: {
|
|
last_seen_at: 1.week.ago,
|
|
username: moderator.username,
|
|
}
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "preview digest inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "preview digest inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#send_digest" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "sends the digest" do
|
|
post "/admin/email/send-digest.json",
|
|
params: {
|
|
last_seen_at: 1.week.ago,
|
|
username: admin.username,
|
|
email: email("previous_replies"),
|
|
}
|
|
expect(response.status).to eq(200)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe "#handle_mail" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "returns a bad request if neither email parameter is present" do
|
|
post "/admin/email/handle_mail.json"
|
|
expect(response.status).to eq(400)
|
|
expect(response.body).to include("param is missing")
|
|
end
|
|
|
|
it "should enqueue the right job, and show a deprecation warning (email_encoded param should be used)" do
|
|
expect_enqueued_with(
|
|
job: :process_email,
|
|
args: {
|
|
mail: email("cc"),
|
|
retry_on_rate_limit: true,
|
|
source: :handle_mail,
|
|
},
|
|
) { post "/admin/email/handle_mail.json", params: { email: email("cc") } }
|
|
expect(response.status).to eq(200)
|
|
expect(response.body).to eq(
|
|
"warning: the email parameter is deprecated. all POST requests to this route should be sent with a base64 strict encoded email_encoded parameter instead. email has been received and is queued for processing",
|
|
)
|
|
end
|
|
|
|
it "should enqueue the right job, decoding the raw email param" do
|
|
expect_enqueued_with(
|
|
job: :process_email,
|
|
args: {
|
|
mail: email("cc"),
|
|
retry_on_rate_limit: true,
|
|
source: :handle_mail,
|
|
},
|
|
) do
|
|
post "/admin/email/handle_mail.json",
|
|
params: {
|
|
email_encoded: Base64.strict_encode64(email("cc")),
|
|
}
|
|
end
|
|
expect(response.status).to eq(200)
|
|
expect(response.body).to eq("email has been received and is queued for processing")
|
|
end
|
|
|
|
it "retries enqueueing with forced UTF-8 encoding when encountering Encoding::UndefinedConversionError" do
|
|
post "/admin/email/handle_mail.json",
|
|
params: {
|
|
email_encoded: Base64.strict_encode64(email("encoding_undefined_conversion")),
|
|
}
|
|
expect(response.status).to eq(200)
|
|
expect(response.body).to eq("email has been received and is queued for processing")
|
|
end
|
|
end
|
|
|
|
shared_examples "email handling not allowed" do
|
|
it "prevents email handling with a 404 response" do
|
|
post "/admin/email/handle_mail.json",
|
|
params: {
|
|
email_encoded: Base64.strict_encode64(email("cc")),
|
|
}
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "email handling not allowed"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "email handling not allowed"
|
|
end
|
|
end
|
|
|
|
describe "#rejected" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "should provide a string for a blank error" do
|
|
Fabricate(:incoming_email, error: "")
|
|
get "/admin/email/rejected.json"
|
|
expect(response.status).to eq(200)
|
|
rejected = response.parsed_body
|
|
expect(rejected.first["error"]).to eq(I18n.t("emails.incoming.unrecognized_error"))
|
|
end
|
|
end
|
|
|
|
shared_examples "rejected emails inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
get "/admin/email/rejected.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "rejected emails inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "rejected emails inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#incoming" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "should provide a string for a blank error" do
|
|
incoming_email = Fabricate(:incoming_email, error: "")
|
|
get "/admin/email/incoming/#{incoming_email.id}.json"
|
|
expect(response.status).to eq(200)
|
|
incoming = response.parsed_body
|
|
expect(incoming["error"]).to eq(I18n.t("emails.incoming.unrecognized_error"))
|
|
end
|
|
end
|
|
|
|
shared_examples "incoming emails inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
incoming_email = Fabricate(:incoming_email, error: "")
|
|
|
|
get "/admin/email/incoming/#{incoming_email.id}.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "incoming emails inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "incoming emails inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#incoming_from_bounced" do
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "raises an error when the email log entry does not exist" do
|
|
get "/admin/email/incoming_from_bounced/12345.json"
|
|
expect(response.status).to eq(404)
|
|
|
|
json = response.parsed_body
|
|
expect(json["errors"]).to include("Discourse::InvalidParameters")
|
|
end
|
|
|
|
it "raises an error when the email log entry is not marked as bounced" do
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(404)
|
|
|
|
json = response.parsed_body
|
|
expect(json["errors"]).to include("Discourse::InvalidParameters")
|
|
end
|
|
|
|
context "when bounced email log entry exists" do
|
|
fab!(:email_log) { Fabricate(:email_log, bounced: true, bounce_key: SecureRandom.hex) }
|
|
let(:error_message) { "Email::Receiver::BouncedEmailError" }
|
|
|
|
it "returns an incoming email sent to the reply_by_email_address" do
|
|
SiteSetting.reply_by_email_address = "replies+%{reply_key}@example.com"
|
|
|
|
Fabricate(
|
|
:incoming_email,
|
|
is_bounce: true,
|
|
error: error_message,
|
|
to_addresses: Email::Sender.bounce_address(email_log.bounce_key),
|
|
)
|
|
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(200)
|
|
|
|
json = response.parsed_body
|
|
expect(json["error"]).to eq(error_message)
|
|
end
|
|
|
|
it "returns an incoming email sent to the notification_email address" do
|
|
Fabricate(
|
|
:incoming_email,
|
|
is_bounce: true,
|
|
error: error_message,
|
|
to_addresses: SiteSetting.notification_email.sub("@", "+verp-#{email_log.bounce_key}@"),
|
|
)
|
|
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(200)
|
|
|
|
json = response.parsed_body
|
|
expect(json["error"]).to eq(error_message)
|
|
end
|
|
|
|
it "returns an incoming email sent to the notification_email address" do
|
|
SiteSetting.reply_by_email_address = "replies+%{reply_key}@subdomain.example.com"
|
|
Fabricate(
|
|
:incoming_email,
|
|
is_bounce: true,
|
|
error: error_message,
|
|
to_addresses: "subdomain+verp-#{email_log.bounce_key}@example.com",
|
|
)
|
|
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(200)
|
|
|
|
json = response.parsed_body
|
|
expect(json["error"]).to eq(error_message)
|
|
end
|
|
|
|
it "raises an error if the bounce_key is blank" do
|
|
email_log.update(bounce_key: nil)
|
|
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(404)
|
|
|
|
json = response.parsed_body
|
|
expect(json["errors"]).to include("Discourse::InvalidParameters")
|
|
end
|
|
|
|
it "raises an error if there is no incoming email" do
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
expect(response.status).to eq(404)
|
|
|
|
json = response.parsed_body
|
|
expect(json["errors"]).to include("Discourse::NotFound")
|
|
end
|
|
end
|
|
end
|
|
|
|
shared_examples "bounced incoming emails inaccessible" do
|
|
it "denies access with a 404 response" do
|
|
email_log = Fabricate(:email_log, bounced: true, bounce_key: SecureRandom.hex)
|
|
error_message = "Email::Receiver::BouncedEmailError"
|
|
SiteSetting.reply_by_email_address = "replies+%{reply_key}@example.com"
|
|
|
|
Fabricate(
|
|
:incoming_email,
|
|
is_bounce: true,
|
|
error: error_message,
|
|
to_addresses: Email::Sender.bounce_address(email_log.bounce_key),
|
|
)
|
|
|
|
get "/admin/email/incoming_from_bounced/#{email_log.id}.json"
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "bounced incoming emails inaccessible"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "bounced incoming emails inaccessible"
|
|
end
|
|
end
|
|
|
|
describe "#advanced_test" do
|
|
let(:email) { <<~EMAIL }
|
|
From: "somebody" <somebody@example.com>
|
|
To: someone@example.com
|
|
Date: Mon, 3 Dec 2018 00:00:00 -0000
|
|
Subject: This is some subject
|
|
Content-Type: text/plain; charset="UTF-8"
|
|
|
|
Hello, this is a test!
|
|
|
|
---
|
|
|
|
This part should be elided.
|
|
EMAIL
|
|
|
|
context "when logged in as an admin" do
|
|
before { sign_in(admin) }
|
|
|
|
it "should ..." do
|
|
post "/admin/email/advanced-test.json", params: { email: email }
|
|
|
|
expect(response.status).to eq(200)
|
|
incoming = response.parsed_body
|
|
expect(incoming["format"]).to eq(1)
|
|
expect(incoming["text"]).to eq("Hello, this is a test!")
|
|
expect(incoming["elided"]).to eq("---\n\nThis part should be elided.")
|
|
end
|
|
end
|
|
|
|
shared_examples "advanced email tests not allowed" do
|
|
it "prevents advanced email tests with a 404 response" do
|
|
post "/admin/email/advanced-test.json", params: { email: email }
|
|
|
|
expect(response.status).to eq(404)
|
|
expect(response.parsed_body["errors"]).to include(I18n.t("not_found"))
|
|
end
|
|
end
|
|
|
|
context "when logged in as a moderator" do
|
|
before { sign_in(moderator) }
|
|
|
|
include_examples "advanced email tests not allowed"
|
|
end
|
|
|
|
context "when logged in as a non-staff user" do
|
|
before { sign_in(user) }
|
|
|
|
include_examples "advanced email tests not allowed"
|
|
end
|
|
end
|
|
end
|