train-core 3.2.5 → 3.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f698ec478a1c770c12cf3414e5aa45c8d1597c71df29f0391530fbd9473bf3ae
-  data.tar.gz: 5ccfc4c79998c2da7e5771f949875d56198e0cecc9bc7a1e9ad2ac6fd50c85d3
+  metadata.gz: c4a9a2b3342fe17d7bcbfe3fcee05215b867798a4c8f01a6924e8ac57846fa9d
+  data.tar.gz: 0041aaaeeb3405feda9ec52c0cdc04867245e3b9b2259a122ed9db44f4506504
 SHA512:
-  metadata.gz: e9fed72580f067cbfee15561c6f332953e25fe0a17e39ad3b9c332877f37182d75fdf92fee0be5b5f4e134388cff86f0ee6f08a17db6aa8208faf6c7c77d3c07
-  data.tar.gz: e42ec0bc0af78769961731c539956d8f63560589459d0e895ac45e4dba0bcfca523af937a9f76956152b3a177c906e84f5d75756dc11ae8042dec237ee41270b
+  metadata.gz: a8d25991efa5582a917b6eb8b89cfc4bb04c54202558043c601fa29be600f384885672cb7371f76cca5709fecb06b0c3fbdd735b6898c4fea96f39f200b987ce
+  data.tar.gz: c9421752289a00b535b7fdff660e9e1e19ff23e37647741e8e042a5ec31e36c9b6af1eef8445217f05905b0178981000681f1c0b0b028b623b7ef2408371da6b

data/lib/train.rb

@@ -2,11 +2,11 @@
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
-require "train/version"
-require "train/options"
-require "train/plugins"
-require "train/errors"
-require "train/platforms"
+require_relative "train/version"
+require_relative "train/options"
+require_relative "train/plugins"
+require_relative "train/errors"
+require_relative "train/platforms"
 require "uri"
 
 module Train

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_relative "extras/command_wrapper"
+  require_relative "extras/stat"
 
   CommandResult = Struct.new(:stdout, :stderr, :exit_status)
   LoginCommand = Struct.new(:command, :arguments)

data/lib/train/extras/command_wrapper.rb

@@ -3,7 +3,7 @@
 # author: Christoph Hartmann
 
 require "base64"
-require "train/errors"
+require_relative "../errors"
 
 module Train::Extras
   # Define the interface of all command wrappers.
@@ -53,47 +53,46 @@ module Train::Extras
       @user          = options[:user]
     end
 
-    def with_sudo_pty
-      old_pty = backend.transport_options[:pty]
-      backend.transport_options[:pty] = true if @sudo
-
-      yield
-    ensure
-      backend.transport_options[:pty] = old_pty
-    end
-
     # (see CommandWrapperBase::verify)
     def verify
       cmd = if @sudo
               # Wrap it up. It needs /dev/null on the outside to disable stdin
-              "bash -c '(#{run("-v")}) < /dev/null'"
+              # NOTE: can't use @sudo_command because -v conflicts with -E.
+              #       See test-kitchen's use of this variable for conflict.
+              "sh -c '(sudo -v) < /dev/null'"
             else
               run("echo")
             end
 
       # rubocop:disable Style/BlockDelimiters
-      res = with_sudo_pty {
+      res = @backend.with_sudo_pty {
         @backend.run_command(cmd)
       }
       return nil if res.exit_status == 0
 
-      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" =>
-          ["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],
-      }.each do |sudo, human|
-        rawerr = human if rawerr.include? sudo
+      rawerr = "#{res.stdout} #{res.stderr}".strip
+
+      case rawerr
+      when "Sorry, try again"
+        ["Wrong sudo password.", :bad_sudo_password]
+      when "sudo: no tty present and no askpass program specified"
+        ["Sudo requires a password, please configure it.", :sudo_password_required]
+      when "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]
+      when "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]
+      else
+        [rawerr, nil]
       end
+    end
 
-      rawerr
+    def verify!
+      msg, reason = verify
+      return nil unless msg
+
+      raise Train::UserError.new("Sudo failed: #{msg}", reason)
     end
 
     # (see CommandWrapperBase::run)
@@ -191,15 +190,11 @@ module Train::Extras
         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)
-        end
+        res.verify!
+
         res
       elsif transport.platform.windows?
-        res = WindowsCommand.new(transport, options)
-        res
+        WindowsCommand.new(transport, options)
       end
     end
   end

data/lib/train/extras/stat.rb

@@ -35,7 +35,7 @@ module Train::Extras
 
     def self.linux_stat(shell_escaped_path, backend, follow_symlink)
       lstat = follow_symlink ? " -L" : ""
-      format = (backend.os.esx? || backend.os[:name] == "alpine") ? "-c" : "--printf"
+      format = (backend.os.esx? || backend.os[:name] == "alpine" || backend.os[:name] == "yocto") ? "-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.

data/lib/train/file.rb

@@ -3,9 +3,9 @@
 # author: Christoph Hartmann
 # author: Dominik Richter
 
-require "train/file/local"
-require "train/file/remote"
-require "train/extras/stat"
+require_relative "file/local"
+require_relative "file/remote"
+require_relative "extras/stat"
 
 module Train
   class File # rubocop:disable Metrics/ClassLength

data/lib/train/file/local.rb

@@ -78,5 +78,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_relative "local/unix"
+require_relative "local/windows"

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

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 require "shellwords"
-require "train/extras/stat"
+require_relative "../../extras/stat"
 
 module Train
   class File

data/lib/train/file/remote.rb

@@ -33,8 +33,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_relative "remote/aix"
+require_relative "remote/linux"
+require_relative "remote/qnx"
+require_relative "remote/unix"
+require_relative "remote/windows"

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

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "train/file/remote/unix"
+require_relative "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_relative "unix"
 
 module Train
   class File

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

@@ -3,7 +3,7 @@
 # author: Christoph Hartmann
 # author: Dominik Richter
 
-require "train/file/remote/unix"
+require_relative "unix"
 
 module Train
   class File

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_relative "platforms/common"
+require_relative "platforms/detect"
+require_relative "platforms/detect/scanner"
+require_relative "platforms/detect/specifications/os"
+require_relative "platforms/detect/specifications/api"
+require_relative "platforms/detect/uuid"
+require_relative "platforms/family"
+require_relative "platforms/platform"
 
 module Train::Platforms
   # Retrieve the current platform list

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

@@ -1,5 +1,5 @@
-require "train/platforms/detect/helpers/os_linux"
-require "train/platforms/detect/helpers/os_windows"
+require_relative "os_linux"
+require_relative "os_windows"
 require "rbconfig"
 
 module Train::Platforms::Detect::Helpers

data/lib/train/platforms/detect/scanner.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "train/platforms/detect/helpers/os_common"
+require_relative "helpers/os_common"
 
 module Train::Platforms::Detect
   class Scanner

data/lib/train/platforms/detect/specifications/os.rb

@@ -17,7 +17,7 @@ module Train::Platforms::Detect::Specifications
 
       plat.family("windows").in_family("os")
         .detect do
-            # Can't return from a `proc` thus the `is_windows` shenanigans
+          # Can't return from a `proc` thus the `is_windows` shenanigans
           is_windows = false
           is_windows = true if winrm?
 
@@ -25,7 +25,7 @@ module Train::Platforms::Detect::Specifications
             is_windows = true if ruby_host_os(/mswin|mingw32|windows/)
           end
 
-            # Try to detect windows even for ssh transport
+          # Try to detect windows even for ssh transport
           if !is_windows && detect_windows == true
             is_windows = true
           end
@@ -41,8 +41,8 @@ module Train::Platforms::Detect::Specifications
       # unix master family
       plat.family("unix").in_family("os")
         .detect do
-            # we want to catch a special case here where cisco commands
-            # don't return an exit status and still print to stdout
+          # we want to catch a special case here where cisco commands
+          # don't return an exit status and still print to stdout
           if unix_uname_s =~ /./ && !unix_uname_s.start_with?("Line has invalid autocommand ") && !unix_uname_s.start_with?("The command you have entered")
             @platform[:arch] = unix_uname_m
             true
@@ -92,7 +92,7 @@ module Train::Platforms::Detect::Specifications
             true
           end
 
-            # if we get this far we have to be some type of debian
+          # if we get this far we have to be some type of debian
           @platform[:release] = unix_file_contents("/etc/debian_version").chomp
           true
         end
@@ -136,9 +136,9 @@ module Train::Platforms::Detect::Specifications
       # redhat family
       plat.family("redhat").in_family("linux")
         .detect do
-            # I am not sure this returns true for all redhats in this family
-            # for now we are going to just try each platform
-            # return true unless unix_file_contents('/etc/redhat-release').nil?
+          # I am not sure this returns true for all redhats in this family
+          # for now we are going to just try each platform
+          # return true unless unix_file_contents('/etc/redhat-release').nil?
 
           true
         end
@@ -318,6 +318,35 @@ module Train::Platforms::Detect::Specifications
           end
         end
 
+      # yocto family
+      plat.family("yocto").in_family("linux")
+        .detect do
+          # /etc/issue isn't specific to yocto, but it's the only way to detect
+          # the platform because there are no other identifying files
+          if unix_file_contents("/etc/issue") &&
+              (unix_file_contents("/etc/issue").match?("Poky") ||
+               unix_file_contents("/etc/issue").match?("balenaOS"))
+            true
+          end
+        end
+      plat.name("yocto").title("Yocto Project Linux").in_family("yocto")
+        .detect do
+          if unix_file_contents("/etc/issue").match?("Poky")
+            # assuming the Poky version is preferred over the /etc/version build
+            @platform[:release] = unix_file_contents("/etc/issue").match('\d+(\.\d+)+')[0]
+            true
+          end
+        end
+      plat.name("balenaos").title("balenaOS Linux").in_family("yocto")
+        .detect do
+          # balenaOS does have the /etc/os-release file
+          if unix_file_contents("/etc/issue").match?("balenaOS") &&
+              linux_os_release["NAME"] =~ /balenaos/i
+            @platform[:release] = linux_os_release["META_BALENA_VERSION"]
+            true
+          end
+        end
+
       # brocade family detected here if device responds to 'uname' command,
       # happens when logging in as root
       plat.family("brocade").title("Brocade Family").in_family("linux")
@@ -325,9 +354,9 @@ module Train::Platforms::Detect::Specifications
           !brocade_version.nil?
         end
 
-      # genaric linux
+      # generic linux
       # this should always be last in the linux family list
-      plat.name("linux").title("Genaric Linux").in_family("linux")
+      plat.name("linux").title("Generic Linux").in_family("linux")
         .detect do
           true
         end
@@ -426,7 +455,7 @@ module Train::Platforms::Detect::Specifications
             true
           end
 
-            # must be some unknown solaris
+          # must be some unknown solaris
           true
         end
 
@@ -457,8 +486,8 @@ module Train::Platforms::Detect::Specifications
       # bsd family
       plat.family("bsd").in_family("unix")
         .detect do
-            # we need a better way to determin this family
-            # for now we are going to just try each platform
+          # we need a better way to determine this family
+          # for now we are going to just try each platform
           true
         end
       plat.family("darwin").in_family("bsd")
@@ -484,7 +513,7 @@ module Train::Platforms::Detect::Specifications
         end
       plat.name("darwin").title("Darwin").in_family("darwin")
         .detect do
-            # must be some other type of darwin
+          # must be some other type of darwin
           @platform[:name] = unix_uname_s.lines[0].chomp
           true
         end

data/lib/train/plugin_test_helper.rb

@@ -3,7 +3,7 @@
 
 # Load Train.  We certainly need the plugin system, and also several other parts
 # that are tightly coupled.  Train itself is fairly light, and non-invasive.
-require "train"
+require_relative "../train"
 
 # You can select from a number of test harnesses.  Since Train is closely related
 # to InSpec, and InSpec uses Spec-style controls in profile code, you will

data/lib/train/plugins.rb

@@ -3,11 +3,11 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)
 
-require "train/errors"
+require_relative "errors"
 
 module Train
   class Plugins
-    require "train/plugins/transport"
+    require_relative "plugins/transport"
 
     class << self
       # Retrieve the current plugin registry, containing all plugin names

data/lib/train/plugins/base_connection.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-require "train/errors"
-require "train/extras"
-require "train/file"
+require_relative "../errors"
+require_relative "../extras"
+require_relative "../file"
 require "logger"
 
 class Train::Plugins::Transport
@@ -38,6 +38,10 @@ class Train::Plugins::Transport
       end
     end
 
+    def with_sudo_pty
+      yield
+    end
+
     # Returns cached client if caching enabled. Otherwise returns whatever is
     # given in the block.
     #
@@ -88,7 +92,7 @@ class Train::Plugins::Transport
     end
 
     def load_json(j)
-      require "train/transports/mock"
+      require_relative "../transports/mock"
       j["files"].each do |path, jf|
         @cache[:file][path] = Train::Transports::Mock::Connection::File.from_json(jf)
       end

data/lib/train/plugins/transport.rb

@@ -4,16 +4,16 @@
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)
 
 require "logger"
-require "train/errors"
-require "train/extras"
-require "train/options"
+require_relative "../errors"
+require_relative "../extras"
+require_relative "../options"
 
 class Train::Plugins
   class Transport
     include Train::Extras
     Train::Options.attach(self)
 
-    require "train/plugins/base_connection"
+    require_relative "base_connection"
 
     # Initialize a new Transport object
     #

data/lib/train/transports/local.rb

@@ -3,8 +3,8 @@
 # author: Dominik Richter
 # author: Christoph Hartmann
 
-require "train/plugins"
-require "train/errors"
+require_relative "../plugins"
+require_relative "../errors"
 require "mixlib/shellout"
 
 module Train::Transports

data/lib/train/transports/mock.rb

@@ -1,4 +1,4 @@
-require "train/plugins"
+require_relative "../plugins"
 require "digest"
 
 module Train::Transports

data/lib/train/transports/ssh.rb

@@ -20,7 +20,7 @@
 
 require "net/ssh"
 require "net/scp"
-require "train/errors"
+require_relative "../errors"
 
 module Train::Transports
   # Wrapped exception for any internally raised SSH-related errors.
@@ -36,8 +36,8 @@ module Train::Transports
   class SSH < Train.plugin(1) # rubocop:disable Metrics/ClassLength
     name "ssh"
 
-    require "train/transports/ssh_connection"
-    require "train/transports/cisco_ios_connection"
+    require_relative "ssh_connection"
+    require_relative "cisco_ios_connection"
 
     # add options for submodules
     include_options Train::Extras::CommandWrapper

data/lib/train/transports/ssh_connection.rb

@@ -164,6 +164,15 @@ class Train::Transports::SSH
       options_to_print
     end
 
+    def with_sudo_pty
+      old_pty = transport_options[:pty]
+      transport_options[:pty] = true if @sudo
+
+      yield
+    ensure
+      transport_options[:pty] = old_pty
+    end
+
     private
 
     PING_COMMAND = "echo '[SSH] Established'".freeze
@@ -213,17 +222,17 @@ class Train::Transports::SSH
       retry
     end
 
-    def file_via_connection(path)
+    def file_via_connection(path, *args)
       if os.aix?
-        Train::File::Remote::Aix.new(self, path)
+        Train::File::Remote::Aix.new(self, path, *args)
       elsif os.solaris?
-        Train::File::Remote::Unix.new(self, path)
+        Train::File::Remote::Unix.new(self, path, *args)
       elsif os[:name] == "qnx"
-        Train::File::Remote::Qnx.new(self, path)
+        Train::File::Remote::Qnx.new(self, path, *args)
       elsif os.windows?
-        Train::File::Remote::Windows.new(self, path)
+        Train::File::Remote::Windows.new(self, path, *args)
       else
-        Train::File::Remote::Linux.new(self, path)
+        Train::File::Remote::Linux.new(self, path, *args)
       end
     end
 

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = "3.2.5".freeze
+  VERSION = "3.2.14".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.14
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json