diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 09:55:51 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-07-20 09:55:51 +0000 |
commit | e8d2c2579383897a1dd7f9debd359abe8ae8373d (patch) | |
tree | c42be41678c2586d49a75cabce89322082698334 /spec/lib/gitlab/email | |
parent | fc845b37ec3a90aaa719975f607740c22ba6a113 (diff) | |
download | gitlab-ce-e8d2c2579383897a1dd7f9debd359abe8ae8373d.tar.gz |
Add latest changes from gitlab-org/gitlab@14-1-stable-eev14.1.0-rc42
Diffstat (limited to 'spec/lib/gitlab/email')
-rw-r--r-- | spec/lib/gitlab/email/handler/service_desk_handler_spec.rb | 12 | ||||
-rw-r--r-- | spec/lib/gitlab/email/receiver_spec.rb | 115 |
2 files changed, 79 insertions, 48 deletions
diff --git a/spec/lib/gitlab/email/handler/service_desk_handler_spec.rb b/spec/lib/gitlab/email/handler/service_desk_handler_spec.rb index 3a60564d8d2..e8470657181 100644 --- a/spec/lib/gitlab/email/handler/service_desk_handler_spec.rb +++ b/spec/lib/gitlab/email/handler/service_desk_handler_spec.rb @@ -12,6 +12,7 @@ RSpec.describe Gitlab::Email::Handler::ServiceDeskHandler do let(:email_raw) { email_fixture('emails/service_desk.eml') } let_it_be(:group) { create(:group, :private, name: "email") } + let(:expected_description) do "Service desk stuff!\n\n```\na = b\n```\n\n`/label ~label1`\n`/assign @user1`\n`/close`\n![image](uploads/image.png)" end @@ -50,6 +51,15 @@ RSpec.describe Gitlab::Email::Handler::ServiceDeskHandler do it 'sends thank you email' do expect { receiver.execute }.to have_enqueued_job.on_queue('mailers') end + + it 'adds metric events for incoming and reply emails' do + metric_transaction = double('Gitlab::Metrics::WebTransaction', increment: true, observe: true) + allow(::Gitlab::Metrics::BackgroundTransaction).to receive(:current).and_return(metric_transaction) + expect(metric_transaction).to receive(:add_event).with(:receive_email_service_desk, { handler: 'Gitlab::Email::Handler::ServiceDeskHandler' }) + expect(metric_transaction).to receive(:add_event).with(:service_desk_thank_you_email) + + receiver.execute + end end context 'when everything is fine' do @@ -169,6 +179,7 @@ RSpec.describe Gitlab::Email::Handler::ServiceDeskHandler do context 'when using service desk key' do let_it_be(:service_desk_key) { 'mykey' } + let(:email_raw) { service_desk_fixture('emails/service_desk_custom_address.eml') } let(:receiver) { Gitlab::Email::ServiceDeskReceiver.new(email_raw) } @@ -200,6 +211,7 @@ RSpec.describe Gitlab::Email::Handler::ServiceDeskHandler do context 'when there are multiple projects with same key' do let_it_be(:project_with_same_key) { create(:project, group: group, service_desk_enabled: true) } + let(:email_raw) { service_desk_fixture('emails/service_desk_custom_address.eml', slug: project_with_same_key.full_path_slug.to_s) } before do diff --git a/spec/lib/gitlab/email/receiver_spec.rb b/spec/lib/gitlab/email/receiver_spec.rb index 2c1fe529a5d..b1a04f0592a 100644 --- a/spec/lib/gitlab/email/receiver_spec.rb +++ b/spec/lib/gitlab/email/receiver_spec.rb @@ -5,106 +5,125 @@ require 'spec_helper' RSpec.describe Gitlab::Email::Receiver do include_context :email_shared_context - shared_examples 'correctly finds the mail key and adds metric event' do - let(:metric_transaction) { double('Gitlab::Metrics::WebTransaction') } + let(:metric_transaction) { instance_double(Gitlab::Metrics::WebTransaction) } - specify :aggregate_failures do + shared_examples 'successful receive' do + let_it_be(:project) { create(:project) } + + let(:handler) { double(:handler, project: project, execute: true, metrics_event: nil, metrics_params: nil) } + + it 'correctly finds the mail key' do expect(Gitlab::Email::Handler).to receive(:for).with(an_instance_of(Mail::Message), 'gitlabhq/gitlabhq+auth_token').and_return(handler) + + receiver.execute + end + + it 'adds metric event' do + allow(receiver).to receive(:handler).and_return(handler) + expect(::Gitlab::Metrics::BackgroundTransaction).to receive(:current).and_return(metric_transaction) expect(metric_transaction).to receive(:add_event).with(handler.metrics_event, handler.metrics_params) receiver.execute end + + it 'returns valid metadata' do + allow(receiver).to receive(:handler).and_return(handler) + + metadata = receiver.mail_metadata + + expect(metadata.keys).to match_array(%i(mail_uid from_address to_address mail_key references delivered_to envelope_to x_envelope_to meta)) + expect(metadata[:meta]).to include(client_id: 'email/jake@example.com', project: project.full_path) + expect(metadata[meta_key]).to eq(meta_value) + end end context 'when the email contains a valid email address in a header' do - let(:handler) { double(:handler) } - let(:metadata) { receiver.mail_metadata } - before do - allow(handler).to receive(:execute) - allow(handler).to receive(:metrics_params) - allow(handler).to receive(:metrics_event) - stub_incoming_email_setting(enabled: true, address: "incoming+%{key}@appmail.example.com") - - expect(receiver.mail_metadata.keys).to match_array(%i(mail_uid from_address to_address mail_key references delivered_to envelope_to x_envelope_to)) end context 'when in a Delivered-To header' do let(:email_raw) { fixture_file('emails/forwarded_new_issue.eml') } + let(:meta_key) { :delivered_to } + let(:meta_value) { ["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com", "support@example.com"] } - it_behaves_like 'correctly finds the mail key and adds metric event' - - it 'parses the metadata' do - expect(metadata[:delivered_to]). to eq(["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com", "support@example.com"]) - end + it_behaves_like 'successful receive' end context 'when in an Envelope-To header' do let(:email_raw) { fixture_file('emails/envelope_to_header.eml') } + let(:meta_key) { :envelope_to } + let(:meta_value) { ["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com"] } - it_behaves_like 'correctly finds the mail key and adds metric event' - - it 'parses the metadata' do - expect(metadata[:envelope_to]). to eq(["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com"]) - end + it_behaves_like 'successful receive' end context 'when in an X-Envelope-To header' do let(:email_raw) { fixture_file('emails/x_envelope_to_header.eml') } + let(:meta_key) { :x_envelope_to } + let(:meta_value) { ["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com"] } - it_behaves_like 'correctly finds the mail key and adds metric event' - - it 'parses the metadata' do - expect(metadata[:x_envelope_to]). to eq(["incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com"]) - end + it_behaves_like 'successful receive' end context 'when enclosed with angle brackets in an Envelope-To header' do let(:email_raw) { fixture_file('emails/envelope_to_header_with_angle_brackets.eml') } + let(:meta_key) { :envelope_to } + let(:meta_value) { ["<incoming+gitlabhq/gitlabhq+auth_token@appmail.example.com>"] } - it_behaves_like 'correctly finds the mail key and adds metric event' + it_behaves_like 'successful receive' end end - context "when we cannot find a capable handler" do - let(:email_raw) { fixture_file('emails/valid_reply.eml').gsub(mail_key, "!!!") } + shared_examples 'failed receive' do + it 'adds metric event' do + expect(::Gitlab::Metrics::BackgroundTransaction).to receive(:current).and_return(metric_transaction) + expect(metric_transaction).to receive(:add_event).with('email_receiver_error', { error: expected_error.name }) - it "raises an UnknownIncomingEmail error" do - expect { receiver.execute }.to raise_error(Gitlab::Email::UnknownIncomingEmail) + expect { receiver.execute }.to raise_error(expected_error) end end - context "when the email is blank" do - let(:email_raw) { "" } + context 'when we cannot find a capable handler' do + let(:email_raw) { fixture_file('emails/valid_reply.eml').gsub(mail_key, '!!!') } + let(:expected_error) { Gitlab::Email::UnknownIncomingEmail } - it "raises an EmptyEmailError" do - expect { receiver.execute }.to raise_error(Gitlab::Email::EmptyEmailError) - end + it_behaves_like 'failed receive' end - context "when the email was auto generated with Auto-Submitted header" do - let(:email_raw) { fixture_file("emails/auto_submitted.eml") } + context 'when the email is blank' do + let(:email_raw) { '' } + let(:expected_error) { Gitlab::Email::EmptyEmailError } - it "raises an AutoGeneratedEmailError" do - expect { receiver.execute }.to raise_error(Gitlab::Email::AutoGeneratedEmailError) - end + it_behaves_like 'failed receive' end - context "when the email was auto generated with X-Autoreply header" do - let(:email_raw) { fixture_file("emails/auto_reply.eml") } + context 'when the email was auto generated with Auto-Submitted header' do + let(:email_raw) { fixture_file('emails/auto_submitted.eml') } + let(:expected_error) { Gitlab::Email::AutoGeneratedEmailError } - it "raises an AutoGeneratedEmailError" do - expect { receiver.execute }.to raise_error(Gitlab::Email::AutoGeneratedEmailError) - end + it_behaves_like 'failed receive' end - it "requires all handlers to have a unique metric_event" do + context 'when the email was auto generated with X-Autoreply header' do + let(:email_raw) { fixture_file('emails/auto_reply.eml') } + let(:expected_error) { Gitlab::Email::AutoGeneratedEmailError } + + it_behaves_like 'failed receive' + end + + it 'requires all handlers to have a unique metric_event' do events = Gitlab::Email::Handler.handlers.map do |handler| handler.new(Mail::Message.new, 'gitlabhq/gitlabhq+auth_token').metrics_event end expect(events.uniq.count).to eq events.count end + + it 'requires all handlers to respond to #project' do + Gitlab::Email::Handler.load_handlers.each do |handler| + expect { handler.new(nil, nil).project }.not_to raise_error + end + end end |