path: root/spec/services/service_desk/custom_email_verifications/update_service_spec.rb

# 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_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)

      stub_incoming_email_setting(enabled: true, address: 'support+%{key}@example.com')
      stub_service_desk_email_setting(enabled: true, address: 'contact+%{key}@example.com')
    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 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(:service_desk_address) { project.service_desk_incoming_address }
        let(:verification_address) { 'custom-support-email+verify@example.com' }
        let(:verification_token) { 'ZROT4ZZXA-Y6' }
        let(:shared_email_raw) do
          <<~EMAIL
          From: Flight Support <custom-support-email@example.com>
          Subject: Verify custom email address custom-support-email@example.com for Flight
          Auto-Submitted: no


          This email is auto-generated. It verifies the ownership of the entered Service Desk custom email address and
          correct functionality of email forwarding.

          Verification token: #{verification_token}
          --

          You're receiving this email because of your account on 127.0.0.1.
          EMAIL
        end

        let(:email_raw) do
          <<~EMAIL
          Delivered-To: #{service_desk_address}
          To: #{verification_address}
          #{shared_email_raw}
          EMAIL
        end

        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 'and service desk address from service_desk_email was used as forwarding target' do
          let(:service_desk_address) { project.service_desk_alias_address }

          it_behaves_like 'a failing verification process', 'incorrect_forwarding_target'

          context 'when multiple Delivered-To headers are present' do
            let(:email_raw) do
              <<~EMAIL
              Delivered-To: other@example.com
              Delivered-To: #{service_desk_address}
              To: #{verification_address}
              #{shared_email_raw}
              EMAIL
            end

            it_behaves_like 'a failing verification process', 'incorrect_forwarding_target'
          end

          context 'when multiple To headers are present' do
            # Microsoft Exchange forwards emails this way when forwarding
            # to an external email address using a transport rule
            let(:email_raw) do
              <<~EMAIL
              To: #{service_desk_address}, #{verification_address}
              #{shared_email_raw}
              EMAIL
            end

            it_behaves_like 'a failing verification process', 'incorrect_forwarding_target'
          end
        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