train 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7604c39afcff5da8e779ef47620e390b71d83a0a
-  data.tar.gz: 1191f7c084243fd91c9e3b1dcfc1ad4ee4758ade
+  metadata.gz: bef369edee3db008a24f018851fb38b4b8ee2690
+  data.tar.gz: 4a029b67d3631b3975ad928c1b7c7832ac7da2cf
 SHA512:
-  metadata.gz: 94543cfac0c7dfb5ccfdcfb2a56f5e9d53680201187f5a10dad5d649eeaa1a9403eff44e56a280f877cea4cba0fa0fa1c97cb3e7d494c8fede74fef2a4296a18
-  data.tar.gz: aa1849279ce4a0c81018d0645f6cea47b0c33d7862c5fab49445d997237371f2b0203146c1b1b93f6877106d3051c463795784c13b06e6ec1c2f5abcbc769ba4
+  metadata.gz: 81d4f61c914a1b3cbdfc11037c90be5652d3a7a8264d8ba351c65e614036a71bb507339ea6bfec310098b65a261b831d0ca97e517bd86dde5d286fae4cc9d466
+  data.tar.gz: c8d5bddc212d56e7d7f604df95008339b676c8dcf59a7dc59c7422d997d23781adce45276db983184a7c4b659282b98bd1d3b6f50b7434444fca12dfb7d8e7c0

data/CHANGELOG.md

@@ -1,7 +1,20 @@
 # Change Log
 
-## [0.13.1](https://github.com/chef/train/tree/0.13.1) (2016-06-16)
-[Full Changelog](https://github.com/chef/train/compare/v0.12.1...0.13.1)
+## [0.14.0](https://github.com/chef/train/tree/0.14.0) (2016-06-27)
+[Full Changelog](https://github.com/chef/train/compare/v0.13.1...0.14.0)
+
+**Implemented enhancements:**
+
+- json in and out for base connection [\#118](https://github.com/chef/train/pull/118) ([arlimus](https://github.com/arlimus))
+- ESX support [\#116](https://github.com/chef/train/pull/116) ([Anirudh-Gupta](https://github.com/Anirudh-Gupta))
+
+**Fixed bugs:**
+
+- sporadic appveyor failure on `winrm delete ...` [\#105](https://github.com/chef/train/issues/105)
+- bugfix: run frozen string commands via ssh [\#117](https://github.com/chef/train/pull/117) ([arlimus](https://github.com/arlimus))
+
+## [v0.13.1](https://github.com/chef/train/tree/v0.13.1) (2016-06-16)
+[Full Changelog](https://github.com/chef/train/compare/v0.12.1...v0.13.1)
 
 **Implemented enhancements:**
 

data/lib/train/extras/file_common.rb

@@ -9,10 +9,12 @@ module Train::Extras
   class FileCommon # rubocop:disable Metrics/ClassLength
     # interface methods: these fields should be implemented by every
     # backend File
-    %w{
+    DATA_FIELDS = %w{
       exist? mode owner group uid gid content mtime size selinux_label path
       product_version file_version
-    }.each do |m|
+    }.freeze
+
+    DATA_FIELDS.each do |m|
       define_method m.to_sym do
         fail NotImplementedError, "File must implement the #{m}() method."
       end
@@ -24,6 +26,14 @@ module Train::Extras
       @follow_symlink = follow_symlink
     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
+    end
+
     def type
       :unknown
     end
@@ -50,27 +60,27 @@ module Train::Extras
     # Additional methods for convenience
 
     def file?
-      type == :file
+      type.to_s == 'file'
     end
 
     def block_device?
-      type == :block_device
+      type.to_s == 'block_device'
     end
 
     def character_device?
-      type == :character_device
+      type.to_s == 'character_device'
     end
 
     def socket?
-      type == :socket
+      type.to_s == 'socket'
     end
 
     def directory?
-      type == :directory
+      type.to_s == 'directory'
     end
 
     def symlink?
-      source.type == :symlink
+      source.type.to_s == 'symlink'
     end
 
     def source_path

data/lib/train/extras/os_common.rb

@@ -12,6 +12,7 @@ require 'train/extras/os_detect_darwin'
 require 'train/extras/os_detect_linux'
 require 'train/extras/os_detect_unix'
 require 'train/extras/os_detect_windows'
+require 'train/extras/os_detect_esx'
 
 module Train::Extras
   class OSCommon
@@ -19,6 +20,7 @@ module Train::Extras
     include Train::Extras::DetectLinux
     include Train::Extras::DetectUnix
     include Train::Extras::DetectWindows
+    include Train::Extras::DetectEsx
 
     def initialize(backend, platform = nil)
       @backend = backend
@@ -107,7 +109,7 @@ module Train::Extras
       detect_family_type
     end
 
-    def detect_family_type
+    def detect_family_type # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       pf = @platform[:family]
 
       return detect_windows if pf == 'windows'
@@ -120,6 +122,7 @@ module Train::Extras
 
       # unix based systems combine the above
       return true if pf == 'unix' and detect_darwin
+      return true if pf == 'unix' and detect_esx
       return true if pf == 'unix' and detect_via_uname
 
       # if we arrive here, we most likey have a regular linux

data/lib/train/extras/os_detect_esx.rb

@@ -11,10 +11,12 @@
 module Train::Extras
   module DetectEsx
     def detect_esx
-      @platform[:family] = 'esx'
-      @platform[:name] = uname_s.lines[0].chomp
-      @platform[:release] = uname_r.lines[0].chomp
-      true
+      if uname_s.downcase.chomp == 'vmkernel'
+        @platform[:family] = 'esx'
+        @platform[:name] = uname_s.lines[0].chomp
+        @platform[:release] = uname_r.lines[0].chomp
+        true
+      end
     end
   end
 end

data/lib/train/extras/stat.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 # author: Dominik Richter
 # author: Christoph Hartmann
-
 module Train::Extras
   class Stat
     TYPES = {
@@ -20,13 +19,13 @@ module Train::Extras
     end
 
     def self.stat(shell_escaped_path, backend, follow_symlink)
-      # use perl scripts for aix and solaris 10
+      # use perl scripts for aix, solaris 10 and hpux
       if backend.os.aix? || (backend.os.solaris? && backend.os[:release].to_i < 11) || backend.os.hpux?
         return aix_stat(shell_escaped_path, backend, follow_symlink)
       end
       return bsd_stat(shell_escaped_path, backend, follow_symlink) if backend.os.bsd?
-      # linux and solaris 11 will use standard linux stats
-      return linux_stat(shell_escaped_path, backend, follow_symlink) if backend.os.unix?
+      # linux,solaris 11 and esx will use standard linux stats
+      return linux_stat(shell_escaped_path, backend, follow_symlink) if backend.os.unix? || backend.os.esx?
       # all other cases we don't handle
       # TODO: print an error if we get here, as it shouldn't be invoked
       # on non-unix
@@ -35,7 +34,8 @@ module Train::Extras
 
     def self.linux_stat(shell_escaped_path, backend, follow_symlink)
       lstat = follow_symlink ? ' -L' : ''
-      res = backend.run_command("stat#{lstat} #{shell_escaped_path} 2>/dev/null --printf '%s\n%f\n%U\n%u\n%G\n%g\n%X\n%Y\n%C'")
+      format = backend.os.esx? ? '-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,8 +45,8 @@ module Train::Extras
 
       tmask = fields[1].to_i(16)
       selinux = fields[8]
-      selinux = nil if selinux == '?' or selinux == '(null)'
-
+      ## selinux security context string not available on esxi
+      selinux = nil if selinux == '?' or selinux == '(null)' or selinux == 'C'
       {
         type:  find_type(tmask),
         mode:  tmask & 07777,

data/lib/train/plugins/base_connection.rb

@@ -18,6 +18,9 @@ class Train::Plugins::Transport
   class BaseConnection
     include Train::Extras
 
+    # Provide access to the files cache.
+    attr_reader :files
+
     # Create a new Connection instance.
     #
     # @param options [Hash] connection options
@@ -25,6 +28,7 @@ class Train::Plugins::Transport
     def initialize(options = nil)
       @options = options || {}
       @logger = @options.delete(:logger) || Logger.new(STDOUT)
+      @files = {}
     end
 
     # Closes the session connection, if it is still active.
@@ -32,6 +36,19 @@ class Train::Plugins::Transport
       # this method may be left unimplemented if that is applicable
     end
 
+    def to_json
+      {
+        'files' => Hash[@files.map { |x, y| [x, y.to_json] }],
+      }
+    end
+
+    def load_json(j)
+      require 'train/transports/mock'
+      j['files'].each do |path, jf|
+        @files[path] = Train::Transports::Mock::Connection::File.from_json(jf)
+      end
+    end
+
     # Execute a command using this connection.
     #
     # @param command [String] command string to execute

data/lib/train/transports/docker.rb

@@ -60,7 +60,6 @@ class Train::Transports::Docker
       @id = options[:host]
       @container = ::Docker::Container.get(@id) ||
                    fail("Can't find Docker container #{@id}")
-      @files = {}
       @cmd_wrapper = nil
       @cmd_wrapper = CommandWrapper.load(self, @options)
       self

data/lib/train/transports/local.rb

@@ -22,7 +22,6 @@ module Train::Transports
     class Connection < BaseConnection
       def initialize(options)
         super(options)
-        @files = {}
         @cmd_wrapper = nil
         @cmd_wrapper = CommandWrapper.load(self, options)
       end

data/lib/train/transports/mock.rb

@@ -65,7 +65,6 @@ class Train::Transports::Mock
 
     def initialize(conf = nil)
       @conf = conf || {}
-      @files = {}
       @os = OS.new(self, family: 'unknown')
       @commands = {}
     end
@@ -130,12 +129,27 @@ end
 
 class Train::Transports::Mock::Connection
   class File < FileCommon
-    %w{
-      exist? mode owner group link_path content mtime size
-      selinux_label product_version file_version path type
-    }.each do |m|
+    def self.from_json(json)
+      res = new(json['backend'],
+                json['path'],
+                json['follow_symlink'])
+      res.type = json['type']
+      Train::Extras::FileCommon::DATA_FIELDS.each do |f|
+        m = (f.tr('?', '') + '=').to_sym
+        res.method(m).call(json[f])
+      end
+      res
+    end
+
+    Train::Extras::FileCommon::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)

data/lib/train/transports/ssh_connection.rb

@@ -38,7 +38,6 @@ class Train::Transports::SSH
       @connection_retries     = @options.delete(:connection_retries)
       @connection_retry_sleep = @options.delete(:connection_retry_sleep)
       @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
-      @files                  = {}
       @session                = nil
       @transport_options      = @options.delete(:transport_options)
       @cmd_wrapper            = nil
@@ -73,7 +72,7 @@ class Train::Transports::SSH
     def run_command(cmd)
       stdout = stderr = ''
       exit_status = nil
-      cmd.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})")
 
       session.open_channel do |channel|

data/lib/train/transports/winrm_connection.rb

@@ -27,7 +27,7 @@ class Train::Transports::WinRM
   # host such as executing commands, transferring files, etc.
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
+  class Connection < BaseConnection
     def initialize(options)
       super(options)
       @endpoint               = @options.delete(:endpoint)
@@ -36,7 +36,6 @@ class Train::Transports::WinRM
       @connection_retries     = @options.delete(:connection_retries)
       @connection_retry_sleep = @options.delete(:connection_retry_sleep)
       @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
-      @files                  = {}
     end
 
     # (see Base::Connection#close)

data/lib/train/version.rb

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

data/test/integration/test-one.yaml

@@ -0,0 +1,4 @@
+images:
+- alpine:edge
+provision:
+- script: bootstrap.sh

data/test/integration/test-two.yaml

@@ -0,0 +1,4 @@
+images:
+- ubuntu:16.04
+provision:
+- script: bootstrap.sh

data/test/integration/tests/path_file_test.rb

@@ -75,5 +75,11 @@ describe 'file interface' do
     it 'has no file_version' do
       file.file_version.must_equal(nil)
     end
+
+    it 'provides a json representation' do
+      j = file.to_json
+      j.must_be_kind_of Hash
+      j['type'].must_equal :file
+    end
   end
 end

data/test/integration/tests/run_command_test.rb

@@ -10,6 +10,13 @@ describe 'run_command' do
     res.exit_status.must_equal(0)
   end
 
+  it 'can run frozen commands' do
+    res = backend.run_command('echo hello world'.freeze)
+    res.stdout.must_equal("hello world\n")
+    res.stderr.must_equal('')
+    res.exit_status.must_equal(0)
+  end
+
   it 'can echo commands to stderr' do
     # TODO: Specinfra often fails on this test.
     # Fix and re-enable it.

data/test/unit/extras/os_common_test.rb

@@ -270,6 +270,7 @@ describe 'os common plugin' do
     let(:os) { mock_platform('esx') }
     it { os.solaris?.must_equal(false) }
     it { os.linux?.must_equal(false) }
+    it {os[:family].must_equal('esx')}
     it { os.unix?.must_equal(false) }
     it { os.esx?.must_equal(true) }
   end

data/test/unit/extras/stat_test.rb

@@ -46,15 +46,56 @@ describe 'stat' do
 
     it 'ignores wrong stat results' do
       res = Minitest::Mock.new
+      os = Minitest::Mock.new
       res.expect :stdout, ''
+      os.expect :esx?, false
+      backend.expect :os, os
       backend.expect :run_command, res, [String]
       cls.linux_stat('/path', backend, false).must_equal({})
     end
 
     it 'reads correct stat results' do
       res = Minitest::Mock.new
+      os = Minitest::Mock.new
       # 43ff is 41777; linux_stat strips the 4
       res.expect :stdout, "360\n43ff\nroot\n0\nrootz\n1\n1444520846\n1444522445\n?"
+      os.expect :esx?, false
+      backend.expect :os, os
+      backend.expect :run_command, res, [String]
+      cls.linux_stat('/path', backend, false).must_equal({
+        type: :directory,
+        mode: 01777,
+        owner: 'root',
+        uid: 0,
+        group: 'rootz',
+        gid: 1,
+        mtime: 1444522445,
+        size: 360,
+        selinux_label: nil,
+      })
+    end
+  end
+
+  describe 'esx stat' do
+    let(:backend) { Minitest::Mock.new }
+
+    it 'ignores wrong stat results' do
+      res = Minitest::Mock.new
+      os = Minitest::Mock.new
+      res.expect :stdout, ''
+      os.expect :esx?, true
+      backend.expect :os, os
+      backend.expect :run_command, res, [String]
+      cls.linux_stat('/path', backend, false).must_equal({})
+    end
+
+    it 'reads correct stat results' do
+      res = Minitest::Mock.new
+      os = Minitest::Mock.new
+      # 43ff is 41777; linux_stat strips the 4
+      res.expect :stdout, "360\n43ff\nroot\n0\nrootz\n1\n1444520846\n1444522445\nC"
+      os.expect :esx?, true
+      backend.expect :os, os
       backend.expect :run_command, res, [String]
       cls.linux_stat('/path', backend, false).must_equal({
         type: :directory,

data/test/unit/transports/mock_test.rb

@@ -84,8 +84,15 @@ describe 'mock transport' do
   end
 
   describe 'when accessing a mocked file' do
-    it 'gets results for content' do
-
+    JSON = Train.create('local').connection.file(__FILE__).to_json
+    RES = Train::Transports::Mock::Connection::File.from_json(JSON)
+
+    # tests if all fields between the local json and resulting mock file
+    # are equal
+    %w{ content mode owner group }.each do |f|
+      it "can be initialized from json (field #{f})" do
+        RES.method(f).call.must_equal JSON[f]
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -188,8 +188,10 @@ files:
 - test/integration/sudo/passwd.rb
 - test/integration/sudo/reqtty.rb
 - test/integration/sudo/run_as.rb
+- test/integration/test-one.yaml
 - test/integration/test-travis-1.yaml
 - test/integration/test-travis-2.yaml
+- test/integration/test-two.yaml
 - test/integration/test_local.rb
 - test/integration/test_ssh.rb
 - test/integration/tests/path_block_device_test.rb
@@ -241,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Transport interface to talk to different backends.
@@ -262,8 +264,10 @@ test_files:
 - test/integration/sudo/passwd.rb
 - test/integration/sudo/reqtty.rb
 - test/integration/sudo/run_as.rb
+- test/integration/test-one.yaml
 - test/integration/test-travis-1.yaml
 - test/integration/test-travis-2.yaml
+- test/integration/test-two.yaml
 - test/integration/test_local.rb
 - test/integration/test_ssh.rb
 - test/integration/tests/path_block_device_test.rb