beaker 4.38.1 → 5.0.0

data/lib/beaker/host/cisco.rb

@@ -1,10 +1,9 @@
-[ 'host', 'command_factory' ].each do |lib|
+%w[host command_factory].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Cisco
   class Host < Unix::Host
-
     # as the cisco hosts tend to have custom
     # ssh configuration, the presets
     # do not apply where verification of the
@@ -12,10 +11,10 @@ module Cisco
     def platform_defaults
       h = Beaker::Options::OptionsHash.new
       h.merge({
-        'ssh' => {
-          :verify_host_key => false,
-        },
-      })
+                'ssh' => {
+                  :verify_host_key => false,
+                },
+              })
     end
 
     # Tells you whether a host platform supports beaker's
@@ -34,9 +33,7 @@ module Cisco
     #
     # @return nil
     def scp_post_operations(scp_file_actual, scp_file_target)
-      if self[:platform] =~ /cisco_nexus/
-        execute( "mv #{scp_file_actual} #{scp_file_target}" )
-      end
+      execute("mv #{scp_file_actual} #{scp_file_target}") if self[:platform].include?('cisco_nexus')
       nil
     end
 
@@ -47,10 +44,10 @@ module Cisco
     # @return [String] path, changed if needed due to host
     #   constraints
     def scp_path(path)
-      if self[:platform] =~ /cisco_nexus/
-        @home_dir ||= execute( 'pwd' )
-        answer = "#{@home_dir}/#{File.basename( path )}"
-        answer << '/' if path =~ /\/$/
+      if self[:platform].include?('cisco_nexus')
+        @home_dir ||= execute('pwd')
+        answer = "#{@home_dir}/#{File.basename(path)}"
+        answer << '/' if /\/$/.match?(path)
         return answer
       end
       path
@@ -81,20 +78,17 @@ module Cisco
     # @param [Hash] opts optional parameters
     #
     # @return [String] Command string as needed for this host
-    def prepend_commands(command = '', user_pc = '', opts = {})
+    def prepend_commands(command = '', user_pc = '', _opts = {})
       return user_pc unless command.index('vsh').nil?
-      if self[:platform] =~ /cisco_nexus/
+
+      if self[:platform].include?('cisco_nexus')
         return user_pc unless command.index('ntpdate').nil?
       end
 
       prepend_cmds = 'source /etc/profile;'
       prepend_cmds << " sudo -E sh -c \"" if self[:user] != 'root'
-      if self[:vrf]
-        prepend_cmds << "ip netns exec #{self[:vrf]} "
-      end
-      if user_pc && !user_pc.empty?
-        prepend_cmds << "#{user_pc} "
-      end
+      prepend_cmds << "ip netns exec #{self[:vrf]} " if self[:vrf]
+      prepend_cmds << "#{user_pc} " if user_pc && !user_pc.empty?
       prepend_cmds.strip
     end
 
@@ -105,10 +99,10 @@ module Cisco
     # @param [Hash] opts optional parameters
     #
     # @return [String] Command string as needed for this host
-    def append_commands(command = '', user_ac = '', opts = {})
-      command.gsub('"') {'\\"'}
+    def append_commands(command = '', _user_ac = '', _opts = {})
+      command.gsub('"') { '\\"' }
       # vsh commands, ntpdate or when user is root commands do not require an appended `"`
-      return '"' unless command =~ /ntpdate|\/isan\/bin\/vsh/ || self[:user] == 'root'
+      return '"' unless /ntpdate|\/isan\/bin\/vsh/.match?(command) || self[:user] == 'root'
     end
 
     # Construct the environment string for this command
@@ -125,16 +119,17 @@ module Cisco
     def environment_string env
       prestring = ''
       return prestring if env.empty?
-      env_array = self.environment_variable_string_pair_array( env )
+
+      env_array = self.environment_variable_string_pair_array(env)
       environment_string = env_array.join(' ')
 
-      if self[:platform] =~ /cisco_nexus/
-        prestring << " export"
-      else
-        prestring << " env"
-      end
+      prestring << if self[:platform].include?('cisco_nexus')
+                     " export"
+                   else
+                     " env"
+                   end
       environment_string = "#{prestring} #{environment_string}"
-      environment_string << ';' if prestring =~ /export/
+      environment_string << ';' if prestring.include?('export')
       environment_string
     end
 
@@ -145,27 +140,20 @@ module Cisco
     #   this will be raised with the appropriate message
     def validate_setup
       msg = nil
-      if self[:platform] =~ /cisco_nexus/
-        if !self[:vrf]
-          msg = 'Cisco Nexus hosts must be provided with a :vrf value.'
-        end
-        if !self[:user]
-          msg = 'Cisco hosts must be provided with a :user value'
-        end
+      if self[:platform].include?('cisco_nexus')
+        msg = 'Cisco Nexus hosts must be provided with a :vrf value.' if !self[:vrf]
+        msg = 'Cisco hosts must be provided with a :user value' if !self[:user]
       end
-      if self[:platform] =~ /cisco_ios_xr/
-        if !self[:user]
-          msg = 'Cisco hosts must be provided with a :user value'
-        end
+      if self[:platform].include?('cisco_ios_xr')
+        msg = 'Cisco hosts must be provided with a :user value' if !self[:user]
       end
 
-      if msg
-        msg << <<-EOF
+      return unless msg
+
+      msg << <<-EOF
           Check https://github.com/puppetlabs/beaker/blob/master/docs/hosts/cisco.md for more info.'
-        EOF
-        raise ArgumentError, msg
-      end
+      EOF
+      raise ArgumentError, msg
     end
-
   end
 end

data/lib/beaker/host/eos.rb

@@ -1,34 +1,9 @@
-[ 'host', 'command_factory' ].each do |lib|
+%w[host command_factory].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Eos
   class Host < Unix::Host
-
-    # Gets the path & file name for the puppet agent dev package on EOS
-    #
-    # @param [String] puppet_collection Name of the puppet collection to use
-    # @param [String] puppet_agent_version Version of puppet agent to get
-    # @param [Hash{Symbol=>String}] opts Options hash to provide extra values
-    #
-    # @note EOS doesn't use any additional options at this time, but does require
-    #   both puppet_collection & puppet_agent_version, & will fail without them
-    #
-    # @raise [ArgumentError] If one of the two required parameters (puppet_collection,
-    #   puppet_agent_version) is either not passed or set to nil
-    #
-    # @return [String, String] Path to the directory and filename of the package, respectively
-    def puppet_agent_dev_package_info( puppet_collection = nil, puppet_agent_version = nil, opts = {} )
-      error_message = "Must provide %s argument to get puppet agent dev package information"
-      raise ArgumentError, error_message % "puppet_collection" unless puppet_collection
-      raise ArgumentError, error_message % "puppet_agent_version" unless puppet_agent_version
-
-      variant, version, arch, _ = self['platform'].to_array
-      release_path = "#{variant}/#{version}/#{puppet_collection}/#{arch}"
-      release_file = "puppet-agent-#{puppet_agent_version}-1.#{variant}#{version}.#{arch}.swix"
-      return release_path, release_file
-    end
-
     # Copies a remote file to the host location specified
     #
     # @param [String] remote_url URL to the remote file
@@ -38,7 +13,7 @@ module Eos
     #   about location, so that parameter is ignored
     #
     # @return [Result] The result of copying that file to the host
-    def get_remote_file( remote_url, host_directory = '' )
+    def get_remote_file(remote_url, _host_directory = '')
       commands = ['enable', "copy #{remote_url} extension:"]
       command = commands.join("\n")
       execute("Cli -c '#{command}'")
@@ -49,11 +24,10 @@ module Eos
     # @param [String] filename Name of the file to install, including file extension
     #
     # @return [Result] The result of running the install command on the host
-    def install_from_file( filename )
+    def install_from_file(filename)
       commands = ['enable', "extension #{filename}"]
       command = commands.join("\n")
       execute("Cli -c '#{command}'")
     end
-
   end
-end
+end

data/lib/beaker/host/freebsd/exec.rb

@@ -3,7 +3,7 @@ module FreeBSD::Exec
 
   def echo_to_file(str, filename)
     # FreeBSD gets weird about special characters, we have to go a little OTT here
-    escaped_str = str.gsub(/\t/,'\\t').gsub(/\n/,'\\n')
+    escaped_str = str.gsub(/\t/, '\\t').gsub(/\n/, '\\n')
 
     exec(Beaker::Command.new("printf \"#{escaped_str}\" > #{filename}"))
   end

data/lib/beaker/host/freebsd/pkg.rb

@@ -8,11 +8,11 @@ module FreeBSD::Pkg
 
   def check_pkgng_sh
     'TMPDIR=/dev/null ASSUME_ALWAYS_YES=1 PACKAGESITE=file:///nonexist ' \
-    'pkg info -x "pkg(-devel)?\\$" > /dev/null 2>&1'
+      'pkg info -x "pkg(-devel)?\\$" > /dev/null 2>&1'
   end
 
   def pkgng_active?(opts = {})
-    opts = {:accept_all_exit_codes => true}.merge(opts)
+    opts = { :accept_all_exit_codes => true }.merge(opts)
     execute("/bin/sh -c '#{check_pkgng_sh}'", opts) { |r| r }.exit_code == 0
   end
 
@@ -35,7 +35,7 @@ module FreeBSD::Pkg
   end
 
   def check_for_package(package, opts = {})
-    opts = {:accept_all_exit_codes => true}.merge(opts)
+    opts = { :accept_all_exit_codes => true }.merge(opts)
     cmd = if pkgng_active?
             "pkg info #{package}"
           else

data/lib/beaker/host/freebsd.rb

@@ -1,15 +1,14 @@
-[ 'host', 'command_factory' ].each do |lib|
+%w[host command_factory].each do |lib|
   require "beaker/#{lib}"
 end
 
 module FreeBSD
   class Host < Unix::Host
-
-    [
-      'exec',
-      'pkg',
+    %w[
+      exec
+      pkg
     ].each do |lib|
-        require "beaker/host/freebsd/#{lib}"
+      require "beaker/host/freebsd/#{lib}"
     end
 
     include FreeBSD::Exec
@@ -18,12 +17,10 @@ module FreeBSD
     def platform_defaults
       h = Beaker::Options::OptionsHash.new
       h.merge({
-        'user'              => 'root',
-        'group'             => 'root',
-        'pathseparator'     => ':',
-        })
+                'user' => 'root',
+                'group' => 'root',
+                'pathseparator' => ':',
+              })
     end
-
   end
-
 end

data/lib/beaker/host/mac/exec.rb

@@ -1,7 +1,7 @@
 module Mac::Exec
   include Beaker::CommandFactory
 
-  def touch(file, abs=true)
+  def touch(file, abs = true)
     (abs ? '/usr/bin/touch' : 'touch') + " #{file}"
   end
 
@@ -21,17 +21,17 @@ module Mac::Exec
   #   (from {#ssh_service_restart})
   def ssh_permit_user_environment
     ssh_config_file = '/etc/sshd_config'
-    ssh_config_file = '/private/etc/ssh/sshd_config' if self['platform'] =~ /^osx-/
+    ssh_config_file = '/private/etc/ssh/sshd_config' if /^osx-/.match?(self['platform'])
 
     exec(Beaker::Command.new("echo '\nPermitUserEnvironment yes' >> #{ssh_config_file}"))
-    ssh_service_restart()
+    ssh_service_restart
   end
 
-  # Checks if selinux is enabled
+  #  Checks if selinux is enabled
   # selinux is not availble on OS X
   #
   # @return [Boolean] false
-  def selinux_enabled?()
+  def selinux_enabled?
     false
   end
 

data/lib/beaker/host/mac/group.rb

@@ -6,11 +6,11 @@ module Mac::Group
   # @param [Proc] block Additional actions or insertions
   #
   # @return [Array<String>] The list of group names on the system
-  def group_list(&block)
+  def group_list
     execute('dscacheutil -q group') do |result|
       groups = []
       result.stdout.each_line do |line|
-        groups << line.split(': ')[1].strip if line =~ /^name:/
+        groups << line.split(': ')[1].strip if /^name:/.match?(line)
       end
 
       yield result if block_given?
@@ -28,14 +28,14 @@ module Mac::Group
   # @return [String] Group information in /etc/group format
   # @raise [FailTest] Raises an Assertion failure if it can't find the name
   #                   queried for in the returned block
-  def group_get(name, &block)
+  def group_get(name)
     execute("dscacheutil -q group -a name #{name}") do |result|
-      fail_test "failed to get group #{name}" unless result.stdout =~ /^name: #{name}/
-      gi = Hash.new  # group info
-      result.stdout.each_line { |line|
+      fail_test "failed to get group #{name}" unless /^name: #{name}/.match?(result.stdout)
+      gi = {} # group info
+      result.stdout.each_line do |line|
         pieces = line.split(': ')
         gi[pieces[0].to_sym] = pieces[1].strip if pieces[1] != nil
-      }
+      end
       answer = "#{gi[:name]}:#{gi[:password]}:#{gi[:gid]}"
 
       yield answer if block_given?
@@ -51,12 +51,12 @@ module Mac::Group
   def group_gid(name)
     gid = -1
     execute("dscacheutil -q group -a name #{name}") do |result|
-      result.stdout.each_line { |line|
-        if line =~ /^gid:/
+      result.stdout.each_line do |line|
+        if /^gid:/.match?(line)
           gid = (line[5, line.length - 5]).chomp
           break
         end
-      }
+      end
       gid
     end
   end
@@ -65,16 +65,16 @@ module Mac::Group
   #
   # @param [String] name Name of the group
   # @param [Proc] block Additional actions or insertions
-  def group_present(name, &block)
+  def group_present(name)
     group_exists = false
     execute("dscacheutil -q group -a name #{name}") do |result|
-      group_exists = result.stdout =~  /^name: #{name}/
+      group_exists = result.stdout.start_with?("name: #{name}")
     end
 
     return if group_exists
 
     gid = gid_next
-    create_cmd  =     "dscl . create /Groups/#{name}"
+    create_cmd = "dscl . create /Groups/#{name}"
     create_cmd << " && dscl . create /Groups/#{name} PrimaryGroupID #{gid}"
     execute(create_cmd)
   end

data/lib/beaker/host/mac/pkg.rb

@@ -5,7 +5,7 @@ module Mac::Pkg
     raise "Package #{name} cannot be queried on #{self}"
   end
 
-  def install_package(name, cmdline_args = '', version = nil)
+  def install_package(name, _cmdline_args = '', _version = nil)
     generic_install_dmg("#{name}.dmg", name, "#{name}.pkg")
   end
 
@@ -28,7 +28,7 @@ module Mac::Pkg
     execute("installer -pkg /Volumes/#{pkg_base}/#{pkg_name} -target /")
   end
 
-  def uninstall_package(name, cmdline_args = '')
+  def uninstall_package(name, _cmdline_args = '')
     raise "Package #{name} cannot be uninstalled on #{self}"
   end
 
@@ -37,117 +37,14 @@ module Mac::Pkg
   # @param [String] name          The name of the package to update
   # @param [String] cmdline_args  Additional command line arguments for
   #                               the package manager
-  def upgrade_package(name, cmdline_args = '')
-      raise "Package #{name} cannot be upgraded on #{self}"
+  def upgrade_package(name, _cmdline_args = '')
+    raise "Package #{name} cannot be upgraded on #{self}"
   end
 
-  # Deploy configuration generated by the packaging tooling to this host.
-  #
-  # This method calls one of #deploy_apt_repo, #deploy_yum_repo, or
-  # #deploy_zyp_repo depending on the platform of this Host.
-  #
-  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
-  #       params
-  def deploy_package_repo(path, name, version)
-    raise "Package repo cannot be deployed on #{self}; the platform is not supported"
-  end
-
-  #Examine the host system to determine the architecture
-  #@return [Boolean] true if x86_64, false otherwise
+  # Examine the host system to determine the architecture
+  # @return [Boolean] true if x86_64, false otherwise
   def determine_if_x86_64
     result = exec(Beaker::Command.new("uname -a | grep x86_64"), :expect_all_exit_codes => true)
     result.exit_code == 0
   end
-
-  # Gets the path & file name for the puppet agent dev package on OSX
-  #
-  # @param [String] puppet_collection Name of the puppet collection to use
-  # @param [String] puppet_agent_version Version of puppet agent to get
-  # @param [Hash{Symbol=>String}] opts Options hash to provide extra values
-  #
-  # @note OSX does require :download_url to be set on the opts argument
-  #   in order to check for builds on the builds server
-  #
-  # @raise [ArgumentError] If one of the two required parameters (puppet_collection,
-  #   puppet_agent_version) is either not passed or set to nil
-  #
-  # @return [String, String] Path to the directory and filename of the package, respectively
-  def puppet_agent_dev_package_info( puppet_collection = nil, puppet_agent_version = nil, opts = {} )
-    error_message = "Must provide %s argument to get puppet agent dev package information"
-    raise ArgumentError, error_message % "puppet_collection" unless puppet_collection
-    raise ArgumentError, error_message % "puppet_agent_version" unless puppet_agent_version
-    raise ArgumentError, error_message % "opts[:download_url]" unless opts[:download_url]
-
-    variant, version, arch, codename = self['platform'].to_array
-
-    mac_pkg_name = "puppet-agent-#{puppet_agent_version}"
-    version = version[0,2] + '.' + version[2,2] unless version.include?(".")
-    # newest hotness
-    path_chunk = "apple/#{version}/#{puppet_collection}/#{arch}"
-    release_path_end = path_chunk
-    # moved to doing this when 'el capitan' came out & the objection was
-    # raised that the code name wasn't a fact, & as such can be hard to script
-    # example: puppet-agent-0.1.0-1.osx10.9.dmg
-    release_file = "#{mac_pkg_name}-1.osx#{version}.dmg"
-    if not link_exists?("#{opts[:download_url]}/#{release_path_end}/#{release_file}") # new hotness
-      # little older change involved the code name as only difference from above
-      # example: puppet-agent-0.1.0-1.mavericks.dmg
-      release_file = "#{mac_pkg_name}-1.#{codename}.dmg"
-    end
-    if not link_exists?("#{opts[:download_url]}/#{release_path_end}/#{release_file}") # oops, try the old stuff
-      release_path_end = "apple/#{puppet_collection}"
-      # example: puppet-agent-0.1.0-osx-10.9-x86_64.dmg
-      release_file = "#{mac_pkg_name}-#{variant}-#{version}-x86_64.dmg"
-    end
-    return release_path_end, release_file
-  end
-
-  # Gets host-specific information for PE promoted puppet-agent packages
-  #
-  # @param [String] puppet_collection Name of the puppet collection to use
-  # @param [Hash{Symbol=>String}] opts Options hash to provide extra values
-  #
-  # @return [String, String, String] Host-specific information for packages
-  #   1. release_path_end Suffix for the release_path. Used on Windows. Check
-  #   {Windows::Pkg#pe_puppet_agent_promoted_package_info} to see usage.
-  #   2. release_file Path to the file on release build servers
-  #   3. download_file Filename for the package itself
-  def pe_puppet_agent_promoted_package_info( puppet_collection = nil, opts = {} )
-    error_message = "Must provide %s argument to get puppet agent dev package information"
-    raise ArgumentError, error_message % "puppet_collection" unless puppet_collection
-
-    variant, version, arch, codename = self['platform'].to_array
-    release_file = "/repos/apple/#{version}/#{puppet_collection}/#{arch}/puppet-agent-*"
-
-    # macOS puppet-agent tarballs haven't always included arch
-    agent_version = opts[:puppet_agent_version]
-    agent_version_f = agent_version&.to_f
-
-    download_file = if agent_version_f.nil? || (agent_version_f < 6.28 || (agent_version_f >= 7.0 && agent_version_f < 7.18))
-                      "puppet-agent-#{variant}-#{version}.tar.gz"
-                    else
-                      "puppet-agent-#{variant}-#{version}-#{arch}.tar.gz"
-                    end
-
-    return '', release_file, download_file
-  end
-
-  # Installs a given PE promoted package on a host
-  #
-  # @param [String] onhost_copy_base Base copy directory on the host
-  # @param [String] onhost_copied_download Downloaded file path on the host
-  # @param [String] onhost_copied_file Copied file path once un-compressed
-  # @param [String] download_file File name of the downloaded file
-  # @param [Hash{Symbol=>String}] opts additional options
-  #
-  # @return nil
-  def pe_puppet_agent_promoted_package_install(
-    onhost_copy_base, onhost_copied_download, onhost_copied_file, download_file, opts
-  )
-    execute("tar -zxvf #{onhost_copied_download} -C #{onhost_copy_base}")
-    # move to better location
-    execute("mv #{onhost_copied_file}.dmg .")
-    self.install_package("puppet-agent-*")
-  end
-
 end

data/lib/beaker/host/mac/user.rb

@@ -6,11 +6,11 @@ module Mac::User
   # @param [Proc] block Additional actions or insertions
   #
   # @return [Array<String>] The list of user names on the system
-  def user_list(&block)
+  def user_list
     execute('dscacheutil -q user') do |result|
       users = []
       result.stdout.each_line do |line|
-        users << line.split(': ')[1].strip if line =~ /^name:/
+        users << line.split(': ')[1].strip if /^name:/.match?(line)
       end
 
       yield result if block_given?
@@ -31,9 +31,9 @@ module Mac::User
   # @return [Result] User information in /etc/passwd format
   # @raise [FailTest] Raises an Assertion failure if it can't find the name
   #                   queried for in the returned block
-  def user_get(name, &block)
+  def user_get(name)
     execute("id -P #{name}") do |result|
-      fail_test "failed to get user #{name}" unless result.stdout =~  /^#{name}:/
+      fail_test "failed to get user #{name}" unless /^#{name}:/.match?(result.stdout)
 
       yield result if block_given?
       result
@@ -44,17 +44,17 @@ module Mac::User
   #
   # @param [String] name Name of the user
   # @param [Proc] block Additional actions or insertions
-  def user_present(name, &block)
+  def user_present(name)
     user_exists = false
     execute("dscacheutil -q user -a name #{name}") do |result|
-       user_exists = result.stdout =~  /^name: #{name}/
+      user_exists = result.stdout.start_with?("name: #{name}")
     end
 
     return if user_exists
 
     uid = uid_next
     gid = gid_next
-    create_cmd  =     "dscl . create /Users/#{name}"
+    create_cmd = "dscl . create /Users/#{name}"
     create_cmd << " && dscl . create /Users/#{name} NFSHomeDirectory /Users/#{name}"
     create_cmd << " && dscl . create /Users/#{name} UserShell /bin/bash"
     create_cmd << " && dscl . create /Users/#{name} UniqueID #{uid}"

data/lib/beaker/host/mac.rb

@@ -1,11 +1,10 @@
-[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
+%w[host command_factory command options].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Mac
-    class Host < Unix::Host
-
-    [ 'exec', 'user', 'group', 'pkg' ].each do |lib|
+  class Host < Unix::Host
+    %w[exec user group pkg].each do |lib|
       require "beaker/host/mac/#{lib}"
     end
 
@@ -17,18 +16,18 @@ module Mac
     def platform_defaults
       h = Beaker::Options::OptionsHash.new
       h.merge({
-        'user'             => 'root',
-        'group'            => 'root',
-        'pathseparator'    => ':',
-      })
+                'user' => 'root',
+                'group' => 'root',
+                'pathseparator' => ':',
+              })
     end
 
     attr_reader :external_copy_base
+
     def initialize name, host_hash, options
       super
 
       @external_copy_base = '/var/root'
     end
-
   end
 end