From d87c645bd0447217b440934e6bd8cf5867b7f649 Mon Sep 17 00:00:00 2001
From: Chris Roberts <croberts@hashicorp.com>
Date: Mon, 7 Jan 2019 16:19:14 -0800
Subject: [PATCH] Fix garbage detection within SSH communicator

Fixes #10552
---
 plugins/communicators/ssh/communicator.rb     |  6 +--
 .../communicators/ssh/communicator_test.rb    | 44 +++++++++++++++++++
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/plugins/communicators/ssh/communicator.rb b/plugins/communicators/ssh/communicator.rb
index c92e39980..9ef4b3e09 100644
--- a/plugins/communicators/ssh/communicator.rb
+++ b/plugins/communicators/ssh/communicator.rb
@@ -573,14 +573,14 @@ module VagrantPlugins
                 stderr_data_buffer << data
                 marker_index = stderr_data_buffer.index(CMD_GARBAGE_MARKER)
                 if marker_index
-                  marker_found = true
+                  stderr_marker_found = true
                   stderr_data_buffer.slice!(0, marker_index + CMD_GARBAGE_MARKER.size)
                   data.replace(stderr_data_buffer)
-                  data_buffer = nil
+                  stderr_data_buffer = nil
                 end
               end
 
-              if block_given? && marker_found && !data.empty?
+              if block_given? && stderr_marker_found && !data.empty?
                 yield :stderr, data
               end
             end
diff --git a/test/unit/plugins/communicators/ssh/communicator_test.rb b/test/unit/plugins/communicators/ssh/communicator_test.rb
index 6a979ecc3..6db627d70 100644
--- a/test/unit/plugins/communicators/ssh/communicator_test.rb
+++ b/test/unit/plugins/communicators/ssh/communicator_test.rb
@@ -321,6 +321,7 @@ describe VagrantPlugins::CommunicatorSSH::Communicator do
       let(:command_stdout_data) do
         "Line of garbage\nMore garbage\n#{command_garbage_marker}bin\ntmp\n"
       end
+      let(:command_stderr_data) { "some data" }
 
       it "removes any garbage output prepended to command output" do
         stdout = ''
@@ -333,12 +334,23 @@ describe VagrantPlugins::CommunicatorSSH::Communicator do
         ).to eq(0)
         expect(stdout).to eq("bin\ntmp\n")
       end
+
+      it "should not receive any stderr data" do
+        stderr = ''
+        communicator.execute("ls /") do |type, data|
+          if type == :stderr
+            stderr << data
+          end
+        end
+        expect(stderr).to be_empty
+      end
     end
 
     context "with no command output" do
       let(:command_stdout_data) do
         "#{command_garbage_marker}"
       end
+      let(:command_stderr_data) { "some data" }
 
       it "does not send empty stdout data string" do
         empty = true
@@ -351,12 +363,23 @@ describe VagrantPlugins::CommunicatorSSH::Communicator do
         ).to eq(0)
         expect(empty).to be(true)
       end
+
+      it "should not receive any stderr data" do
+        stderr = ''
+        communicator.execute("ls /") do |type, data|
+          if type == :stderr
+            stderr << data
+          end
+        end
+        expect(stderr).to be_empty
+      end
     end
 
     context "with garbage content prepended to command stderr output" do
       let(:command_stderr_data) do
         "Line of garbage\nMore garbage\n#{command_garbage_marker}bin\ntmp\n"
       end
+      let(:command_stdout_data) { "some data" }
 
       it "removes any garbage output prepended to command stderr output" do
         stderr = ''
@@ -369,12 +392,23 @@ describe VagrantPlugins::CommunicatorSSH::Communicator do
         ).to eq(0)
         expect(stderr).to eq("bin\ntmp\n")
       end
+
+      it "should not receive any stdout data" do
+        stdout = ''
+        communicator.execute("ls /") do |type, data|
+          if type == :stdout
+            stdout << data
+          end
+        end
+        expect(stdout).to be_empty
+      end
     end
 
     context "with no command output on stderr" do
       let(:command_stderr_data) do
         "#{command_garbage_marker}"
       end
+      let(:command_std_data) { "some data" }
 
       it "does not send empty stderr data string" do
         empty = true
@@ -387,6 +421,16 @@ describe VagrantPlugins::CommunicatorSSH::Communicator do
         ).to eq(0)
         expect(empty).to be(true)
       end
+
+      it "should not receive any stdout data" do
+        stdout = ''
+        communicator.execute("ls /") do |type, data|
+          if type == :stdout
+            stdout << data
+          end
+        end
+        expect(stdout).to be_empty
+      end
     end
 
     context "with pty enabled" do