Fix issue with non-ASCII characters in Buffer and Stream attachments

Author: simondean

features/attachments.feature

@@ -19,7 +19,13 @@ Feature: Attachments
       """
       var hooks = function () {
         this.Before(function(scenario, callback) {
-          scenario.attach(new Buffer([100, 97, 116, 97]), 'image/png');
+          var data = [];
+
+          for (var i = 0; i < 256; i++) {
+            data.push(i);
+          }
+
+          scenario.attach(new Buffer(data), 'image/png');
           callback();
         });
       };
@@ -57,7 +63,7 @@ Feature: Attachments
                   "embeddings": [
                     {
                       "mime_type": "image/png",
-                      "data": "ZGF0YQ=="
+                      "data": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w=="
                     }
                   ]
                 },
@@ -98,22 +104,33 @@ Feature: Attachments
       var hooks = function () {
         this.Before(function(scenario, callback) {
           var Stream = require('stream');
-          var versionParts = /v(\d+)\.(\d+)\.(\d+)/.exec(process.version);
-          var major = parseInt(versionParts[0], 10);
-          var minor = parseInt(versionParts[1], 10);
+          var versionParts = process.version.match(/v(\d+)\.(\d+)\.(\d+)/);
+          var major = parseInt(versionParts[1], 10);
+          var minor = parseInt(versionParts[2], 10);
+          var data1 = [];
+          var data2 = [];
+
+          for (var i = 0; i < 128; i++) {
+            data1.push(i);
+          }
+
+          for (var i = 128; i < 256; i++) {
+            data2.push(i);
+          }
 
           if (major > 0 || minor >= 10) {
             var stream = new Stream.Readable();
             stream._read = function() {};
-            stream.push(new Buffer([100, 97, 116, 97]));
+            stream.push(new Buffer(data1));
+            stream.push(new Buffer(data2));
             stream.push(null);
 
             scenario.attach(stream, 'image/png', function(error) {
               callback(error);
             });
           }
           else {
-            scenario.attach(new Buffer([100, 97, 116, 97]), 'image/png');
+            scenario.attach(new Buffer([].concat(data1, data2)), 'image/png');
             callback();
           }
         });
@@ -152,7 +169,7 @@ Feature: Attachments
                   "embeddings": [
                     {
                       "mime_type": "image/png",
-                      "data": "ZGF0YQ=="
+                      "data": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w=="
                     }
                   ]
                 },

lib/cucumber/api/scenario.js

@@ -23,9 +23,9 @@ var Scenario = function (astTreeWalker, astScenario) {
 
         data.on('data', function(chunk) {
           buffers.push(chunk);
-        })
+        });
         data.on('end', function() {
-          astTreeWalker.attach(Buffer.concat(buffers).toString(), mimeType);
+          astTreeWalker.attach(Buffer.concat(buffers).toString('binary'), mimeType);
 
           callback();
         });
@@ -34,7 +34,7 @@ var Scenario = function (astTreeWalker, astScenario) {
         if (!mimeType)
           throw Error(Scenario.ATTACH_MISSING_MIME_TYPE_ARGUMENT);
 
-        astTreeWalker.attach(data.toString(), mimeType);
+        astTreeWalker.attach(data.toString('binary'), mimeType);
 
         if (callback) {
           callback();

spec/cucumber/api/scenario_spec.js

@@ -164,6 +164,33 @@ describe("Cucumber.Api.Scenario", function() {
               expect(callback).toHaveBeenCalled();
             });
           });
+
+          describe("when the stream finishes providing data and the data contains non-ASCII characters", function() {
+            var data1, data2, text;
+
+            beforeEach(function() {
+              data1 = [];
+              data2 = [];
+
+              for (var i = 0; i < 256; i++) {
+                data1.push(i);
+                data2.push(i);
+              }
+
+              dataListener(new Buffer(data1));
+              dataListener(new Buffer(data2));
+              text = String.fromCharCode.apply(null, [].concat(data1, data2));
+              endListener();
+            });
+
+            it("instructs the ast tree walker to create an attachment containing the contents of the stream", function() {
+              expect(astTreeWalker.attach).toHaveBeenCalledWith(text, mimeType);
+            });
+
+            it("calls back", function() {
+              expect(callback).toHaveBeenCalled();
+            });
+          });
         })
       });
     }
@@ -203,6 +230,27 @@ describe("Cucumber.Api.Scenario", function() {
           expect(callback).not.toHaveBeenCalled();
         });
       });
+
+     describe("when the data contains non-ASCII characters", function() {
+       var data, buffer, text;
+
+       beforeEach(function() {
+         data = [];
+
+         for (var i = 0; i < 256; i++) {
+           data.push(i);
+         }
+
+         buffer = new Buffer(data);
+         text = String.fromCharCode.apply(null, data);
+         scenario.attach(buffer, mimeType, callback);
+       });
+
+       it("instructs the ast tree walker to create an attachment containing the contents of the buffer", function() {
+         scenario.attach(buffer, mimeType);
+         expect(astTreeWalker.attach).toHaveBeenCalledWith(text, mimeType);
+       });
+     });
     });
 
     describe("when the data is a string", function() {