train 2.1.7 → 2.1.13

data/lib/train/file/local.rb

@@ -12,7 +12,7 @@ module Train
       end
 
       def content
-        @content ||= ::File.read(@path, encoding: 'UTF-8')
+        @content ||= ::File.read(@path, encoding: "UTF-8")
       rescue StandardError => _
         nil
       end
@@ -23,7 +23,7 @@ module Train
           @link_path ||= ::File.realpath(@path)
         rescue Errno::ELOOP => _
           # Leave it blank on symbolic loop, same as readlink
-          @link_path = ''
+          @link_path = ""
         end
       end
 
@@ -42,13 +42,13 @@ module Train
 
       def type
         case ::File.ftype(@path)
-        when 'blockSpecial'
+        when "blockSpecial"
           :block_device
-        when 'characterSpecial'
+        when "characterSpecial"
           :character_device
-        when 'link'
+        when "link"
           :symlink
-        when 'fifo'
+        when "fifo"
           :pipe
         else
           ::File.ftype(@path).to_sym
@@ -76,5 +76,5 @@ end
 
 # subclass requires are loaded after Train::File::Local is defined
 # to avoid superclass mismatch errors
-require 'train/file/local/unix'
-require 'train/file/local/windows'
+require "train/file/local/unix"
+require "train/file/local/windows"

data/lib/train/file/local/unix.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-require 'shellwords'
-require 'train/extras/stat'
+require "shellwords"
+require "train/extras/stat"
 
 module Train
   class File
@@ -36,9 +36,9 @@ module Train
             gid: file_stat.gid,
           }
 
-          lstat = @follow_symlink ? ' -L' : ''
+          lstat = @follow_symlink ? " -L" : ""
           res = @backend.run_command("stat#{lstat} #{@spath} 2>/dev/null --printf '%C'")
-          if res.exit_status == 0 && !res.stdout.empty? && res.stdout != '?'
+          if res.exit_status == 0 && !res.stdout.empty? && res.stdout != "?"
             @stat[:selinux_label] = res.stdout.strip
           end
 
@@ -79,7 +79,7 @@ module Train
         end
 
         UNIX_MODE_OWNERS = {
-          all:   00777,
+          all: 00777,
           owner: 00700,
           group: 00070,
           other: 00007,

data/lib/train/file/local/windows.rb

@@ -9,7 +9,7 @@ module Train
         def sanitize_filename(path)
           return if path.nil?
           # we do not filter :, backslash and forward slash, since they are part of the path
-          @spath = path.gsub(/[<>"|?*]/, '')
+          @spath = path.gsub(/[<>"|?*]/, "")
         end
 
         def product_version

data/lib/train/file/remote.rb

@@ -3,9 +3,9 @@
 module Train
   class File
     class Remote < Train::File
-      def basename(suffix = nil, sep = '/')
-        fail 'Not yet supported: Suffix in file.basename' unless suffix.nil?
-        @basename ||= detect_filename(path, sep || '/')
+      def basename(suffix = nil, sep = "/")
+        raise "Not yet supported: Suffix in file.basename" unless suffix.nil?
+        @basename ||= detect_filename(path, sep || "/")
       end
 
       def stat
@@ -29,8 +29,8 @@ end
 
 # subclass requires are loaded after Train::File::Remote is defined
 # to avoid superclass mismatch errors
-require 'train/file/remote/aix'
-require 'train/file/remote/linux'
-require 'train/file/remote/qnx'
-require 'train/file/remote/unix'
-require 'train/file/remote/windows'
+require "train/file/remote/aix"
+require "train/file/remote/linux"
+require "train/file/remote/qnx"
+require "train/file/remote/unix"
+require "train/file/remote/windows"

data/lib/train/file/remote/aix.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'train/file/remote/unix'
+require "train/file/remote/unix"
 
 module Train
   class File

data/lib/train/file/remote/linux.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'train/file/remote/unix'
+require "train/file/remote/unix"
 
 module Train
   class File
@@ -10,7 +10,7 @@ module Train
           return @content if defined?(@content)
           @content = @backend.run_command("cat #{@spath} || echo -n").stdout
           return @content unless @content.empty?
-          @content = nil if directory? or size.nil? or size > 0
+          @content = nil if directory? || size.nil? || (size > 0)
           @content
         end
       end

data/lib/train/file/remote/qnx.rb

@@ -3,28 +3,28 @@
 # author: Christoph Hartmann
 # author: Dominik Richter
 
-require 'train/file/remote/unix'
+require "train/file/remote/unix"
 
 module Train
   class File
     class Remote
       class Qnx < Train::File::Remote::Unix
         def content
-          cat = 'cat'
-          cat = '/proc/boot/cat' if @backend.os[:release].to_i >= 7
+          cat = "cat"
+          cat = "/proc/boot/cat" if @backend.os[:release].to_i >= 7
           @content ||= case
                        when !exist?
                          nil
                        else
-                         @backend.run_command("#{cat} #{@spath}").stdout || ''
+                         @backend.run_command("#{cat} #{@spath}").stdout || ""
                        end
         end
 
         def type
-          if @backend.run_command("file #{@spath}").stdout.include?('directory')
-            return :directory
+          if @backend.run_command("file #{@spath}").stdout.include?("directory")
+            :directory
           else
-            return :file
+            :file
           end
         end
 
@@ -32,7 +32,7 @@ module Train
           mode owner group uid gid mtime size selinux_label link_path mounted stat
         }.each do |field|
           define_method field.to_sym do
-            fail NotImplementedError, "QNX does not implement the #{field}() method yet."
+            raise NotImplementedError, "QNX does not implement the #{field}() method yet."
           end
         end
       end

data/lib/train/file/remote/unix.rb

@@ -1,13 +1,9 @@
-# encoding: utf-8
-
-require 'shellwords'
+require "shellwords"
 
 module Train
   class File
     class Remote
       class Unix < Train::File::Remote
-        attr_reader :path
-
         def sanitize_filename(path)
           @spath = Shellwords.escape(path) || @path
         end
@@ -16,19 +12,19 @@ module Train
           @content ||=
             if !exist? || directory?
               nil
-            elsif size.nil? || size.zero?
-              ''
+            elsif size.nil? || size == 0
+              ""
             else
-              @backend.run_command("cat #{@spath}").stdout || ''
+              @backend.run_command("cat #{@spath}").stdout || ""
             end
         end
 
         def exist?
-          @exist ||= (
-            f = @follow_symlink ? '' : " || test -L #{@spath}"
-            @backend.run_command("test -e #{@spath}"+f)
+          @exist ||= begin
+            f = @follow_symlink ? "" : " || test -L #{@spath}"
+            @backend.run_command("test -e #{@spath}" + f)
                     .exit_status == 0
-          )
+          end
         end
 
         def mounted
@@ -88,14 +84,14 @@ module Train
           full_path = @backend.run_command("readlink -n #{@spath} -f").stdout
           # Needed for some OSes like OSX that returns relative path
           # when the link and target are in the same directory
-          if !full_path.start_with?('/') && full_path != ''
+          if !full_path.start_with?("/") && full_path != ""
             full_path = ::File.expand_path("../#{full_path}", @spath)
           end
           full_path
         end
 
         UNIX_MODE_OWNERS = {
-          all:   00777,
+          all: 00777,
           owner: 00700,
           group: 00070,
           other: 00007,

data/lib/train/file/remote/windows.rb

@@ -10,7 +10,7 @@ module Train
         def sanitize_filename(path)
           return if path.nil?
           # we do not filter :, backslash and forward slash, since they are part of the path
-          @spath = path.gsub(/[<>"|?*]/, '')
+          @spath = path.gsub(/[<>"|?*]/, "")
         end
 
         def basename(suffix = nil, sep = '\\')
@@ -28,7 +28,7 @@ module Train
         def exist?
           return @exist if defined?(@exist)
           @exist = @backend.run_command(
-            "(Test-Path -Path \"#{@spath}\").ToString()").stdout.chomp == 'True'
+            "(Test-Path -Path \"#{@spath}\").ToString()").stdout.chomp == "True"
         end
 
         def owner
@@ -39,11 +39,11 @@ module Train
         end
 
         def type
-          if attributes.include?('Archive') && !attributes.include?('Directory')
+          if attributes.include?("Archive") && !attributes.include?("Directory")
             return :file
-          elsif attributes.include?('ReparsePoint')
+          elsif attributes.include?("ReparsePoint")
             return :symlink
-          elsif attributes.include?('Directory')
+          elsif attributes.include?("Directory")
             return :directory
           end
           :unknown

data/lib/train/globals.rb

@@ -1,5 +1,5 @@
 module Train
   def self.src_root
-    File.expand_path(File.join(__FILE__, '..', '..', '..'))
+    File.expand_path(File.join(__FILE__, "..", "..", ".."))
   end
 end

data/lib/train/options.rb

@@ -14,15 +14,15 @@ module Train
       def option(name, conf = nil, &block)
         d = conf || {}
         unless d.is_a? Hash
-          fail Train::ClientError,
+          raise Train::ClientError,
                "The transport plugin #{self} declared an option #{name} "\
                "and didn't provide a valid configuration hash."
         end
 
-        if !conf.nil? and !conf[:default].nil? and block_given?
-          fail Train::ClientError,
+        if !conf.nil? && !conf[:default].nil? && block_given?
+          raise Train::ClientError,
                "The transport plugin #{self} declared an option #{name} "\
-               'with both a default value and block. Only use one of these.'
+               "with both a default value and block. Only use one of these."
         end
 
         d[:default] = block if block_given?
@@ -37,7 +37,7 @@ module Train
 
       def include_options(other)
         unless other.respond_to?(:default_options)
-          fail "Trying to include options from module #{other.inspect}, "\
+          raise "Trying to include options from module #{other.inspect}, "\
                "which doesn't seem to support options."
         end
         default_options.merge!(other.default_options)
@@ -55,7 +55,7 @@ module Train
       def merge_options(base, opts)
         res = base.merge(opts || {})
         default_options.each do |field, hm|
-          next unless res[field].nil? and hm.key?(:default)
+          next unless res[field].nil? && hm.key?(:default)
           default = hm[:default]
           if default.is_a? Proc
             res[field] = default.call(res)
@@ -68,8 +68,8 @@ module Train
 
       def validate_options(opts)
         default_options.each do |field, hm|
-          if opts[field].nil? and hm[:required]
-            fail Train::ClientError,
+          if opts[field].nil? && hm[:required]
+            raise Train::ClientError,
                  "You must provide a value for #{field.to_s.inspect}."
           end
         end

data/lib/train/platforms.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 
-require 'train/platforms/common'
-require 'train/platforms/detect'
-require 'train/platforms/detect/scanner'
-require 'train/platforms/detect/specifications/os'
-require 'train/platforms/detect/specifications/api'
-require 'train/platforms/detect/uuid'
-require 'train/platforms/family'
-require 'train/platforms/platform'
+require "train/platforms/common"
+require "train/platforms/detect"
+require "train/platforms/detect/scanner"
+require "train/platforms/detect/specifications/os"
+require "train/platforms/detect/specifications/api"
+require "train/platforms/detect/uuid"
+require "train/platforms/family"
+require "train/platforms/platform"
 
 module Train::Platforms
   class << self

data/lib/train/platforms/common.rb

@@ -6,7 +6,7 @@ module Train::Platforms
     # if it does not exist and add a child relationship.
     def in_family(family)
       if self.class == Train::Platforms::Family && @name == family
-        fail "Unable to add family #{@name} to itself: '#{@name}.in_family(#{family})'"
+        raise "Unable to add family #{@name} to itself: '#{@name}.in_family(#{family})'"
       end
 
       # add family to the family list

data/lib/train/platforms/detect/helpers/os_common.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
-require 'train/platforms/detect/helpers/os_linux'
-require 'train/platforms/detect/helpers/os_windows'
-require 'rbconfig'
+require "train/platforms/detect/helpers/os_linux"
+require "train/platforms/detect/helpers/os_windows"
+require "rbconfig"
 
 module Train::Platforms::Detect::Helpers
   module OSCommon
@@ -10,11 +8,11 @@ module Train::Platforms::Detect::Helpers
     include Train::Platforms::Detect::Helpers::Windows
 
     def ruby_host_os(regex)
-      ::RbConfig::CONFIG['host_os'] =~ regex
+      ::RbConfig::CONFIG["host_os"] =~ regex
     end
 
     def winrm?
-      @backend.class.to_s == 'Train::Transports::WinRM::Connection'
+      @backend.class.to_s == "Train::Transports::WinRM::Connection"
     end
 
     def unix_file_contents(path)
@@ -23,42 +21,48 @@ module Train::Platforms::Detect::Helpers
 
       res = @backend.run_command("test -f #{path} && cat #{path}")
       # ignore files that can't be read
-      @files[path] = res.exit_status.zero? ? res.stdout : nil
+      @files[path] = res.exit_status == 0 ? res.stdout : nil
       @files[path]
     end
 
     def unix_file_exist?(path)
-      @backend.run_command("test -f #{path}").exit_status.zero?
+      @backend.run_command("test -f #{path}").exit_status == 0
     end
 
     def command_output(cmd)
       res = @backend.run_command(cmd).stdout
+      # When you try to execute command using ssh connction as root user and you have provided ssh user identity file
+      # it gives standard output to login as authorised user other than root. To show this standard ouput as an error
+      # to user we are matching the string of stdout and raising the error here so that user gets exact information.
+      if @backend.class.to_s == "Train::Transports::SSH::Connection" && res =~ /Please login as the user/
+        raise Train::UserError, "SSH failed: #{res}"
+      end
       res.strip! unless res.nil?
       res
     end
 
     def unix_uname_s
       return @uname[:s] if @uname.key?(:s)
-      @uname[:s] = command_output('uname -s')
+      @uname[:s] = command_output("uname -s")
     end
 
     def unix_uname_r
       return @uname[:r] if @uname.key?(:r)
-      @uname[:r] = command_output('uname -r')
+      @uname[:r] = command_output("uname -r")
     end
 
     def unix_uname_m
       return @uname[:m] if @uname.key?(:m)
-      @uname[:m] = command_output('uname -m')
+      @uname[:m] = command_output("uname -m")
     end
 
     def brocade_version
       return @cache[:brocade] if @cache.key?(:brocade)
-      res = command_output('version')
+      res = command_output("version")
 
       m = res.match(/^Fabric OS:\s+v(\S+)$/)
       unless m.nil?
-        return @cache[:brocade] = { version: m[1], type: 'fos' }
+        return @cache[:brocade] = { version: m[1], type: "fos" }
       end
 
       @cache[:brocade] = nil
@@ -66,53 +70,53 @@ module Train::Platforms::Detect::Helpers
 
     def cisco_show_version
       return @cache[:cisco] if @cache.key?(:cisco)
-      res = command_output('show version')
+      res = command_output("show version")
 
       m = res.match(/Cisco IOS Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+)/)
       unless m.nil?
-        return @cache[:cisco] = { version: m[2], model: m[1], type: 'ios' }
+        return @cache[:cisco] = { version: m[2], model: m[1], type: "ios" }
       end
 
       m = res.match(/Cisco IOS Software, IOS-XE Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+\.\d+[A-Z]*)/)
       unless m.nil?
-        return @cache[:cisco] = { version: m[2], model: m[1], type: 'ios-xe' }
+        return @cache[:cisco] = { version: m[2], model: m[1], type: "ios-xe" }
       end
 
       m = res.match(/Cisco Nexus Operating System \(NX-OS\) Software/)
       unless m.nil?
         v = res[/^\s*system:\s+version (\d+\.\d+)/, 1]
-        return @cache[:cisco] = { version: v, type: 'nexus' }
+        return @cache[:cisco] = { version: v, type: "nexus" }
       end
 
       @cache[:cisco] = nil
     end
 
     def unix_uuid
-      uuid = unix_uuid_from_chef
-      uuid = unix_uuid_from_machine_file if uuid.nil?
-      uuid = uuid_from_command if uuid.nil?
-      raise Train::TransportError, 'Cannot find a UUID for your node.' if uuid.nil?
-      uuid
+      (unix_uuid_from_chef         ||
+       unix_uuid_from_machine_file ||
+       uuid_from_command           ||
+       raise(Train::TransportError, "Cannot find a UUID for your node."))
     end
 
     def unix_uuid_from_chef
-      file = @backend.file('/var/chef/cache/data_collector_metadata.json')
-      if file.exist? && !file.size.zero?
+      file = @backend.file("/var/chef/cache/data_collector_metadata.json")
+      if file.exist? && file.size != 0
         json = ::JSON.parse(file.content)
-        return json['node_uuid'] if json['node_uuid']
+        return json["node_uuid"] if json["node_uuid"]
       end
     end
 
     def unix_uuid_from_machine_file
-      %W(
+      # require 'pry';binding.pry
+      %W{
         /etc/chef/chef_guid
         #{ENV['HOME']}/.chef/chef_guid
         /etc/machine-id
         /var/lib/dbus/machine-id
         /var/db/dbus/machine-id
-      ).each do |path|
+      }.each do |path|
         file = @backend.file(path)
-        next unless file.exist? && !file.size.zero?
+        next unless file.exist? && file.size != 0
         return file.content.chomp if path =~ /guid/
         return uuid_from_string(file.content.chomp)
       end
@@ -125,7 +129,7 @@ module Train::Platforms::Detect::Helpers
     def uuid_from_command
       return unless @platform[:uuid_command]
       result = @backend.run_command(@platform[:uuid_command])
-      uuid_from_string(result.stdout.chomp) if result.exit_status.zero? && !result.stdout.empty?
+      uuid_from_string(result.stdout.chomp) if result.exit_status == 0 && !result.stdout.empty?
     end
 
     # This hashes the passed string into SHA1.
@@ -134,11 +138,11 @@ module Train::Platforms::Detect::Helpers
     def uuid_from_string(string)
       hash = Digest::SHA1.new
       hash.update(string)
-      ary = hash.digest.unpack('NnnnnN')
+      ary = hash.digest.unpack("NnnnnN")
       ary[2] = (ary[2] & 0x0FFF) | (5 << 12)
       ary[3] = (ary[3] & 0x3FFF) | 0x8000
       # rubocop:disable Style/FormatString
-      '%08x-%04x-%04x-%04x-%04x%08x' % ary
+      "%08x-%04x-%04x-%04x-%04x%08x" % ary
     end
   end
 end