openproject/spec/services/notifications/mail_service_spec.rb

#-- encoding: UTF-8

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++

require 'spec_helper'

describe Notifications::MailService, type: :model do
  subject(:call) { instance.call }

  let(:recipient) do
    FactoryBot.build_stubbed(:user)
  end
  let(:actor) do
    FactoryBot.build_stubbed(:user)
  end
  let(:instance) { described_class.new(notification) }

  context 'with a work package journal notification' do
    let(:journal) do
      FactoryBot.build_stubbed(:work_package_journal).tap do |j|
        allow(j)
          .to receive(:initial?)
                .and_return(journal_initial)
      end
    end
    let(:read_ian) { false }
    let(:notification) do
      FactoryBot.build_stubbed(:notification,
                               journal: journal,
                               recipient: recipient,
                               actor: actor,
                               read_ian: read_ian)
    end
    let(:journal_initial) { false }

    let(:mail) do
      mail = instance_double(ActionMailer::MessageDelivery)

      allow(UserMailer)
        .to receive(:work_package_added)
              .and_return(mail)

      allow(UserMailer)
        .to receive(:work_package_updated)
              .and_return(mail)

      allow(mail)
        .to receive(:deliver_later)

      mail
    end

    before do
      mail
    end

    context 'with the notification being for an initial journal' do
      let(:journal_initial) { true }

      it 'sends a mail' do
        call

        expect(UserMailer)
          .to have_received(:work_package_added)
                .with(recipient,
                      journal,
                      journal.user)

        expect(mail)
          .to have_received(:deliver_later)
      end
    end

    context 'with the notification being for an update journal' do
      let(:journal_initial) { false }

      it 'sends a mail' do
        call

        expect(UserMailer)
          .to have_received(:work_package_updated)
                .with(recipient,
                      journal,
                      journal.user)

        expect(mail)
          .to have_received(:deliver_later)
      end
    end

    context 'with the notification read in app already' do
      let(:read_ian) { true }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:work_package_added)
        expect(UserMailer)
          .not_to have_received(:work_package_updated)
      end
    end
  end

  context 'with a wiki_content journal notification' do
    let(:journal) do
      FactoryBot.build_stubbed(:wiki_content_journal,
                               journable: FactoryBot.build_stubbed(:wiki_content)).tap do |j|
        allow(j)
          .to receive(:initial?)
                .and_return(journal_initial)
      end
    end
    let(:read_ian) { false }
    let(:notification) do
      FactoryBot.build_stubbed(:notification,
                               journal: journal,
                               recipient: recipient,
                               actor: actor,
                               read_ian: read_ian)
    end
    let(:notification_setting) { %w(wiki_content_added wiki_content_updated) }
    let(:mail) do
      mail = instance_double(ActionMailer::MessageDelivery)

      allow(UserMailer)
        .to receive(:wiki_content_added)
              .and_return(mail)

      allow(UserMailer)
        .to receive(:wiki_content_updated)
              .and_return(mail)

      allow(mail)
        .to receive(:deliver_later)

      mail
    end
    let(:journal_initial) { false }

    before do
      mail

      allow(Setting).to receive(:notified_events).and_return(notification_setting)
    end

    context 'with the notification being for an initial journal' do
      let(:journal_initial) { true }

      it 'sends a mail' do
        call

        expect(UserMailer)
          .to have_received(:wiki_content_added)
                .with(recipient,
                      journal.journable,
                      journal.user)

        expect(mail)
          .to have_received(:deliver_later)
      end
    end

    context 'with the notification being for an initial journal but the event is disabled' do
      let(:journal_initial) { true }
      let(:notification_setting) { %w(wiki_content_updated) }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:wiki_content_added)
      end
    end

    context 'with the notification being for an update journal' do
      let(:journal_initial) { false }

      it 'sends a mail' do
        call

        expect(UserMailer)
          .to have_received(:wiki_content_updated)
                .with(recipient,
                      journal.journable,
                      journal.user)

        expect(mail)
          .to have_received(:deliver_later)
      end
    end

    context 'with the notification being for an update journal but the event is disabled' do
      let(:journal_initial) { false }
      let(:notification_setting) { %w(wiki_content_added) }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:wiki_content_updated)
      end
    end

    context 'with the notification read in app already' do
      let(:read_ian) { true }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:wiki_content_added)
        expect(UserMailer)
          .not_to have_received(:wiki_content_updated)
      end
    end
  end

  context 'with a news journal notification' do
    let(:journal) do
      FactoryBot.build_stubbed(:news_journal,
                               journable: FactoryBot.build_stubbed(:news)).tap do |j|
        allow(j)
          .to receive(:initial?)
                .and_return(journal_initial)
      end
    end
    let(:notification) do
      FactoryBot.build_stubbed(:notification,
                               journal: journal,
                               recipient: recipient,
                               actor: actor)
    end
    let(:notification_setting) { %w(news_added) }
    let(:mail) do
      mail = instance_double(ActionMailer::MessageDelivery)

      allow(UserMailer)
        .to receive(:news_added)
              .and_return(mail)

      allow(mail)
        .to receive(:deliver_later)

      mail
    end
    let(:journal_initial) { false }

    before do
      mail

      allow(Setting).to receive(:notified_events).and_return(notification_setting)
    end

    context 'with the notification being for an initial journal' do
      let(:journal_initial) { true }

      it 'sends a mail' do
        call

        expect(UserMailer)
          .to have_received(:news_added)
                .with(recipient,
                      journal.journable,
                      journal.user)

        expect(mail)
          .to have_received(:deliver_later)
      end
    end

    context 'with the notification being for an initial journal but the event is disabled' do
      let(:journal_initial) { true }
      let(:notification_setting) { %w() }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:news_added)
      end
    end

    # This case should not happen as no notification is created in this case that would
    # trigger the NotificationJob. But as this might change, this test case is in place.
    context 'with the notification being for an update journal' do
      let(:journal_initial) { false }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:news_added)
      end
    end
  end

  context 'with a message journal notification' do
    let(:journal) do
      FactoryBot.build_stubbed(:message_journal,
                               journable: FactoryBot.build_stubbed(:message))
    end
    let(:read_ian) { false }
    let(:notification) do
      FactoryBot.build_stubbed(:notification,
                               journal: journal,
                               resource: journal.journable,
                               recipient: recipient,
                               actor: actor,
                               read_ian: read_ian)
    end
    let(:notification_setting) { %w(message_posted) }
    let(:mail) do
      mail = instance_double(ActionMailer::MessageDelivery)

      allow(UserMailer)
        .to receive(:message_posted)
              .and_return(mail)

      allow(mail)
        .to receive(:deliver_later)

      mail
    end

    before do
      mail

      allow(Setting).to receive(:notified_events).and_return(notification_setting)
    end

    it 'sends a mail' do
      call

      expect(UserMailer)
        .to have_received(:message_posted)
              .with(recipient,
                    journal.journable,
                    actor)

      expect(mail)
        .to have_received(:deliver_later)
    end

    context 'with the event being disabled' do
      let(:notification_setting) { %w(wiki_content_updated) }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:message_posted)
      end
    end

    context 'with the notification read in app already' do
      let(:read_ian) { true }

      it 'sends no mail' do
        call

        expect(UserMailer)
          .not_to have_received(:message_posted)
      end
    end
  end

  context 'with a different journal notification' do
    # This is actually not supported by now but serves as a test
    let(:journal) do
      FactoryBot.build_stubbed(:journal,
                               journable: FactoryBot.build_stubbed(:user))
    end
    let(:notification) do
      FactoryBot.build_stubbed(:notification,
                               journal: journal,
                               recipient: recipient,
                               actor: actor)
    end

    it 'raises an error' do
      expect { call }
        .to raise_error(ArgumentError)
    end
  end
end