beaker-puppet 1.29.0 → 2.0.0

data/lib/beaker-puppet/install_utils/puppet_utils.rb

@@ -5,21 +5,20 @@ module Beaker
       # This module contains methods useful for both foss and pe installs
       #
       module PuppetUtils
-
-        #Given a type return an understood host type
-        #@param [String] type The host type to be normalized
-        #@return [String] The normalized type
+        # Given a type return an understood host type
+        # @param [String] type The host type to be normalized
+        # @return [String] The normalized type
         #
-        #@example
+        # @example
         #  normalize_type('pe-aio')
         #    'pe'
-        #@example
+        # @example
         #  normalize_type('git')
         #    'foss'
-        #@example
+        # @example
         #  normalize_type('foss-internal')
         #    'foss'
-        def normalize_type type
+        def normalize_type(type)
           case type
           when /(\A|-)foss(\Z|-)/
             'foss'
@@ -27,44 +26,40 @@ module Beaker
             'pe'
           when /(\A|-)aio(\Z|-)/
             'aio'
-          else
-            nil
           end
         end
 
-        #Given a host construct a PATH that includes puppetbindir, facterbindir and hierabindir
+        # Given a host construct a PATH that includes puppetbindir, facterbindir and hierabindir
         # @param [Host] host    A single host to construct pathing for
         def construct_puppet_path(host)
-          path = (%w(puppetbindir facterbindir hierabindir privatebindir)).compact.reject(&:empty?)
-          #get the PATH defaults
+          path = %w[puppetbindir facterbindir hierabindir privatebindir].compact.reject(&:empty?)
+          # get the PATH defaults
           path.map! { |val| host[val] }
           path = path.compact.reject(&:empty?)
-          #run the paths through echo to see if they have any subcommands that need processing
+          # run the paths through echo to see if they have any subcommands that need processing
           path.map! { |val| echo_on(host, val) }
 
           separator = host['pathseparator']
-          if not host.is_powershell?
-            separator = ':'
-          end
+          separator = ':' unless host.is_powershell?
           path.join(separator)
         end
 
-        #Append puppetbindir, facterbindir and hierabindir to the PATH for each host
+        # Append puppetbindir, facterbindir and hierabindir to the PATH for each host
         # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
         #                            or a role (String or Symbol) that identifies one or more hosts.
         def add_puppet_paths_on(hosts)
-          block_on hosts do | host |
+          block_on hosts do |host|
             puppet_path = construct_puppet_path(host)
             host.add_env_var('PATH', puppet_path)
           end
         end
 
-        #Remove puppetbindir, facterbindir and hierabindir to the PATH for each host
+        # Remove puppetbindir, facterbindir and hierabindir to the PATH for each host
         #
         # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
         #                            or a role (String or Symbol) that identifies one or more hosts.
         def remove_puppet_paths_on(hosts)
-          block_on hosts do | host |
+          block_on hosts do |host|
             puppet_path = construct_puppet_path(host)
             host.delete_env_var('PATH', puppet_path)
           end
@@ -76,12 +71,12 @@ module Beaker
         # @deprecated This method returns 'PC1' as the latest puppet collection;
         #     this is incorrect. Use {#puppet_collection_for} instead.
         def get_puppet_collection(agent_version = 'latest')
-          collection = "PC1"
+          collection = 'PC1'
           if agent_version != 'latest'
-            if ! version_is_less( agent_version, "5.5.4") and version_is_less(agent_version, "5.99")
-              collection = "puppet5"
-            elsif ! version_is_less( agent_version, "5.99")
-              collection = "puppet6"
+            if !version_is_less(agent_version, '5.5.4') and version_is_less(agent_version, '5.99')
+              collection = 'puppet5'
+            elsif !version_is_less(agent_version, '5.99')
+              collection = 'puppet6'
             end
           end
           collection
@@ -98,15 +93,13 @@ module Beaker
         # @param version [String] a version number or the string 'latest'
         # @returns [String|nil] the name of the corresponding puppet collection, if any
         def puppet_collection_for(package, version)
-          valid_packages = [
-            :puppet_agent,
-            :puppet,
-            :puppetserver
+          valid_packages = %i[
+            puppet_agent
+            puppet
+            puppetserver
           ]
 
-          unless valid_packages.include?(package)
-            raise "package must be one of #{valid_packages.join(', ')}"
-          end
+          raise "package must be one of #{valid_packages.join(', ')}" unless valid_packages.include?(package)
 
           case package
           when :puppet_agent, :puppet, :puppetserver
@@ -119,7 +112,7 @@ module Beaker
             pc1_x = {
               puppet: 4,
               puppet_agent: 1,
-              puppetserver: 2
+              puppetserver: 2,
             }
 
             return 'pc1' if x == pc1_x[package]
@@ -136,9 +129,8 @@ module Beaker
         # @returns [String|nil] The version of puppet-agent, or nil if puppet-agent is not installed
         def puppet_agent_version_on(host)
           result = on(host, facter('aio_agent_version'), accept_all_exit_codes: true)
-          if result.exit_code.zero?
-            return result.stdout.strip
-          end
+          return result.stdout.strip if result.exit_code.zero?
+
           nil
         end
 
@@ -149,36 +141,36 @@ module Beaker
         def puppetserver_version_on(host)
           result = on(host, 'puppetserver --version', accept_all_exit_codes: true)
           if result.exit_code.zero?
-            matched = result.stdout.strip.scan(%r{\d+\.\d+\.\d+})
+            matched = result.stdout.strip.scan(/\d+\.\d+\.\d+/)
             return matched.first
           end
           nil
         end
 
-        #Configure the provided hosts to be of the provided type (one of foss, aio, pe), if the host
-        #is already associated with a type then remove the previous settings for that type
+        # Configure the provided hosts to be of the provided type (one of foss, aio, pe), if the host
+        # is already associated with a type then remove the previous settings for that type
         # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
         #                            or a role (String or Symbol) that identifies one or more hosts.
         # @param [String] type One of 'aio', 'pe' or 'foss'
-        def configure_defaults_on( hosts, type )
+        def configure_defaults_on(hosts, type)
           block_on hosts do |host|
-
             # check to see if the host already has a type associated with it
             remove_defaults_on(host)
 
             add_method = "add_#{type}_defaults_on"
-            if self.respond_to?(add_method, host)
-              self.send(add_method, host)
-            else
-              raise "cannot add defaults of type #{type} for host #{host.name} (#{add_method} not present)"
-            end
+            raise "cannot add defaults of type #{type} for host #{host.name} (#{add_method} not present)" unless respond_to?(
+              add_method, host
+            )
+
+            send(add_method, host)
+
             # add pathing env
             add_puppet_paths_on(host)
           end
         end
 
         # Configure the provided hosts to be of their host[:type], it host[type] == nil do nothing
-        def configure_type_defaults_on( hosts )
+        def configure_type_defaults_on(hosts)
           block_on hosts do |host|
             has_defaults = false
             if host[:type]
@@ -189,11 +181,12 @@ module Beaker
               host_type = normalize_type(host_type)
               if host_type and host_type !~ /aio/
                 add_method = "add_#{host_type}_defaults_on"
-                if self.respond_to?(add_method, host)
-                  self.send(add_method, host)
-                else
-                  raise "cannot add defaults of type #{host_type} for host #{host.name} (#{add_method} not present)"
-                end
+                raise "cannot add defaults of type #{host_type} for host #{host.name} (#{add_method} not present)" unless respond_to?(
+                  add_method, host
+                )
+
+                send(add_method, host)
+
                 has_defaults = true
               end
             end
@@ -202,18 +195,16 @@ module Beaker
               has_defaults = true
             end
             # add pathing env
-            if has_defaults
-              add_puppet_paths_on(host)
-            end
+            add_puppet_paths_on(host) if has_defaults
           end
         end
-        alias_method :configure_foss_defaults_on, :configure_type_defaults_on
-        alias_method :configure_pe_defaults_on, :configure_type_defaults_on
+        alias configure_foss_defaults_on configure_type_defaults_on
+        alias configure_pe_defaults_on configure_type_defaults_on
 
-        #If the host is associated with a type remove all defaults and environment associated with that type.
+        # If the host is associated with a type remove all defaults and environment associated with that type.
         # @param [Host, Array<Host>, String, Symbol] hosts    One or more hosts to act upon,
         #                            or a role (String or Symbol) that identifies one or more hosts.
-        def remove_defaults_on( hosts )
+        def remove_defaults_on(hosts)
           block_on hosts do |host|
             if host['type']
               # clean up the naming conventions here (some teams use foss-package, git-whatever, we need
@@ -222,14 +213,13 @@ module Beaker
               host_type = normalize_type(host['type'])
               remove_puppet_paths_on(hosts)
               remove_method = "remove_#{host_type}_defaults_on"
-              if self.respond_to?(remove_method, host)
-                self.send(remove_method, host)
-              else
-                raise "cannot remove defaults of type #{host_type} associated with host #{host.name} (#{remove_method} not present)"
-              end
-              if aio_version?(host)
-                remove_aio_defaults_on(host)
-              end
+              raise "cannot remove defaults of type #{host_type} associated with host #{host.name} (#{remove_method} not present)" unless respond_to?(
+                remove_method, host
+              )
+
+              send(remove_method, host)
+
+              remove_aio_defaults_on(host) if aio_version?(host)
             end
           end
         end

data/lib/beaker-puppet/install_utils/windows_utils.rb

@@ -13,7 +13,7 @@ module Beaker
         def get_system_temp_path(host)
           host.system_temp_path
         end
-        alias_method :get_temp_path, :get_system_temp_path
+        alias get_temp_path get_system_temp_path
 
         # Generates commands to be inserted into a Windows batch file to launch an MSI install
         # @param [String] msi_path The path of the MSI - can be a local Windows style file path like
@@ -25,15 +25,15 @@ module Beaker
         # @api private
         def msi_install_script(msi_path, msi_opts, log_path)
           # msiexec requires backslashes in file paths launched under cmd.exe start /w
-          url_pattern = /^(https?|file):\/\//
-          msi_path = msi_path.gsub(/\//, "\\") if msi_path !~ url_pattern
+          url_pattern = %r{^(https?|file)://}
+          msi_path = msi_path.gsub(%r{/}, '\\') if msi_path !~ url_pattern
 
-          msi_params = msi_opts.map{|k, v| "#{k}=#{v}"}.join(' ')
+          msi_params = msi_opts.map { |k, v| "#{k}=#{v}" }.join(' ')
 
           # msiexec requires quotes around paths with backslashes - c:\ or file://c:\
           # not strictly needed for http:// but it simplifies this code
           batch_contents = <<~BATCH
-            start /w msiexec.exe /i \"#{msi_path}\" /qn /L*V #{log_path} #{msi_params}
+            start /w msiexec.exe /i "#{msi_path}" /qn /L*V #{log_path} #{msi_params}
             exit /B %errorlevel%
           BATCH
         end
@@ -67,7 +67,7 @@ module Beaker
             host.do_scp_to(tmp_file.path, batch_path, {})
           end
 
-          return batch_path, log_path
+          [batch_path, log_path]
         end
 
         # Given hosts construct a PATH that includes puppetbindir, facterbindir and hierabindir
@@ -112,34 +112,31 @@ module Beaker
         #
         # @api private
         def install_msi_on(hosts, msi_path, msi_opts = {}, opts = {})
-          block_on hosts do | host |
+          block_on hosts do |host|
             msi_opts['PUPPET_AGENT_STARTUP_MODE'] ||= 'Manual'
             batch_path, log_file = create_install_msi_batch_on(host, msi_path, msi_opts)
             # Powershell command looses an escaped slash resulting in cygwin relative path
             # See https://github.com/puppetlabs/beaker/pull/1626#issuecomment-621341555
-            log_file_escaped = log_file.gsub('\\','\\\\\\')
+            log_file_escaped = log_file.gsub('\\', '\\\\\\')
             # begin / rescue here so that we can reuse existing error msg propagation
             begin
               # 1641 = ERROR_SUCCESS_REBOOT_INITIATED
               # 3010 = ERROR_SUCCESS_REBOOT_REQUIRED
-              on host, Command.new("\"#{batch_path}\"", [], { :cmdexe => true }), :acceptable_exit_codes => [0, 1641, 3010]
-            rescue
+              on host, Command.new("\"#{batch_path}\"", [], { cmdexe: true }), acceptable_exit_codes: [0, 1641, 3010]
+            rescue StandardError
               logger.info(file_contents_on(host, log_file_escaped))
               raise
             end
 
-            if opts[:debug]
-              logger.info(file_contents_on(host, log_file_escaped))
-            end
+            logger.info(file_contents_on(host, log_file_escaped)) if opts[:debug]
 
             unless host.is_cygwin?
               # Enable the PATH updates
               host.close
 
               # Some systems require a full reboot to trigger the enabled path
-              unless on(host, Command.new('puppet -h', [], { :cmdexe => true}), :accept_all_exit_codes => true).exit_code == 0
-                host.reboot
-              end
+              host.reboot unless on(host, Command.new('puppet -h', [], { cmdexe: true }),
+                                    accept_all_exit_codes: true).exit_code == 0
             end
 
             # verify service status post install
@@ -149,18 +146,18 @@ module Beaker
             #
             # We also take advantage of this output to verify the startup
             # settings are honored as supplied to the MSI
-            on host, Command.new("sc qc puppet || sc qc pe-puppet", [], { :cmdexe => true }) do |result|
+            on host, Command.new('sc qc puppet || sc qc pe-puppet', [], { cmdexe: true }) do |result|
               output = result.stdout
               startup_mode = msi_opts['PUPPET_AGENT_STARTUP_MODE'].upcase
 
               search = case startup_mode
-                when 'AUTOMATIC'
-                  { :code => 2, :name => 'AUTO_START' }
-                when 'MANUAL'
-                  { :code => 3, :name => 'DEMAND_START' }
-                when 'DISABLED'
-                  { :code => 4, :name => 'DISABLED' }
-                end
+                       when 'AUTOMATIC'
+                         { code: 2, name: 'AUTO_START' }
+                       when 'MANUAL'
+                         { code: 3, name: 'DEMAND_START' }
+                       when 'DISABLED'
+                         { code: 4, name: 'DISABLED' }
+                       end
 
               if output !~ /^\s+START_TYPE\s+:\s+#{search[:code]}\s+#{search[:name]}/
                 raise "puppet service startup mode did not match supplied MSI option '#{startup_mode}'"
@@ -169,10 +166,13 @@ module Beaker
 
             # (PA-514) value for PUPPET_AGENT_STARTUP_MODE should be present in
             # registry and honored after install/upgrade.
-            reg_key = host.is_x86_64? ? "HKLM\\SOFTWARE\\Wow6432Node\\Puppet Labs\\PuppetInstaller" :
-                                        "HKLM\\SOFTWARE\\Puppet Labs\\PuppetInstaller"
-            reg_query_command = %Q(reg query "#{reg_key}" /v "RememberedPuppetAgentStartupMode" | findstr #{msi_opts['PUPPET_AGENT_STARTUP_MODE']})
-            on host, Command.new(reg_query_command, [], { :cmdexe => true })
+            reg_key = if host.is_x86_64?
+                        'HKLM\\SOFTWARE\\Wow6432Node\\Puppet Labs\\PuppetInstaller'
+                      else
+                        'HKLM\\SOFTWARE\\Puppet Labs\\PuppetInstaller'
+                      end
+            reg_query_command = %(reg query "#{reg_key}" /v "RememberedPuppetAgentStartupMode" | findstr #{msi_opts['PUPPET_AGENT_STARTUP_MODE']})
+            on host, Command.new(reg_query_command, [], { cmdexe: true })
 
             # emit the misc/versions.txt file which contains component versions for
             # puppet, facter, hiera, pxp-agent, packaging and vendored Ruby
@@ -180,7 +180,7 @@ module Beaker
               "'%PROGRAMFILES%\\Puppet Labs\\puppet\\misc\\versions.txt'",
               "'%PROGRAMFILES(X86)%\\Puppet Labs\\puppet\\misc\\versions.txt'",
             ].each do |path|
-              result = on(host, "cmd /c type #{path}", :accept_all_exit_codes => true)
+              result = on(host, "cmd /c type #{path}", accept_all_exit_codes: true)
               if result.exit_code == 0
                 logger.info(result.stdout)
                 break
@@ -203,25 +203,23 @@ module Beaker
         #
         # @api private
         def generic_install_msi_on(hosts, msi_path, msi_opts = {}, opts = {})
-          block_on hosts do | host |
+          block_on hosts do |host|
             batch_path, log_file = create_install_msi_batch_on(host, msi_path, msi_opts)
             # Powershell command looses an escaped slash resulting in cygwin relative path
             # See https://github.com/puppetlabs/beaker/pull/1626#issuecomment-621341555
-            log_file_escaped = log_file.gsub('\\','\\\\\\')
+            log_file_escaped = log_file.gsub('\\', '\\\\\\')
             # begin / rescue here so that we can reuse existing error msg propagation
             begin
               # 1641 = ERROR_SUCCESS_REBOOT_INITIATED
               # 3010 = ERROR_SUCCESS_REBOOT_REQUIRED
-              on host, Command.new("\"#{batch_path}\"", [], { :cmdexe => true }), :acceptable_exit_codes => [0, 1641, 3010]
-            rescue
+              on host, Command.new("\"#{batch_path}\"", [], { cmdexe: true }), acceptable_exit_codes: [0, 1641, 3010]
+            rescue StandardError
               logger.info(file_contents_on(host, log_file_escaped))
 
               raise
             end
 
-            if opts[:debug]
-              logger.info(file_contents_on(host, log_file_escaped))
-            end
+            logger.info(file_contents_on(host, log_file_escaped)) if opts[:debug]
 
             host.close unless host.is_cygwin?
           end

data/lib/beaker-puppet/version.rb

@@ -1,3 +1,3 @@
 module BeakerPuppet
-  VERSION = '1.29.0'
+  VERSION = '2.0.0'
 end

data/lib/beaker-puppet/wrappers.rb

@@ -1,7 +1,6 @@
 module Beaker
   module DSL
     module Wrappers
-
       # This is hairy and because of legacy code it will take a bit more
       # work to disentangle all of the things that are being passed into
       # this catchall param.
@@ -10,7 +9,7 @@ module Beaker
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
         options[:cmdexe] = true
-        Command.new('facter', args, options )
+        Command.new('facter', args, options)
       end
 
       # This is hairy and because of legacy code it will take a bit more
@@ -21,7 +20,7 @@ module Beaker
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
         options[:cmdexe] = true
-        Command.new('cfacter', args, options )
+        Command.new('cfacter', args, options)
       end
 
       # This is hairy and because of legacy code it will take a bit more
@@ -32,7 +31,7 @@ module Beaker
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
         options[:cmdexe] = true
-        Command.new('hiera', args, options )
+        Command.new('hiera', args, options)
       end
 
       # This is hairy and because of legacy code it will take a bit more
@@ -46,48 +45,48 @@ module Beaker
         # we assume that an invocation with `puppet()` will have it's first argument
         # a face or sub command
         cmd = "puppet #{args.shift}"
-        Command.new( cmd, args, options )
+        Command.new(cmd, args, options)
       end
 
       # @!visibility private
       def puppet_resource(*args)
-        puppet( 'resource', *args )
+        puppet('resource', *args)
       end
 
       # @!visibility private
       def puppet_doc(*args)
-        puppet( 'doc', *args )
+        puppet('doc', *args)
       end
 
       # @!visibility private
       def puppet_kick(*args)
-        puppet( 'kick', *args )
+        puppet('kick', *args)
       end
 
       # @!visibility private
       def puppet_cert(*args)
-        puppet( 'cert', *args )
+        puppet('cert', *args)
       end
 
       # @!visibility private
       def puppet_apply(*args)
-        puppet( 'apply', *args )
+        puppet('apply', *args)
       end
 
       # @!visibility private
       def puppet_master(*args)
-        puppet( 'master', *args )
+        puppet('master', *args)
       end
 
       # @!visibility private
       def puppet_agent(*args)
-        puppet( 'agent', *args )
+        puppet('agent', *args)
       end
 
       # @!visibility private
       def puppet_filebucket(*args)
-        puppet( 'filebucket', *args )
+        puppet('filebucket', *args)
       end
     end
   end
-end
+end

data/lib/beaker-puppet.rb

@@ -6,19 +6,18 @@ require 'beaker-puppet/wrappers'
 
 require 'beaker-puppet/helpers/rake_helpers'
 
-[ 'aio', 'foss' ].each do |lib|
+%w[aio foss].each do |lib|
   require "beaker-puppet/install_utils/#{lib}_defaults"
 end
-[ 'windows', 'foss', 'puppet', 'ezbake', 'module' ].each do |lib|
+%w[windows foss puppet ezbake module].each do |lib|
   require "beaker-puppet/install_utils/#{lib}_utils"
 end
-[ 'tk', 'facter', 'puppet', 'host' ].each do |lib|
+%w[tk facter puppet host].each do |lib|
   require "beaker-puppet/helpers/#{lib}_helpers"
 end
 
 require 'beaker-puppet/install_utils/puppet5'
 
-
 module BeakerPuppet
   include Beaker::DSL::InstallUtils::FOSSDefaults
   include Beaker::DSL::InstallUtils::AIODefaults
@@ -40,4 +39,4 @@ module BeakerPuppet
 end
 
 # Register the DSL extension
-Beaker::DSL.register( BeakerPuppet )
+Beaker::DSL.register(BeakerPuppet)

data/setup/aio/010_Install_Puppet_Agent.rb

@@ -1,10 +1,9 @@
-test_name "Install Puppet Agent Packages" do
-
+test_name 'Install Puppet Agent Packages' do
   opts = {
-    :nightly_builds_url => ENV['NIGHTLY_BUILDS_URL'],
-    :dev_builds_url => ENV['DEV_BUILDS_URL'],
-    :puppet_agent_version => ENV['SHA'],
-    :puppet_collection => ENV['RELEASE_STREAM']
+    nightly_builds_url: ENV.fetch('NIGHTLY_BUILDS_URL', nil),
+    dev_builds_url: ENV.fetch('DEV_BUILDS_URL', nil),
+    puppet_agent_version: ENV.fetch('SHA', nil),
+    puppet_collection: ENV.fetch('RELEASE_STREAM', nil),
   }
 
   install_puppet_agent_on(hosts, opts)

data/setup/common/000-delete-puppet-when-none.rb

@@ -1,11 +1,9 @@
-test_name "Expunge puppet bits if hypervisor is none"
+test_name 'Expunge puppet bits if hypervisor is none'
 
 # Ensure that the any previous installations of puppet
 # are removed from the host if it is not managed by a
 # provisioning hypervisor.
 
 hosts.each do |host|
-  if host[:hypervisor] == "none"
-    remove_puppet_on(host)
-  end
+  remove_puppet_on(host) if host[:hypervisor] == 'none'
 end