Module: Beaker::DSL::InstallUtils::FOSSUtils

Includes:
AIODefaults, FOSSDefaults, PuppetUtils
Included in:
Beaker::DSL::InstallUtils
Defined in:
lib/beaker/dsl/install_utils/foss_utils.rb

Overview

This module contains methods to install FOSS puppet from various sources

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

DEFAULT_DOWNLOAD_URLS = 
{
  :win_download_url => "http://downloads.puppetlabs.com/windows",
  :mac_download_url => "http://downloads.puppetlabs.com/mac"
}
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=='

Constants included from FOSSDefaults

Beaker::DSL::InstallUtils::FOSSDefaults::FOSS_DEFAULTS

Constants included from AIODefaults

AIODefaults::AIO_DEFAULTS

Instance Method Summary collapse

Methods included from PuppetUtils

#add_puppet_paths_on, #construct_puppet_path, #remove_puppet_paths_on

Methods included from FOSSDefaults

#add_foss_defaults_on, #add_platform_foss_defaults, #remove_foss_defaults_on, #remove_platform_foss_defaults

Methods included from AIODefaults

#add_aio_defaults_on, #add_platform_aio_defaults, #remove_aio_defaults_on, #remove_platform_aio_defaults

Instance Method Details

#compute_puppet_msi_name(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. 



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
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 479

def compute_puppet_msi_name(host, opts)
  version = opts[:version]
  install_32 = host['install_32'] || opts['install_32']
  less_than_3_dot_7 = version && version_is_less(version, '3.7')

  # If there's no version declared, install the latest in the 3.x series
  if not version
    if !host.is_x86_64? || install_32
      host['dist'] = 'puppet-latest'
    else
      host['dist'] = 'puppet-x64-latest'
    end

  # Install Puppet 3.x with the x86 installer if:
  # - we are on puppet < 3.7, or
  # - we are less than puppet 4.0 and on an x86 host, or
  # - we have install_32 set on host or globally
  # Install Puppet 3.x with the x64 installer if:
  # - we are otherwise trying to install Puppet 3.x on a x64 host
  elsif less_than_3_dot_7 or not host.is_x86_64? or install_32
    host['dist'] = "puppet-#{version}"

  elsif host.is_x86_64?
     host['dist'] = "puppet-#{version}-x64"

  else
    raise "I don't understand how to install Puppet version: #{version}"
  end
end

#configure_foss_defaults_on(hosts) ⇒ Object

Set defaults and PATH for these hosts to be either foss or aio, have host == aio for aio settings, defaults to foss.

Parameters:

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

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 41

def configure_foss_defaults_on( hosts )
  block_on hosts do |host|
    if host['type'] && host['type'] =~ /aio/
      # add foss defaults to host
      add_aio_defaults_on(host)
    else
      add_foss_defaults_on(host)
    end
    # add pathing env
    add_puppet_paths_on(host)
  end
end

#configure_puppet(opts = {}) ⇒ Object

Deprecated.

Use #configure_puppet_on instead.



327
328
329
330
331
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 327

def configure_puppet(opts={})
  hosts.each do |host|
    configure_puppet_on(host,opts)
  end
end

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

Configure puppet.conf on the given host(s) based upon a provided hash

Examples:

will configure /etc/puppet.conf on the puppet master.

config = {
  'main' => {
    'server'   => 'testbox.test.local',
    'certname' => 'testbox.test.local',
    'logdir'   => '/var/log/puppet',
    'vardir'   => '/var/lib/puppet',
    'ssldir'   => '/var/lib/puppet/ssl',
    'rundir'   => '/var/run/puppet'
  },
  'agent' => {
    'environment' => 'dev'
  }
}
configure_puppet(master, config)

Parameters:

  • hosts (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{Symbol=>String}) (defaults to: {})

Options Hash (opts):

  • :main (Hash{String=>String}) —

    configure the main section of puppet.conf

  • :agent (Hash{String=>String}) —

    configure the agent section of puppet.conf

Returns:

  • nil



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 357

def configure_puppet_on(hosts, opts = {})
  block_on hosts do |host|
    if host['platform'] =~ /windows/
      puppet_conf = host.puppet['config']
      conf_data = ''
      opts.each do |section,options|
        conf_data << "[#{section}]`n"
        options.each do |option,value|
          conf_data << "#{option}=#{value}`n"
        end
        conf_data << "`n"
      end
      on host, powershell("\$text = \\\"#{conf_data}\\\"; Set-Content -path '#{puppet_conf}' -value \$text")
    else
      puppet_conf = host.puppet['config']
      conf_data = ''
      opts.each do |section,options|
        conf_data << "[#{section}]\n"
        options.each do |option,value|
          conf_data << "#{option}=#{value}\n"
        end
        conf_data << "\n"
      end
      on host, "echo \"#{conf_data}\" > #{puppet_conf}"
    end
  end
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)



72
73
74
75
76
77
78
79
80
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 72

def extract_repo_info_from uri
  require 'pathname'
  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

#find_git_repo_versions(host, path, repository) ⇒ Hash

Note:

This requires the helper methods:

  • Helpers#on

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.



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 114

def find_git_repo_versions host, path, repository
  logger.notify("\n  * Grab version for #{repository[:name]}")

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

  version
end

#install_a_puppet_msi_on(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. 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 532

def install_a_puppet_msi_on(host, opts)
  link = "#{opts[:win_download_url]}/#{host['dist']}.msi"
  if not link_exists?( link )
    raise "Puppet #{version} at #{link} does not exist!"
  end

  if host.is_cygwin?
    dest = "#{host['dist']}.msi"
    on host, "curl -O #{link}"

    #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 }

    on host, "cmd /C 'start /w msiexec.exe /qn /i #{dest}'"
  else
    dest = "C:\\Windows\\Temp\\#{host['dist']}.msi"

    on host, powershell("$webclient = New-Object System.Net.WebClient;  $webclient.DownloadFile('#{link}','#{dest}')")

    on host, "start /w msiexec.exe /qn /i #{dest}"
  end

  configure_foss_defaults_on( host )
  if not host.is_cygwin?
    host.mkdir_p host['distmoduledir']
  end
end

#install_cert_on_windows(host, cert_name, cert) ⇒ Object

This method will install a pem file certifcate on a windows host

Parameters:

  • host (Host) —

    A host object

  • cert_name (String) —

    The name of the pem file

  • cert (String) —

    The contents of the certificate



981
982
983
984
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 981

def install_cert_on_windows(host, cert_name, cert)
  create_remote_file(host, "C:\\Windows\\Temp\\#{cert_name}.pem", cert)
  on host, "certutil -v -addstore Root C:\\Windows\\Temp\\#{cert_name}.pem"
end

#install_from_git(host, path, repository) ⇒ Object

See Also:



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
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 128

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

  logger.notify("\n  * Clone #{repo} if needed")

  on host, "test -d #{path} || mkdir -p #{path}"
  on host, "test -d #{target} || #{clone_cmd}"

  logger.notify("\n  * Update #{name} and check out revision #{rev}")

  commands = ["cd #{target}",
              "remote rm origin",
              "remote add origin #{repo}",
              "fetch origin +refs/pull/*:refs/remotes/origin/pr/* +refs/heads/*:refs/remotes/origin/*",
              "clean -fdx",
              "checkout -f #{rev}"]
  on host, commands.join(" && git ")

  logger.notify("\n  * Install #{name} on the system")
  # 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

#install_packages_from_local_dev_repo(host, package_name) ⇒ Object

Note:

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

Note:

This method is paired to be run directly after #install_puppetlabs_dev_repo

Installs packages from the local development repository on the given host

Parameters:

  • host (Host) —

    An object implementing Hosts‘s interface.

  • package_name (Regexp) —

    The name of the package whose repository is being installed.



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

def install_packages_from_local_dev_repo( host, package_name )
  if host['platform'] =~ /debian|ubuntu|cumulus/
    find_filename = '*.deb'
    find_command  = 'dpkg -i'
  elsif host['platform'] =~ /fedora|el|centos/
    find_filename = '*.rpm'
    find_command  = 'rpm -ivh'
  else
    raise "No repository installation step for #{host['platform']} yet..."
  end
  find_command = "find /root/#{package_name} -type f -name '#{find_filename}' -exec #{find_command} {} \\;"
  on host, find_command
  configure_foss_defaults_on( host )
end

#install_puppet(opts = {}) ⇒ Object

Deprecated.

Use #install_puppet_on instead.



176
177
178
179
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 176

def install_puppet(opts = {})
  #send in the global hosts!
  install_puppet_on(hosts, opts)
end

#install_puppet_agent_from_dmg_on(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 Agent to install

  • :mac_download_url (String) —

    Url to download msi pattern of %url%/puppet-%version%.msi

Returns:

  • nil



617
618
619
620
621
622
623
624
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 617

def install_puppet_agent_from_dmg_on(host, opts)
  version = opts[:version] || 'latest'
  on host, "curl -O #{opts[:mac_download_url]}/puppet-agent-#{version}.dmg"

  host.install_package("puppet-agent-#{version}")

  configure_foss_defaults_on( host )
end

#install_puppet_agent_from_msi_on(host, opts) ⇒ Object

Note:

on windows, the :ruby_arch host parameter can determine in addition

Installs Puppet Agent and dependencies from msi

to other settings whether the 32 or 64bit install is used

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 Agent to install

  • :win_download_url (String) —

    The url to download puppet from



518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 518

def install_puppet_agent_from_msi_on(host, opts)
  arch = host.is_x86_64? ? 'x64' : 'x86'

  # If we don't specify a version install the latest MSI for puppet-agent
  if opts['version']
    host['dist'] = "puppet-agent-#{opts[:version]}-#{arch}"
  else
    host['dist'] = "puppet-agent-#{arch}-latest"
  end

  install_a_puppet_msi_on(host, opts)
end

#install_puppet_agent_on(hosts, opts) ⇒ Object

Note:

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

Install Puppet Agent based on specified hosts using provided options

Examples:

will install puppet-agent 1.1.0 from native puppetlabs provided packages wherever possible and will fail over to gem installing latest puppet

install_puppet_agent_on(hosts, {
  :version          => '1.1.0',
  :default_action   => 'gem_install',
 })

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

install_puppet_agent_on(hosts)

Parameters:

  • hosts (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{Symbol=>String})

Options Hash (opts):

  • :version (String) —

    Version of puppet to download

  • :puppet_gem_version (String) —

    Version of puppet to install via gem if no puppet-agent package is available

  • :mac_download_url (String) —

    Url to download msi pattern of %url%/puppet-agent-%version%.msi

  • :win_download_url (String) —

    Url to download dmg pattern of %url%/puppet-agent-%version%.msi

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 289

def install_puppet_agent_on(hosts, opts)
  opts = DEFAULT_DOWNLOAD_URLS.merge(opts)
  opts[:repo] ||= 'pc1'

  block_on hosts do |host|
    case host['platform']
    when /el-|fedora/
      install_puppetlabs_release_repo(host, opts[:repo])
      if opts[:version]
        host.install_package("puppet-agent-#{opts[:version]}")
      else
        host.install_package('puppet-agent')
      end
    when /debian|ubuntu|cumulus/
      install_puppetlabs_release_repo(host, opts[:repo])
      if opts[:version]
        host.install_package("puppet-agent=#{opts[:version]}-1#{host['platform'].codename}")
      else
        host.install_package('puppet-agent')
      end
    when /windows/
      install_puppet_agent_from_msi_on(host, opts)
    when /osx/
      install_puppet_agent_from_dmg_on(host, opts)
    else
      if opts[:default_action] == 'gem_install'
        opts[:version] = opts[:puppet_gem_version]
        install_puppet_from_gem_on(host, opts)
        on host, "echo '' >> #{host.puppet['hiera_config']}"
      else
        raise "install_puppet_agent_on() called for unsupported " +
              "platform '#{host['platform']}' on '#{host.name}'"
      end
    end
  end
end

#install_puppet_from_deb_on(host, opts) ⇒ Object Also known as: install_puppet_from_deb

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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 424

def install_puppet_from_deb_on( host, opts )
  install_puppetlabs_release_repo(host)

  if opts[:facter_version]
    host.install_package("facter=#{opts[:facter_version]}-1puppetlabs1")
  end

  if opts[:hiera_version]
    host.install_package("hiera=#{opts[:hiera_version]}-1puppetlabs1")
  end

  if opts[:version]
    host.install_package("puppet-common=#{opts[:version]}-1puppetlabs1")
    host.install_package("puppet=#{opts[:version]}-1puppetlabs1")
  else
    host.install_package('puppet')
  end
  configure_foss_defaults_on( host )
end

#install_puppet_from_dmg_on(host, opts) ⇒ Object Also known as: install_puppet_from_dmg

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

  • :facter_version (String) —

    The version of Facter to install

  • :hiera_version (String) —

    The version of Hiera to install

  • :mac_download_url (String) —

    Url to download msi pattern of %url%/puppet-%version%.msi

Returns:

  • nil



574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 574

def install_puppet_from_dmg_on( host, opts )

  if opts[:version] && !version_is_less(opts[:version], '4.0.0')
    if opts[:puppet_agent_version].nil?
      raise "You must specify the version of puppet-agent you " +
            "want to install if you want to install Puppet 4.0 " +
            "or greater on OSX"
    end

    opts[:version] = opts[:puppet_agent_version]
    install_puppet_agent_from_dmg_on(host, opts)

  else
    puppet_ver = opts[:version] || 'latest'
    facter_ver = opts[:facter_version] || 'latest'
    hiera_ver = opts[:hiera_version] || 'latest'

    if [puppet_ver, facter_ver, hiera_ver].include?(nil)
      raise "You need to specify versions for OSX host\n eg. install_puppet({:version => '3.6.2',:facter_version => '2.1.0',:hiera_version  => '1.3.4',})"
    end

    on host, "curl -O #{opts[:mac_download_url]}/puppet-#{puppet_ver}.dmg"
    on host, "curl -O #{opts[:mac_download_url]}/facter-#{facter_ver}.dmg"
    on host, "curl -O #{opts[:mac_download_url]}/hiera-#{hiera_ver}.dmg"

    host.install_package("puppet-#{puppet_ver}")
    host.install_package("facter-#{facter_ver}")
    host.install_package("hiera-#{hiera_ver}")

    configure_foss_defaults_on( host )
  end
end

#install_puppet_from_gem_on(host, opts) ⇒ Object Also known as: install_puppet_from_gem, install_puppet_agent_from_gem_on

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



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 637

def install_puppet_from_gem_on( 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-|cumulus/  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|cumulus/
    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
  configure_foss_defaults_on( host )
end

#install_puppet_from_msi_on(host, opts) ⇒ Object Also known as: install_puppet_from_msi

Note:

on windows, the :ruby_arch host parameter can determine in addition

Installs Puppet and dependencies from msi

to other settings whether the 32 or 64bit install is used

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

  • :puppet_agent_version (String) —

    The version of the puppet-agent package to install, required if version is 4.0.0 or greater

  • :win_download_url (String) —

    The url to download puppet from



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 456

def install_puppet_from_msi_on( host, opts )

  version = opts[:version]

  if version && !version_is_less(version, '4.0.0')
    if opts[:puppet_agent_version].nil?
      raise "You must specify the version of puppet agent you " +
            "want to install if you want to install Puppet 4.0 " +
            "or greater on Windows"
    end

    opts[:version] = opts[:puppet_agent_version]
    install_puppet_agent_from_msi_on(host, opts)

  else
    compute_puppet_msi_name(host, opts)
    install_a_puppet_msi_on(host, opts)

  end
end

#install_puppet_from_rpm_on(host, opts) ⇒ Object Also known as: install_puppet_from_rpm

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

  • :release (String) —

    The major release of the OS

  • :family (String) —

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

Returns:

  • nil



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 397

def install_puppet_from_rpm_on( host, opts )
  install_puppetlabs_release_repo(host)

  if opts[:facter_version]
    host.install_package("facter-#{opts[:facter_version]}")
  end

  if opts[:hiera_version]
    host.install_package("hiera-#{opts[:hiera_version]}")
  end

  puppet_pkg = opts[:version] ? "puppet-#{opts[:version]}" : 'puppet'
  host.install_package("#{puppet_pkg}")
  configure_foss_defaults_on( host )
end

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

Note:

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

Install FOSS based on specified hosts using provided 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_on(hosts, {
  :version          => '3.6.1',
  :facter_version   => '2.0.1',
  :hiera_version    => '1.3.3',
  :default_action   => 'gem_install',
 })

will install puppet 4 from native puppetlabs provided puppet-agent 1.x package wherever possible and will fail over to gem installation when impossible

install_puppet({
  :version              => '4',
  :default_action       => 'gem_install'
})

will install puppet 4.1.0 from native puppetlabs provided puppet-agent 1.1.0 package wherever possible and will fail over to gem installation when impossible

install_puppet({
  :version              => '4.1.0',
  :puppet_agent_version => '1.1.0',
  :default_action       => 'gem_install'
})

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

install_puppet_on(hosts)

Parameters:

  • hosts (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{Symbol=>String}) (defaults to: {})

Options Hash (opts):

  • :version (String) —

    Version of puppet to download

  • :mac_download_url (String) —

    Url to download msi pattern of %url%/puppet-%version%.msi

  • :win_download_url (String) —

    Url to download dmg pattern of %url%/(puppet|hiera|facter)-%version%.msi

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 222

def install_puppet_on(hosts, opts={})
  opts = DEFAULT_DOWNLOAD_URLS.merge(opts)

  # If version isn't specified assume the latest in the 3.x series
  if opts[:version] and not version_is_less(opts[:version], '4.0.0')
    opts[:version] = opts[:puppet_agent_version]
    install_puppet_agent_on(hosts, opts)

  else
    block_on hosts do |host|
      if host['platform'] =~ /el-(5|6|7)/
        relver = $1
        install_puppet_from_rpm_on(host, opts.merge(:release => relver, :family => 'el'))
      elsif host['platform'] =~ /fedora-(\d+)/
        relver = $1
        install_puppet_from_rpm_on(host, opts.merge(:release => relver, :family => 'fedora'))
      elsif host['platform'] =~ /(ubuntu|debian|cumulus)/
        install_puppet_from_deb_on(host, opts)
      elsif host['platform'] =~ /windows/
        relver = opts[:version]
        install_puppet_from_msi_on(host, opts)
      elsif host['platform'] =~ /osx/
        install_puppet_from_dmg_on(host, opts)
      else
        if opts[:default_action] == 'gem_install'
          opts[:version] ||= '~> 3.x'
          install_puppet_from_gem_on(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']}" unless host[:type] =~ /aio/
      on host, "echo '' >> #{host.puppet['hiera_config']}"
    end
  end

  nil
end

#install_puppetagent_dev_repo(host, opts) ⇒ Object

Note:

on windows, the :ruby_arch host parameter can determine in addition

Install development repo of the puppet-agent on the given host

to other settings whether the 32 or 64bit install is used

Parameters:

  • host (Host) —

    An object implementing Hosts‘s interface

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

    An options hash

Options Hash (opts):

  • :version (String) —

    The version of puppet-agent to install

  • :copy_base_local (String) —

    Directory where puppet-agent artifact will be stored locally (default: ‘tmp/repo_configs’)

  • :copy_dir_external (String) —

    Directory where puppet-agent artifact will be pushed to on the external machine (default: ‘/root’)

Returns:

  • nil



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 928

def install_puppetagent_dev_repo( host, opts )
  opts[:copy_base_local]    ||= File.join('tmp', 'repo_configs')
  opts[:copy_dir_external]  ||= File.join('/', 'root')
  variant, version, arch, codename = host['platform'].to_array
  release_path = "#{options[:dev_builds_url]}/puppet-agent/#{opts[:version]}/artifacts/"
  copy_dir_local = File.join(opts[:copy_base_local], variant)
  onhost_copy_base = opts[:copy_dir_external]

  case variant
  when /^(fedora|el|centos)$/
    release_path << "el/#{version}/products/#{arch}"
    release_file = "puppet-agent-#{opts[:version]}-1.#{arch}.rpm"
  when /^(debian|ubuntu|cumulus)$/
    release_path << "deb/#{codename}"
    release_file = "puppet-agent_#{opts[:version]}-1_#{arch}.deb"
  when /^windows$/
    release_path << 'windows'
    onhost_copy_base = '`cygpath -smF 35`/'
    is_config_32 = host['ruby_arch'] == 'x86' || host['install_32'] || opts['install_32']
    should_install_64bit = host.is_x86_64? && !is_config_32
    # only install 64bit builds if
    # - we do not have install_32 set on host
    # - we do not have install_32 set globally
    arch_suffix = should_install_64bit ? '64' : '86'
    release_file = "puppet-agent-x#{arch_suffix}.msi"
  else
    raise "No repository installation step for #{variant} yet..."
  end

  onhost_copied_file = File.join(onhost_copy_base, release_file)
  fetch_http_file( release_path, release_file, copy_dir_local)
  scp_to host, File.join(copy_dir_local, release_file), onhost_copy_base

  case variant
  when /^(fedora|el|centos)$/
    on host, "rpm -ivh #{onhost_copied_file}"
  when /^(debian|ubuntu|cumulus)$/
    on host, "dpkg -i --force-all #{onhost_copied_file}"
    on host, "apt-get update"
  when /^windows$/
    result = on host, "echo #{onhost_copied_file}"
    onhost_copied_file = result.raw_output.chomp
    on host, Command.new("start /w #{onhost_copied_file}", [], { :cmdexe => true })
  end
  configure_foss_defaults_on( host )
end

#install_puppetlabs_dev_repo(host, package_name, build_version, repo_configs_dir = 'tmp/repo_configs', opts = options) ⇒ 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.

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

    Options to alter execution.

Options Hash (opts):

  • :dev_builds_url (String) —

    The URL to look for dev builds.

  • :dev_builds_repos (String, Array<String>) —

    The repo(s) to check for dev builds in.



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
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
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 769

def install_puppetlabs_dev_repo ( host, package_name, build_version,
                          repo_configs_dir = 'tmp/repo_configs',
                          opts = options )
  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,
  # plus this opens up possibility of switching the behavior on provided
  # url type
  _, protocol, hostname = opts[: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 = nil
    package_repos = opts[:dev_builds_repos].nil? ? [] : [opts[:dev_builds_repos]]
    package_repos.push(['products', 'devel']).flatten!
    package_repos.each do |repo|
      link =  "%s/%s/%s/repos/%s/%s%s/%s/%s/" %
        [ dev_builds_url, package_name, build_version, variant,
          fedora_prefix, version, repo, arch ]

      unless link_exists?( link )
        logger.debug("couldn't find link at '#{repo}', falling back to next option...")
      else
        logger.debug("found link at '#{repo}'")
        break
      end
    end
    raise "Unable to reach a repo directory at #{link}" unless link_exists?( link )

    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|cumulus)$/
    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}"

    repo_name = nil
    package_repos = opts[:dev_builds_repos].nil? ? [] : [opts[:dev_builds_repos]]
    package_repos.flatten!
    package_repos.each do |repo|
      repo_path = "/root/#{package_name}/#{codename}/#{repo}"
      repo_check = on(host, "[[ -d #{repo_path} ]]", :acceptable_exit_codes => [0,1])
      if repo_check.exit_code == 0
        logger.debug("found repo at '#{repo_path}'")
        repo_name = repo
        break
      else
        logger.debug("couldn't find repo at '#{repo_path}', falling back to next option...")
      end
    end
    if repo_name.nil?
      repo_name = 'main'
      logger.debug("using default repo '#{repo_name}'")
    end

    search = "deb\\s\\+http:\\/\\/#{hostname}.*$"
    replace = "deb file:\\/\\/\\/root\\/#{package_name}\\/#{codename} #{codename} #{repo_name}"
    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"
    configure_foss_defaults_on( host )

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

#install_puppetlabs_release_repo_on(host, repo = nil, opts = options) ⇒ Object Also known as: install_puppetlabs_release_repo

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.



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/beaker/dsl/install_utils/foss_utils.rb', line 717

def install_puppetlabs_release_repo_on( host, repo = nil, opts = options )
  variant, version, arch, codename = host['platform'].to_array
  repo_name = repo.nil? ? '' : '-' + repo

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

    rpm = "puppetlabs-release%s-%s-%s.noarch.rpm" % [repo_name, variant, version]
    remote = URI.join( options[:release_yum_repo_url], rpm )

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

  when /^(debian|ubuntu|cumulus)$/
    deb = "puppetlabs-release%s-%s.deb" % [repo_name, codename]

    remote = URI.join( options[:release_apt_repo_url], deb )

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