Module: Pkg::Util::Execution

Defined in:
lib/packaging/util/execution.rb

Overview

Utility methods for handling system calls and interactions

Class Method Summary collapse

Class Method Details

.capture3(command, debug = false) ⇒ Object

Turns out trying to change ex to use Open3 is SUPER DANGEROUS and destructive in ways I hadn’t imagined. I’m going to add a new method here instead and start converting code to use that so I don’t break more than I plan to.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/packaging/util/execution.rb', line 40

def capture3(command, debug = false)
  require 'open3'
  puts "Executing '#{command}'..." if debug
  stdout, stderr, ret = Open3.capture3(command)
  unless Pkg::Util::Execution.success?(ret)
    raise "#{stdout}#{stderr}"
  end

  if debug
    puts "Command '#{command}' returned:"
    puts stdout
  end

  return stdout, stderr, ret
end

.ex(command, debug = false) ⇒ Object

ex combines the behavior of ‘%xcmd` and rake’s ‘sh “cmd”`. `%xcmd` has the benefit of returning the standard out of an executed command, enabling us to query the file system, e.g. `contents = %xls`. The drawback to `%xcmd` is that on failure of a command (something returned non-zero) the return of `%xcmd` is just an empty string. As such, we can’t know if we succeeded. Rake’s ‘sh “cmd”`, on the other hand, will raise a RuntimeError if a command does not return 0, but doesn’t return any of the stdout from the command - only true or false depending on its success or failure. With ‘ex(cmd)` we purport to both return the results of the command execution (ala `%xcmd`) while also raising an exception if a command does not succeed (ala `sh “cmd”`).



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/packaging/util/execution.rb', line 22

def ex(command, debug = false)
  puts "Executing '#{command}'..." if debug
  ret = %x(#{command})
  unless Pkg::Util::Execution.success?
    raise RuntimeError
  end

  if debug
    puts "Command '#{command}' returned:"
    puts ret
  end

  ret
end

.retry_on_fail(args, &blk) ⇒ Object

Loop a block up to the number of attempts given, exiting when we receive success or max attempts is reached. Raise an exception unless we’ve succeeded.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/packaging/util/execution.rb', line 58

def retry_on_fail(args, &blk)
  success = false
  exception = ''

  if args[:times].respond_to?(:times) and block_given?
    args[:times].times do |i|
      if args[:delay]
        sleep args[:delay]
      end

      begin
        blk.call
        success = true
        break
      rescue StandardError => err
        puts "An error was encountered evaluating block. Retrying.."
        exception = "#{err.to_s}\n#{err.backtrace.join("\n")}"
      end
    end
  else
    fail "retry_on_fail requires and arg (:times => x) where x is an Integer/Fixnum, and a block to execute"
  end
  fail "Block failed maximum of #{args[:times]} tries. Exiting..\nLast failure was: #{exception}" unless success
end

.success?(statusobject = $?) ⇒ Boolean

Alias to $?.success? that makes success? slightly easier to test and stub If immediately run, $? will not be instanciated, so only call success? if $? exists, otherwise return nil

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/packaging/util/execution.rb', line 8

def success?(statusobject = $?)
  return statusobject.success?
end