train 2.1.7 → 2.1.13

data/lib/train/transports/ssh.rb

@@ -18,9 +18,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/ssh'
-require 'net/scp'
-require 'train/errors'
+require "net/ssh"
+require "net/scp"
+require "train/errors"
 
 module Train::Transports
   # Wrapped exception for any internally raised SSH-related errors.
@@ -34,10 +34,10 @@ module Train::Transports
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class SSH < Train.plugin(1) # rubocop:disable Metrics/ClassLength
-    name 'ssh'
+    name "ssh"
 
-    require 'train/transports/ssh_connection'
-    require 'train/transports/cisco_ios_connection'
+    require "train/transports/ssh_connection"
+    require "train/transports/cisco_ios_connection"
 
     # add options for submodules
     include_options Train::Extras::CommandWrapper
@@ -45,7 +45,7 @@ module Train::Transports
     # common target configuration
     option :host,      required: true
     option :port,      default: 22, required: true
-    option :user,      default: 'root', required: true
+    option :user,      default: "root", required: true
     option :key_files, default: nil
     option :password,  default: nil
 
@@ -60,7 +60,7 @@ module Train::Transports
     option :pty, default: false
     option :proxy_command, default: nil
     option :bastion_host, default: nil
-    option :bastion_user, default: 'root'
+    option :bastion_user, default: "root"
     option :bastion_port, default: 22
     option :non_interactive, default: false
     option :verify_host_key, default: false
@@ -89,34 +89,34 @@ module Train::Transports
       super(options)
 
       key_files = Array(options[:key_files])
-      options[:auth_methods] ||= ['none']
+      options[:auth_methods] ||= ["none"]
 
       unless key_files.empty?
-        options[:auth_methods].push('publickey')
+        options[:auth_methods].push("publickey")
         options[:keys_only] = true if options[:password].nil?
         options[:key_files] = key_files
       end
 
       unless options[:password].nil?
-        options[:auth_methods].push('password', 'keyboard-interactive')
+        options[:auth_methods].push("password", "keyboard-interactive")
       end
 
-      if options[:auth_methods] == ['none']
+      if options[:auth_methods] == ["none"]
         if ssh_known_identities.empty?
-          fail Train::ClientError,
-               'Your SSH Agent has no keys added, and you have not specified a password or a key file'
+          raise Train::ClientError,
+               "Your SSH Agent has no keys added, and you have not specified a password or a key file"
         else
-          logger.debug('[SSH] Using Agent keys as no password or key file have been specified')
-          options[:auth_methods].push('publickey')
+          logger.debug("[SSH] Using Agent keys as no password or key file have been specified")
+          options[:auth_methods].push("publickey")
         end
       end
 
       if options[:pty]
-        logger.warn('[SSH] PTY requested: stderr will be merged into stdout')
+        logger.warn("[SSH] PTY requested: stderr will be merged into stdout")
       end
 
       if [options[:proxy_command], options[:bastion_host]].all? { |type| !type.nil? }
-        fail Train::ClientError, 'Only one of proxy_command or bastion_host needs to be specified'
+        raise Train::ClientError, "Only one of proxy_command or bastion_host needs to be specified"
       end
 
       super
@@ -142,30 +142,30 @@ module Train::Transports
     # @api private
     def connection_options(opts)
       connection_options = {
-        logger:                 logger,
-        user_known_hosts_file:  '/dev/null',
-        hostname:               opts[:host],
-        port:                   opts[:port],
-        username:               opts[:user],
-        compression:            opts[:compression],
-        compression_level:      opts[:compression_level],
-        keepalive:              opts[:keepalive],
-        keepalive_interval:     opts[:keepalive_interval],
-        timeout:                opts[:connection_timeout],
-        connection_retries:     opts[:connection_retries],
+        logger: logger,
+        user_known_hosts_file: "/dev/null",
+        hostname: opts[:host],
+        port: opts[:port],
+        username: opts[:user],
+        compression: opts[:compression],
+        compression_level: opts[:compression_level],
+        keepalive: opts[:keepalive],
+        keepalive_interval: opts[:keepalive_interval],
+        timeout: opts[:connection_timeout],
+        connection_retries: opts[:connection_retries],
         connection_retry_sleep: opts[:connection_retry_sleep],
-        max_wait_until_ready:   opts[:max_wait_until_ready],
-        auth_methods:           opts[:auth_methods],
-        keys_only:              opts[:keys_only],
-        keys:                   opts[:key_files],
-        password:               opts[:password],
-        forward_agent:          opts[:forward_agent],
-        proxy_command:          opts[:proxy_command],
-        bastion_host:           opts[:bastion_host],
-        bastion_user:           opts[:bastion_user],
-        bastion_port:           opts[:bastion_port],
-        non_interactive:        opts[:non_interactive],
-        transport_options:      opts,
+        max_wait_until_ready: opts[:max_wait_until_ready],
+        auth_methods: opts[:auth_methods],
+        keys_only: opts[:keys_only],
+        keys: opts[:key_files],
+        password: opts[:password],
+        forward_agent: opts[:forward_agent],
+        proxy_command: opts[:proxy_command],
+        bastion_host: opts[:bastion_host],
+        bastion_user: opts[:bastion_user],
+        bastion_port: opts[:bastion_port],
+        non_interactive: opts[:non_interactive],
+        transport_options: opts,
       }
       # disable host key verification. The hash key and value to use
       # depends on the version of net-ssh in use.
@@ -203,20 +203,20 @@ module Train::Transports
         # 5.0+ style
         {
           # It's not a boolean anymore.
-          'true' => :always,
-          'false' => :never,
+          "true" => :always,
+          "false" => :never,
           true => :always,
           false => :never,
           # May be correct value, but strings from JSON config
-          'always' => :always,
-          'never' => :never,
+          "always" => :always,
+          "never" => :never,
           nil => :never,
         }.fetch(given, given)
       else
         # up to 4.2 style
         {
-          'true' => true,
-          'false' => false,
+          "true" => true,
+          "false" => false,
           nil => false,
         }.fetch(given, given)
       end

data/lib/train/transports/ssh_connection.rb

@@ -18,9 +18,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/ssh'
-require 'net/scp'
-require 'timeout'
+require "net/ssh"
+require "net/scp"
+require "timeout"
 
 class Train::Transports::SSH
   # A Connection instance can be generated and re-generated, given new
@@ -63,17 +63,17 @@ class Train::Transports::SSH
     end
 
     def ssh_opts
-      level = logger.debug? ? 'VERBOSE' : 'ERROR'
-      fwd_agent = options[:forward_agent] ? 'yes' : 'no'
+      level = logger.debug? ? "VERBOSE" : "ERROR"
+      fwd_agent = options[:forward_agent] ? "yes" : "no"
 
       args  = %w{ -o UserKnownHostsFile=/dev/null }
       args += %w{ -o StrictHostKeyChecking=no }
       args += %w{ -o IdentitiesOnly=yes } if options[:keys]
       args += %w{ -o BatchMode=yes } if options[:non_interactive]
-      args += %W( -o LogLevel=#{level} )
-      args += %W( -o ForwardAgent=#{fwd_agent} ) if options.key?(:forward_agent)
+      args += %W{ -o LogLevel=#{level} }
+      args += %W{ -o ForwardAgent=#{fwd_agent} } if options.key?(:forward_agent)
       Array(options[:keys]).each do |ssh_key|
-        args += %W( -i #{ssh_key} )
+        args += %W{ -i #{ssh_key} }
       end
       args
     end
@@ -86,19 +86,19 @@ class Train::Transports::SSH
       return @proxy_command unless @proxy_command.nil?
       args = %w{ ssh }
       args += ssh_opts
-      args += %W( #{@bastion_user}@#{@bastion_host} )
-      args += %W( -p #{@bastion_port} )
+      args += %W{ #{@bastion_user}@#{@bastion_host} }
+      args += %W{ -p #{@bastion_port} }
       args += %w{ -W %h:%p }
-      args.join(' ')
+      args.join(" ")
     end
 
     # (see Base::Connection#login_command)
     def login_command
       args = ssh_opts
-      args += %W( -o ProxyCommand='#{generate_proxy_command}' ) if check_proxy
-      args += %W( -p #{@port} )
-      args += %W( #{@username}@#{@hostname} )
-      LoginCommand.new('ssh', args)
+      args += %W{ -o ProxyCommand='#{generate_proxy_command}' } if check_proxy
+      args += %W{ -p #{@port} }
+      args += %W{ #{@username}@#{@hostname} }
+      LoginCommand.new("ssh", args)
     end
 
     # (see Base::Connection#upload)
@@ -138,7 +138,7 @@ class Train::Transports::SSH
         retries: @max_wait_until_ready / delay,
         delay:   delay,
         message: "Waiting for SSH service on #{@hostname}:#{@port}, " \
-                 "retrying in #{delay} seconds",
+                 "retrying in #{delay} seconds"
       )
       run_command(PING_COMMAND.dup)
     end
@@ -172,14 +172,14 @@ class Train::Transports::SSH
     def establish_connection(opts)
       logger.debug("[SSH] opening connection to #{self}")
       if check_proxy
-        require 'net/ssh/proxy/command'
+        require "net/ssh/proxy/command"
         @options[:proxy] = Net::SSH::Proxy::Command.new(generate_proxy_command)
       end
       Net::SSH.start(@hostname, @username, @options.clone.delete_if { |_key, value| value.nil? })
     rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH => e
       if (opts[:retries] -= 1) <= 0
         logger.warn("[SSH] connection failed, terminating (#{e.inspect})")
-        raise Train::Transports::SSHFailed, 'SSH session could not be established'
+        raise Train::Transports::SSHFailed, "SSH session could not be established"
       end
 
       if opts[:message]
@@ -200,7 +200,7 @@ class Train::Transports::SSH
         Train::File::Remote::Aix.new(self, path)
       elsif os.solaris?
         Train::File::Remote::Unix.new(self, path)
-      elsif os[:name] == 'qnx'
+      elsif os[:name] == "qnx"
         Train::File::Remote::Qnx.new(self, path)
       elsif os.windows?
         Train::File::Remote::Windows.new(self, path)
@@ -210,7 +210,7 @@ class Train::Transports::SSH
     end
 
     def run_command_via_connection(cmd, &data_handler)
-      cmd.dup.force_encoding('binary') if cmd.respond_to?(:force_encoding)
+      cmd.dup.force_encoding("binary") if cmd.respond_to?(:force_encoding)
       logger.debug("[SSH] #{self} (#{cmd})")
 
       reset_session if session.closed?
@@ -228,7 +228,7 @@ class Train::Transports::SSH
       # transport. This retries the command if this is the case.
       # See:
       #  https://github.com/inspec/train/pull/271
-      logger.debug('[SSH] Possible Cisco IOS race condition, retrying command')
+      logger.debug("[SSH] Possible Cisco IOS race condition, retrying command")
 
       # Only attempt retry up to 5 times to avoid infinite loop
       @ios_cmd_retries += 1
@@ -246,7 +246,7 @@ class Train::Transports::SSH
     def session(retry_options = {})
       @session ||= establish_connection({
         retries: @connection_retries.to_i,
-        delay:   @connection_retry_sleep.to_i,
+        delay: @connection_retry_sleep.to_i,
       }.merge(retry_options))
     end
 
@@ -260,7 +260,7 @@ class Train::Transports::SSH
     # @api private
     def to_s
       options_to_print = @options.clone
-      options_to_print[:password] = '<hidden>' if options_to_print.key?(:password)
+      options_to_print[:password] = "<hidden>" if options_to_print.key?(:password)
       "#{@username}@#{@hostname}<#{options_to_print.inspect}>"
     end
 
@@ -274,7 +274,7 @@ class Train::Transports::SSH
     #
     # @api private
     def execute_on_channel(cmd, &data_handler)
-      stdout = stderr = ''
+      stdout = stderr = ""
       exit_status = nil
       session.open_channel do |channel|
         # wrap commands if that is configured
@@ -282,11 +282,11 @@ class Train::Transports::SSH
 
         if @transport_options[:pty]
           channel.request_pty do |_ch, success|
-            fail Train::Transports::SSHPTYFailed, 'Requesting PTY failed' unless success
+            raise Train::Transports::SSHPTYFailed, "Requesting PTY failed" unless success
           end
         end
         channel.exec(cmd) do |_, success|
-          abort 'Couldn\'t execute command on SSH.' unless success
+          abort "Couldn't execute command on SSH." unless success
           channel.on_data do |_, data|
             yield(data) unless data_handler.nil?
             stdout += data
@@ -297,11 +297,11 @@ class Train::Transports::SSH
             stderr += data
           end
 
-          channel.on_request('exit-status') do |_, data|
+          channel.on_request("exit-status") do |_, data|
             exit_status = data.read_long
           end
 
-          channel.on_request('exit-signal') do |_, data|
+          channel.on_request("exit-signal") do |_, data|
             exit_status = data.read_long
           end
         end

data/lib/train/transports/vmware.rb

@@ -1,16 +1,16 @@
 # encoding: utf-8
-require 'train/plugins'
-require 'open3'
-require 'ostruct'
-require 'json'
-require 'mkmf'
+require "train/plugins"
+require "open3"
+require "ostruct"
+require "json"
+require "mkmf"
 
 module Train::Transports
   class VMware < Train.plugin(1)
-    name 'vmware'
-    option :viserver, default: ENV['VISERVER']
-    option :username, default: ENV['VISERVER_USERNAME']
-    option :password, default: ENV['VISERVER_PASSWORD']
+    name "vmware"
+    option :viserver, default: proc { ENV["VISERVER"]          }
+    option :username, default: proc { ENV["VISERVER_USERNAME"] }
+    option :password, default: proc { ENV["VISERVER_PASSWORD"] }
     option :insecure, default: false
 
     def connection(_ = nil)
@@ -18,7 +18,7 @@ module Train::Transports
     end
 
     class Connection < BaseConnection # rubocop:disable ClassLength
-      POWERSHELL_PROMPT_REGEX = /PS\s.*> $/
+      POWERSHELL_PROMPT_REGEX = /PS\s.*> $/.freeze
 
       def initialize(options)
         super(options)
@@ -29,18 +29,18 @@ module Train::Transports
         @username = options[:username]
         @viserver = options[:viserver]
         @session = nil
-        @stdout_buffer = ''
-        @stderr_buffer = ''
+        @stdout_buffer = ""
+        @stderr_buffer = ""
 
         @powershell_binary = detect_powershell_binary
 
         if @powershell_binary == :powershell
-          require 'train/transports/local'
+          require "train/transports/local"
           @powershell = Train::Transports::Local::Connection.new(options)
         end
 
         if options[:insecure] == true
-          run_command_via_connection('Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope Session -Confirm:$False')
+          run_command_via_connection("Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope Session -Confirm:$False")
         end
 
         @platform_details = {
@@ -58,11 +58,11 @@ module Train::Transports
           message = "Unable to connect to VIServer at #{options[:viserver]}. "
           case result.stderr
           when /Invalid server certificate/
-            message += 'Certification verification failed. Please use `--insecure` or set `Set-PowerCLIConfiguration -InvalidCertificateAction Ignore` in PowerShell'
+            message += "Certification verification failed. Please use `--insecure` or set `Set-PowerCLIConfiguration -InvalidCertificateAction Ignore` in PowerShell"
           when /incorrect user name or password/
-            message += 'Incorrect username or password'
+            message += "Incorrect username or password"
           else
-            message += result.stderr.gsub(/-Password .*\s/, '-Password REDACTED')
+            message += result.stderr.gsub(/-Password .*\s/, "-Password REDACTED")
           end
 
           raise message
@@ -70,7 +70,7 @@ module Train::Transports
       end
 
       def platform
-        force_platform!('vmware', @platform_details)
+        force_platform!("vmware", @platform_details)
       end
 
       def run_command_via_connection(cmd, &_data_handler)
@@ -78,8 +78,8 @@ module Train::Transports
           result = parse_pwsh_output(cmd)
 
           # Attach exit status to result
-          exit_status = parse_pwsh_output('echo $?').stdout.chomp
-          result.exit_status = exit_status == 'True' ? 0 : 1
+          exit_status = parse_pwsh_output("echo $?").stdout.chomp
+          result.exit_status = exit_status == "True" ? 0 : 1
 
           result
         else
@@ -88,7 +88,7 @@ module Train::Transports
       end
 
       def unique_identifier
-        uuid_command = '(Get-VMHost | Get-View).hardware.systeminfo.uuid'
+        uuid_command = "(Get-VMHost | Get-View).hardware.systeminfo.uuid"
         run_command_via_connection(uuid_command).stdout.chomp
       end
 
@@ -99,26 +99,24 @@ module Train::Transports
       private
 
       def detect_powershell_binary
-        if find_executable0('pwsh')
+        if find_executable0("pwsh")
           :pwsh
-        elsif find_executable0('powershell')
+        elsif find_executable0("powershell")
           :powershell
         else
-          raise 'Cannot find PowerShell binary, is `pwsh` installed?'
+          raise "Cannot find PowerShell binary, is `pwsh` installed?"
         end
       end
 
       # Read from stdout pipe until prompt is received
       def flush_stdout(pipe)
-        while @stdout_buffer !~ POWERSHELL_PROMPT_REGEX
-          @stdout_buffer += pipe.read_nonblock(1)
-        end
+        @stdout_buffer += pipe.read_nonblock(1) while @stdout_buffer !~ POWERSHELL_PROMPT_REGEX
         @stdout_buffer
       rescue IO::EAGAINWaitReadable
         # We cannot know when the stdout pipe is finished so we keep reading
         retry
       ensure
-        @stdout_buffer = ''
+        @stdout_buffer = ""
       end
 
       # This must be called after `flush_stdout` to ensure buffer is full
@@ -132,7 +130,7 @@ module Train::Transports
         # is unreadable.
         @stderr_buffer
       ensure
-        @stderr_buffer = ''
+        @stderr_buffer = ""
       end
 
       def parse_pwsh_output(cmd)
@@ -141,10 +139,10 @@ module Train::Transports
         stdout = flush_stdout(session.stdout)
 
         # Remove stdin from stdout (including trailing newline)
-        stdout.slice!(0, cmd.length+1)
+        stdout.slice!(0, cmd.length + 1)
 
         # Remove prompt from stdout
-        stdout.gsub!(POWERSHELL_PROMPT_REGEX, '')
+        stdout.gsub!(POWERSHELL_PROMPT_REGEX, "")
 
         # Grab stderr
         stderr = flush_stderr(session.stderr)
@@ -157,10 +155,10 @@ module Train::Transports
       end
 
       def powercli_version
-        version_command = '[string](Get-Module -Name VMware.PowerCLI -ListAvailable | Select -ExpandProperty Version)'
+        version_command = "[string](Get-Module -Name VMware.PowerCLI -ListAvailable | Select -ExpandProperty Version)"
         result = run_command_via_connection(version_command)
         if result.stdout.empty? || result.exit_status != 0
-          raise 'Unable to determine PowerCLI Module version, is it installed?'
+          raise "Unable to determine PowerCLI Module version, is it installed?"
         end
 
         result.stdout.chomp
@@ -169,7 +167,7 @@ module Train::Transports
       def session
         return @session unless @session.nil?
 
-        stdin, stdout, stderr = Open3.popen3('pwsh')
+        stdin, stdout, stderr = Open3.popen3("pwsh")
 
         # Remove leading prompt and intro text
         flush_stdout(stdout)