Module: Beaker::DSL::Wrappers

Included in:
Beaker::DSL, PSWindows::Exec
Defined in:
lib/beaker/dsl/wrappers.rb

Overview

These are wrappers to equivalent Command objects so that command line actions are executed within an appropriate and configurable environment.

I find most of these adapters of suspicious value and have deprecated many of them.

Instance Method Summary collapse

Instance Method Details

#cfacter(*args) ⇒ Object

This is hairy and because of legacy code it will take a bit more work to disentangle all of the things that are being passed into this catchall param.



27
28
29
30
31
32
 
# File 'lib/beaker/dsl/wrappers.rb', line 27

def cfacter(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options['ENV'] ||= {}
  options[:cmdexe] = true
  Command.new('cfacter', args, options )
end

#encode_command(cmd) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Convert the provided command string to Base64

Parameters:

  • cmd (String) —

    The command to convert to Base64

Returns:

  • (String) —

    The converted string



169
170
171
172
173
174
175
 
# File 'lib/beaker/dsl/wrappers.rb', line 169

def encode_command(cmd)
  cmd = cmd.chars.to_a.join("\x00").chomp
  cmd << "\x00" unless cmd[-1].eql? "\x00"
  # use strict_encode because linefeeds are not correctly handled in our model
  cmd = Base64.strict_encode64(cmd).chomp
  cmd
end

#facter(*args) ⇒ Object

This is hairy and because of legacy code it will take a bit more work to disentangle all of the things that are being passed into this catchall param.



16
17
18
19
20
21
 
# File 'lib/beaker/dsl/wrappers.rb', line 16

def facter(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options['ENV'] ||= {}
  options[:cmdexe] = true
  Command.new('facter', args, options )
end

#hiera(*args) ⇒ Object

This is hairy and because of legacy code it will take a bit more work to disentangle all of the things that are being passed into this catchall param.



38
39
40
41
42
43
 
# File 'lib/beaker/dsl/wrappers.rb', line 38

def hiera(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options['ENV'] ||= {}
  options[:cmdexe] = true
  Command.new('hiera', args, options )
end

#powershell(command, args = {}) ⇒ Command

Returns a Command object for executing powershell commands on a host

Examples:

Setting the contents of a file

powershell("Set-Content -path 'fu.txt' -value 'fu'")

Using an alternative execution policy

powershell("Set-Content -path 'fu.txt' -value 'fu'", {'ExecutionPolicy' => 'Unrestricted'})

Using an EncodedCommand (defaults to non-encoded)

powershell("Set Content -path 'fu.txt', -value 'fu'", {'EncodedCommand => true})

executing from a file

powershell("", {'-File' => '/path/to/file'})

Parameters:

  • command (String) —

    The powershell command to execute

  • args (Hash) (defaults to: {}) —

    The commandline parameters to be passed to powershell

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/beaker/dsl/wrappers.rb', line 126

def powershell(command, args={})
  ps_opts = {
    'ExecutionPolicy' => 'Bypass',
    'InputFormat'     => 'None',
    'NoLogo'          => '',
    'NoProfile'       => '',
    'NonInteractive'  => ''
  }
  encoded = false
  ps_opts.merge!(args)
  ps_args = []

  # determine if the command should be encoded
  if ps_opts.has_key?('EncodedCommand')
    v = ps_opts.delete('EncodedCommand')
    # encode the commend if v is true, nil or empty
    encoded = v || v.eql?('') || v.nil?
  end

  ps_opts.each do |k, v|
    if v.eql?('') or v.nil?
      ps_args << "-#{k}"
    else
      ps_args << "-#{k} #{v}"
    end
  end

  # may not have a command if executing a file
  if command && !command.empty?
    if encoded
      ps_args << "-EncodedCommand #{encode_command(command)}"
    else
      ps_args << "-Command #{command}"
    end
  end

  Command.new("powershell.exe", ps_args)
end

#puppet(*args) ⇒ Object

This is hairy and because of legacy code it will take a bit more work to disentangle all of the things that are being passed into this catchall param.



58
59
60
61
62
63
64
65
66
 
# File 'lib/beaker/dsl/wrappers.rb', line 58

def puppet(*args)
  options = args.last.is_a?(Hash) ? args.pop : {}
  options['ENV'] ||= {}
  options[:cmdexe] = true
  # we assume that an invocation with `puppet()` will have it's first argument
  # a face or sub command
  cmd = "puppet #{args.shift}"
  Command.new( cmd, args, options )
end