spreewald 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c446ad46ae093a7bb103d7e4959dbbc7e29327cbc30e5730aff221f8488e36
-  data.tar.gz: e23e4bd833a6234e6ce2b4e6ab104f102708bab13ab54f10aad8b97df08cd39b
+  metadata.gz: 05a2f0dc08e4a044c5da09e999a488eeeab8d0ef21fd26fccf9306651e27d6ba
+  data.tar.gz: bc1753072141059f502b634a9a7347e63c602a072bc04f2a9aaf73a98ebd9eca
 SHA512:
-  metadata.gz: 8d7b6e7ddd55b75433d7c800045c09f68b7175646de8a3f9ac11a5741ee83ce39c22d8bb5a8b5d9d77b4d22df01eda5de51093de4a76cabf73ae354308b12abc
-  data.tar.gz: bc169b566a8878be0ad26b2b1522b960b57772d80d135ffbe4a34476c673282d75b7666d9ccf14a585c229739b3d543620f578c3b59a7e6f62cf036a5df2f90c
+  metadata.gz: 0b59488dcad4d0e94203fdc4b28463f69b6ccf93011f42c19dbc84582f0cca5e988a1b69c5f74520142198023dda9362e60c595d58a1bdc5abdde5b8a9e093ab
+  data.tar.gz: f324ae1ccd2ee7dbe97a71c4fbf614cd6888dd91846b42d2d60d900ae085413e6da55669d58ebe8275519354f10cf1a2826c5ef08323f30140d756572143dc76

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.9.0
+- The step `an email should have been sent with:` does now support wildcards (`*` at the end of a line to ignore the rest of the line, `*` as single character in a line to ignore multiple lines). The step also has better error messages if an email could not be found.
+- The step `show me the emails` got an option to display only the email headers. Additionally, a new step `show me the email( header)?s with:` has been created to only show a subset of all sent emails, with a syntax similar to `an email should have been sent with:`.
+- The email steps `an email should have been sent (from ...) (to ...) (cc ...) ...`, `that email should( not)? have the following lines in the body` and `that email should have the following content in the body:` have been deprecated in favor of `an email should have been sent with:`.
+
 ## 2.8.0
 - Add radio buttons to the `the "..." (field|button|checkbox|radio button) should( not)? be disabled` step.
 

data/README.md

@@ -216,7 +216,7 @@ the step definitions.
 * **When I clear my e?mails**
 
 
-* **Then (an|no) e?mail should have been sent with:**
+* **Then (an?|no)( HTML| plain-text|) e?mail should have been sent with:**
 
   Example:
   
@@ -225,24 +225,23 @@ the step definitions.
         From: max.mustermann@example.com
         Reply-To: mmuster@gmail.com
         To: john.doe@example.com
+        CC: jane.doe@example.com
+        BCC: johnny.doe@example.com
         Subject: The subject may contain "quotes"
-        Attachments: ...
+        Attachments: image.jpg, attachment.pdf
   
-        Message body goes here.
-        """
-  
-  You may skip lines in the header, of course. Note that the mail body is only checked for
-  _inclusion_. That means you can only test a prefix of the body. The subject may also be
-  a prefix.
-
-
-* **Then (an|no) e?mail should have been sent(( |and|with|from "..."|bcc "..."|cc "..."|to "..."|the subject "..."|the body "..."|the attachments "...")+)**
-
-  Example:
+        This is the message body. You can use * as a wildcard to omit the rest
+        of a line *
+        Or you can omit multiple lines if the asterisk is the only
+        character in a single line, like this:
+        *
   
-      Then an email should have been sent from "max.mustermann@example.com" to "john.doe@example.com" with bcc "john.wane@example.com" and with cc "foo@bar.com" and the subject "The subject" and the body "The body" and the attachments "attachment.pdf"
+        """
   
-  You may skip parts, of course.
+  Because of backwards-compatibility, the body currently only has to be a prefix
+  of the real body. However, this is deprecated and will be removed in a future
+  version. Use wildcards instead.
+  You may skip lines in the header, of course.
 
 
 * **When I follow the (first|second|third)? link in the e?mail**
@@ -254,32 +253,20 @@ the step definitions.
 * **Then no e?mail should have been sent**
 
 
-* **Then I should see "..." in the e?mail**
+* **Then I should see "..." in the( HTML| plain-text|) e?mail**
 
   Checks that the last sent email includes some text
 
 
-* **Then show me the e?mails**
-
-  Print all sent emails to STDOUT.
+* **Then show me the e?mail( header)?s**
 
-
-* **Then that e?mail should( not)? have the following lines in the body:**
-
-  Example:
-  
-      And that mail should have the following lines in the body:
-        """
-        All of these lines
-        need to be present
-        """
-  
-  You may skip lines, of course. Note that you may also omit text at the end of each line.
+  Print all sent emails to STDOUT (optionally only the headers).
 
 
-* **Then that e?mail should have the following (|content in the )body:**
+* **Then show me the e?mail( header)?s with:**
 
-  Checks that the text should be included anywhere in the retrieved email body
+  Print a subset of all sent emails to STDOUT
+  This uses the same syntax as `Then an email should have been sent with:`
 
 
 ### file_attachment_steps.rb 

data/lib/spreewald/email_steps.rb

@@ -17,49 +17,74 @@ end.overridable
 #       From: max.mustermann@example.com
 #       Reply-To: mmuster@gmail.com
 #       To: john.doe@example.com
+#       CC: jane.doe@example.com
+#       BCC: johnny.doe@example.com
 #       Subject: The subject may contain "quotes"
-#       Attachments: ...
+#       Attachments: image.jpg, attachment.pdf
+#
+#       This is the message body. You can use * as a wildcard to omit the rest
+#       of a line *
+#       Or you can omit multiple lines if the asterisk is the only
+#       character in a single line, like this:
+#       *
 #
-#       Message body goes here.
 #       """
 #
-# You may skip lines in the header, of course. Note that the mail body is only checked for
-# _inclusion_. That means you can only test a prefix of the body. The subject may also be
-# a prefix.
-Then /^(an|no) e?mail should have been sent with:$/ do |mode, raw_data|
+# Because of backwards-compatibility, the body currently only has to be a prefix
+# of the real body. However, this is deprecated and will be removed in a future
+# version. Use wildcards instead.
+# You may skip lines in the header, of course.
+Then /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/ do |mode, type, raw_data|
   patiently do
-    raw_data.strip!
-    header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
-    conditions = {}
-    header.split("\n").each do |row|
-      if row.match(/^[a-z\-]+: /i)
-        key, value = row.split(": ", 2)
-        conditions[key.underscore.to_sym] = value
+    results = MailFinder.find(raw_data, type.strip)
+
+    if mode == 'no'
+      expect(results).to be_empty
+    else
+      if results.one?
+        @mail = results.mails[0]
+      elsif results.many?
+        warn <<-WARNING
+#{results.size} emails were found with the following conditions.
+You may want to make the description more precise or clear the emails in between.
+#{raw_data}
+WARNING
+      else
+        message = <<-ERROR
+No matching mail was found. There were #{ActionMailer::Base.deliveries.size} mails in total.
+#{results.matching_header.size} of those had matching headers.
+ERROR
+        if results.matching_header.empty?
+          message << "Expected\n" + '-' * 80 + "\n"
+          message << raw_data.split(/\n\n/, 2)[0] # Show the expected header
+          message << "\n" + '-' * 80 + "\n\n"
+          message << MailFinder.show_mails(ActionMailer::Base.deliveries, true)
+        else
+          message << "\nTried to match #{results.body_regex.inspect} in the following mails:\n"
+          message << results.matching_header.map { |mail| MailFinder.email_text_body(mail, type.strip).strip.inspect }.join("\n")
+          message << "\n"
+        end
+        raise RSpec::Expectations::ExpectationNotMetError.new(message)
       end
     end
-    conditions[:body] = body if body
-    @mail = MailFinder.find(conditions)
-    expectation = mode == 'no' ? 'not_to' : 'to'
-    expect(@mail).send(expectation, be_present)
   end
 end.overridable
 
-# Example:
-#
-#     Then an email should have been sent from "max.mustermann@example.com" to "john.doe@example.com" with bcc "john.wane@example.com" and with cc "foo@bar.com" and the subject "The subject" and the body "The body" and the attachments "attachment.pdf"
-#
-# You may skip parts, of course.
+# nodoc (deprecated)
 Then /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/ do |mode, query|
+  warn "The step `an email should have been sent (from ...) (to ...) (cc ...) ...` has been deprecated in favor of `(an?|no)( HTML| plain-text|) e?mail should have been sent with:`"
   patiently do
-    conditions = {}
-    conditions[:to] = $1 if query =~ /to "([^"]+)"/
-    conditions[:Cc] = $1 if query =~ /cc "([^"]+)"/
-    conditions[:bcc] = $1 if query =~ /bcc "([^"]+)"/
-    conditions[:from] = $1 if query =~ /from "([^"]+)"/
-    conditions[:subject] = $1 if query =~ /the subject "([^"]+)"/
-    conditions[:body] = $1 if query =~ /the body "([^"]+)"/
-    conditions[:attachments] = $1 if query =~ /the attachments "([^"]+)"/
-    @mail = MailFinder.find(conditions)
+    filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
+    @mail = ActionMailer::Base.deliveries.find do |mail|
+        [ query =~ /to "([^"]+)"/ && !mail.to.include?(MailFinder.resolve_email $1),
+          query =~ /cc "([^"]+)"/ && !mail.cc.include?(MailFinder.resolve_email $1),
+          query =~ /bcc "([^"]+)"/ && !mail.bcc.include?(MailFinder.resolve_email $1),
+          query =~ /from "([^"]+)"/ && !mail.from.include?(MailFinder.resolve_email $1),
+          query =~ /reply_to "([^"]+)"/ && !mail.reply_to.include?(MailFinder.resolve_email $1),
+          query =~ /subject "([^"]+)"/ && !mail.subject.include?($1),
+          query =~ /the attachments "([^"]+)"/ && $1.split(/\s*,\s*/).sort != Array(mail.attachments).collect(&:"#{filename_method}").sort
+        ].none?
+    end
     expectation = mode == 'no' ? 'not_to' : 'to'
     expect(@mail).send(expectation, be_present)
   end
@@ -88,34 +113,38 @@ Then /^no e?mail should have been sent$/ do
 end.overridable
 
 # Checks that the last sent email includes some text
-Then /^I should see "([^\"]*)" in the e?mail$/ do |text|
-  expect(MailFinder.email_text_body(ActionMailer::Base.deliveries.last)).to include(text)
+Then /^I should see "([^\"]*)" in the( HTML| plain-text|) e?mail$/ do |text, type|
+  expect(MailFinder.email_text_body(ActionMailer::Base.deliveries.last, type.strip)).to include(text)
+end.overridable
+
+# Print all sent emails to STDOUT (optionally only the headers).
+Then /^show me the e?mail( header)?s$/ do |only_header|
+  if ActionMailer::Base.deliveries.empty?
+    puts MailFinder.show_mails(ActionMailer::Base.deliveries, only_header)
+  else
+    puts "No emails found" if ActionMailer::Base.deliveries.empty?
+  end
+
 end.overridable
 
-# Print all sent emails to STDOUT.
-Then /^show me the e?mails$/ do
-  ActionMailer::Base.deliveries.each_with_index do |mail, i|
-    puts "E-Mail ##{i}"
-    print "-" * 80
-    puts [ "From:    #{mail.from}",
-           "To:      #{mail.to}",
-           "Subject: #{mail.subject}",
-           "\n" + MailFinder.email_text_body(mail)
-         ].join("\n")
-    print "-" * 80
+# Print a subset of all sent emails to STDOUT
+# This uses the same syntax as `Then an email should have been sent with:`
+Then /^show me the e?mail( header)?s with:$/ do |only_header, raw_data|
+  results = MailFinder.find(raw_data)
+  if results.empty?
+    if results.matching_header.empty?
+      puts "There are no emails matching the given header."
+    else
+      puts "There are no emails matching the given header and body, but #{results.matching_header.size} matching only the header."
+    end
   end
+
+  print MailFinder.show_mails(results.mails, only_header)
 end.overridable
 
-# Example:
-#
-#     And that mail should have the following lines in the body:
-#       """
-#       All of these lines
-#       need to be present
-#       """
-#
-# You may skip lines, of course. Note that you may also omit text at the end of each line.
+# nodoc (deprecated)
 Then /^that e?mail should( not)? have the following lines in the body:$/ do |negate, body|
+  warn "The step /^that e?mail should( not)? have the following lines in the body:$/ has been deprecated in favor of the updated step /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/."
   expectation = negate ? 'not_to' : 'to'
   mail = @mail || ActionMailer::Base.deliveries.last
   email_text_body = MailFinder.email_text_body(mail)
@@ -125,8 +154,9 @@ Then /^that e?mail should( not)? have the following lines in the body:$/ do |neg
   end
 end.overridable
 
-# Checks that the text should be included anywhere in the retrieved email body
+# nodoc (deprecated)
 Then /^that e?mail should have the following (?:|content in the )body:$/ do |body|
+  warn "The step /^that e?mail should have the following( content in the)? body:$/ has been deprecated in favor of the updated step /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/."
   mail = @mail || ActionMailer::Base.deliveries.last
   expect(MailFinder.email_text_body(mail)).to include(body.strip)
 end.overridable

data/lib/spreewald_support/mail_finder.rb

@@ -5,22 +5,38 @@ class MailFinder
 
     attr_accessor :user_identity
 
-    def find(conditions)
+    def find(raw_data, type = '')
+      header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+      conditions = {}
+      header.split("\n").each do |row|
+        if row.match(/^[A-Za-z\-]+: /i)
+          key, value = row.split(": ", 2)
+          conditions[key.strip.underscore.to_sym] = value.strip
+        end
+      end
+
       filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
-      ActionMailer::Base.deliveries.detect do |mail|
-        mail_body = email_text_body(mail)
+      matching_header = ActionMailer::Base.deliveries.select do |mail|
         [ conditions[:to].nil? || mail.to.include?(resolve_email conditions[:to]),
           conditions[:cc].nil? || mail.cc && mail.cc.include?(resolve_email conditions[:cc]),
           conditions[:bcc].nil? || mail.bcc && mail.bcc.include?(resolve_email conditions[:bcc]),
           conditions[:from].nil? || mail.from.include?(resolve_email conditions[:from]),
           conditions[:reply_to].nil? || mail.reply_to.include?(resolve_email conditions[:reply_to]),
           conditions[:subject].nil? || mail.subject.include?(conditions[:subject]),
-          conditions[:body].nil? || mail_body.include?(conditions[:body]),
           conditions[:attachments].nil? || conditions[:attachments].split(/\s*,\s*/).sort == Array(mail.attachments).collect(&:"#{filename_method}").sort
         ].all?
-      end.tap do |mail|
-        log(mail)
       end
+
+      matching_mails = if body
+        body_regex = expected_body_regex(body)
+        matching_header.select do |mail|
+          body_regex =~ email_text_body(mail, type).strip
+        end
+      else
+        matching_header
+      end
+
+      Results.new(matching_mails, matching_header, body_regex)
     end
 
     def resolve_email(identity)
@@ -31,46 +47,60 @@ class MailFinder
       end
     end
 
-    def log(mail)
-      if mail.present?
-        File.open("log/test_mails.log", "a") do |file|
-          file << "From: #{mail.from}\n"
-          file << "To: #{mail.to.join(', ')}\n" if mail.to
-          file << "Subject: #{mail.subject}\n\n"
-          file << email_text_body(mail)
-          file << "\n-------------------------\n\n"
-        end
-      end
+    def header_representation(mail)
+      header = ""
+      header << "From: #{mail.from}\n"
+      header << "Reply-To: #{mail.reply_to.join(', ')}\n" if mail.reply_to
+      header << "To: #{mail.to.join(', ')}\n" if mail.to
+      header << "CC: #{mail.cc.join(', ')}\n" if mail.cc
+      header << "BCC: #{mail.bcc.join(', ')}\n" if mail.bcc
+      header << "Subject: #{mail.subject}\n"
     end
 
-    def email_text_body(mail)
-      body = if mail.parts.any?
-        mail_bodies = mail.parts.map { |part|
-          if part.header.to_s.include?('Quoted-printable')
-            if Rails.version.starts_with?('2.3')
-              part.body.to_s
-            else
-              part.decoded
-            end
-          elsif part.content_type.include?('multipart/alternative')
-            part.parts.map(&:decoded)
-          else
-            part.decoded
-          end
-        }
-        utf8_parts = mail_bodies.flatten.select{ |part|
-          encoding = part.try(:encoding)
-          encoding.nil? or # Ruby < 1.9.1
-            encoding.name == 'UTF-8' # Ruby > 1.9.1
-        }
-        utf8_parts.join('\n')
-      elsif mail.body.respond_to? :raw_source
-        mail.body.raw_source
+    def email_text_body(mail, type = '')
+      if mail.html_part && type != 'plain-text'
+        dom = Nokogiri::HTML(mail.html_part.body.to_s)
+        dom.at_css('body').text.gsub(/\n\n/, "\n")
+      elsif mail.text_part && type != 'HTML'
+        mail.text_part.body.to_s
       else
-        mail.body
+        mail.body.to_s
       end
-      body.gsub("\r\n", "\n") # The mail gem (>= 2.7.1) switched from \n to \r\n line breaks (LF to CRLF) in plain text mails.
     end
 
+    def show_mails(mails, only_header = false)
+      message = ""
+      mails.each_with_index do |mail, i|
+        message << "E-Mail ##{i}\n"
+        message <<  "-" * 80 + "\n"
+        message << header_representation(mail)
+        message << "\n" + email_text_body(mail).strip + "\n" unless only_header
+        message <<  "-" * 80 + "\n\n"
+      end
+      message
+    end
+
+    def expected_body_regex(expected_body)
+      # To stay backwards-compatible, this will only check whether an email
+      # starts with the expected body.
+      expected = '\A\n' + Regexp.quote(expected_body.strip) + '\n\Z'
+      expected.gsub! '\n\*\n', '\n[\s\S]*\n'
+      expected.gsub! '\*\n', '.*\n'
+
+      expected.gsub! '\A\n', '\A'
+      expected.gsub! '\n\Z', '' # Change '' to '\Z' to force that the whole body matches
+
+      Regexp.new(expected)
+    end
+
+  end
+end
+
+class MailFinder::Results < Struct.new(:mails, :matching_header, :body_regex)
+  extend Forwardable
+  delegate [:size, :one?, :empty?] => :mails
+
+  def many?
+    size > 1
   end
 end

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '2.8.0'
+  VERSION = '2.9.0'
 end

data/tests/rails-3_capybara-1/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.8.0)
+    spreewald (2.9.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-3_capybara-2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.8.0)
+    spreewald (2.9.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-4_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.8.0)
+    spreewald (2.9.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-6_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.8.0)
+    spreewald (2.9.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/shared/features/shared/email_steps.feature

@@ -1,10 +1,10 @@
 Feature: Test Spreewald's email steps
-  
+
   Scenario: /^no e?mail should have been sent$/
     When I go to "/emails/do_nothing"
     Then the following step should succeed:
       | no email should have been sent |
-  
+
     When I go to "/emails/send_email"
     Then the following step should fail:
       | no email should have been sent |
@@ -50,6 +50,53 @@ Feature: Test Spreewald's email steps
         '''
       """
 
+    # Test with end-of-line wildcards
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Bo*
+        wi*
+        li*
+        br*
+        '''
+      """
+
+    # Test with multiple-line wildcards
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        *
+        breaks
+        '''
+      """
+
+    # Test with the whole body being a multiple-line wildcard
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        *
+        '''
+      """
+
     # Test with incorrect From header
     Then the following multiline step should fail:
       """
@@ -148,12 +195,29 @@ Feature: Test Spreewald's email steps
         with
         line
         breaks
-        
+
         MORE-BODY
         '''
       """
 
-  Scenario: /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/
+    # Test body with wildcard not at the end of a line
+    Then the following multiline step should fail:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        *th
+        line
+        break
+        '''
+      """
+
+  Scenario: Scenario: /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/
     When I go to "/emails/send_email"
 
     # Test with correct conditions
@@ -181,7 +245,7 @@ Feature: Test Spreewald's email steps
         '''
       """
 
-     # Test with wrong body lines
+    # Test with wrong body lines
     Then the following multiline step should fail:
       """
       Then that email should have the following lines in the body:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreewald
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber