Merge pull request #1983 from bwitt/retry-on-array

Allow `retry_on` to work for host array

Author: ekohl

acceptance/tests/base/dsl/helpers/host_helpers/retry_on_test.rb

@@ -24,10 +24,7 @@
     assert_equal "", result.stdout
   end
 
-  step "#retry_on CURRENTLY fails when provided a host array" do
-    # NOTE: would expect this to work across hosts, or be better documented and
-    #       to raise Beaker::Host::CommandFailure
-
+  step "#retry_on works when provided a host array" do
     remote_tmpdir = default.tmpdir
     remote_script_file = File.join(remote_tmpdir, "test.sh")
 
@@ -36,8 +33,13 @@
       create_remote_file_from_fixture("retry_script", host, remote_tmpdir, "test.sh")
     end
 
-    assert_raises NoMethodError do
-      retry_on hosts, "bash #{remote_script_file} #{remote_tmpdir} 2", { :max_retries => 4, :retry_interval => 0.1 }
+    results = retry_on hosts, "bash #{remote_script_file} #{remote_tmpdir} 2", { :max_retries => 4, :retry_interval => 0.1 }
+
+    assert_kind_of Array, results
+    assert_equal hosts.length, results.length
+    results.each do |result|
+      assert_equal 0, result.exit_code
+      assert_equal "", result.stdout
     end
   end
 end

lib/beaker/dsl/helpers/host_helpers.rb

@@ -557,25 +557,30 @@ def retry_on(host, command, opts = {}, &)
           retry_interval        = option_retry_interval == 0 ? 1 : option_retry_interval
           verbose               = true.to_s == opts[:verbose]
 
-          log_prefix = host.log_prefix
-          logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{command}"
-          logger.debug "  Trying command #{max_retries} times."
-          logger.debug ".", add_newline: false
-
-          result = on(host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &)
-          num_retries = 0
-          until desired_exit_codes.include?(result.exit_code)
-            sleep retry_interval
-            result = on(host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &)
-            num_retries += 1
+          block_opts = {}
+          block_opts[:run_in_parallel] = opts[:run_in_parallel] if opts.key?(:run_in_parallel)
+
+          block_on host, block_opts do |single_host|
+            log_prefix = single_host.log_prefix
+            logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{command}"
+            logger.debug "  Trying command #{max_retries} times."
             logger.debug ".", add_newline: false
-            if (num_retries > max_retries)
-              logger.debug "  Command \`#{command}\` failed."
-              fail("Command \`#{command}\` failed.")
+
+            result = on(single_host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &)
+            num_retries = 0
+            until desired_exit_codes.include?(result.exit_code)
+              sleep retry_interval
+              result = on(single_host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &)
+              num_retries += 1
+              logger.debug ".", add_newline: false
+              if (num_retries > max_retries)
+                logger.debug "  Command \`#{command}\` failed."
+                fail("Command \`#{command}\` failed.")
+              end
             end
+            logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{command} ostensibly successful."
+            result
           end
-          logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{command} ostensibly successful."
-          result
         end
 
         # FIX: this should be moved into host/platform

spec/beaker/dsl/helpers/host_helpers_spec.rb

@@ -241,6 +241,23 @@ def logger
       result_given = subject.retry_on(host, command, opts)
       expect(result_given.exit_code).to be === 0
     end
+
+    it 'operates correctly when host is an array' do
+      result.stdout = 'stdout'
+      result.stderr = 'stderr'
+      result.exit_code = 0
+
+      opts = {
+        :max_retries => 5,
+        :retry_interval => 0.0001,
+      }
+
+      allow(subject).to receive(:on).and_return(result)
+      expect(subject).to receive(:on).exactly(hosts.length).times
+
+      results = subject.retry_on(hosts, command, opts)
+      expect(results).to eq(Array.new(hosts.length, result))
+    end
   end
 
   describe "shell" do