beaker 2.33.0 → 2.34.0

data/lib/beaker/dsl/helpers/host_helpers.rb

@@ -61,16 +61,21 @@ module Beaker
         # @raise  [FailTest] Raises an exception if *command* obviously fails.
         def on(host, command, opts = {}, &block)
           block_on host do | host |
-            cur_command = command
-            if command.is_a? Command
-              cur_command = command.cmd_line(host)
-            end
-            cmd_opts = {}
-            #add any additional environment variables to the command
-            if opts[:environment]
-              cmd_opts['ENV'] = opts[:environment]
+            if command.is_a? String
+              cmd_opts = {}
+              #add any additional environment variables to the command
+              if opts[:environment]
+                cmd_opts['ENV'] = opts[:environment]
+              end
+              command_object = Command.new(command.to_s, [], cmd_opts)
+            elsif command.is_a? Command
+              command_object = command
+            else
+              msg = "DSL method `on` can only be called with a String or Beaker::Command"
+              msg << " object as the command parameter, not #{command.class}."
+              raise ArgumentError, msg
             end
-            @result = host.exec(Command.new(cur_command.to_s, [], cmd_opts), opts)
+            @result = host.exec(command_object, opts)
 
             # Also, let additional checking be performed by the caller.
             if block_given?

data/lib/beaker/dsl/install_utils/foss_utils.rb

@@ -333,7 +333,7 @@ module Beaker
             add_role(host, 'aio') #we are installing agent, so we want aio role
             package_name = nil
             case host['platform']
-            when /el-|fedora|sles|centos/
+            when /el-|fedora|sles|centos|cisco-/
               package_name = 'puppet-agent'
               package_name << "-#{opts[:puppet_agent_version]}" if opts[:puppet_agent_version]
             when /debian|ubuntu|cumulus/
@@ -393,30 +393,18 @@ module Beaker
         #
         # @return nil
         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}"
+          puppet_conf_text = ''
+          opts.each do |section,options|
+            puppet_conf_text << "[#{section}]\n"
+            options.each do |option,value|
+              puppet_conf_text << "#{option}=#{value}\n"
             end
+            puppet_conf_text << "\n"
+          end
+          logger.debug( "setting config '#{puppet_conf_text}' on hosts #{hosts}" )
+          block_on hosts do |host|
+            puppet_conf_path = host.puppet['config']
+            create_remote_file(host, puppet_conf_path, puppet_conf_text)
           end
         end
 
@@ -854,13 +842,19 @@ module Beaker
             opts = FOSS_DEFAULT_DOWNLOAD_URLS.merge(opts)
 
             case variant
-            when /^(fedora|el|centos|sles)$/
-              variant = (($1 == 'centos') ? 'el' : $1)
+            when /^(fedora|el|centos|sles|cisco)$/
+              variant_url_value = (($1 == 'centos') ? 'el' : $1)
+              variant_url_value = 'cisco-wrlinux' if variant == 'cisco'
               remote = "%s/puppetlabs-release%s-%s-%s.noarch.rpm" %
-                [opts[:release_yum_repo_url], repo_name, variant, version]
+                [opts[:release_yum_repo_url], repo_name, variant_url_value, version]
 
-              host.install_package_with_rpm(remote, '--replacepkgs',
-                {:package_proxy => opts[:package_proxy]})
+              if variant == 'cisco'
+                # cisco requires using yum to install the repo
+                host.install_package( remote )
+              else
+                host.install_package_with_rpm( remote, '--replacepkgs',
+                  { :package_proxy => opts[:package_proxy] } )
+              end
 
             when /^(debian|ubuntu|cumulus)$/
               deb = "puppetlabs-release%s-%s.deb" % [repo_name, codename]
@@ -895,7 +889,13 @@ module Beaker
           repo = fetch_http_file( repo_config_folder_url,
                                   repo_filename,
                                   copy_dir )
-          scp_to( host, repo, host.package_config_dir )
+
+          if host[:platform] =~ /cisco-5/
+            to_path = "#{host.package_config_dir}/#{File.basename(repo)}"
+          else
+            to_path = host.package_config_dir
+          end
+          scp_to( host, repo, to_path )
 
           on( host, 'apt-get update' ) if host['platform'] =~ /ubuntu-|debian-|cumulus-/
           nil
@@ -932,7 +932,7 @@ module Beaker
                                   repo_configs_dir = nil,
                                   opts = options )
           variant, version, arch, codename = host['platform'].to_array
-          if variant !~ /^(fedora|el|centos|debian|ubuntu|cumulus)$/
+          if variant !~ /^(fedora|el|centos|debian|ubuntu|cumulus|cisco)$/
             raise "No repository installation step for #{variant} yet..."
           end
           repo_configs_dir ||= 'tmp/repo_configs'
@@ -1029,7 +1029,7 @@ module Beaker
             onhost_copy_base = opts[:copy_dir_external]
 
             case variant
-            when /^(fedora|el|centos|debian|ubuntu|cumulus)$/
+            when /^(fedora|el|centos|debian|ubuntu|cumulus|cisco)$/
               sha = opts[:puppet_agent_sha] || opts[:puppet_agent_version]
               opts[:dev_builds_repos] ||= [ opts[:puppet_collection] ]
               install_puppetlabs_dev_repo( host, 'puppet-agent', sha, nil, opts )

data/lib/beaker/host.rb

@@ -57,6 +57,8 @@ module Beaker
         FreeBSD::Host.new name, host_hash, options
       when /eos/
         Eos::Host.new name, host_hash, options
+      when /cisco/
+        Cisco::Host.new name, host_hash, options
       else
         Unix::Host.new name, host_hash, options
       end
@@ -331,7 +333,7 @@ module Beaker
     # to that source dir.
     #
     # @param source [String] The path to the file/dir to upload
-    # @param target [String] The destination path on the host
+    # @param target_path [String] The destination path on the host
     # @param options [Hash{Symbol=>String}] Options to alter execution
     # @option options [Array<String>] :ignore An array of file/dir paths that will not be copied to the host
     # @example
@@ -340,8 +342,8 @@ module Beaker
     #
     #   do_scp_to('source/file.rb', 'target', { :ignore => 'file.rb' }
     #   -> will result in not files copyed to the host, all are ignored
-    def do_scp_to source, target, options
-      target = self.scp_path(target)
+    def do_scp_to source, target_path, options
+      target = self.scp_path( target_path )
       @logger.notify "localhost $ scp #{source} #{@name}:#{target} {:ignore => #{options[:ignore]}}"
 
       result = Result.new(@name, [source, target])
@@ -409,6 +411,7 @@ module Beaker
         end
       end
 
+      self.scp_post_operations( target, target_path )
       return result
     end
 
@@ -510,6 +513,7 @@ module Beaker
     'windows',
     'pswindows',
     'eos',
+    'cisco',
   ].each do |lib|
     require "beaker/host/#{lib}"
   end

data/lib/beaker/host/cisco.rb

@@ -0,0 +1,124 @@
+[ 'host', 'command_factory' ].each do |lib|
+  require "beaker/#{lib}"
+end
+
+module Cisco
+  class Host < Unix::Host
+
+    # Tells you whether a host platform supports beaker's
+    #   {Beaker::HostPrebuiltSteps#set_env} method
+    #
+    # @return [String,nil] Reason message if set_env should be skipped,
+    #   nil if it should run.
+    def skip_set_env?
+      'Cisco does not allow SSH control through the BASH shell'
+    end
+
+    # Handles host operations needed after an SCP takes place
+    #
+    # @param [String] scp_file_actual File path to actual SCP'd file on host
+    # @param [String] scp_file_target File path to target SCP location on host
+    #
+    # @return nil
+    def scp_post_operations(scp_file_actual, scp_file_target)
+      if self[:platform] =~ /cisco-5/
+        execute( "mv #{scp_file_actual} #{scp_file_target}" )
+      end
+      nil
+    end
+
+    # Handles any changes needed in a path for SCP
+    #
+    # @param [String] path File path to SCP to
+    #
+    # @return [String] path, changed if needed due to host
+    #   constraints
+    def scp_path(path)
+      if self[:platform] =~ /cisco-5/
+        @home_dir ||= execute( 'pwd' )
+        answer = "#{@home_dir}/#{File.basename( path )}"
+        answer << '/' if path =~ /\/$/
+        return answer
+      end
+      path
+    end
+
+    # Gets the repo type for the given platform
+    #
+    # @raise [ArgumentError] For an unknown platform
+    #
+    # @return [String] Type of repo (rpm|deb)
+    def repo_type
+      'rpm'
+    end
+
+    # Gets the config dir location for package information
+    #
+    # @raise [ArgumentError] For an unknown platform
+    #
+    # @return [String] Path to package config dir
+    def package_config_dir
+      '/etc/yum/repos.d/'
+    end
+
+    # Gets the specific prepend commands as needed for this host
+    #
+    # @param [String] command Command to be executed
+    # @param [String] user_pc List of user-specified commands to prepend
+    # @param [Hash] opts optional parameters
+    #
+    # @return [String] Command string as needed for this host
+    def prepend_commands(command = '', user_pc = '', opts = {})
+      return user_pc unless command.index('vsh').nil?
+
+      prepend_cmds = 'source /etc/profile;'
+      if self[:platform] =~ /cisco-5/
+        prepend_cmds << ' sudo ip netns exec '
+        prepend_cmds << ( self[:vrf] ? self[:vrf] : '' )
+      end
+      return prepend_cmds
+    end
+
+    # Construct the environment string for this command
+    #
+    # @param [Hash{String=>String}] env   An optional Hash containing
+    #                                     key-value pairs to be treated
+    #                                     as environment variables that
+    #                                     should be set for the duration
+    #                                     of the puppet command.
+    #
+    # @return [String] Returns a string containing command line arguments that
+    #                  will ensure the environment is correctly set for the
+    #                  given host.
+    def environment_string env
+      return '' if env.empty?
+      env_array = self.environment_variable_string_pair_array( env )
+      environment_string = env_array.join(' ')
+
+      command = self[:platform] =~ /cisco-5/ ? 'export' : 'env'
+      "#{command} #{environment_string};"
+    end
+
+    # Validates that the host was setup correctly
+    #
+    # @return nil
+    # @raise [ArgumentError] If the host is setup incorrectly,
+    #   this will be raised with the appropriate message
+    def validate_setup
+      msg = nil
+      msg = 'Cisco hosts must be provided with a :vrf value.' unless self[:vrf]
+
+      if !msg && self[:platform] =~ /cisco-5/ && self[:user] == 'root'
+        msg = 'Cisco-5 hosts must be provided with a :user value, as they can not SSH in as root.'
+      end
+
+      if msg
+        msg << <<-EOF
+          Check https://github.com/puppetlabs/beaker/blob/master/docs/hosts/cisco.md for more info.'
+        EOF
+        raise ArgumentError, msg
+      end
+    end
+
+  end
+end

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

@@ -148,6 +148,17 @@ module PSWindows::Exec
     self.close #refresh the state
   end
 
+  def environment_string env
+    return '' if env.empty?
+    env_array = self.environment_variable_string_pair_array( env )
+
+    environment_string = ''
+    env_array.each_with_index do |env|
+      environment_string += "set #{env} && "
+    end
+    environment_string
+  end
+
   # Overrides the {Windows::Exec#ssh_permit_user_environment} method,
   # since no steps are needed in this setup to allow user ssh environments
   # to work.

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

@@ -5,7 +5,7 @@ module PSWindows::User
     execute('cmd /c echo "" | wmic useraccount where localaccount="true" get name /format:value') do |result|
       users = []
       result.stdout.each_line do |line|
-        users << (line.match(/^Name=([\w ]+)/) or next)[1]
+        users << (line.match(/^Name=(.+)/) or next)[1]
       end
 
       yield result if block_given?

data/lib/beaker/host/unix.rb

@@ -146,8 +146,6 @@ module Unix
     def skip_set_env?
       variant, version, arch, codename = self['platform'].to_array
       case variant
-      when /^cisco$/
-        'Cisco does not allow SSH control through the BASH shell'
       when /^(f5|netscaler)$/
         "no puppet-agent package for network device platform '#{variant}'"
       else
@@ -155,6 +153,15 @@ module Unix
       end
     end
 
+    # Validates that the host was setup correctly
+    #
+    # @return nil
+    # @raise [ArgumentError] If the host is setup incorrectly,
+    #   this will be raised with the appropriate message
+    def validate_setup
+      nil
+    end
+
     def initialize name, host_hash, options
       super
 

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

@@ -219,6 +219,49 @@ module Unix::Exec
     ssh_service_restart()
   end
 
+  # Construct the environment string for this command
+  #
+  # @param [Hash{String=>String}] env   An optional Hash containing
+  #                                     key-value pairs to be treated
+  #                                     as environment variables that
+  #                                     should be set for the duration
+  #                                     of the puppet command.
+  #
+  # @return [String] Returns a string containing command line arguments that
+  #                  will ensure the environment is correctly set for the
+  #                  given host.
+  def environment_string env
+    return '' if env.empty?
+    env_array = self.environment_variable_string_pair_array( env )
+    environment_string = env_array.join(' ')
+    "env #{environment_string}"
+  end
+
+  def environment_variable_string_pair_array env
+    env_array = []
+    env.each_key do |key|
+      val = env[key]
+      if val.is_a?(Array)
+        val = val.join(':')
+      else
+        val = val.to_s
+      end
+      env_array << "#{key.to_s.upcase}=\"#{val}\""
+    end
+    env_array
+  end
+
+  # Gets the specific prepend commands as needed for this host
+  #
+  # @param [String] command Command to be executed
+  # @param [String] user_pc List of user-specified commands to prepend
+  # @param [Hash] opts optional parameters
+  #
+  # @return [String] Command string as needed for this host
+  def prepend_commands(command = '', user_pc = '', opts = {})
+    user_pc
+  end
+
   # Fills the user SSH environment file.
   #
   # @param [Hash{String=>String}] env Environment variables to set on the system,

data/lib/beaker/host/unix/file.rb

@@ -15,9 +15,11 @@ module Unix::File
 
   # Handles any changes needed in a path for SCP
   #
-  # @note This is really only needed in Windows at this point. Refer to
-  #   {Windows::File#scp_path} for more info
-  def scp_path path
+  # @param [String] path File path to SCP to
+  #
+  # @return [String] path, changed if needed due to host
+  #   constraints
+  def scp_path(path)
     path
   end
 
@@ -60,8 +62,9 @@ module Unix::File
     repo_filename = "pl-%s-%s-" % [ package_name, build_version ]
 
     case variant
-    when /fedora|el|centos/
+    when /fedora|el|centos|cisco/
       variant = 'el' if variant == 'centos'
+      variant = 'cisco-wrlinux' if variant == 'cisco'
       fedora_prefix = ((variant == 'fedora') ? 'f' : '')
       pattern = "%s-%s%s-%s.repo"
       pattern = "repos-pe-#{pattern}" if self.is_pe?
@@ -144,4 +147,16 @@ NOASK
     end
     noask
   end
+
+  protected
+
+  # Handles host operations needed after an SCP takes place
+  #
+  # @param [String] scp_file_actual File path to actual SCP'd file on host
+  # @param [String] scp_file_target File path to target SCP location on host
+  #
+  # @return nil
+  def scp_post_operations(scp_file_actual, scp_file_target)
+    nil
+  end
 end