train-core 1.4.11 → 1.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff59e268df6e0644952fce6ab783058d6be0ca2077272ca3a78c1060c23563f4
-  data.tar.gz: 1a90a57d1ad91feb1778f114d319982d4f70560d29e98b38256b52b38f3d9bd3
+  metadata.gz: d7805799b5b97d3b08f81da4541c45e92387f2fdccd51d7e1acd399d5c3c6fff
+  data.tar.gz: b46ec1e385e9e23a963da63af3e40034bca9ff1e939160dc4314173ff381c212
 SHA512:
-  metadata.gz: 88c791a6d0742f4ebf8eab8c665087c10fd0d43cb7db2ff51602e19dcc913c1af5043b58c8e51d6b4365e9c9438a574a37da567a2daac3675dc53747477bd418
-  data.tar.gz: e9911e47a0a2ccccdb96bc92b3ac0bd8802be2080d42dcd45b5e548b057bcc13393e40b5f0b232081823b22721090e98b46577af542647484195bf36bb54585d
+  metadata.gz: 1f99ac1e603296c34c3442fc6c0d2de422f8c55614b7dec1fbd921d04d64ef53b5e71074ef625834a638e8cf020b1ad93ea2d529f777a78981114272f385e8b7
+  data.tar.gz: f6eb84dcdc248671e1ec0df04ef5f9efc3651d2844962d54e8ac10aaf1cf6d2c0addbb92d7ab76a231cd81e4dbef310fe56652eb02ab891eb0f1b46f48e03d51

data/CHANGELOG.md

@@ -1,23 +1,31 @@
-<!-- latest_release 1.4.11 -->
-## [v1.4.11](https://github.com/chef/train/tree/v1.4.11) (2018-05-17)
+<!-- latest_release 1.4.15 -->
+## [v1.4.15](https://github.com/inspec/train/tree/v1.4.15) (2018-06-14)
 
 #### Merged Pull Requests
-- Add required env for azure shell msi headers [#302](https://github.com/chef/train/pull/302) ([jquick](https://github.com/jquick))
+- Don&#39;t double-escape paths [#306](https://github.com/inspec/train/pull/306) ([voroniys](https://github.com/voroniys))
 <!-- latest_release -->
 
-<!-- release_rollup since=1.4.10 -->
-### Changes since 1.4.10 release
+<!-- release_rollup since=1.4.11 -->
+### Changes since 1.4.11 release
 
 #### Merged Pull Requests
-- Add required env for azure shell msi headers [#302](https://github.com/chef/train/pull/302) ([jquick](https://github.com/jquick)) <!-- 1.4.11 -->
+- Don&#39;t double-escape paths [#306](https://github.com/inspec/train/pull/306) ([voroniys](https://github.com/voroniys)) <!-- 1.4.15 -->
+- Add the mock transport to train-core [#308](https://github.com/inspec/train/pull/308) ([jquick](https://github.com/jquick)) <!-- 1.4.14 -->
+- Adding Oneview to platform detection. [#307](https://github.com/inspec/train/pull/307) ([skpaterson](https://github.com/skpaterson)) <!-- 1.4.13 -->
+- Allow TrainError to provide a supplement reason [#303](https://github.com/chef/train/pull/303) ([marcparadise](https://github.com/marcparadise)) <!-- 1.4.12 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v1.4.11](https://github.com/chef/train/tree/v1.4.11) (2018-05-17)
+
+#### Merged Pull Requests
+- Add required env for azure shell msi headers [#302](https://github.com/chef/train/pull/302) ([jquick](https://github.com/jquick))
+<!-- latest_stable_release -->
+
 ## [v1.4.10](https://github.com/chef/train/tree/v1.4.10) (2018-05-17)
 
 #### Merged Pull Requests
 - support sudo passwords for cisco [#301](https://github.com/chef/train/pull/301) ([arlimus](https://github.com/arlimus))
-<!-- latest_stable_release -->
 
 ## [v1.4.9](https://github.com/chef/train/tree/v1.4.9) (2018-05-16)
 

data/lib/train/errors.rb

@@ -10,7 +10,14 @@
 
 module Train
   # Base exception for any exception explicitly raised by the Train library.
-  class Error < ::StandardError; end
+  class Error < ::StandardError
+    attr_reader :reason
+
+    def initialize(message = '', reason = :not_provided)
+      super(message)
+      @reason = reason
+    end
+  end
 
   # Base exception class for all exceptions that are caused by user input
   # errors.

data/lib/train/extras/command_wrapper.rb

@@ -58,15 +58,15 @@ module Train::Extras
       rawerr = res.stdout + ' ' + res.stderr
 
       {
-        'Sorry, try again' => 'Wrong sudo password.',
+        '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 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.',
+          ["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 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
@@ -128,8 +128,11 @@ module Train::Extras
       if transport.os.unix?
         return nil unless LinuxCommand.active?(options)
         res = LinuxCommand.new(transport, options)
-        msg = res.verify
-        fail Train::UserError, "Sudo failed: #{msg}" unless msg.nil?
+        verification_res = res.verify
+        if verification_res
+          msg, reason = verification_res
+          raise Train::UserError.new("Sudo failed: #{msg}", reason)
+        end
         res
       end
     end

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

@@ -47,7 +47,7 @@ module Train
 
         def mounted
           @mounted ||=
-            @backend.run_command("mount | grep -- ' on #{@spath} '")
+            @backend.run_command("mount | grep -- ' on #{@path} '")
         end
 
         def grouped_into?(sth)

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

@@ -33,7 +33,7 @@ module Train
 
         def mounted
           @mounted ||=
-            @backend.run_command("mount | grep -- ' on #{@spath} '")
+            @backend.run_command("mount | grep -- ' on #{@path} '")
         end
 
         %w{

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

@@ -11,6 +11,8 @@ module Train::Platforms::Detect::Specifications
       plat.name('aws').in_family('cloud')
       plat.name('azure').in_family('cloud')
       plat.name('gcp').in_family('cloud')
+      plat.family('iaas').in_family('api')
+      plat.name('oneview').in_family('iaas')
     end
   end
 end

data/lib/train/transports/mock.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+
+require 'train/plugins'
+require 'digest'
+
+module Train::Transports
+  class Mock < Train.plugin(1)
+    name 'mock'
+
+    def initialize(conf = nil)
+      @conf = conf || {}
+      trace_calls if @conf[:trace]
+    end
+
+    def connection
+      @connection ||= Connection.new(@conf)
+    end
+
+    def to_s
+      'Mock Transport'
+    end
+
+    private
+
+    def trace_calls
+      interface_methods = {
+        'Train::Transports::Mock' =>
+          Train::Transports::Mock.instance_methods(false),
+        'Train::Transports::Mock::Connection' =>
+          Connection.instance_methods(false),
+        'Train::Transports::Mock::Connection::File' =>
+          Connection::FileCommon.instance_methods(false),
+        'Train::Transports::Mock::Connection::OS' =>
+          Train::Platform.instance_methods(false),
+      }
+
+      # rubocop:disable Metrics/ParameterLists
+      # rubocop:disable Lint/Eval
+      set_trace_func proc { |event, _file, _line, id, binding, classname|
+        unless classname.to_s.start_with?('Train::Transports::Mock') and
+               event == 'call' and
+               interface_methods[classname.to_s].include?(id)
+          next
+        end
+        # kindly borrowed from the wonderful simple-tracer by matugm
+        arg_names = eval(
+          'method(__method__).parameters.map { |arg| arg[1].to_s }',
+          binding)
+        args = eval("#{arg_names}.map { |arg| eval(arg) }", binding).join(', ')
+        prefix = '-' * (classname.to_s.count(':') - 2) + '> '
+        puts("#{prefix}#{id} #{args}")
+      }
+      # rubocop:enable all
+    end
+  end
+end
+
+class Train::Transports::Mock
+  class Connection < BaseConnection
+    attr_reader :options
+
+    def initialize(conf = nil)
+      super(conf)
+      mock_os
+      enable_cache(:file)
+      enable_cache(:command)
+    end
+
+    def uri
+      'mock://'
+    end
+
+    def mock_os(value = {})
+      # if a user passes a nil value, set to an empty hash so the merge still succeeds
+      value ||= {}
+      value.each { |k, v| value[k] = 'unknown' if v.nil? }
+      value = { name: 'mock', family: 'mock', release: 'unknown', arch: 'unknown' }.merge(value)
+
+      platform = Train::Platforms.name(value[:name])
+      platform.family_hierarchy = family_hierarchy(platform).flatten
+      platform.platform = value
+      platform.add_platform_methods
+      @platform = platform
+    end
+
+    def commands=(commands)
+      @cache[:command] = commands
+    end
+
+    def commands
+      @cache[:command]
+    end
+
+    def files=(files)
+      @cache[:file] = files
+    end
+
+    def files
+      @cache[:file]
+    end
+
+    def mock_command(cmd, stdout = nil, stderr = nil, exit_status = 0)
+      @cache[:command][cmd] = Command.new(stdout || '', stderr || '', exit_status)
+    end
+
+    def command_not_found(cmd)
+      if @options[:verbose]
+        STDERR.puts('Command not mocked:')
+        STDERR.puts('    '+cmd.to_s.split("\n").join("\n    "))
+        STDERR.puts('    SHA: ' + Digest::SHA256.hexdigest(cmd.to_s))
+      end
+      # return a non-zero exit code
+      mock_command(cmd, nil, nil, 1)
+    end
+
+    def file_not_found(path)
+      STDERR.puts('File not mocked: '+path.to_s) if @options[:verbose]
+      File.new(self, path)
+    end
+
+    def to_s
+      'Mock Connection'
+    end
+
+    private
+
+    def run_command_via_connection(cmd)
+      @cache[:command][Digest::SHA256.hexdigest cmd.to_s] ||
+        command_not_found(cmd)
+    end
+
+    def file_via_connection(path)
+      file_not_found(path)
+    end
+  end
+end
+
+class Train::Transports::Mock::Connection
+  Command = Struct.new(:stdout, :stderr, :exit_status)
+end
+
+class Train::Transports::Mock::Connection
+  class File < Train::File
+    def self.from_json(json)
+      res = new(json['backend'],
+                json['path'],
+                json['follow_symlink'])
+      res.type = json['type']
+      Train::File::DATA_FIELDS.each do |f|
+        m = (f.tr('?', '') + '=').to_sym
+        res.method(m).call(json[f])
+      end
+      res
+    end
+
+    Train::File::DATA_FIELDS.each do |m|
+      attr_accessor m.tr('?', '').to_sym
+      next unless m.include?('?')
+
+      define_method m.to_sym do
+        method(m.tr('?', '').to_sym).call
+      end
+    end
+    attr_accessor :type
+
+    def initialize(backend, path, follow_symlink = true)
+      super(backend, path, follow_symlink)
+      @type = :unknown
+      @exist = false
+    end
+
+    def mounted
+      @mounted ||=
+        @backend.run_command("mount | grep -- ' on #{@path}'")
+    end
+  end
+end

data/lib/train/version.rb

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

data/train-core.gemspec

@@ -3,6 +3,11 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'train/version'
 
+CORE_TRANSPORTS = [
+  'lib/train/transports/local.rb',
+  'lib/train/transports/mock.rb',
+].freeze
+
 Gem::Specification.new do |spec|
   spec.name          = 'train-core'
   spec.version       = Train::VERSION
@@ -15,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.files = %w{train-core.gemspec README.md LICENSE Gemfile CHANGELOG.md} + Dir
                .glob('lib/**/*', File::FNM_DOTMATCH)
-               .reject { |f| f =~ /^(?!.*(local.rb)).*transports/ }
+               .reject { |f| f =~ %r{lib/train/transports} unless CORE_TRANSPORTS.include?(f) }
                .reject { |f| File.directory?(f) }
 
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 1.4.11
+  version: 1.4.15
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-17 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -87,6 +87,7 @@ files:
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
 - lib/train/transports/local.rb
+- lib/train/transports/mock.rb
 - lib/train/version.rb
 - train-core.gemspec
 homepage: https://github.com/chef/train/