Allow attaching path

CHANGELOG.md

@@ -16,6 +16,11 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ### Fixed
 
+* It is now possible to attach a file passing its path
+  ([#1506](https://github.com/cucumber/cucumber-ruby/issues/1506)
+   [#1514](https://github.com/cucumber/cucumber-ruby/pull/1514)
+   [aurelien-reeves](https://github.com/aurelien-reeves))
+
 ### Changed
 
 * Upgraded to `cucumber-create-meta` 3.0.0 ([aurelien-reeves](https://github.com/aurelien-reeves), [TimotheeVille](https://github.com/TimotheeVille))

cucumber.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'cucumber-messages', '~> 14.0', '>= 14.0.1'
   s.add_dependency 'cucumber-wire', '~> 4.0', '>= 4.0.1'
   s.add_dependency 'diff-lcs', '~> 1.4', '>= 1.4.4'
+  s.add_dependency 'mime-types', '~> 3.3', '>= 3.3.1'
   s.add_dependency 'multi_test', '~> 0.1', '>= 0.1.2'
   s.add_dependency 'sys-uname', '~> 1.2', '>= 1.2.1'
 

features/docs/raketask.feature

@@ -3,8 +3,8 @@ Feature: Raketask
   In order to use cucumber's rake task
   As a Cuker
   I do not want to see rake's backtraces when it fails
-  Also I want to get zero exit status code on failures
-  And non-zero exit status code when it pases
+  Also I want to get zero exit status code when it passes
+  And non-zero exit status code when it fails
 
   Background:
     Given the standard step definitions

features/docs/writing_support_code/attachments.feature

@@ -0,0 +1,54 @@
+Feature: Attachments
+  It is sometimes useful to take a screenshot while a scenario runs.
+  Or capture some logs.
+
+  Cucumber lets you `attach` arbitrary files during execution, and you can
+  specify a media type for the contents.
+
+  Formatters can then render these attachments in reports.
+
+  Background:
+    Given a file named "features/attaching_screenshot_with_mediatype.feature" with:
+      """
+      Feature: A screenshot feature
+        Scenario:
+          Given I attach a screenshot with media type
+      """
+    Given a file named "features/attaching_screenshot_without_mediatype.feature" with:
+      """
+      Feature: A file feature
+        Scenario:
+          Given I attach a screenshot without media type
+      """
+    And a file named "features/screenshot.png" with:
+      """
+      foo
+      """
+    And a file named "features/step_definitions/attaching_screenshot_steps.rb" with:
+      """
+      Given /^I attach a screenshot with media type/ do
+        attach "features/screenshot.png", "image/png"
+      end
+
+      Given /^I attach a screenshot without media type/ do
+        attach "features/screenshot.png"
+      end
+      """
+
+  Scenario: Files can be attached given their path
+    When I run `cucumber --format message features/attaching_screenshot_with_mediatype.feature`
+    Then output should be valid NDJSON
+    And the output should contain NDJSON with key "attachment"
+    And the output should contain NDJSON with key "body" and value "Zm9v"
+    And the output should contain NDJSON with key "mediaType" and value "image/png"
+
+  Scenario: Media type is inferred from the given file
+    When I run `cucumber --format message features/attaching_screenshot_without_mediatype.feature`
+    Then output should be valid NDJSON
+    And the output should contain NDJSON with key "attachment"
+    And the output should contain NDJSON with key "body" and value "Zm9v"
+    And the output should contain NDJSON with key "mediaType" and value "image/png"
+
+  Scenario: With json formatter, files can be attached given their path
+    When I run `cucumber --format json features/attaching_screenshot_with_mediatype.feature`
+    Then the output should contain "embeddings\":[{\"mime_type\":\"image/png\",\"data\":\"Zm9v\"}]"

features/lib/step_definitions/message_steps.rb

@@ -11,6 +11,10 @@
   end
 end
 
+Then('the output should contain NDJSON with key {string}') do |key|
+  expect(command_line.stdout).to match(/"#{key}":/)
+end
+
 Then('the output should contain NDJSON with key {string} and value {string}') do |key, value|
   expect(command_line.stdout).to match(/"#{key}": ?"#{value}"/)
 end

lib/cucumber/formatter/json.rb

@@ -94,10 +94,7 @@ def attach(src, mime_type)
           test_step_output << src
           return
         end
-        if File.file?(src)
-          content = File.open(src, 'rb', &:read)
-          data = encode64(content)
-        elsif mime_type =~ /;base64$/
+        if mime_type =~ /;base64$/
           mime_type = mime_type[0..-8]
           data = src
         else

lib/cucumber/glue/proto_world.rb

@@ -3,6 +3,7 @@
 require 'cucumber/gherkin/formatter/ansi_escapes'
 require 'cucumber/core/test/data_table'
 require 'cucumber/deprecate'
+require 'mime/types'
 
 module Cucumber
   module Glue
@@ -111,8 +112,13 @@ def log(*messages)
         messages.each { |message| attach(message.to_s.dup, 'text/x.cucumber.log+plain') }
       end
 
-      def attach(file, media_type)
-        super
+      def attach(file, media_type = nil)
+        return super unless File.file?(file)
+
+        content = File.open(file, 'rb', &:read)
+        media_type = MIME::Types.type_for(file).first if media_type.nil?
+
+        super(content, media_type.to_s)
       end
 
       # Mark the matched step as pending.