train 2.1.7 → 2.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '088cb00fd44675b8b74dc5ff07fd84bd8aae9ab59f4fb4137c6877453f7e5353'
-  data.tar.gz: 9a1caf9091b4acd6b042638a690fb5d4c75a4ac704b53a83ba602f32be80e90e
+  metadata.gz: c3f1acf1dad7c8f838071070a8d440d91d7ca2247ed58b30c9d2276efb9af120
+  data.tar.gz: ad583ee440c0e4b3ca19e719e333ab82f88ad8b0659b05b1a7ac19ab106496c6
 SHA512:
-  metadata.gz: 2b58c0f37eba0fb23bd5b507f609233adae32bfb6508449d5fea6c2eab0c727328d4d235cfabd9f921a7cba4aea485fe8d742a07f8bdd016140893963c5ba9b6
-  data.tar.gz: 054dcb57476a6e9d1b64bf9e7d505bd3030f26756f9017f411b1addec68a8c6d7c16f8f5031e5be0d7994c30ff1618a5dc7c5e0e0af903a806b677338e489f5e
+  metadata.gz: 81153fd511325cef5fc5d9ed031718c058b9a6330aecc49d22f9adced40493b5c7cad90b478a37e36751595fd4cc30aefc4d493bae076136d453d52343cfe1d9
+  data.tar.gz: 11f3b1494d0fc4e5971fa2f0112ac1320babe51a298952fd57d3bd9c00d2d73249f5b4eb4389e50cff269cefe1135f29f71957d6640337ee1e8756cfbd49c283

data/lib/train.rb

@@ -2,12 +2,12 @@
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
-require 'train/version'
-require 'train/options'
-require 'train/plugins'
-require 'train/errors'
-require 'train/platforms'
-require 'uri'
+require "train/version"
+require "train/options"
+require "train/plugins"
+require "train/errors"
+require "train/platforms"
+require "uri"
 
 module Train
   # Create a new transport instance, with the plugin indicated by the
@@ -42,12 +42,12 @@ module Train
     return transport_class unless transport_class.nil?
 
     # Try to load the transport name from the core transports...
-    require 'train/transports/' + transport_name
-    return Train::Plugins.registry[transport_name]
+    require "train/transports/" + transport_name
+    Train::Plugins.registry[transport_name]
   rescue LoadError => _
     begin
       # If it's not in the core transports, try loading from a train plugin gem.
-      gem_name = 'train-' + transport_name
+      gem_name = "train-" + transport_name
       require gem_name
       return Train::Plugins.registry[transport_name]
       # rubocop: disable Lint/HandleExceptions
@@ -92,7 +92,7 @@ module Train
 
     # split up the target's host/scheme configuration
     uri = parse_uri(uri_string)
-    unless uri.host.nil? and uri.scheme.nil?
+    unless uri.host.nil? && uri.scheme.nil?
       creds[:backend]  ||= uri.scheme
       creds[:host]     ||= uri.hostname
       creds[:port]     ||= uri.port
@@ -128,9 +128,9 @@ module Train
     # e.g. mock://. To do this, we match it manually and fake the hostname
     case string
     when %r{^([a-z]+)://$}
-      string += 'dummy'
+      string += "dummy"
     when /^([a-z]+):$/
-      string += '//dummy'
+      string += "//dummy"
     else
       raise Train::UserError, e
     end
@@ -144,15 +144,15 @@ module Train
   # Examine the given credential information, and if all is well,
   # return the transport name.
   # TODO: this actually does no validation of the credential options whatsoever
-  def self.validate_backend(credentials, default_transport_name = 'local')
+  def self.validate_backend(credentials, default_transport_name = "local")
     return default_transport_name if credentials.nil?
     transport_name = credentials[:backend]
 
     # TODO: Determine if it is ever possible (or supported) for transport_name to be 'localhost'
     # TODO: After inspec/inspec/pull/3750 is merged, should be able to remove nil from the list
-    if credentials[:sudo] && [nil, 'local', 'localhost'].include?(transport_name)
-      fail Train::UserError, 'Sudo is only valid when running against a remote host. '\
-        'To run this locally with elevated privileges, run the command with `sudo ...`.'
+    if credentials[:sudo] && [nil, "local", "localhost"].include?(transport_name)
+      raise Train::UserError, "Sudo is only valid when running against a remote host. "\
+        "To run this locally with elevated privileges, run the command with `sudo ...`."
     end
 
     return transport_name if !transport_name.nil?
@@ -160,13 +160,13 @@ module Train
     if !credentials[:target].nil?
       # We should not get here, because if target_uri unpacking was successful,
       # it would have set credentials[:backend]
-      fail Train::UserError, 'Cannot determine backend from target '\
+      raise Train::UserError, "Cannot determine backend from target "\
            "configuration #{credentials[:target]}. Valid example: ssh://192.168.0.1"
     end
 
     if !credentials[:host].nil?
-      fail Train::UserError, 'Host configured, but no backend was provided. Please '\
-           'specify how you want to connect. Valid example: ssh://192.168.0.1'
+      raise Train::UserError, "Host configured, but no backend was provided. Please "\
+           "specify how you want to connect. Valid example: ssh://192.168.0.1"
     end
 
     credentials[:backend] = default_transport_name
@@ -181,7 +181,7 @@ module Train
     conf[:key_files] = []
     conf[:keys] = []
     keys_mixed.each do |key|
-      if !key.nil? and File.file?(key)
+      if !key.nil? && File.file?(key)
         conf[:key_files].push(key)
       else
         conf[:keys].push(key)

data/lib/train/errors.rb

@@ -13,7 +13,7 @@ module Train
   class Error < ::StandardError
     attr_reader :reason
 
-    def initialize(message = '', reason = :not_provided)
+    def initialize(message = "", reason = :not_provided)
       super(message)
       @reason = reason
     end

data/lib/train/extras.rb

@@ -3,8 +3,8 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train::Extras
-  require 'train/extras/command_wrapper'
-  require 'train/extras/stat'
+  require "train/extras/command_wrapper"
+  require "train/extras/stat"
 
   CommandResult = Struct.new(:stdout, :stderr, :exit_status)
   LoginCommand = Struct.new(:command, :arguments)

data/lib/train/extras/command_wrapper.rb

@@ -2,8 +2,8 @@
 # author: Dominik Richter
 # author: Christoph Hartmann
 
-require 'base64'
-require 'train/errors'
+require "base64"
+require "train/errors"
 
 module Train::Extras
   # Define the interface of all command wrappers.
@@ -12,7 +12,7 @@ module Train::Extras
     #
     # @return [Any] verification result, nil if all went well, otherwise a message
     def verify
-      fail Train::ClientError, "#{self.class} does not implement #verify()"
+      raise Train::ClientError, "#{self.class} does not implement #verify()"
     end
 
     # Wrap a command and return the augmented command which can be executed.
@@ -20,7 +20,7 @@ module Train::Extras
     # @param [Strin] command that will be wrapper
     # @return [String] result of wrapping the command
     def run(_command)
-      fail Train::ClientError, "#{self.class} does not implement #run(command)"
+      raise Train::ClientError, "#{self.class} does not implement #run(command)"
     end
   end
 
@@ -53,20 +53,20 @@ module Train::Extras
 
     # (see CommandWrapperBase::verify)
     def verify
-      res = @backend.run_command(run('echo'))
+      res = @backend.run_command(run("echo"))
       return nil if res.exit_status == 0
-      rawerr = res.stdout + ' ' + res.stderr
+      rawerr = res.stdout + " " + res.stderr
 
       {
-        'Sorry, try again' => ['Wrong sudo password.', :bad_sudo_password],
-        'sudo: no tty present and no askpass program specified' =>
-          ['Sudo requires a password, please configure it.', :sudo_password_required],
-        'sudo: command not found' =>
+        "Sorry, try again" => ["Wrong sudo password.", :bad_sudo_password],
+        "sudo: no tty present and no askpass program specified" =>
+          ["Sudo requires a password, please configure it.", :sudo_password_required],
+        "sudo: command not found" =>
           ["Can't find sudo command. Please either install and "\
-            'configure it on the target or deactivate sudo.', :sudo_command_not_found],
-        'sudo: sorry, you must have a tty to run sudo' =>
-          ['Sudo requires a TTY. Please see the README on how to configure '\
-            'sudo to allow for non-interactive usage.', :sudo_no_tty],
+            "configure it on the target or deactivate sudo.", :sudo_command_not_found],
+        "sudo: sorry, you must have a tty to run sudo" =>
+          ["Sudo requires a TTY. Please see the README on how to configure "\
+            "sudo to allow for non-interactive usage.", :sudo_no_tty],
       }.each do |sudo, human|
         rawerr = human if rawerr.include? sudo
       end
@@ -91,13 +91,13 @@ module Train::Extras
     # wrap the cmd in a sudo command
     def sudo_wrap(cmd)
       return cmd unless @sudo
-      return cmd if @user == 'root'
+      return cmd if @user == "root"
 
-      res = (@sudo_command || 'sudo') + ' '
+      res = (@sudo_command || "sudo") + " "
 
       res = "#{safe_string(@sudo_password + "\n")} | #{res}-S " unless @sudo_password.nil?
 
-      res << @sudo_options.to_s + ' ' unless @sudo_options.nil?
+      res << @sudo_options.to_s + " " unless @sudo_options.nil?
 
       res + cmd
     end
@@ -107,8 +107,8 @@ module Train::Extras
     def shell_wrap(cmd)
       return cmd unless @shell
 
-      shell = @shell_command || '$SHELL'
-      options = ' ' + @shell_options.to_s unless @shell_options.nil?
+      shell = @shell_command || "$SHELL"
+      options = " " + @shell_options.to_s unless @shell_options.nil?
 
       "#{safe_string(cmd)} | #{shell}#{options}"
     end
@@ -143,13 +143,13 @@ module Train::Extras
 
     # Wrap the cmd in an encoded command to allow pipes and quotes
     def powershell_wrap(cmd)
-      shell = @shell_command || 'powershell'
+      shell = @shell_command || "powershell"
 
       # Prevent progress stream from leaking into stderr
       script = "$ProgressPreference='SilentlyContinue';" + cmd
 
       # Encode script so PowerShell can use it
-      script = script.encode('UTF-16LE', 'UTF-8')
+      script = script.encode("UTF-16LE", "UTF-8")
       base64_script = Base64.strict_encode64(script)
 
       cmd = "#{shell} -NoProfile -EncodedCommand #{base64_script}"
@@ -162,16 +162,16 @@ module Train::Extras
     include_options WindowsCommand
 
     def self.load(transport, options)
-      if transport.os.unix?
+      if transport.platform.unix?
         return nil unless LinuxCommand.active?(options)
         res = LinuxCommand.new(transport, options)
         verification_res = res.verify
         if verification_res
           msg, reason = verification_res
-          raise Train::UserError.new("Sudo failed: #{msg}", reason)
+          raise Train::UserError, "Sudo failed: #{msg}", reason
         end
         res
-      elsif transport.os.windows?
+      elsif transport.platform.windows?
         res = WindowsCommand.new(transport, options)
         res
       end

data/lib/train/extras/stat.rb

@@ -4,13 +4,13 @@
 module Train::Extras
   class Stat
     TYPES = {
-      socket:           00140000,
-      symlink:          00120000,
-      file:             00100000,
-      block_device:     00060000,
-      directory:        00040000,
+      socket: 00140000,
+      symlink: 00120000,
+      file: 00100000,
+      block_device: 00060000,
+      directory: 00040000,
       character_device: 00020000,
-      pipe:             00010000,
+      pipe: 00010000,
     }.freeze
 
     def self.find_type(mode)
@@ -33,8 +33,8 @@ module Train::Extras
     end
 
     def self.linux_stat(shell_escaped_path, backend, follow_symlink)
-      lstat = follow_symlink ? ' -L' : ''
-      format = (backend.os.esx? || backend.os[:name] == 'alpine') ? '-c' : '--printf'
+      lstat = follow_symlink ? " -L" : ""
+      format = (backend.os.esx? || backend.os[:name] == "alpine") ? "-c" : "--printf"
       res = backend.run_command("stat#{lstat} #{shell_escaped_path} 2>/dev/null #{format} '%s\n%f\n%U\n%u\n%G\n%g\n%X\n%Y\n%C'")
       # ignore the exit_code: it is != 0 if selinux labels are not supported
       # on the system.
@@ -45,16 +45,16 @@ module Train::Extras
       tmask = fields[1].to_i(16)
       selinux = fields[8]
       ## selinux security context string not available on esxi
-      selinux = nil if selinux == '?' or selinux == '(null)' or selinux == 'C'
+      selinux = nil if (selinux == "?") || (selinux == "(null)") || (selinux == "C")
       {
-        type:  find_type(tmask),
-        mode:  tmask & 07777,
+        type: find_type(tmask),
+        mode: tmask & 07777,
         owner: fields[2],
-        uid:   fields[3].to_i,
+        uid: fields[3].to_i,
         group: fields[4],
-        gid:   fields[5].to_i,
+        gid: fields[5].to_i,
         mtime: fields[7].to_i,
-        size:  fields[0].to_i,
+        size: fields[0].to_i,
         selinux_label: selinux,
       }
     end
@@ -74,7 +74,7 @@ module Train::Extras
       # in combination with:
       #      ...
       #      gu      Display group or user name.
-      lstat = follow_symlink ? ' -L' : ''
+      lstat = follow_symlink ? " -L" : ""
       res = backend.run_command(
         "stat#{lstat} -f '%z\n%p\n%Su\n%u\n%Sg\n%g\n%a\n%m' "\
         "#{shell_escaped_path}")
@@ -87,21 +87,21 @@ module Train::Extras
       tmask = fields[1].to_i(8)
 
       {
-        type:  find_type(tmask),
-        mode:  tmask & 07777,
+        type: find_type(tmask),
+        mode: tmask & 07777,
         owner: fields[2],
-        uid:   fields[3].to_i,
+        uid: fields[3].to_i,
         group: fields[4],
-        gid:   fields[5].to_i,
+        gid: fields[5].to_i,
         mtime: fields[7].to_i,
-        size:  fields[0].to_i,
+        size: fields[0].to_i,
         selinux_label: fields[8],
       }
     end
 
     def self.aix_stat(shell_escaped_path, backend, follow_symlink)
       # Perl here b/c it is default on AIX
-      lstat = follow_symlink ? 'lstat' : 'stat'
+      lstat = follow_symlink ? "lstat" : "stat"
       stat_cmd = <<-EOP
       perl -e '
       @a = #{lstat}(shift) or exit 2;
@@ -115,16 +115,16 @@ module Train::Extras
       return {} if res.exit_status != 0
       fields = res.stdout.split("\n")
       return {} if fields.length != 7
-      tmask  = fields[0].to_i(8)
+      tmask = fields[0].to_i(8)
       {
-        type:  find_type(tmask),
-        mode:  tmask & 07777,
+        type: find_type(tmask),
+        mode: tmask & 07777,
         owner: fields[1],
-        uid:   fields[2].to_i,
+        uid: fields[2].to_i,
         group: fields[3],
-        gid:   fields[4].to_i,
+        gid: fields[4].to_i,
         mtime: fields[5].to_i,
-        size:  fields[6].to_i,
+        size: fields[6].to_i,
         selinux_label: nil,
       }
     end

data/lib/train/file.rb

@@ -3,15 +3,15 @@
 # author: Christoph Hartmann
 # author: Dominik Richter
 
-require 'train/file/local'
-require 'train/file/remote'
-require 'train/extras/stat'
+require "train/file/local"
+require "train/file/remote"
+require "train/extras/stat"
 
 module Train
   class File # rubocop:disable Metrics/ClassLength
     def initialize(backend, path, follow_symlink = true)
       @backend = backend
-      @path = path || ''
+      @path = path || ""
       @follow_symlink = follow_symlink
 
       sanitize_filename(path)
@@ -30,15 +30,15 @@ module Train
 
     DATA_FIELDS.each do |m|
       define_method m.to_sym do
-        fail NotImplementedError, "File must implement the #{m}() method."
+        raise NotImplementedError, "File must implement the #{m}() method."
       end
     end
 
     def to_json
       res = Hash[DATA_FIELDS.map { |x| [x, method(x).call] }]
       # additional fields provided as input
-      res['type'] = type
-      res['follow_symlink'] = @follow_symlink
+      res["type"] = type
+      res["follow_symlink"] = @follow_symlink
       res
     end
 
@@ -73,36 +73,36 @@ module Train
     end
 
     def version?(version)
-      product_version == version or
-        file_version == version
+      (product_version == version) ||
+        (file_version == version)
     end
 
     def block_device?
-      type.to_s == 'block_device'
+      type.to_s == "block_device"
     end
 
     def character_device?
-      type.to_s == 'character_device'
+      type.to_s == "character_device"
     end
 
     def pipe?
-      type.to_s == 'pipe'
+      type.to_s == "pipe"
     end
 
     def file?
-      type.to_s == 'file'
+      type.to_s == "file"
     end
 
     def socket?
-      type.to_s == 'socket'
+      type.to_s == "socket"
     end
 
     def directory?
-      type.to_s == 'directory'
+      type.to_s == "directory"
     end
 
     def symlink?
-      source.type.to_s == 'symlink'
+      source.type.to_s == "symlink"
     end
 
     def owned_by?(sth)
@@ -134,16 +134,16 @@ module Train
       # Skip processing rest of method if fallback method is selected
       return perform_checksum_ruby(:md5) if defined?(@ruby_checksum_fallback)
 
-      checksum = if @backend.os.family == 'windows'
+      checksum = if @backend.os.family == "windows"
                    perform_checksum_windows(:md5)
                  else
                    @md5_command ||= case @backend.os.family
-                                    when 'darwin'
-                                      'md5 -r'
-                                    when 'solaris'
-                                      'digest -a md5'
+                                    when "darwin"
+                                      "md5 -r"
+                                    when "solaris"
+                                      "digest -a md5"
                                     else
-                                      'md5sum'
+                                      "md5sum"
                                     end
 
                    perform_checksum_unix(@md5_command)
@@ -156,16 +156,16 @@ module Train
       # Skip processing rest of method if fallback method is selected
       return perform_checksum_ruby(:sha256) if defined?(@ruby_checksum_fallback)
 
-      checksum = if @backend.os.family == 'windows'
+      checksum = if @backend.os.family == "windows"
                    perform_checksum_windows(:sha256)
                  else
                    @sha256_command ||= case @backend.os.family
-                                       when 'darwin', 'hpux', 'qnx'
-                                         'shasum -a 256'
-                                       when 'solaris'
-                                         'digest -a sha256'
+                                       when "darwin", "hpux", "qnx"
+                                         "shasum -a 256"
+                                       when "solaris"
+                                         "digest -a sha256"
                                        else
-                                         'sha256sum'
+                                         "sha256sum"
                                        end
 
                    perform_checksum_unix(@sha256_command)
@@ -178,13 +178,13 @@ module Train
 
     def perform_checksum_unix(cmd)
       res = @backend.run_command("#{cmd} #{@path}")
-      res.stdout.split(' ').first if res.exit_status == 0
+      res.stdout.split(" ").first if res.exit_status == 0
     end
 
     def perform_checksum_windows(method)
       cmd = "CertUtil -hashfile #{@path} #{method.to_s.upcase}"
       res = @backend.run_command(cmd)
-      res.stdout.split("\r\n")[1].tr(' ', '') if res.exit_status == 0
+      res.stdout.split("\r\n")[1].tr(" ", "") if res.exit_status == 0
     end
 
     # This pulls the content of the file to the machine running Train and uses