debian-mirror-gitlab/spec/lib/gitlab/mail_room/mail_room_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

332 lines
10 KiB
Ruby
Raw Normal View History

2020-01-01 13:55:28 +05:30
# frozen_string_literal: true
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::MailRoom do
2020-01-01 13:55:28 +05:30
let(:default_port) { 143 }
2022-05-07 20:08:51 +05:30
let(:log_path) { Rails.root.join('log', 'mail_room_json.log').to_s }
let(:fake_redis_queues) do
double(
url: "localhost",
db: 99,
sentinels: [{ host: 'localhost', port: 1234 }],
sentinels?: true
)
end
2020-03-13 15:44:24 +05:30
let(:yml_config) do
2020-01-01 13:55:28 +05:30
{
2020-03-13 15:44:24 +05:30
enabled: true,
2022-05-07 20:08:51 +05:30
host: 'mail.example.com',
2020-03-13 15:44:24 +05:30
address: 'address@example.com',
2022-05-07 20:08:51 +05:30
user: 'user@example.com',
password: 'password',
2020-01-01 13:55:28 +05:30
port: default_port,
ssl: false,
start_tls: false,
mailbox: 'inbox',
idle_timeout: 60,
2022-05-07 20:08:51 +05:30
log_path: log_path,
2020-05-24 23:13:21 +05:30
expunge_deleted: false
2020-01-01 13:55:28 +05:30
}
end
2020-03-13 15:44:24 +05:30
let(:custom_config) { {} }
let(:incoming_email_config) { yml_config.merge(custom_config) }
let(:service_desk_email_config) { yml_config.merge(custom_config) }
let(:configs) do
{
incoming_email: incoming_email_config,
service_desk_email: service_desk_email_config
}
end
2020-01-01 13:55:28 +05:30
before do
2022-05-07 20:08:51 +05:30
allow(Gitlab::Redis::Queues).to receive(:new).and_return(fake_redis_queues)
2022-03-02 08:16:31 +05:30
allow(described_class).to receive(:load_yaml).and_return(configs)
2020-03-13 15:44:24 +05:30
described_class.instance_variable_set(:@enabled_configs, nil)
2020-01-01 13:55:28 +05:30
end
2021-09-04 01:27:46 +05:30
after do
described_class.instance_variable_set(:@enabled_configs, nil)
end
2020-03-13 15:44:24 +05:30
describe '#enabled_configs' do
2022-05-07 20:08:51 +05:30
let(:first_value) { described_class.enabled_configs.each_value.first }
2020-03-13 15:44:24 +05:30
context 'when both email and address is set' do
it 'returns email configs' do
expect(described_class.enabled_configs.size).to eq(2)
end
end
context 'when the yml file cannot be found' do
2020-01-01 13:55:28 +05:30
before do
2020-03-13 15:44:24 +05:30
allow(described_class).to receive(:config_file).and_return('not_existing_file')
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
it 'returns an empty list' do
expect(described_class.enabled_configs).to be_empty
2020-01-01 13:55:28 +05:30
end
end
2020-03-13 15:44:24 +05:30
context 'when email is disabled' do
let(:custom_config) { { enabled: false } }
it 'returns an empty list' do
expect(described_class.enabled_configs).to be_empty
end
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
context 'when email is enabled but address is not set' do
let(:custom_config) { { enabled: true, address: '' } }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
it 'returns an empty list' do
expect(described_class.enabled_configs).to be_empty
end
2020-01-01 13:55:28 +05:30
end
context 'when a config value is missing from the yml file' do
2020-03-13 15:44:24 +05:30
let(:yml_config) { {} }
let(:custom_config) { { enabled: true, address: 'address@example.com' } }
2020-01-01 13:55:28 +05:30
it 'overwrites missing values with the default' do
2022-05-07 20:08:51 +05:30
expect(first_value[:port]).to eq(Gitlab::MailRoom::DEFAULT_CONFIG[:port])
2020-03-13 15:44:24 +05:30
end
end
context 'when only incoming_email config is present' do
let(:configs) { { incoming_email: incoming_email_config } }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
it 'returns only encoming_email' do
expect(described_class.enabled_configs.size).to eq(1)
2022-05-07 20:08:51 +05:30
expect(first_value[:worker]).to eq('EmailReceiverWorker')
2020-01-01 13:55:28 +05:30
end
end
describe 'setting up redis settings' do
2022-05-07 20:08:51 +05:30
it 'sets delivery method to Sidekiq by default' do
config = first_value
expect(config).to include(
delivery_method: 'sidekiq'
)
2020-01-01 13:55:28 +05:30
end
2020-03-13 15:44:24 +05:30
it 'sets redis config' do
2022-05-07 20:08:51 +05:30
config = first_value
2022-03-02 08:16:31 +05:30
expect(config).to include(
redis_url: 'localhost',
redis_db: 99,
2022-05-07 20:08:51 +05:30
sentinels: [{ host: 'localhost', port: 1234 }]
2022-03-02 08:16:31 +05:30
)
2020-03-13 15:44:24 +05:30
end
2020-01-01 13:55:28 +05:30
end
describe 'setting up the log path' do
context 'if the log path is a relative path' do
2020-03-13 15:44:24 +05:30
let(:custom_config) { { log_path: 'tiny_log.log' } }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
it 'expands the log path to an absolute value' do
2022-05-07 20:08:51 +05:30
new_path = Pathname.new(first_value[:log_path])
2020-01-01 13:55:28 +05:30
expect(new_path.absolute?).to be_truthy
end
end
context 'if the log path is absolute path' do
2020-03-13 15:44:24 +05:30
let(:custom_config) { { log_path: '/dev/null' } }
2020-01-01 13:55:28 +05:30
2020-03-13 15:44:24 +05:30
it 'leaves the path as-is' do
2022-05-07 20:08:51 +05:30
expect(first_value[:log_path]).to eq '/dev/null'
2020-01-01 13:55:28 +05:30
end
end
end
end
2022-03-02 08:16:31 +05:30
describe '#enabled_mailbox_types' do
context 'when all mailbox types are enabled' do
it 'returns the mailbox types' do
expect(described_class.enabled_mailbox_types).to match(%w[incoming_email service_desk_email])
end
end
context 'when an mailbox_types is disabled' do
let(:incoming_email_config) { yml_config.merge(enabled: false) }
it 'returns the mailbox types' do
expect(described_class.enabled_mailbox_types).to match(%w[service_desk_email])
end
end
context 'when email is disabled' do
let(:custom_config) { { enabled: false } }
it 'returns an empty array' do
expect(described_class.enabled_mailbox_types).to match_array([])
end
end
end
describe '#worker_for' do
context 'matched mailbox types' do
it 'returns the constantized worker class' do
expect(described_class.worker_for('incoming_email')).to eql(EmailReceiverWorker)
expect(described_class.worker_for('service_desk_email')).to eql(ServiceDeskEmailReceiverWorker)
end
end
context 'non-existing mailbox_type' do
it 'returns nil' do
expect(described_class.worker_for('another_mailbox_type')).to be(nil)
end
end
end
2022-05-07 20:08:51 +05:30
describe 'config/mail_room.yml' do
let(:mail_room_template) { ERB.new(File.read(Rails.root.join("./config/mail_room.yml"))).result }
let(:mail_room_yml) { YAML.safe_load(mail_room_template, permitted_classes: [Symbol]) }
shared_examples 'renders mail-specific config file correctly' do
it 'renders mail room config file correctly' do
expect(mail_room_yml[:mailboxes]).to be_an(Array)
expect(mail_room_yml[:mailboxes].length).to eq(2)
expect(mail_room_yml[:mailboxes]).to all(
match(
a_hash_including(
host: 'mail.example.com',
port: default_port,
ssl: false,
start_tls: false,
email: 'user@example.com',
password: 'password',
idle_timeout: 60,
logger: {
log_path: log_path
},
name: 'inbox',
delete_after_delivery: true,
expunge_deleted: false
)
)
)
end
end
shared_examples 'renders arbitration options correctly' do
it 'renders arbitration options correctly' do
expect(mail_room_yml[:mailboxes]).to be_an(Array)
expect(mail_room_yml[:mailboxes].length).to eq(2)
expect(mail_room_yml[:mailboxes]).to all(
match(
a_hash_including(
arbitration_method: "redis",
arbitration_options: {
redis_url: "localhost",
namespace: "mail_room:gitlab",
sentinels: [{ host: "localhost", port: 1234 }]
}
)
)
)
end
end
shared_examples 'renders the sidekiq delivery method and options correctly' do
it 'renders the sidekiq delivery method and options correctly' do
expect(mail_room_yml[:mailboxes]).to be_an(Array)
expect(mail_room_yml[:mailboxes].length).to eq(2)
expect(mail_room_yml[:mailboxes][0]).to match(
a_hash_including(
delivery_method: 'sidekiq',
delivery_options: {
redis_url: "localhost",
redis_db: 99,
namespace: "resque:gitlab",
queue: "email_receiver",
worker: "EmailReceiverWorker",
sentinels: [{ host: "localhost", port: 1234 }]
}
)
)
expect(mail_room_yml[:mailboxes][1]).to match(
a_hash_including(
delivery_method: 'sidekiq',
delivery_options: {
redis_url: "localhost",
redis_db: 99,
namespace: "resque:gitlab",
queue: "service_desk_email_receiver",
worker: "ServiceDeskEmailReceiverWorker",
sentinels: [{ host: "localhost", port: 1234 }]
}
)
)
end
end
context 'when delivery_method is implicit' do
it_behaves_like 'renders mail-specific config file correctly'
it_behaves_like 'renders arbitration options correctly'
it_behaves_like 'renders the sidekiq delivery method and options correctly'
end
context 'when delivery_method is explicitly sidekiq' do
let(:custom_config) { { delivery_method: 'sidekiq' } }
it_behaves_like 'renders mail-specific config file correctly'
it_behaves_like 'renders arbitration options correctly'
it_behaves_like 'renders the sidekiq delivery method and options correctly'
end
context 'when delivery_method is webhook (internally postback in mail_room)' do
let(:custom_config) do
{
delivery_method: 'webhook',
gitlab_url: 'http://gitlab.example',
secret_file: '/path/to/secret/file'
}
end
it_behaves_like 'renders mail-specific config file correctly'
it_behaves_like 'renders arbitration options correctly'
it 'renders the webhook (postback) delivery method and options correctly' do
expect(mail_room_yml[:mailboxes]).to be_an(Array)
expect(mail_room_yml[:mailboxes].length).to eq(2)
expect(mail_room_yml[:mailboxes][0]).to match(
a_hash_including(
delivery_method: 'postback',
delivery_options: {
delivery_url: "http://gitlab.example/api/v4/internal/mail_room/incoming_email",
2022-07-23 23:45:48 +05:30
content_type: "text/plain",
2022-05-07 20:08:51 +05:30
jwt_auth_header: Gitlab::MailRoom::INTERNAL_API_REQUEST_HEADER,
jwt_issuer: Gitlab::MailRoom::INTERNAL_API_REQUEST_JWT_ISSUER,
jwt_algorithm: 'HS256',
jwt_secret_path: '/path/to/secret/file'
}
)
)
expect(mail_room_yml[:mailboxes][1]).to match(
a_hash_including(
delivery_method: 'postback',
delivery_options: {
delivery_url: "http://gitlab.example/api/v4/internal/mail_room/service_desk_email",
2022-07-23 23:45:48 +05:30
content_type: "text/plain",
2022-05-07 20:08:51 +05:30
jwt_auth_header: Gitlab::MailRoom::INTERNAL_API_REQUEST_HEADER,
jwt_issuer: Gitlab::MailRoom::INTERNAL_API_REQUEST_JWT_ISSUER,
jwt_algorithm: 'HS256',
jwt_secret_path: '/path/to/secret/file'
}
)
)
end
end
end
2020-01-01 13:55:28 +05:30
end