Refactoring: Migrate email_process_out_of_office_test to RSpec

spec/models/channel/email_parser_spec.rb

@@ -540,5 +540,55 @@ RSpec.describe Channel::EmailParser, type: :model do
         end
       end
     end
+
+    context 'for “out-of-office” notifications (a.k.a. auto-response messages)' do
+      let(:raw_mail) { <<~RAW.chomp }
+        From: me@example.com
+        To: customer@example.com
+        Subject: #{subject_line}
+
+        Some Text
+      RAW
+      let(:subject_line) { 'Lorem ipsum dolor' }
+
+      it 'applies the OutOfOfficeCheck filter to given message' do
+        expect(Channel::Filter::OutOfOfficeCheck)
+          .to receive(:run)
+          .with(kind_of(Hash), hash_including(subject: subject_line))
+
+        described_class.new.process({}, raw_mail)
+      end
+
+      context 'on an existing, closed ticket' do
+        let(:ticket) { create(:ticket, state_name: 'closed') }
+        let(:subject_line) { ticket.subject_build('Lorem ipsum dolor') }
+
+        context 'when OutOfOfficeCheck filter applies x-zammad-out-of-office: false' do
+          before do
+            allow(Channel::Filter::OutOfOfficeCheck)
+              .to receive(:run) { |_, mail_hash| mail_hash[:'x-zammad-out-of-office'] = false }
+          end
+
+          it 're-opens a closed ticket' do
+            expect { described_class.new.process({}, raw_mail) }
+              .to not_change { Ticket.count }
+              .and change { ticket.reload.state.name }.to('open')
+          end
+        end
+
+        context 'when OutOfOfficeCheck filter applies x-zammad-out-of-office: true' do
+          before do
+            allow(Channel::Filter::OutOfOfficeCheck)
+              .to receive(:run) { |_, mail_hash| mail_hash[:'x-zammad-out-of-office'] = true }
+          end
+
+          it 'does not re-open a closed ticket' do
+            expect { described_class.new.process({}, raw_mail) }
+              .to not_change { Ticket.count }
+              .and not_change { ticket.reload.state.name }
+          end
+        end
+      end
+    end
   end
 end

spec/models/channel/filter/out_of_office_check_spec.rb

@@ -0,0 +1,97 @@
+require 'rails_helper'
+
+RSpec.describe Channel::Filter::OutOfOfficeCheck do
+  describe '.run' do
+    let(:mail_hash) { Channel::EmailParser.new.parse(<<~RAW.chomp) }
+      From: me@example.com
+      To: customer@example.com
+      Subject: #{subject_line}
+      #{client_headers}
+
+      Some Text
+    RAW
+
+    let(:subject_line) { 'Lorem ipsum dolor' }
+
+    shared_examples 'regular message' do
+      it 'sets x-zammad-out-of-office header to false' do
+        expect { described_class.run({}, mail_hash) }
+          .to change { mail_hash[:'x-zammad-out-of-office'] }.to(false)
+      end
+    end
+
+    shared_examples 'auto-response' do
+      it 'sets x-zammad-out-of-office header to true' do
+        expect { described_class.run({}, mail_hash) }
+          .to change { mail_hash[:'x-zammad-out-of-office'] }.to(true)
+      end
+    end
+
+    context 'for regular messages' do
+      context 'with MS/Exchange-style headers' do
+        let(:client_headers) { 'X-MS-Exchange-Inbox-Rules-Loop: aaa.bbb@example.com' }
+
+        include_examples 'regular message'
+      end
+
+      context 'with Zimbra-style headers' do
+        let(:client_headers) { 'X-Mailer: Zimbra 7.1.3_GA_3346' }
+
+        include_examples 'regular message'
+      end
+
+      context 'with no additional headers (Cloud- & Gmail-style)' do
+        let(:client_headers) { '' }
+
+        include_examples 'regular message'
+      end
+    end
+
+    context 'for auto-response messages' do
+      context 'with MS/Exchange-style headers' do
+        let(:client_headers) { <<~HEAD.chomp }
+          X-MS-Has-Attach:
+          X-Auto-Response-Suppress: All
+          X-MS-Exchange-Inbox-Rules-Loop: aaa.bbb@example.com
+          X-MS-TNEF-Correlator:
+          x-olx-disclaimer: Done
+          x-tm-as-product-ver: SMEX-11.0.0.4179-8.000.1202-21706.006
+          x-tm-as-result: No--39.689200-0.000000-31
+          x-tm-as-user-approved-sender: Yes
+          x-tm-as-user-blocked-sender: No
+        HEAD
+
+        include_examples 'auto-response'
+      end
+
+      context 'with Zimbra-style headers' do
+        let(:client_headers) { <<~HEAD.chomp }
+          Auto-Submitted: auto-replied (zimbra; vacation)
+          Precedence: bulk
+          X-Mailer: Zimbra 7.1.3_GA_3346
+        HEAD
+
+        include_examples 'auto-response'
+      end
+
+      context 'with Cloud-style headers' do
+        let(:client_headers) { <<~HEAD.chomp }
+          Auto-submitted: auto-replied; owner-email="me@example.com"
+        HEAD
+
+        include_examples 'auto-response'
+      end
+
+      context 'with Gmail-style headers' do
+        let(:subject_line) { 'vacation: Lorem ipsum dolor' }
+        let(:client_headers) { <<~HEAD.chomp }
+          Precedence: bulk
+          X-Autoreply: yes
+          Auto-Submitted: auto-replied
+        HEAD
+
+        include_examples 'auto-response'
+      end
+    end
+  end
+end

test/unit/email_process_out_of_office_test.rb

@@ -1,299 +0,0 @@
-require 'test_helper'
-
-class EmailProcessOutOfOfficeTest < ActiveSupport::TestCase
-
-  test 'process with out of office check - ms' do
-
-    ticket = Ticket.create!(
-      title:         'ooo check - ms',
-      group:         Group.lookup(name: 'Users'),
-      customer_id:   2,
-      state:         Ticket::State.lookup(name: 'closed'),
-      priority:      Ticket::Priority.lookup(name: '2 normal'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    article = Ticket::Article.create!(
-      ticket_id:     ticket.id,
-      from:          'some_sender@example.com',
-      to:            'some_recipient@example.com',
-      subject:       'ooo check',
-      message_id:    '<20150830145601.30.608881@edenhofer.zammad.com>',
-      body:          'some message bounce check',
-      internal:      false,
-      sender:        Ticket::Article::Sender.lookup(name: 'Agent'),
-      type:          Ticket::Article::Type.lookup(name: 'email'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    travel 1.second
-
-    # exchange out of office example #1
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 1')}
-X-MS-Has-Attach:
-X-Auto-Response-Suppress: All
-X-MS-Exchange-Inbox-Rules-Loop: aaa.bbb@example.com
-X-MS-TNEF-Correlator:
-x-olx-disclaimer: Done
-x-tm-as-product-ver: SMEX-11.0.0.4179-8.000.1202-21706.006
-x-tm-as-result: No--39.689200-0.000000-31
-x-tm-as-user-approved-sender: Yes
-x-tm-as-user-blocked-sender: No
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-
-    # normal follow up
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject - none')}
-X-MS-Exchange-Inbox-Rules-Loop: aaa.bbb@example.com
-
-Some Text 2"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(false, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('open', ticket_p.state.name)
-
-    ticket = Ticket.find(ticket.id)
-    ticket.state = Ticket::State.lookup(name: 'closed')
-    ticket.save
-
-    # exchange out of office example #2
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 2')}
-X-MS-Has-Attach:
-X-Auto-Response-Suppress: All
-X-MS-Exchange-Inbox-Rules-Loop: aaa.bbb@example.com
-X-MS-TNEF-Correlator:
-x-exclaimer-md-config: 8c10826d-4052-4c5c-a8e8-e09011276827
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-    travel_back
-  end
-
-  test 'process with out of office check - zimbra' do
-
-    ticket = Ticket.create!(
-      title:         'ooo check - zimbra',
-      group:         Group.lookup(name: 'Users'),
-      customer_id:   2,
-      state:         Ticket::State.lookup(name: 'closed'),
-      priority:      Ticket::Priority.lookup(name: '2 normal'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    article = Ticket::Article.create!(
-      ticket_id:     ticket.id,
-      from:          'some_sender@example.com',
-      to:            'some_recipient@example.com',
-      subject:       'ooo check',
-      message_id:    '<20150830145601.30.608881@edenhofer.zammad.com>',
-      body:          'some message bounce check',
-      internal:      false,
-      sender:        Ticket::Article::Sender.lookup(name: 'Agent'),
-      type:          Ticket::Article::Type.lookup(name: 'email'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    travel 1.second
-
-    # exchange out of office example #1
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 1')}
-Auto-Submitted: auto-replied (zimbra; vacation)
-Precedence: bulk
-X-Mailer: Zimbra 7.1.3_GA_3346
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-
-    # normal follow up
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject - none')}
-X-Mailer: Zimbra 7.1.3_GA_3346
-
-Some Text 2"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(false, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('open', ticket_p.state.name)
-
-    ticket = Ticket.find(ticket.id)
-    ticket.state = Ticket::State.lookup(name: 'closed')
-    ticket.save
-
-    # exchange out of office example #2
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 2')}
-Auto-Submitted: auto-replied (zimbra; vacation)
-Precedence: bulk
-X-Mailer: Zimbra 7.1.3_GA_3346
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-    travel_back
-  end
-
-  test 'process with out of office check - cloud' do
-
-    ticket = Ticket.create!(
-      title:         'ooo check - cloud',
-      group:         Group.lookup(name: 'Users'),
-      customer_id:   2,
-      state:         Ticket::State.lookup(name: 'closed'),
-      priority:      Ticket::Priority.lookup(name: '2 normal'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    article = Ticket::Article.create!(
-      ticket_id:     ticket.id,
-      from:          'some_sender@example.com',
-      to:            'some_recipient@example.com',
-      subject:       'ooo check',
-      message_id:    '<20150830145601.30.608881@edenhofer.zammad.com>',
-      body:          'some message bounce check',
-      internal:      false,
-      sender:        Ticket::Article::Sender.lookup(name: 'Agent'),
-      type:          Ticket::Article::Type.lookup(name: 'email'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    travel 1.second
-
-    # exchange out of office example #1
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 1')}
-Auto-submitted: auto-replied; owner-email=\"me@example.com\"
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-
-    # normal follow up
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject - none')}
-
-Some Text 2"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(false, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('open', ticket_p.state.name)
-
-    ticket = Ticket.find(ticket.id)
-    ticket.state = Ticket::State.lookup(name: 'closed')
-    ticket.save
-
-    # exchange out of office example #2
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject 2')}
-Auto-submitted: auto-replied; owner-email=\"me@example.com\"
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-    travel_back
-  end
-
-  test 'process with out of office check - gmail' do
-
-    ticket = Ticket.create!(
-      title:         'ooo check - gmail',
-      group:         Group.lookup(name: 'Users'),
-      customer_id:   2,
-      state:         Ticket::State.lookup(name: 'closed'),
-      priority:      Ticket::Priority.lookup(name: '2 normal'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    article = Ticket::Article.create!(
-      ticket_id:     ticket.id,
-      from:          'some_sender@example.com',
-      to:            'some_recipient@example.com',
-      subject:       'ooo check',
-      message_id:    '<20150830145601.30.608881@edenhofer.zammad.com>',
-      body:          'some message bounce check',
-      internal:      false,
-      sender:        Ticket::Article::Sender.lookup(name: 'Agent'),
-      type:          Ticket::Article::Type.lookup(name: 'email'),
-      updated_by_id: 1,
-      created_by_id: 1,
-    )
-    travel 1.second
-
-    # gmail out of office example #1
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: vacation: #{ticket.subject_build('some new subject 1')}
-Precedence: bulk
-X-Autoreply: yes
-Auto-Submitted: auto-replied
-
-Some Text"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(true, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('closed', ticket.state.name)
-
-    # normal follow up
-    email_raw_string = "From: me@example.com
-To: customer@example.com
-Subject: #{ticket.subject_build('some new subject - none')}
-
-Some Text 2"
-
-    ticket_p, article_p, user_p, mail = Channel::EmailParser.new.process({}, email_raw_string)
-    assert_equal(false, mail['x-zammad-out-of-office'.to_sym])
-    ticket = Ticket.find(ticket.id)
-    assert_equal(ticket.id, ticket_p.id)
-    assert_equal('open', ticket_p.state.name)
-    travel_back
-  end
-
-end