SWAMPy

✎ CARVE FLESH

EDITING: reply_to_address_spec.rb

# frozen_string_literal: true

#
# Copyright (C) 2013 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas 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 Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

describe IncomingMail::ReplyToAddress do
  let(:expect_secure_id) { Canvas::Security.hmac_sha1(Shard.short_id_for(@shard1.global_id_for(42))) }

describe "initialize" do
    it "persists the message argument" do
      expect(IncomingMail::ReplyToAddress.new("some message").message).to eq "some message"
    end
  end

describe "address" do
    it "returns nil for SMS messages" do
      message = double
      expect(message).to receive(:path_type).and_return("sms")

expect(IncomingMail::ReplyToAddress.new(message).address).to be_nil
    end

it "returns the message from address for error reports" do
      message = double
      expect(message).to receive(:path_type).and_return("email")
      expect(message).to receive(:context_type).and_return("ErrorReport")
      expect(message).to receive(:from).and_return("user@example.com")

expect(IncomingMail::ReplyToAddress.new(message).address).to eq "user@example.com"
    end

context "sharding" do
      specs_require_sharding

it "generates a reply-to address for email messages" do
        message = double

expect(message).to receive(:path_type).and_return("email")
        expect(message).to receive(:context_type).and_return("Course")
        expect(message).to receive(:id).twice.and_return(1)
        expect(message).to receive(:global_id).twice.and_return(@shard1.global_id_for(42))
        created_at = Time.now.utc
        expect(message).to receive(:created_at).and_return(created_at)
        IncomingMail::ReplyToAddress.address_pool = %w[canvas@example.com]

short_id = Shard.short_id_for(@shard1.global_id_for(42))

expect(IncomingMail::ReplyToAddress.new(message).address).to eq "canvas+#{expect_secure_id[0..15]}-#{short_id}-#{created_at.to_i}@example.com"
      end

it "limits a reply-to address to 64 chars before @" do
        message = double

expect(message).to receive(:path_type).and_return("email")
        expect(message).to receive(:context_type).and_return("Course")
        expect(message).to receive(:id).twice.and_return(Shard::IDS_PER_SHARD - 1)
        @shard1.id = 123_456
        @shard1.save!
        expect(message).to receive(:global_id).twice.and_return(@shard1.global_id_for(Shard::IDS_PER_SHARD - 1))
        created_at = 50.years.from_now
        expect(message).to receive(:created_at).and_return(created_at)
        IncomingMail::ReplyToAddress.address_pool = %w[canvas@example.com]

expect(IncomingMail::ReplyToAddress.new(message).address.split("@").first.length < 64).to be_truthy
      end

it "is a valid hmac in the reply address" do
        message = double
        expect(message).to receive(:global_id).and_return(@shard1.global_id_for(42))
        secure_id = IncomingMail::ReplyToAddress.new(message).secure_id
        expect(secure_id.length).to eq 16
        expect(secure_id).to eq expect_secure_id[0, 16]
        expect(IncomingMail::MessageHandler.new.send(:valid_secure_id?, Shard.short_id_for(@shard1.global_id_for(42)), secure_id)).to be_truthy
      end
    end
  end

describe "secure_id" do
    specs_require_sharding

it "generates a unique hash for the message" do
      message = double
      expect(message).to receive(:global_id).and_return(@shard1.global_id_for(42))

expect(IncomingMail::ReplyToAddress.new(message).secure_id).to eq expect_secure_id[0, 16]
    end
  end

describe "self.address_pool=" do
    it "persists an address pool" do
      pool = %w[canvas@example.com canvas2@example.com]
      IncomingMail::ReplyToAddress.address_pool = pool

expect(IncomingMail::ReplyToAddress.instance_variable_get(:@address_pool)).to eq pool
    end
  end

describe "self.address_from_pool" do
    it "returns an address from the pool in a deterministic way" do
      message, message2 = [double, double]

expect(message).to receive(:id).twice.and_return(14)
      expect(message2).to receive(:id).twice.and_return(15)
      IncomingMail::ReplyToAddress.address_pool = %w[canvas@example.com canvas2@example.com]

expect(IncomingMail::ReplyToAddress.address_from_pool(message)).to  eq "canvas@example.com"
      expect(IncomingMail::ReplyToAddress.address_from_pool(message2)).to eq "canvas2@example.com"
    end

it "raises EmptyReplyAddressPool if pool is empty" do
      message = double
      IncomingMail::ReplyToAddress.address_pool = []

expect do
        IncomingMail::ReplyToAddress.address_from_pool(message)
      end.to raise_error(IncomingMail::ReplyToAddress::EmptyReplyAddressPool)
    end

it "randomly selects a pool address if the message has no id" do
      message = double

expect(message).to receive(:id).and_return(nil)
      IncomingMail::ReplyToAddress.address_pool = %w[canvas@example.com]

expect(IncomingMail::ReplyToAddress.address_from_pool(message)).to eq "canvas@example.com"
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 message_handler_spec.rb	RB	14.9 KB	2023-09-24 03:39	EDIT
📄 reply_to_address_spec.rb	RB	5.5 KB	2023-09-24 03:36	EDIT