train 1.4.22 → 1.4.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455f5a9ff1827140f4f890be1b536a30261120db86836ee266b15eb418fe2900
-  data.tar.gz: e4d8c9dba2799532849ed9699cf11e813ec44669abc519f5e52de9ec9c5bd507
+  metadata.gz: 6ecda8bbe5e6b070ad719dbdaa0fd84f7711951331006dca61073f7c466ecf62
+  data.tar.gz: 0c3bf400d8f4feb0c36b5cc0ef1b51b50ed61e2a75a7725197c510652958c0fb
 SHA512:
-  metadata.gz: 8403b5941b3596a6aff77c830332e21f4b9a878eeb65b39c84fc598467060dae99b69c7968f9697379534d2fd5867b990343783a971658b257a21110ceeca044
-  data.tar.gz: 0dd9693a229a54b80c6bdaf9fe91f9d80ef3809bd2d860f5fa77ca7438f349df3d6951a0516057672651942251fa1eea432570774172b2b9afe3b49f100b973b
+  metadata.gz: 9d0108b3647bedda9f7b1d7c85ef5ebbd40498b23ea17a6c625b978262328cdb76db8ee3d5e38409d743f95a34bb6f78b6fb5dc22da5eb325a2bb75bc1b5db81
+  data.tar.gz: aadc074f3ce261c4b9d410691e8d6e6e2203ac83ddd297107c2852a24f017800f9465b8b9e9e5eb59aeadefc9270c546a5b95a3c128177630c7c92f3abee9cbc

data/CHANGELOG.md

@@ -1,24 +1,30 @@
-<!-- latest_release 1.4.22 -->
-## [v1.4.22](https://github.com/inspec/train/tree/v1.4.22) (2018-07-12)
+<!-- latest_release 1.4.24 -->
+## [v1.4.24](https://github.com/inspec/train/tree/v1.4.24) (2018-07-26)
 
 #### Merged Pull Requests
-- Add VMware transport [#321](https://github.com/inspec/train/pull/321) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+- Retry SSH command on IOError (Cisco IOS specific) [#326](https://github.com/inspec/train/pull/326) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
 <!-- latest_release -->
 
-<!-- release_rollup since=1.4.21 -->
-### Changes since 1.4.21 release
+<!-- release_rollup since=1.4.22 -->
+### Changes since 1.4.22 release
 
 #### Merged Pull Requests
-- Add VMware transport [#321](https://github.com/inspec/train/pull/321) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.22 -->
+- Retry SSH command on IOError (Cisco IOS specific) [#326](https://github.com/inspec/train/pull/326) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.24 -->
+- Add shallow_link_path to inspect symlink direct link [#309](https://github.com/inspec/train/pull/309) ([ColinHebert](https://github.com/ColinHebert)) <!-- 1.4.23 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v1.4.22](https://github.com/inspec/train/tree/v1.4.22) (2018-07-16)
+
+#### Merged Pull Requests
+- Add VMware transport [#321](https://github.com/inspec/train/pull/321) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+<!-- latest_stable_release -->
+
 ## [v1.4.21](https://github.com/inspec/train/tree/v1.4.21) (2018-07-05)
 
 #### Merged Pull Requests
 - Remove the delivery cookbook [#317](https://github.com/inspec/train/pull/317) ([tas50](https://github.com/tas50))
 - Modify `WindowsPipeRunner` stderr to use String [#320](https://github.com/inspec/train/pull/320) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
-<!-- latest_stable_release -->
 
 ## [v1.4.19](https://github.com/inspec/train/tree/v1.4.19) (2018-06-29)
 

data/lib/train/file/local.rb

@@ -27,6 +27,11 @@ module Train
         end
       end
 
+      def shallow_link_path
+        return nil unless symlink?
+        @link_path ||= ::File.readlink(@path)
+      end
+
       def block_device?
         ::File.blockdev?(@path)
       end

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

@@ -12,6 +12,12 @@ module Train
             @backend.run_command("perl -e 'print readlink shift' #{@spath}").stdout.chomp
         end
 
+        def shallow_link_path
+          return nil unless symlink?
+          @shallow_link_path ||=
+            @backend.run_command("perl -e 'print readlink shift' #{@spath}").stdout.chomp
+        end
+
         def mounted
           @mounted ||= @backend.run_command("lsfs -c #{@spath}")
         end

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

@@ -60,6 +60,11 @@ module Train
           symlink? ? path : nil
         end
 
+        def shallow_link_path
+          return nil unless symlink?
+          @shallow_link_path ||= ::File.readlink(@path)
+        end
+
         def unix_mode_mask(owner, type)
           o = UNIX_MODE_OWNERS[owner.to_sym]
           return nil if o.nil?

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

@@ -77,6 +77,10 @@ module Train
           nil
         end
 
+        def shallow_link_path
+          nil
+        end
+
         def mounted
           nil
         end

data/lib/train/transports/ssh_connection.rb

@@ -32,6 +32,9 @@ class Train::Transports::SSH
   class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
     attr_reader :hostname
     def initialize(options)
+      # Track IOS command retries to prevent infinite loop on IOError. This must
+      # be done before `super()` because the parent runs detection commands.
+      @ios_cmd_retries = 0
       super(options)
       @username               = @options.delete(:username)
       @hostname               = @options.delete(:hostname)
@@ -203,7 +206,7 @@ class Train::Transports::SSH
       end
     end
 
-    def run_command_via_connection(cmd)
+    def run_command_via_connection(cmd) # rubocop:disable AbcSize
       stdout = stderr = ''
       exit_status = nil
       cmd.dup.force_encoding('binary') if cmd.respond_to?(:force_encoding)
@@ -242,9 +245,25 @@ class Train::Transports::SSH
       end
       @session.loop
 
+      # Since `@session.loop` succeeded, reset the IOS command retry counter
+      @ios_cmd_retries = 0
+
       CommandResult.new(stdout, stderr, exit_status)
     rescue Net::SSH::Exception => ex
       raise Train::Transports::SSHFailed, "SSH command failed (#{ex.message})"
+    rescue IOError
+      # Cisco IOS occasionally closes the stream prematurely while we are
+      # running commands to detect if we need to switch to the Cisco IOS
+      # transport. This retries the command if this is the case.
+      # See:
+      #  https://github.com/inspec/train/pull/271
+      logger.debug('[SSH] Possible Cisco IOS race condition, retrying command')
+
+      # Only attempt retry up to 5 times to avoid infinite loop
+      @ios_cmd_retries += 1
+      raise if @ios_cmd_retries >= 5
+
+      retry
     end
 
     # Returns a connection session, or establishes one when invoked the

data/lib/train/version.rb

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

data/test/unit/file/local_test.rb

@@ -10,7 +10,7 @@ describe Train::File::Local do
     File.stub :read, res do
       connection.file(rand.to_s).content.must_equal(res)
     end
-  end 
+  end
 
   {
     exist?:            :exist?,
@@ -33,13 +33,13 @@ describe Train::File::Local do
     it 'returns the type block_device if it is block device' do
       File.stub :ftype, "blockSpecial" do
         connection.file(rand.to_s).type.must_equal :block_device
-      end  
+      end
     end
 
     it 'returns the type character_device if it is character device' do
       File.stub :ftype, "characterSpecial" do
         connection.file(rand.to_s).type.must_equal :character_device
-      end  
+      end
     end
 
     it 'returns the type symlink if it is symlink' do
@@ -77,7 +77,7 @@ describe Train::File::Local do
         connection.file(rand.to_s).type.must_equal :unknown
       end
     end
-  end  
+  end
 
   describe '#path' do
     it 'returns the path if it is not a symlink' do
@@ -107,4 +107,15 @@ describe Train::File::Local do
       end
     end
   end
-end
+
+  describe '#shallow_shlink_path' do
+    it 'returns file\'s direct link path' do
+      out = rand.to_s
+      File.stub :readlink, out do
+        File.stub :symlink?, true do
+          connection.file(rand.to_s).shallow_link_path.must_equal out
+        end
+      end
+    end
+  end
+end

data/test/unit/file/remote/aix_test.rb

@@ -23,4 +23,11 @@ describe Train::File::Remote::Aix do
     backend.mock_command("perl -e 'print readlink shift' path", 'our_link_path')
     file.link_path.must_equal 'our_link_path'
   end
+
+  it 'returns a correct shallow_link_path' do
+    file = cls.new(backend, 'path')
+    file.stubs(:symlink?).returns(true)
+    backend.mock_command("perl -e 'print readlink shift' path", 'our_link_path')
+    file.link_path.must_equal 'our_link_path'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.4.22
+  version: 1.4.24
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json