Module: Beaker::DSL::InstallUtils

Included in:
Beaker::DSL
Defined in:
lib/beaker/dsl/install_utils.rb

Overview

This module contains methods to help cloning, extracting git info, ordering of Puppet packages, and installing ruby projects that contain an ‘install.rb` script.

To mix this is into a class you need the following:

  • a method hosts that yields any hosts implementing Host‘s interface to act upon.

  • a method options that provides an options hash, see Options::OptionsHash

  • the module Roles that provides access to the various hosts implementing Host‘s interface to act upon

  • the module Wrappers the provides convenience methods for Command creation

Constant Summary collapse

SourcePath =

The default install path

"/opt/puppet-git-repos"
GitURI =

A regex to know if the uri passed is pointing to a git repo

%r{^(git|https?|file)://|^git@|^gitmirror@}
GitHubSig =

Github’s ssh signature for cloning via ssh

'github.com,207.97.227.239 ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAq2A7hRGmdnm9tUDbO9IDSwBK6TbQa+PXYPCPy6rbTrTtw7PHkccKrpp0yVhp5HdEIcKr6pLlVDBfOLX9QUsyCOV0wzfjIJNlGEYsdlLJizHhbn2mUjvSAHQqZETYP81eFzLQNnPHt4EVVUh7VfDESU84KezmD5QlWpXLmvU31/yMf+Se8xhHTvKSCZIFImWwoG6mbUoWf9nzpIoaSjB+weqqUUmpaaasXVal72J+UX2B+2RPW3RcT0eOzQgqlJL3RKrTJvdsjE3JEAvGq3lGHSZXy28G3skua2SmVi/w4yCE6gbODqnTWlg7+wC604ydGXA8VJiS5ap43JXiUFFAaQ=='
PUPPET_MODULE_INSTALL_IGNORE =

The directories in the module directory that will not be scp-ed to the test system when using ‘copy_module_to`

['.bundle', '.git', '.idea', '.vagrant', '.vendor', 'acceptance', 'spec', 'tests', 'log']

Instance Method Summary collapse

Instance Method Details

#build_ignore_list(opts = {}) ⇒ Object

Build an array list of files/directories to ignore when pushing to remote host Automatically adds ‘..’ and ‘.’ to array. If not opts of :ignore list is provided it will use the static variable PUPPET_MODULE_INSTALL_IGNORE

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :ignore_list (Array) —

    A list of files/directories to ignore



1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/beaker/dsl/install_utils.rb', line 1286

def build_ignore_list(opts = {})
  ignore_list = opts[:ignore_list] || PUPPET_MODULE_INSTALL_IGNORE
  if !ignore_list.kind_of?(Array) || ignore_list.nil?
    raise ArgumentError "Ignore list must be an Array"
  end
  ignore_list << '.' unless ignore_list.include? '.'
  ignore_list << '..' unless ignore_list.include? '..'
  ignore_list
end

#check_for_package(host, package_name) ⇒ Boolean

Check to see if a package is installed on a remote host

Parameters:

  • host (Host) —

    A host object

  • package_name (String) —

    Name of the package to check for.

Returns:

  • (Boolean) —

    true/false if the package is found



1195
1196
1197
 
# File 'lib/beaker/dsl/install_utils.rb', line 1195

def check_for_package host, package_name
  host.check_for_package package_name
end

#copy_module_to(host, opts = {}) ⇒ Object Also known as: copy_root_module_to

Install local module for acceptance testing should be used as a presuite to ensure local module is copied to the hosts you want, particularly masters

Parameters:

  • host (Host, Array<Host>, String, Symbol) —

    One or more hosts to act upon, or a role (String or Symbol) that identifies one or more hosts.

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

    a customizable set of options

Options Hash (opts):

  • :source (String) — default: './' —

    The current directory where the module sits, otherwise will try

    and walk the tree to figure out
  • :module_name (String) — default: nil —

    Name which the module should be installed under, please do not include author,

    if none is provided it will attempt to parse the metadata.json and then the Modulefile to determine
the name of the module
  • :target_module_path (String) — default: host['distmoduledir']/modules —

    Location where the module should be installed, will default

    to host['distmoduledir']/modules
  • :ignore_list (Array)

Raises:

  • (ArgumentError) —

    if not host is provided or module_name is not provided and can not be found in Modulefile



1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'lib/beaker/dsl/install_utils.rb', line 1163

def copy_module_to(host, opts = {})
  opts = {:source => './',
          :target_module_path => host['distmoduledir'],
          :ignore_list => PUPPET_MODULE_INSTALL_IGNORE}.merge(opts)
  ignore_list = build_ignore_list(opts)
  target_module_dir = on( host, "echo #{opts[:target_module_path]}" ).stdout.chomp
  source = File.expand_path( opts[:source] )
  if opts.has_key?(:module_name)
    module_name = opts[:module_name]
  else
    _, module_name = parse_for_modulename( source )
  end
  scp_to host, source, File.join(target_module_dir, module_name), {:ignore => ignore_list}
end

#deploy_frictionless_to_master(host) ⇒ Object

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.

Classify the master so that it can deploy frictionless packages for a given host.

Parameters:

  • host (Host) —

    The host to install pacakges for



402
403
404
405
406
407
408
409
 
# File 'lib/beaker/dsl/install_utils.rb', line 402

def deploy_frictionless_to_master(host)
  klass = host['platform'].gsub(/-/, '_').gsub(/\./,'')
  klass = "pe_repo::platform::#{klass}"
  on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake nodeclass:add[#{klass},skip]"
  on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake node:add[#{master}]"
  on dashboard, "cd /opt/puppet/share/puppet-dashboard && /opt/puppet/bin/bundle exec /opt/puppet/bin/rake node:addclass[#{master},#{klass}]"
  on master, "puppet agent -t", :acceptable_exit_codes => [0,2]
end

#do_higgs_install(host, opts) ⇒ Object

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.

Perform a Puppet Enterprise Higgs install up until web browser interaction is required, runs on linux hosts only.

Examples:

do_higgs_install(master, {:pe_dir => path, :pe_ver => version})

Parameters:

  • host (Host) —

    The host to install higgs on

  • opts (Hash{Symbol=>Symbol, String}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)

  • :pe_ver (String) —

    Default PE version to install (Otherwise uses individual hosts pe_ver)

Raises:

  • (StandardError) —

    When installation times out



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/beaker/dsl/install_utils.rb', line 543

def do_higgs_install host, opts
  use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true'
  platform = use_all_tar ? 'all' : host['platform']
  version = host['pe_ver'] || opts[:pe_ver]
  host['dist'] = "puppet-enterprise-#{version}-#{platform}"

  use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true'
  host['pe_installer'] ||= 'puppet-enterprise-installer'
  host['working_dir'] = host.tmpdir(Time.new.strftime("%Y-%m-%d_%H.%M.%S"))

  fetch_puppet([host], opts)

  host['higgs_file'] = "higgs_#{File.basename(host['working_dir'])}.log"
  on host, higgs_installer_cmd(host), opts

  #wait for output to host['higgs_file']
  #we're all done when we find this line in the PE installation log
  higgs_re = /Please\s+go\s+to\s+https:\/\/.*\s+in\s+your\s+browser\s+to\s+continue\s+installation/m
  res = Result.new(host, 'tmp cmd')
  tries = 10
  attempts = 0
  prev_sleep = 0
  cur_sleep = 1
  while (res.stdout !~ higgs_re) and (attempts < tries)
    res = on host, "cd #{host['working_dir']}/#{host['dist']} && cat #{host['higgs_file']}", :acceptable_exit_codes => (0..255)
    attempts += 1
    sleep( cur_sleep )
    prev_sleep = cur_sleep
    cur_sleep = cur_sleep + prev_sleep
  end

  if attempts >= tries
    raise "Failed to kick off PE (Higgs) web installation"
  end

end

#do_install(hosts, opts = {}) ⇒ Object

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.

Perform a Puppet Enterprise upgrade or install

Examples:

do_install(hosts, {:type => :upgrade, :pe_dir => path, :pe_ver => version, :pe_ver_win =>  version_win})

Parameters:

  • hosts (Array<Host>) —

    The hosts to install or upgrade PE on

  • opts (Hash{Symbol=>Symbol, String}) (defaults to: {}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)

  • :pe_ver (String) —

    Default PE version to install or upgrade to (Otherwise uses individual hosts pe_ver)

  • :pe_ver_win (String) —

    Default PE version to install or upgrade to on Windows hosts (Otherwise uses individual Windows hosts pe_ver)

  • :type (Symbol) — default: :install —

    One of :upgrade or :install

  • :answers (Hash<String>) —

    Pre-set answers based upon ENV vars and defaults (See Options::Presets.env_vars)



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/beaker/dsl/install_utils.rb', line 429

def do_install hosts, opts = {}
  opts[:type] = opts[:type] || :install
  pre30database = version_is_less(opts[:pe_ver] || database['pe_ver'], '3.0')
  pre30master = version_is_less(opts[:pe_ver] || master['pe_ver'], '3.0')

  # Set PE distribution for all the hosts, create working dir
  use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true'
  hosts.each do |host|
    host['pe_installer'] ||= 'puppet-enterprise-installer'
    if host['platform'] !~ /windows|osx/
      platform = use_all_tar ? 'all' : host['platform']
      version = host['pe_ver'] || opts[:pe_ver]
      host['dist'] = "puppet-enterprise-#{version}-#{platform}"
    elsif host['platform'] =~ /osx/
      version = host['pe_ver'] || opts[:pe_ver]
      host['dist'] = "puppet-enterprise-#{version}-#{host['platform']}"
    elsif host['platform'] =~ /windows/
      version = host[:pe_ver] || opts['pe_ver_win']
      #only install 64bit builds if
      # - we are on pe version 3.4+
      # - we do not have install_32 set on host
      # - we do not have install_32 set globally
      if !(version_is_less(version, '3.4')) and host.is_x86_64? and not host['install_32'] and not opts['install_32']
        host['dist'] = "puppet-enterprise-#{version}-x64"
      else
        host['dist'] = "puppet-enterprise-#{version}"
      end
    end
    host['working_dir'] = host.tmpdir(Time.new.strftime("%Y-%m-%d_%H.%M.%S"))
  end

  fetch_puppet(hosts, opts)

  # If we're installing a database version less than 3.0, ignore the database host
  install_hosts = hosts.dup
  install_hosts.delete(database) if pre30database and database != master and database != dashboard

  install_hosts.each do |host|
    if host['platform'] =~ /windows/
      on host, installer_cmd(host, opts)
    elsif host['platform'] =~ /osx/
      on host, installer_cmd(host, opts)
      #set the certname and master
      on host, puppet("config set server #{master}")
      on host, puppet("config set certname #{host}")
      #run once to request cert
      on host, puppet_agent('-t'), :acceptable_exit_codes => [1]
    else
      # We only need answers if we're using the classic installer
      version = host['pe_ver'] || opts[:pe_ver]
      if (! host['roles'].include? 'frictionless') || version_is_less(version, '3.2.0')
        answers = Beaker::Answers.create(opts[:pe_ver] || host['pe_ver'], hosts, opts)
        create_remote_file host, "#{host['working_dir']}/answers", answers.answer_string(host)
      else
        # If We're *not* running the classic installer, we want
        # to make sure the master has packages for us.
        deploy_frictionless_to_master(host)
      end

      on host, installer_cmd(host, opts)
    end

    # On each agent, we ensure the certificate is signed then shut down the agent
    sign_certificate_for(host)
    stop_agent_on(host)
  end

  # Wait for PuppetDB to be totally up and running (post 3.0 version of pe only)
  sleep_until_puppetdb_started(database) unless pre30database

  # Run the agent once to ensure everything is in the dashboard
  install_hosts.each do |host|
    on host, puppet_agent('-t'), :acceptable_exit_codes => [0,2]

    # Workaround for PE-1105 when deploying 3.0.0
    # The installer did not respect our database host answers in 3.0.0,
    # and would cause puppetdb to be bounced by the agent run. By sleeping
    # again here, we ensure that if that bounce happens during an upgrade
    # test we won't fail early in the install process.
    if host['pe_ver'] == '3.0.0' and host == database
      sleep_until_puppetdb_started(database)
    end
  end

  install_hosts.each do |host|
    wait_for_host_in_dashboard(host)
  end

  if pre30master
    task = 'nodegroup:add_all_nodes group=default'
  else
    task = 'defaultgroup:ensure_default_group'
  end
  on dashboard, "/opt/puppet/bin/rake -sf /opt/puppet/share/puppet-dashboard/Rakefile #{task} RAILS_ENV=production"

  # Now that all hosts are in the dashbaord, run puppet one more
  # time to configure mcollective
  on install_hosts, puppet_agent('-t'), :acceptable_exit_codes => [0,2]
end

#extract_repo_info_from(uri) ⇒ Hash{Symbol=>String}

Returns a hash containing the project name, repository path, and revision (defaults to HEAD)

Examples:

Usage

project = extract_repo_info_from '[email protected]:puppetlabs/SuperSecretSauce#what_is_justin_doing'

puts project[:name]
#=> 'SuperSecretSauce'

puts project[:rev]
#=> 'what_is_justin_doing'

Parameters:

  • uri (String) —

    A uri in the format of <git uri>#<revision> the ‘git://`, `http://`, `https://`, and ssh (if cloning as the remote git user) protocols are valid for <git uri>

Returns:

  • (Hash{Symbol=>String}) —

    Returns a hash containing the project name, repository path, and revision (defaults to HEAD)



50
51
52
53
54
55
56
57
 
# File 'lib/beaker/dsl/install_utils.rb', line 50

def extract_repo_info_from uri
  project = {}
  repo, rev = uri.split('#', 2)
  project[:name] = Pathname.new(repo).basename('.git').to_s
  project[:path] = repo
  project[:rev]  = rev || 'HEAD'
  return project
end

#fetch_puppet(hosts, opts) ⇒ Object

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.

Determine the PE package to download/upload per-host, download/upload that package onto the host and unpack it.

Parameters:

  • hosts (Array<Host>) —

    The hosts to download/upload and unpack PE onto

  • opts (Hash{Symbol=>Symbol, String}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)

  • :pe_ver (String) —

    Default PE version to install or upgrade to (Otherwise uses individual hosts pe_ver)

  • :pe_ver_win (String) —

    Default PE version to install or upgrade to on Windows hosts (Otherwise uses individual Windows hosts pe_ver)



384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/beaker/dsl/install_utils.rb', line 384

def fetch_puppet(hosts, opts)
  hosts.each do |host|
    # We install Puppet from the master for frictionless installs, so we don't need to *fetch* anything
    next if host['roles'].include? 'frictionless' and ! version_is_less(opts[:pe_ver] || host['pe_ver'], '3.2.0')

    if host['platform'] =~ /windows/
      fetch_puppet_on_windows(host, opts)
    elsif host['platform'] =~ /osx/
      fetch_puppet_on_mac(host, opts)
    else
      fetch_puppet_on_unix(host, opts)
    end
  end
end

#fetch_puppet_on_mac(host, opts) ⇒ Object

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.

Determine the PE package to download/upload on a mac host, download/upload that package onto the host. Assumed file name format: puppet-enterprise-3.3.0-rc1-559-g97f0833-osx-10.9-x86_64.dmg.

Parameters:

  • host (Host) —

    The mac host to download/upload and unpack PE onto

  • opts (Hash{Symbol=>Symbol, String}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/beaker/dsl/install_utils.rb', line 292

def fetch_puppet_on_mac(host, opts)
  path = host['pe_dir'] || opts[:pe_dir]
  local = File.directory?(path)
  filename = "#{host['dist']}"
  extension = ".dmg"
  if local
    if not File.exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}"
  else
    if not link_exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    on host, "cd #{host['working_dir']}; curl -O #{path}/#{filename}#{extension}"
  end
end

#fetch_puppet_on_unix(host, opts) ⇒ Object

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.

Determine the PE package to download/upload on a unix style host, download/upload that package onto the host and unpack it.

Parameters:

  • host (Host) —

    The unix style host to download/upload and unpack PE onto

  • opts (Hash{Symbol=>Symbol, String}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/beaker/dsl/install_utils.rb', line 345

def fetch_puppet_on_unix(host, opts)
  path = host['pe_dir'] || opts[:pe_dir]
  local = File.directory?(path)
  filename = "#{host['dist']}"
  if local
    extension = File.exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
    if not File.exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}"
    if extension =~ /gz/
      on host, "cd #{host['working_dir']}; gunzip #{filename}#{extension}"
    end
    if extension =~ /tar/
      on host, "cd #{host['working_dir']}; tar -xvf #{filename}.tar"
    end
  else
    extension = link_exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
    if not link_exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    unpack = 'tar -xvf -'
    unpack = extension =~ /gz/ ? 'gunzip | ' + unpack  : unpack

    on host, "cd #{host['working_dir']}; curl #{path}/#{filename}#{extension} | #{unpack}"
  end
end

#fetch_puppet_on_windows(host, opts) ⇒ Object

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.

Determine the PE package to download/upload on a windows host, download/upload that package onto the host. Assumed file name format: puppet-enterprise-3.3.0-rc1-559-g97f0833.msi

Parameters:

  • host (Host) —

    The windows host to download/upload and unpack PE onto

  • opts (Hash{Symbol=>Symbol, String}) —

    The options

Options Hash (opts):

  • :pe_dir (String) —

    Default directory or URL to pull PE package from (Otherwise uses individual hosts pe_dir)

  • :pe_ver_win (String) —

    Default PE version to install or upgrade to (Otherwise uses individual hosts pe_ver)



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/beaker/dsl/install_utils.rb', line 319

def fetch_puppet_on_windows(host, opts)
  path = host['pe_dir'] || opts[:pe_dir]
  local = File.directory?(path)
  version = host['pe_ver'] || opts[:pe_ver_win]
  filename = "#{host['dist']}"
  extension = ".msi"
  if local
    if not File.exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}"
  else
    if not link_exists?("#{path}/#{filename}#{extension}")
      raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist"
    end
    on host, "cd #{host['working_dir']}; curl -O #{path}/#{filename}#{extension}"
  end
end

#find_git_repo_versions(host, path, repository) ⇒ Hash

Note:

This requires the helper methods:

Returns Executes git describe on [host] and returns a Hash with the key of [repository] and value of the output from git describe.

Examples:

Getting multiple project versions

versions = [puppet_repo, facter_repo, hiera_repo].inject({}) do |vers, repo_info|
  vers.merge(find_git_repo_versions(host, '/opt/git-puppet-repos', repo_info) )
end

Parameters:

  • host (Host) —

    An object implementing Hosts‘s interface.

  • path (String) —

    The path on the remote [host] to the repository

  • repository (Hash{Symbol=>String}) —

    A hash representing repo info like that emitted by #extract_repo_info_from

Returns:

  • (Hash) —

    Executes git describe on [host] and returns a Hash with the key of [repository] and value of the output from git describe.



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/beaker/dsl/install_utils.rb', line 93

def find_git_repo_versions host, path, repository
  version = {}
  step "Grab version for #{repository[:name]}" do
    on host, "cd #{path}/#{repository[:name]} && " +
              "git describe || true" do
      version[repository[:name]] = stdout.chomp
    end
  end
  version
end

#get_module_name(author_module_name) ⇒ String?

Parse modulename from the pattern ‘Auther-ModuleName’

Parameters:

  • author_module_name (String) —

    <Author>-<ModuleName> pattern

Returns:

  • (String, nil) 


1259
1260
1261
1262
1263
1264
 
# File 'lib/beaker/dsl/install_utils.rb', line 1259

def get_module_name(author_module_name)
  split_name = split_author_modulename(author_module_name)
  if split_name
    return split_name[:author], split_name[:module]
  end
end

#higgs_installer_cmd(host) ⇒ Object

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.

Create the Higgs install command string based upon the host and options settings. Installation command will be run as a background process. The output of the command will be stored in the provided host.

Parameters:

  • host (Host) —

    The host that Higgs is to be installed on The host object must have the ‘working_dir’, ‘dist’ and ‘pe_installer’ field set correctly.



193
194
195
196
197
 
# File 'lib/beaker/dsl/install_utils.rb', line 193

def higgs_installer_cmd host

  "cd #{host['working_dir']}/#{host['dist']} ; nohup ./#{host['pe_installer']} <<<Y > #{host['higgs_file']} 2>&1 &"

end

#install_dev_puppet_module(opts) ⇒ Object Also known as: puppet_module_install

Install the desired module on all hosts using either the PMT or a

staging forge

Passes options through to either ‘install_puppet_module_via_pmt_on`

or `copy_module_to`

Examples:

Installing a module from the local directory

install_dev_puppet_module( :source => './', :module_name => 'concat' )

Installing a module from a staging forge

options[:forge_host] = 'my-forge-api.example.com'
install_dev_puppet_module( :source => './', :module_name => 'concat' )

Parameters:

  • opts (Hash)

See Also:



1114
1115
1116
 
# File 'lib/beaker/dsl/install_utils.rb', line 1114

def install_dev_puppet_module( opts )
  block_on( hosts ) {|h| install_dev_puppet_module_on( h, opts ) }
end

#install_dev_puppet_module_on(host, opts) ⇒ Object Also known as: puppet_module_install_on

Install the desired module on all hosts using either the PMT or a

staging forge

See Also:



1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/beaker/dsl/install_utils.rb', line 1086

def install_dev_puppet_module_on( host, opts )
  if options[:forge_host]
    with_forge_stubbed_on( host ) do
      install_puppet_module_via_pmt_on( host, opts )
    end
  else
    copy_module_to( host, opts )
  end
end

#install_from_git(host, path, repository) ⇒ Object

See Also:



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
145
146
147
148
149
150
151
152
 
# File 'lib/beaker/dsl/install_utils.rb', line 106

def install_from_git host, path, repository
  name          = repository[:name]
  repo          = repository[:path]
  rev           = repository[:rev]
  depth         = repository[:depth]
  depth_branch  = repository[:depth_branch]
  target        = "#{path}/#{name}"

  if (depth_branch.nil?)
    depth_branch = rev
  end

  clone_cmd = "git clone #{repo} #{target}"
  if (depth)
    clone_cmd = "git clone --branch #{depth_branch} --depth #{depth} #{repo} #{target}"
  end

  step "Clone #{repo} if needed" do
    on host, "test -d #{path} || mkdir -p #{path}"
    on host, "test -d #{target} || #{clone_cmd}"
  end

  step "Update #{name} and check out revision #{rev}" do
    commands = ["cd #{target}",
                "remote rm origin",
                "remote add origin #{repo}",
                "fetch origin",
                "clean -fdx",
                "checkout -f #{rev}"]
    on host, commands.join(" && git ")
  end

  step "Install #{name} on the system" do
    # The solaris ruby IPS package has bindir set to /usr/ruby/1.8/bin.
    # However, this is not the path to which we want to deliver our
    # binaries. So if we are using solaris, we have to pass the bin and
    # sbin directories to the install.rb
    install_opts = ''
    install_opts = '--bindir=/usr/bin --sbindir=/usr/sbin' if
      host['platform'].include? 'solaris'

      on host,  "cd #{target} && " +
                "if [ -f install.rb ]; then " +
                "ruby ./install.rb #{install_opts}; " +
                "else true; fi"
  end
end

#install_higgs(higgs_host = master) ⇒ Object

Note:

Either pe_ver and pe_dir should be set in the ENV or each host should have pe_ver and pe_dir set individually. Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz).

Install Higgs up till the point where you need to continue installation in a web browser, defaults to execution on the master node.

Examples:

install_higgs

Parameters:

  • higgs_host (Host) (defaults to: master) —

    The host to install Higgs on (supported on linux platform only)



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
 
# File 'lib/beaker/dsl/install_utils.rb', line 1070

def install_higgs( higgs_host = master )
  #process the version files if necessary
  master['pe_dir'] ||= options[:pe_dir]
  master['pe_ver'] = master['pe_ver'] || options['pe_ver'] ||
    Beaker::Options::PEVersionScraper.load_pe_version(master[:pe_dir] || options[:pe_dir], options[:pe_version_file])
  if higgs_host['platform'] =~ /osx|windows/
    raise "Attempting higgs installation on host #{higgs_host.name} with unsupported platform #{higgs_host['platform']}"
  end
  #send in the global options hash
  do_higgs_install higgs_host, options
end

#install_package(host, package_name, package_version = nil) ⇒ Result

Install a package on a host

Parameters:

  • host (Host) —

    A host object

  • package_name (String) —

    Name of the package to install

Returns:

  • (Result) —

    An object representing the outcome of *install command*.



1185
1186
1187
 
# File 'lib/beaker/dsl/install_utils.rb', line 1185

def install_package host, package_name, package_version = nil
  host.install_package package_name, '', package_version
end

#install_pe ⇒ Object

Note:

Either pe_ver and pe_dir should be set in the ENV or each host should have pe_ver and pe_dir set individually. Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz) for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.

Install PE based upon host configuration and options

Examples:

install_pe


870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/beaker/dsl/install_utils.rb', line 870

def install_pe
  #process the version files if necessary
  hosts.each do |host|
    host['pe_dir'] ||= options[:pe_dir]
    if host['platform'] =~ /windows/
      host['pe_ver'] = host['pe_ver'] || options['pe_ver'] ||
        Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || options[:pe_dir], options[:pe_version_file_win])
    else
      host['pe_ver'] = host['pe_ver'] || options['pe_ver'] ||
        Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || options[:pe_dir], options[:pe_version_file])
    end
  end
  #send in the global options hash
  do_install sorted_hosts, options
end

#install_puppet(opts = {}) ⇒ Object

Note:

This will attempt to add a repository for apt.puppetlabs.com on Debian or Ubuntu machines, or yum.puppetlabs.com on EL or Fedora machines, then install the package ‘puppet’.

Install FOSS based upon host configuration and options

Examples:

will install puppet 3.6.1 from native puppetlabs provided packages wherever possible and will fail over to gem installation when impossible

install_puppet({
  :version        => '3.6.1',
  :facter_version => '2.0.1',
  :hiera_version  => '1.3.3',
  :default_action => 'gem_install'

Will install latest packages on Enterprise Linux and Debian based distros and fail hard on all othere platforms.

install_puppet()

Returns:

  • nil

Raises:

  • (StandardError) —

    When encountering an unsupported platform by default, or if gem cannot be found when default_action => ‘gem_install’

  • (FailTest) —

    When error occurs during the actual installation process



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/beaker/dsl/install_utils.rb', line 616

def install_puppet(opts = {})
  hosts.each do |host|
    if host['platform'] =~ /el-(5|6|7)/
      relver = $1
      install_puppet_from_rpm host, opts.merge(:release => relver, :family => 'el')
    elsif host['platform'] =~ /fedora-(\d+)/
      relver = $1
      install_puppet_from_rpm host, opts.merge(:release => relver, :family => 'fedora')
    elsif host['platform'] =~ /(ubuntu|debian)/
      install_puppet_from_deb host, opts
    elsif host['platform'] =~ /windows/
      relver = opts[:version]
      install_puppet_from_msi host, opts
    elsif host['platform'] =~ /osx/
      install_puppet_from_dmg host, opts
    else
      if opts[:default_action] == 'gem_install'
        install_puppet_from_gem host, opts
      else
        raise "install_puppet() called for unsupported platform '#{host['platform']}' on '#{host.name}'"
      end
    end

    # Certain install paths may not create the config dirs/files needed
    on host, "mkdir -p #{host['puppetpath']}"
    on host, "echo '' >> #{host['hieraconf']}"
  end
  nil
end

#install_puppet_from_deb(host, opts) ⇒ Object

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.

Installs Puppet and dependencies from deb

Parameters:

  • host (Host) —

    The host to install packages on

  • opts (Hash{Symbol=>String}) —

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of Puppet to install, if nil installs latest version

  • :facter_version (String) —

    The version of Facter to install, if nil installs latest version

  • :hiera_version (String) —

    The version of Hiera to install, if nil installs latest version

Returns:

  • nil



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/beaker/dsl/install_utils.rb', line 689

def install_puppet_from_deb( host, opts )
  if ! host.check_for_package 'lsb-release'
    host.install_package('lsb-release')
  end

  if ! host.check_for_command 'curl'
    on host, 'apt-get install -y curl'
  end

  on host, 'curl -O http://apt.puppetlabs.com/puppetlabs-release-$(lsb_release -c -s).deb'
  on host, 'dpkg -i puppetlabs-release-$(lsb_release -c -s).deb'
  on host, 'apt-get update'

  if opts[:facter_version]
    on host, "apt-get install -y facter=#{opts[:facter_version]}-1puppetlabs1"
  end

  if opts[:hiera_version]
    on host, "apt-get install -y hiera=#{opts[:hiera_version]}-1puppetlabs1"
  end

  if opts[:version]
    on host, "apt-get install -y puppet-common=#{opts[:version]}-1puppetlabs1"
    on host, "apt-get install -y puppet=#{opts[:version]}-1puppetlabs1"
  else
    on host, 'apt-get install -y puppet'
  end
end

#install_puppet_from_dmg(host, opts) ⇒ Object

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.

Installs Puppet and dependencies from dmg

Parameters:

  • host (Host) —

    The host to install packages on

  • opts (Hash{Symbol=>String}) —

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of Puppet to install, required

  • :facter_version (String) —

    The version of Facter to install, required

  • :hiera_version (String) —

    The version of Hiera to install, required

Returns:

  • nil



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/beaker/dsl/install_utils.rb', line 761

def install_puppet_from_dmg( host, opts )
  puppet_ver = opts[:version]
  facter_ver = opts[:facter_version]
  hiera_ver = opts[:hiera_version]

  on host, "curl -O http://downloads.puppetlabs.com/mac/puppet-#{puppet_ver}.dmg"
  on host, "curl -O http://downloads.puppetlabs.com/mac/facter-#{facter_ver}.dmg"
  on host, "curl -O http://downloads.puppetlabs.com/mac/hiera-#{hiera_ver}.dmg"

  on host, "hdiutil attach puppet-#{puppet_ver}.dmg"
  on host, "hdiutil attach facter-#{facter_ver}.dmg"
  on host, "hdiutil attach hiera-#{hiera_ver}.dmg"

  on host, "installer -pkg /Volumes/puppet-#{puppet_ver}/puppet-#{puppet_ver}.pkg -target /"
  on host, "installer -pkg /Volumes/facter-#{facter_ver}/facter-#{facter_ver}.pkg -target /"
  on host, "installer -pkg /Volumes/hiera-#{hiera_ver}/hiera-#{hiera_ver}.pkg -target /"
end

#install_puppet_from_gem(host, opts) ⇒ Object

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.

Installs Puppet and dependencies from gem

Parameters:

  • host (Host) —

    The host to install packages on

  • opts (Hash{Symbol=>String}) —

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of Puppet to install, if nil installs latest

  • :facter_version (String) —

    The version of Facter to install, if nil installs latest

  • :hiera_version (String) —

    The version of Hiera to install, if nil installs latest

Returns:

  • nil

Raises:

  • (StandardError) —

    if gem does not exist on target host



790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/beaker/dsl/install_utils.rb', line 790

def install_puppet_from_gem( host, opts )
  # There are a lot of special things to do for Solaris and Solaris 10.
  # This is easier than checking host['platform'] every time.
  is_solaris10 = host['platform'] =~ /solaris-10/
  is_solaris = host['platform'] =~ /solaris/

  # Hosts may be provisioned with csw but pkgutil won't be in the
  # PATH by default to avoid changing the behavior for Puppet's tests
  if is_solaris10
    on host, 'ln -s /opt/csw/bin/pkgutil /usr/bin/pkgutil'
  end

  # Solaris doesn't necessarily have this, but gem needs it
  if is_solaris
    on host, 'mkdir -p /var/lib'
  end

  unless host.check_for_command( 'gem' )
    gempkg = case host['platform']
             when /solaris-11/                   then 'ruby-18'
             when /ubuntu-14/                    then 'ruby'
             when /solaris-10|ubuntu|debian|el-/ then 'rubygems'
             else
               raise "install_puppet() called with default_action " +
                     "'gem_install' but program `gem' is " +
                     "not installed on #{host.name}"
             end

    host.install_package gempkg
  end

  # Link 'gem' to /usr/bin instead of adding /opt/csw/bin to PATH.
  if is_solaris10
    on host, 'ln -s /opt/csw/bin/gem /usr/bin/gem'
  end

  if host['platform'] =~ /debian|ubuntu|solaris/
    gem_env = YAML.load( on( host, 'gem environment' ).stdout )
    gem_paths_array = gem_env['RubyGems Environment'].find {|h| h['GEM PATHS'] != nil }['GEM PATHS']
    path_with_gem = 'export PATH=' + gem_paths_array.join(':') + ':${PATH}'
    on host, "echo '#{path_with_gem}' >> ~/.bashrc"
  end

  if opts[:facter_version]
    on host, "gem install facter -v#{opts[:facter_version]} --no-ri --no-rdoc"
  end

  if opts[:hiera_version]
    on host, "gem install hiera -v#{opts[:hiera_version]} --no-ri --no-rdoc"
  end

  ver_cmd = opts[:version] ? "-v#{opts[:version]}" : ''
  on host, "gem install puppet #{ver_cmd} --no-ri --no-rdoc"

  # Similar to the treatment of 'gem' above.
  # This avoids adding /opt/csw/bin to PATH.
  if is_solaris
    gem_env = YAML.load( on( host, 'gem environment' ).stdout )
    # This is the section we want - this has the dir where gem executables go.
    env_sect = 'EXECUTABLE DIRECTORY'
    # Get the directory where 'gem' installs executables.
    # On Solaris 10 this is usually /opt/csw/bin
    gem_exec_dir = gem_env['RubyGems Environment'].find {|h| h[env_sect] != nil }[env_sect]

    on host, "ln -s #{gem_exec_dir}/hiera /usr/bin/hiera"
    on host, "ln -s #{gem_exec_dir}/facter /usr/bin/facter"
    on host, "ln -s #{gem_exec_dir}/puppet /usr/bin/puppet"
  end
end

#install_puppet_from_msi(host, opts) ⇒ Object

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.

Installs Puppet and dependencies from msi

Parameters:

  • host (Host) —

    The host to install packages on

  • opts (Hash{Symbol=>String}) —

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of Puppet to install, required

Returns:

  • nil



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/beaker/dsl/install_utils.rb', line 726

def install_puppet_from_msi( host, opts )
  #only install 64bit builds if
  # - we are on puppet version 3.7+
  # - we do not have install_32 set on host
  # - we do not have install_32 set globally
  version = opts[:version]
  if !(version_is_less(version, '3.7')) and host.is_x86_64? and not host['install_32'] and not opts['install_32']
    host['dist'] = "puppet-#{version}-x64"
  else
    host['dist'] = "puppet-#{version}"
  end
  link = "http://downloads.puppetlabs.com/windows/#{host['dist']}.msi"
  if not link_exists?( link )
    raise "Puppet #{version} at #{link} does not exist!"
  end
  on host, "curl -O #{link}"
  on host, "msiexec /qn /i #{host['dist']}.msi"

  #Because the msi installer doesn't add Puppet to the environment path
  #Add both potential paths for simplicity
  #NOTE - this is unnecessary if the host has been correctly identified as 'foss' during set up
  puppetbin_path = "\"/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin\":\"/cygdrive/c/Program Files/Puppet Labs/Puppet/bin\""
  on host, %Q{ echo 'export PATH=$PATH:#{puppetbin_path}' > /etc/bash.bashrc }
end

#install_puppet_from_rpm(host, opts) ⇒ Object

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.

Installs Puppet and dependencies using rpm

Parameters:

  • host (Host) —

    The host to install packages on

  • opts (Hash{Symbol=>String}) —

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of Puppet to install, if nil installs latest version

  • :facter_version (String) —

    The version of Facter to install, if nil installs latest version

  • :hiera_version (String) —

    The version of Hiera to install, if nil installs latest version

  • :default_action (String) —

    What to do if we don’t know how to install native packages on host. Valid value is ‘gem_install’ or nil. If nil raises an exception when on an unsupported platform. When ‘gem_install’ attempts to install Puppet via gem.

  • :release (String) —

    The major release of the OS

  • :family (String) —

    The OS family (one of ‘el’ or ‘fedora’)

Returns:

  • nil



662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/beaker/dsl/install_utils.rb', line 662

def install_puppet_from_rpm( host, opts )
  release_package_string = "http://yum.puppetlabs.com/puppetlabs-release-#{opts[:family]}-#{opts[:release]}.noarch.rpm"

  on host, "rpm -ivh #{release_package_string}"

  if opts[:facter_version]
    on host, "yum install -y facter-#{opts[:facter_version]}"
  end

  if opts[:hiera_version]
    on host, "yum install -y hiera-#{opts[:hiera_version]}"
  end

  puppet_pkg = opts[:version] ? "puppet-#{opts[:version]}" : 'puppet'
  on host, "yum install -y #{puppet_pkg}"
end

#install_puppet_module_via_pmt(opts = {}) ⇒ Object

Install the desired module with the PMT on all known hosts

See Also:



1140
1141
1142
 
# File 'lib/beaker/dsl/install_utils.rb', line 1140

def install_puppet_module_via_pmt( opts = {} )
  install_puppet_module_via_pmt_on(hosts, opts)
end

#install_puppet_module_via_pmt_on(host, opts = {}) ⇒ Object

Install the desired module with the PMT on a given host

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :module_name (String) —

    The short name of the module to be installed

  • :version (String) —

    The version of the module to be installed



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'lib/beaker/dsl/install_utils.rb', line 1124

def install_puppet_module_via_pmt_on( host, opts = {} )
  block_on host do |h|
    version_info = opts[:version] ? "-v #{opts[:version]}" : ""
    if opts[:source]
      author_name, module_name = parse_for_modulename( opts[:source] )
      modname = "#{author_name}-#{module_name}"
    else
      modname = opts[:module_name]
    end

    on h, puppet("module install #{modname} #{version_info}")
  end
end

#install_puppetlabs_dev_repo(host, package_name, build_version, repo_configs_dir = 'tmp/repo_configs') ⇒ Object

Note:

This method only works on redhat-like and debian-like hosts.

Install development repository on the given host. This method pushes all repository information including package files for the specified package_name to the host and modifies the repository configuration file to point at the new repository. This is particularly useful for installing development packages on hosts that can’t access the builds server.

Parameters:

  • host (Host) —

    An object implementing Hosts‘s interface.

  • package_name (String) —

    The name of the package whose repository is being installed.

  • build_version (String) —

    A string identifying the output of a packaging job for use in looking up repository directory information

  • repo_configs_dir (String) (defaults to: 'tmp/repo_configs') —

    A local directory where repository files will be stored as an intermediate step before pushing them to the given host.



966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/beaker/dsl/install_utils.rb', line 966

def install_puppetlabs_dev_repo ( host, package_name, build_version,
                          repo_configs_dir = 'tmp/repo_configs' )
  variant, version, arch, codename = host['platform'].to_array
  platform_configs_dir = File.join(repo_configs_dir, variant)

  # some of the uses of dev_builds_url below can't include protocol info,
  # pluse this opens up possibility of switching the behavior on provided
  # url type
  _, protocol, hostname = options[:dev_builds_url].partition /.*:\/\//
  dev_builds_url = protocol + hostname

  on host, "mkdir -p /root/#{package_name}"

  case variant
  when /^(fedora|el|centos)$/
    variant = (($1 == 'centos') ? 'el' : $1)
    fedora_prefix = ((variant == 'fedora') ? 'f' : '')

    if host.is_pe?
      pattern = "pl-%s-%s-repos-pe-%s-%s%s-%s.repo"
    else
      pattern = "pl-%s-%s-%s-%s%s-%s.repo"
    end

    repo_filename = pattern % [
      package_name,
      build_version,
      variant,
      fedora_prefix,
      version,
      arch
    ]

    repo = fetch_http_file( "%s/%s/%s/repo_configs/rpm/" %
                 [ dev_builds_url, package_name, build_version ],
                  repo_filename,
                  platform_configs_dir)

    link = "%s/%s/%s/repos/%s/%s%s/products/%s/" %
      [ dev_builds_url, package_name, build_version, variant,
        fedora_prefix, version, arch ]

    if not link_exists?( link )
      link = "%s/%s/%s/repos/%s/%s%s/devel/%s/" %
        [ dev_builds_url, package_name, build_version, variant,
          fedora_prefix, version, arch ]
    end

    if not link_exists?( link )
      raise "Unable to reach a repo directory at #{link}"
    end

    repo_dir = fetch_http_dir( link, platform_configs_dir )

    config_dir = '/etc/yum.repos.d/'
    scp_to host, repo, config_dir
    scp_to host, repo_dir, "/root/#{package_name}"

    search = "baseurl\\s*=\\s*http:\\/\\/#{hostname}.*$"
    replace = "baseurl=file:\\/\\/\\/root\\/#{package_name}\\/#{arch}"
    sed_command = "sed -i 's/#{search}/#{replace}/'"
    find_and_sed = "find #{config_dir} -name \"*.repo\" -exec #{sed_command} {} \\;"

    on host, find_and_sed

  when /^(debian|ubuntu)$/
    list = fetch_http_file( "%s/%s/%s/repo_configs/deb/" %
                   [ dev_builds_url, package_name, build_version ],
                  "pl-%s-%s-%s.list" %
                   [ package_name, build_version, codename ],
                  platform_configs_dir )

    repo_dir = fetch_http_dir( "%s/%s/%s/repos/apt/%s" %
                                [ dev_builds_url, package_name,
                                  build_version, codename ],
                                 platform_configs_dir )

    config_dir = '/etc/apt/sources.list.d'
    scp_to host, list, config_dir
    scp_to host, repo_dir, "/root/#{package_name}"

    search = "deb\\s\\+http:\\/\\/#{hostname}.*$"
    replace = "deb file:\\/\\/\\/root\\/#{package_name}\\/#{codename} #{codename} main"
    sed_command = "sed -i 's/#{search}/#{replace}/'"
    find_and_sed = "find #{config_dir} -name \"*.list\" -exec #{sed_command} {} \\;"

    on host, find_and_sed
    on host, "apt-get update"

  else
    raise "No repository installation step for #{variant} yet..."
  end
end

#install_puppetlabs_release_repo(host) ⇒ Object

Note:

This method only works on redhat-like and debian-like hosts.

Install official puppetlabs release repository configuration on host.

Parameters:

  • host (Host) —

    An object implementing Hosts‘s interface.



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
 
# File 'lib/beaker/dsl/install_utils.rb', line 923

def install_puppetlabs_release_repo ( host )
  variant, version, arch, codename = host['platform'].to_array

  case variant
  when /^(fedora|el|centos)$/
    variant = (($1 == 'centos') ? 'el' : $1)

    rpm = options[:release_yum_repo_url] +
      "/puppetlabs-release-%s-%s.noarch.rpm" % [variant, version]

    on host, "rpm -ivh --force #{rpm}"

  when /^(debian|ubuntu)$/
    deb = URI.join(options[:release_apt_repo_url],  "puppetlabs-release-%s.deb" % codename)

    on host, "wget -O /tmp/puppet.deb #{deb}"
    on host, "dpkg -i --force-all /tmp/puppet.deb"
    on host, "apt-get update"
  else
    raise "No repository installation step for #{variant} yet..."
  end
end

#installer_cmd(host, opts) ⇒ Object

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.

Create the PE install command string based upon the host and options settings

Examples:

on host, "#{installer_cmd(host, opts)} -a #{host['working_dir']}/answers"

Parameters:

  • host (Host) —

    The host that PE is to be installed on For UNIX machines using the full PE installer, the host object must have the ‘pe_installer’ field set correctly.

  • opts (Hash{Symbol=>String}) —

    The options

Options Hash (opts):

  • :pe_ver_win (String) —

    Default PE version to install or upgrade to on Windows hosts (Othersie uses individual Windows hosts pe_ver)

  • :pe_ver (String) —

    Default PE version to install or upgrade to (Otherwise uses individual hosts pe_ver)

  • :pe_debug (Boolean) — default: false —

    Should we run the installer in debug mode?



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/beaker/dsl/install_utils.rb', line 166

def installer_cmd(host, opts)
  version = host['pe_ver'] || opts[:pe_ver]
  if host['platform'] =~ /windows/
    log_file = "#{File.basename(host['working_dir'])}.log"
    pe_debug = host[:pe_debug] || opts[:pe_debug] ? " && cat #{log_file}" : ''
    "cd #{host['working_dir']} && cmd /C 'start /w msiexec.exe /qn /L*V #{log_file} /i #{host['dist']}.msi PUPPET_MASTER_SERVER=#{master} PUPPET_AGENT_CERTNAME=#{host}'#{pe_debug}"
  elsif host['platform'] =~ /osx/
    version = host['pe_ver'] || opts[:pe_ver]
    pe_debug = host[:pe_debug] || opts[:pe_debug] ? ' -verboseR' : ''
    "cd #{host['working_dir']} && hdiutil attach #{host['dist']}.dmg && installer#{pe_debug} -pkg /Volumes/puppet-enterprise-#{version}/puppet-enterprise-installer-#{version}.pkg -target /"

  # Frictionless install didn't exist pre-3.2.0, so in that case we fall
  # through and do a regular install.
  elsif host['roles'].include? 'frictionless' and ! version_is_less(version, '3.2.0')
    pe_debug = host[:pe_debug] || opts[:pe_debug] ? ' -x' : ''
    "cd #{host['working_dir']} && curl -kO https://#{master}:8140/packages/#{version}/install.bash && bash#{pe_debug} install.bash"
  else
    pe_debug = host[:pe_debug] || opts[:pe_debug]  ? ' -D' : ''
    "cd #{host['working_dir']}/#{host['dist']} && ./#{host['pe_installer']}#{pe_debug} -a #{host['working_dir']}/answers"
  end
end

#link_exists?(link) ⇒ Boolean

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.

Determine is a given URL is accessible

Examples:

extension = link_exists?("#{URL}.tar.gz") ? ".tar.gz" : ".tar"

Parameters:

  • link (String) —

    The URL to examine

Returns:

  • (Boolean) —

    true if the URL has a ‘200’ HTTP response code, false otherwise



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/beaker/dsl/install_utils.rb', line 205

def link_exists?(link)
  require "net/http"
  require "net/https"
  require "open-uri"
  url = URI.parse(link)
  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = (url.scheme == 'https')
  http.start do |http|
    return http.head(url.request_uri).code == "200"
  end
end

#parse_for_modulename(root_module_dir) ⇒ String

Parse root directory of a module for module name Searches for metadata.json and then if none found, Modulefile and parses for the Name attribute

Parameters:

  • root_module_dir (String)

Returns:

  • (String) —

    module name



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/beaker/dsl/install_utils.rb', line 1232

def parse_for_modulename(root_module_dir)
  author_name, module_name = nil, nil
  if File.exists?("#{root_module_dir}/metadata.json")
    logger.debug "Attempting to parse Modulename from metadata.json"
    module_json = JSON.parse(File.read "#{root_module_dir}/metadata.json")
    if(module_json.has_key?('name'))
      author_name, module_name = get_module_name(module_json['name'])
    end
  end
  if !module_name && File.exists?("#{root_module_dir}/Modulefile")
    logger.debug "Attempting to parse Modulename from Modulefile"
    if /^name\s+'?(\w+-\w+)'?\s*$/i.match(File.read("#{root_module_dir}/Modulefile"))
      author_name, module_name = get_module_name(Regexp.last_match[1])
    end
  end
  if !module_name && !author_name
    logger.debug "Unable to determine name, returning null"
  end
  return author_name, module_name
end

#parse_for_moduleroot(possible_module_directory) ⇒ String?

Recursive method for finding the module root Assumes that a Modulefile exists

Parameters:

  • possible_module_directory (String) —

    will look for Modulefile and if none found go up one level and try again until root is reached

Returns:

  • (String, nil) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/beaker/dsl/install_utils.rb', line 1215

def parse_for_moduleroot(possible_module_directory)
  if File.exists?("#{possible_module_directory}/Modulefile")
    possible_module_directory
  elsif possible_module_directory === '/'
    logger.error "At root, can't parse for another directory"
    nil
  else
    logger.debug "No Modulefile found at #{possible_module_directory}, moving up"
    parse_for_moduleroot File.expand_path(File.join(possible_module_directory,'..'))
  end
end

#split_author_modulename(author_module_attr) ⇒ Hash<Symbol,String>?

Split the Author-Name into a hash

Parameters:

  • author_module_attr (String)

Returns:

  • (Hash<Symbol,String>, nil) —

    :author and :module symbols will be returned



1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/beaker/dsl/install_utils.rb', line 1271

def split_author_modulename(author_module_attr)
  result = /(\w+)-(\w+)/.match(author_module_attr)
  if result
    {:author => result[1], :module => result[2]}
  else
    nil
  end
end

#upgrade_package(host, package_name) ⇒ Result

Upgrade a package on a host. The package must already be installed

Parameters:

  • host (Host) —

    A host object

  • package_name (String) —

    Name of the package to install

Returns:

  • (Result) —

    An object representing the outcome of *upgrade command*.



1205
1206
1207
 
# File 'lib/beaker/dsl/install_utils.rb', line 1205

def upgrade_package host, package_name
  host.upgrade_package package_name
end

#upgrade_pe(path = nil) ⇒ Object

Note:

Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz) for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.

Upgrade PE based upon host configuration and options

Examples:

upgrade_pe("http://neptune.puppetlabs.lan/3.0/ci-ready/")

Parameters:

  • path (String) (defaults to: nil) —

    A path (either local directory or a URL to a listing of PE builds). Will contain a LATEST file indicating the latest build to install. This is ignored if a pe_upgrade_ver and pe_upgrade_dir are specified in the host configuration file.



897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'lib/beaker/dsl/install_utils.rb', line 897

def upgrade_pe path=nil
  hosts.each do |host|
    host['pe_dir'] = host['pe_upgrade_dir'] || path
    if host['platform'] =~ /windows/
      host['pe_ver'] = host['pe_upgrade_ver'] || options['pe_upgrade_ver'] ||
        Options::PEVersionScraper.load_pe_version(host['pe_dir'], options[:pe_version_file_win])
    else
      host['pe_ver'] = host['pe_upgrade_ver'] || options['pe_upgrade_ver'] ||
        Options::PEVersionScraper.load_pe_version(host['pe_dir'], options[:pe_version_file])
    end
    if version_is_less(host['pe_ver'], '3.0')
      host['pe_installer'] ||= 'puppet-enterprise-upgrader'
    end
  end
  #send in the global options hash
  do_install(sorted_hosts, options.merge({:type => :upgrade}))
  options['upgrade'] = true
end