Module: Beaker::TaskHelper

Includes:
DSL
Defined in:
lib/beaker-task_helper.rb,
lib/beaker-task_helper/version.rb,
lib/beaker-task_helper/inventory.rb

Overview

Beaker task Helper

Defined Under Namespace

Modules: Inventory

Constant Summary collapse

VERSION = 
'1.7.0'.freeze
DEFAULT_PASSWORD = 
if ENV.has_key?('BEAKER_password')
  ENV['BEAKER_password']
elsif !defined?(default)
  'root'
elsif default[:hypervisor] == 'vagrant'
  'puppet'
else
  'root'
end
BOLT_VERSION = 
if ENV['BEAKER_PUPPET_COLLECTION'].nil? || ENV['BEAKER_PUPPET_COLLECTION'] == 'pc1'
# puppet4 uses an older version of ruby (2.1.9) that bolt has stopped supporting
  '0.16.1'.freeze
else
  '0.23.0'.freeze
end

Instance Method Summary collapse

Instance Method Details

#expect_multiple_regexes(result:, regexes:) ⇒ Object 



161
162
163
164
165
 
# File 'lib/beaker-task_helper.rb', line 161

def expect_multiple_regexes(result:, regexes:)
  regexes.each do |regex|
    expect(result).to match(regex)
  end
end

#install_bolt_on(hosts, version = BOLT_VERSION, source = nil) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/beaker-task_helper.rb', line 28

def install_bolt_on(hosts, version = BOLT_VERSION, source = nil)
  unless default[:docker_image_commands].nil?
    if default[:docker_image_commands].to_s.include? 'yum'
      on(hosts, 'yum install -y make gcc ruby-devel', acceptable_exit_codes: [0, 1]).stdout
    elsif default[:docker_image_commands].to_s.include? 'apt-get'
      on(hosts, 'apt-get install -y make gcc ruby-dev', acceptable_exit_codes: [0, 1]).stdout
    end
  end

  Array(hosts).each do |host|

    # Work around for BOLT-845
    pp0 = <<-INSTALL_FFI_PP
package { 'ffi' :
  provider => 'puppet_gem',
  ensure   => '1.9.18', }
INSTALL_FFI_PP

    apply_manifest_on(host, pp0) if fact_on(host, 'osfamily') == 'RedHat' && fact_on(host, 'operatingsystemmajrelease') == '5'

    pp = <<-INSTALL_BOLT_PP
package { 'bolt' :
  provider => 'puppet_gem',
  ensure   => '#{version}',
INSTALL_BOLT_PP
    pp << "source   => '#{source}'" if source
    pp << '}'
    apply_manifest_on(host, pp)

    bolt_confdir = "#{on(host, 'echo $HOME').stdout.chomp}/.puppetlabs/bolt"
    on host, "mkdir -p #{bolt_confdir}"
    create_remote_file(host, "#{bolt_confdir}/analytics.yaml", { 'disabled' => true }.to_yaml)
  end
end

#pe_install? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/beaker-task_helper.rb', line 63

def pe_install?
  ENV['PUPPET_INSTALL_TYPE'] =~ %r{pe}i
end

#puppet_version ⇒ Object 



7
8
9
 
# File 'lib/beaker-task_helper.rb', line 7

def puppet_version
  (on default, puppet('--version')).output.chomp
end

#run_bolt_task(task_name:, params: nil, password: DEFAULT_PASSWORD, host: '127.0.0.1', format: 'human', module_path: nil) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/beaker-task_helper.rb', line 104

def run_bolt_task(task_name:, params: nil, password: DEFAULT_PASSWORD,
                  host: '127.0.0.1', format: 'human', module_path: nil)
  if fact_on(default, 'osfamily') == 'windows'
    bolt_path = if ENV['BEAKER_PUPPET_COLLECTION'].nil? || ENV['BEAKER_PUPPET_COLLECTION'] == 'pc1' || ENV['BEAKER_PUPPET_COLLECTION'] == 'puppet5'
                  '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/sys/ruby/bin/bolt.bat'
                else
                  '/cygdrive/c/Program\ Files/Puppet\ Labs/Puppet/puppet/bin/bolt.bat'
                end
    module_path ||= 'C:/ProgramData/PuppetLabs/code/modules'

    if version_is_less('0.15.0', BOLT_VERSION)
      check = '--no-ssl'
    else
      check = '--insecure'
    end
  else
    bolt_path = '/opt/puppetlabs/puppet/bin/bolt'
    module_path ||='/etc/puppetlabs/code/modules'

    if version_is_less('0.15.0', BOLT_VERSION)
      check = '--no-host-key-check'
    else
      check = '--insecure'
    end
  end

  bolt_full_cli = "#{bolt_path} task run #{task_name} #{check} -m #{module_path} " \
                  "--nodes #{host} --password #{password}"
  bolt_full_cli << " --format #{format}" if format != 'human'
  bolt_full_cli << if params.class == Hash
                     " --params '#{params.to_json}'"
                   else
                     " #{params}"
                   end
  # windows is special
  if fact_on(default, 'osfamily') == 'windows'
    bolt_full_cli << ' --transport winrm --user Administrator'
  end
  puts "BOLT_CLI: #{bolt_full_cli}" if ENV['BEAKER_debug']
  on(default, bolt_full_cli, acceptable_exit_codes: [0, 1, 2]).stdout
end

#run_puppet_access_login(user:, password: '~!@#$%^*-/ aZ', lifetime: '5y') ⇒ Object 



67
68
69
 
# File 'lib/beaker-task_helper.rb', line 67

def (user:, password: '~!@#$%^*-/ aZ', lifetime: '5y')
  on(master, puppet('access', 'login', '--username', user, '--lifetime', lifetime), stdin: password)
end

#run_puppet_task(task_name:, params: nil, host: '127.0.0.1', format: 'human') ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/beaker-task_helper.rb', line 146

def run_puppet_task(task_name:, params: nil, host: '127.0.0.1', format: 'human')
  args = ['task', 'run', task_name, '--nodes', host]
  if params.class == Hash
    args << '--params'
    args << params.to_json
  else
    args << params
  end
  if format != 'human'
    args << '--format'
    args << format
  end
  on(master, puppet(*args), acceptable_exit_codes: [0, 1]).stdout
end

#run_task(task_name:, params: nil, password: DEFAULT_PASSWORD, host: nil, format: 'human') ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/beaker-task_helper.rb', line 86

def run_task(task_name:, params: nil, password: DEFAULT_PASSWORD, host: nil, format: 'human')
  output = if pe_install?
             host = master.hostname if host.nil?
             run_puppet_task(task_name: task_name, params: params, host: host, format: format)
           else
             host = '127.0.0.1' if host.nil?
             run_bolt_task(task_name: task_name, params: params,
                           password: password, host: host, format: format)
           end

  if format == 'json'
    output = JSON.parse(output)
    output['items'][0]
  else
    output
  end
end

#setup_ssh_access(task_runner, nodes) ⇒ Object

Setup ssh access between task runner and nodes TODO: Implement on windows

Parameters:

  • Task (Host) —

    runner

  • Array<Host> (Array<Host> Nodes on which to run the task) —

    Nodes on which to run the task



76
77
78
79
80
81
82
83
84
 
# File 'lib/beaker-task_helper.rb', line 76

def setup_ssh_access(task_runner, nodes)
  ssh_dir_path = '/root/.ssh/'
  rsa_pub_path = "#{ssh_dir_path}/id_rsa.pub"

  on task_runner, "ssh-keygen -f #{ssh_dir_path}/id_rsa -t rsa -N ''"
  public_key = on(task_runner, "cat #{rsa_pub_path}").stdout
  create_remote_file(nodes, "#{rsa_pub_path}", public_key)
  on(nodes, "cat #{rsa_pub_path} >> #{ssh_dir_path}/authorized_keys")
end

#task_summary_line(total_hosts: 1, success_hosts: 1) ⇒ Object 



167
168
169
 
# File 'lib/beaker-task_helper.rb', line 167

def task_summary_line(total_hosts: 1, success_hosts: 1)
  "Job completed. #{success_hosts}/#{total_hosts} nodes succeeded|Ran on #{total_hosts} node"
end