1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ServiceDesk::CustomEmailVerifications::UpdateService, feature_category: :service_desk do
describe '#execute' do
let_it_be_with_reload(:project) { create(:project) }
let_it_be(:user) { create(:user) }
let!(:credential) { create(:service_desk_custom_email_credential, project: project) }
let(:settings) { create(:service_desk_setting, project: project, custom_email: 'custom-support-email@example.com') }
let(:mail_object) { nil }
let(:message_delivery) { instance_double(ActionMailer::MessageDelivery) }
let(:service) { described_class.new(project: settings.project, params: { mail: mail_object }) }
let(:error_feature_flag_disabled) { 'Feature flag service_desk_custom_email is not enabled' }
let(:error_parameter_missing) { s_('ServiceDesk|Service Desk setting or verification object missing') }
let(:error_already_finished) { s_('ServiceDesk|Custom email address has already been verified.') }
let(:error_already_failed) do
s_('ServiceDesk|Custom email address verification has already been processed and failed.')
end
let(:expected_error_message) { error_parameter_missing }
let(:expected_custom_email_enabled) { false }
let(:logger_params) { { category: 'custom_email_verification' } }
before do
allow(message_delivery).to receive(:deliver_later)
allow(Notify).to receive(:service_desk_verification_result_email).and_return(message_delivery)
end
shared_examples 'a failing verification process' do |expected_error_identifier|
it 'refuses to verify and sends result emails', :aggregate_failures do
expect(Notify).to receive(:service_desk_verification_result_email).twice
expect(Gitlab::AppLogger).to receive(:info).with(logger_params.merge(
error_message: expected_error_identifier.to_s
)).once
response = described_class.new(project: settings.project, params: { mail: mail_object }).execute
settings.reset
verification.reset
expect(response).to be_error
expect(settings).not_to be_custom_email_enabled
expect(verification).to be_failed
expect(response.reason).to eq expected_error_identifier
expect(verification.error).to eq expected_error_identifier
end
end
shared_examples 'an early exit from the verification process' do |expected_state|
it 'exits early', :aggregate_failures do
expect(Notify).to receive(:service_desk_verification_result_email).exactly(0).times
expect(Gitlab::AppLogger).to receive(:warn).with(logger_params.merge(
error_message: expected_error_message
)).once
response = service.execute
settings.reset
verification.reset
expect(response).to be_error
expect(settings.custom_email_enabled).to eq expected_custom_email_enabled
expect(verification.state).to eq expected_state
end
end
it 'exits early' do
expect(Notify).to receive(:service_desk_verification_result_email).exactly(0).times
expect(Gitlab::AppLogger).to receive(:warn).with(logger_params.merge(
error_message: expected_error_message
)).once
response = service.execute
settings.reset
expect(response).to be_error
expect(settings).not_to be_custom_email_enabled
end
context 'when feature flag :service_desk_custom_email is disabled' do
let(:expected_error_message) { error_feature_flag_disabled }
before do
stub_feature_flags(service_desk_custom_email: false)
end
it 'exits early' do
expect(Notify).to receive(:service_desk_verification_result_email).exactly(0).times
expect(Gitlab::AppLogger).to receive(:warn).with(logger_params.merge(
error_message: expected_error_message
)).once
response = service.execute
expect(response).to be_error
end
end
context 'when verification exists' do
let!(:verification) { create(:service_desk_custom_email_verification, project: project) }
context 'when we do not have a verification email' do
# Raise if verification started but no email provided
it_behaves_like 'a failing verification process', 'mail_not_received_within_timeframe'
context 'when already verified' do
let(:expected_error_message) { error_already_finished }
before do
verification.mark_as_finished!
end
it_behaves_like 'an early exit from the verification process', 'finished'
end
context 'when we already have an error' do
let(:expected_error_message) { error_already_failed }
before do
verification.mark_as_failed!(:smtp_host_issue)
end
it_behaves_like 'an early exit from the verification process', 'failed'
end
end
context 'when we have a verification email' do
before do
verification.update!(token: 'ZROT4ZZXA-Y6') # token from email fixture
end
let(:email_raw) { email_fixture('emails/service_desk_custom_email_address_verification.eml') }
let(:mail_object) { Mail::Message.new(email_raw) }
it 'verifies and sends result emails' do
expect(Notify).to receive(:service_desk_verification_result_email).twice
expect(Gitlab::AppLogger).to receive(:info).with(logger_params).once
response = service.execute
settings.reset
verification.reset
expect(response).to be_success
expect(settings).not_to be_custom_email_enabled
expect(verification).to be_finished
end
context 'and verification tokens do not match' do
before do
verification.update!(token: 'XXXXXXZXA-XX')
end
it_behaves_like 'a failing verification process', 'incorrect_token'
end
context 'and from address does not match with custom email' do
before do
settings.update!(custom_email: 'some-other@example.com')
end
it_behaves_like 'a failing verification process', 'incorrect_from'
end
context 'and timeframe for receiving the email is over' do
before do
verification.update!(triggered_at: 40.minutes.ago)
end
it_behaves_like 'a failing verification process', 'mail_not_received_within_timeframe'
end
context 'when already verified' do
let(:expected_error_message) { error_already_finished }
before do
verification.mark_as_finished!
end
it_behaves_like 'an early exit from the verification process', 'finished'
context 'when enabled' do
let(:expected_custom_email_enabled) { true }
before do
settings.update!(custom_email_enabled: true)
end
it_behaves_like 'an early exit from the verification process', 'finished'
end
end
end
end
end
end
|
