train 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a7512d438219eb926939d6e65b7ca59541d43c
-  data.tar.gz: 525f5ef0734a59e2f3f6fc90296829f34c0d6376
+  metadata.gz: cc2d4b48426cfdbf820116b76d6b1d0d4d5336b0
+  data.tar.gz: 509cdb12eac96f85cfdc04daf255bd59e1e2dbbd
 SHA512:
-  metadata.gz: f2066a11bad5834d56ac6af79f5e49cd48323736ffe66b21df929e6cbe3c6d76f0d55c87a6a906677960c585067c8a47b9873ba4179dda1ce4e497d075d30053
-  data.tar.gz: fada216873d7e08ed9ba259b2fdc6e1dcc652380964900efe359734dcac817e821fe33f9090ff32985b2703055c0d0850067535d6a04bd150c16368c9126dc17
+  metadata.gz: 46724f6d5f90556e90854488b0eb28736a93f6daacf86389ee2cb45f120c9699c983428d317831ee61cb1e829ec8b49d75883562e0e65548883cee33eec8cc8e
+  data.tar.gz: 7097d55714e3c2e36d1bec6bf169a72a8d84c2a138bfc5012d914059d2487499a1f086f8e4c1f4d2ccc5165b4d83847ca8010459a5fa45ba056dbcc2616d9c69

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Change Log
 
-## [0.21.1](https://github.com/chef/train/tree/0.21.1) (2016-11-04)
-[Full Changelog](https://github.com/chef/train/compare/v0.21.0...0.21.1)
+## [0.22.0](https://github.com/chef/train/tree/0.22.0) (2016-11-29)
+[Full Changelog](https://github.com/chef/train/compare/v0.21.1...0.22.0)
+
+**Implemented enhancements:**
+
+- Try to use ssh agent if no password or key files have been specified [\#165](https://github.com/chef/train/pull/165) ([alexpop](https://github.com/alexpop))
+
+**Merged pull requests:**
+
+- Add openvms detection [\#159](https://github.com/chef/train/pull/159) ([briandoodyie](https://github.com/briandoodyie))
+
+## [v0.21.1](https://github.com/chef/train/tree/v0.21.1) (2016-11-04)
+[Full Changelog](https://github.com/chef/train/compare/v0.21.0...v0.21.1)
 
 **Closed issues:**
 

data/Gemfile

@@ -30,6 +30,7 @@ end
 
 group :tools do
   gem 'pry', '~> 0.10'
+  gem 'rb-readline'
   gem 'license_finder'
   gem 'github_changelog_generator', '~> 1'
 end

data/README.md

@@ -39,6 +39,13 @@ train = Train.create('ssh',
   host: '1.2.3.4', port: 22, user: 'root', key_files: '/vagrant')
 ```
 
+If you don't specify the `key_files` and `password` options, SSH agent authentication will be attempted. For example:
+
+```ruby
+require 'train'
+train = Train.create('ssh', host: '1.2.3.4', port: 22, user: 'root')
+```
+
 **WinRM**
 
 ```ruby

data/lib/train/extras/os_common.rb

@@ -14,6 +14,7 @@ require 'train/extras/os_detect_unix'
 require 'train/extras/os_detect_windows'
 require 'train/extras/os_detect_esx'
 require 'train/extras/os_detect_arista_eos'
+require 'train/extras/os_detect_openvms'
 
 module Train::Extras
   class OSCommon
@@ -23,6 +24,7 @@ module Train::Extras
     include Train::Extras::DetectWindows
     include Train::Extras::DetectEsx
     include Train::Extras::DetectAristaEos
+    include Train::Extras::DetectOpenVMS
 
     attr_accessor :backend
     def initialize(backend, platform = nil)
@@ -96,6 +98,8 @@ module Train::Extras
       # TODO: extend base implementation for detecting the family type
       # to Windows and others
       case uname_s
+      when /unrecognized command verb/
+        @platform[:family] = 'openvms'
       when /linux/i
         @platform[:family] = 'linux'
       when /./
@@ -105,8 +109,8 @@ module Train::Extras
         @platform[:family] = nil
       end
 
-      # try to detect the platform
-      return nil unless @platform[:family].nil?
+      # try to detect the platform if the platform is set to nil, otherwise this code will never work
+      return nil if @platform[:family].nil?
       detect_family_type
     end
 
@@ -116,6 +120,7 @@ module Train::Extras
       return detect_windows if pf == 'windows'
       return detect_darwin if pf == 'darwin'
       return detect_esx if pf == 'esx'
+      return detect_openvms if pf =='openvms'
 
       if %w{freebsd netbsd openbsd aix solaris2 hpux}.include?(pf)
         return detect_via_uname
@@ -124,6 +129,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
+      # This is assuming that pf is set to unix, this should be if pf == 'linux'
       return true if pf == 'unix' and detect_arista_eos
       return true if pf == 'unix' and detect_via_uname
 

data/lib/train/extras/os_detect_openvms.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+# author: Brian Doody (HPE)
+# This is heavily based on:
+#
+#   OHAI https://github.com/chef/ohai
+#   by Adam Jacob, Chef Software Inc
+#
+require 'train/extras/uname'
+
+module Train::Extras
+  module DetectOpenVMS
+    include Train::Extras::Uname
+
+    def detect_openvms
+      cmd = @backend.run_command('show system/noprocess')
+
+      return false if cmd.exit_status != 0
+      return false if cmd.stdout.empty?
+
+      @platform[:name] = cmd.stdout.downcase.split(' ')[0]
+      cmd = @backend.run_command('write sys$output f$getsyi("VERSION")')
+      @platform[:release] = cmd.stdout.downcase.split("\n")[1][1..-1]
+      cmd = @backend.run_command('write sys$output f$getsyi("ARCH_NAME")')
+      @platform[:arch] = cmd.stdout.downcase.split("\n")[1]
+
+      true
+    end
+  end
+end

data/lib/train/transports/ssh.rb

@@ -82,12 +82,6 @@ module Train::Transports
       super(options)
 
       key_files = Array(options[:key_files])
-      if key_files.empty? and options[:password].nil?
-        fail Train::ClientError,
-             'You must configure at least one authentication method for SSH:'\
-             ' Password or key.'
-      end
-
       options[:auth_methods] ||= ['none']
 
       unless key_files.empty?
@@ -100,6 +94,17 @@ module Train::Transports
         options[:auth_methods].push('password', 'keyboard-interactive')
       end
 
+      if options[:auth_methods] == ['none']
+        if ssh_known_identities.empty?
+          fail Train::ClientError,
+               'You must configure at least one authentication method for SSH:'\
+               ' Agent, Key or Password.'
+        else
+          logger.debug('[SSH] Using Agent keys as no password or key file have been specified')
+          options[:auth_methods].push('publickey')
+        end
+      end
+
       if options[:pty]
         logger.warn('[SSH] PTY requested: stderr will be merged into stdout')
       end
@@ -108,6 +113,17 @@ module Train::Transports
       self
     end
 
+    # Creates an SSH Authentication KeyManager instance and saves it for
+    # potential future reuse.
+    #
+    # @return [Hash] hash of SSH Known Identities
+    # @api private
+    def ssh_known_identities
+      # Force KeyManager to load the key(s)
+      @manager ||= Net::SSH::Authentication::KeyManager.new(nil).each_identity {}
+      @manager.known_identities
+    end
+
     # Builds the hash of options needed by the Connection object on
     # construction.
     #

data/lib/train/transports/ssh_connection.rb

@@ -230,7 +230,7 @@ class Train::Transports::SSH
 
     class OS < OSCommon
       def initialize(backend)
-        super(backend, { family: 'unix' })
+        super(backend)
       end
     end
   end

data/lib/train/version.rb

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

data/test/unit/transports/ssh_test.rb

@@ -23,6 +23,7 @@ describe 'ssh transport' do
     password: rand.to_s,
     key_files: rand.to_s,
   }}
+  let(:cls_agent) { cls.new({ host: rand.to_s }) }
 
   describe 'default options' do
     let(:ssh) { cls.new({ host: 'dummy' }) }
@@ -84,6 +85,26 @@ describe 'ssh transport' do
         "root@#{conf[:host]}",
       ])
     end
+
+    it 'sets the right auth_methods when password is specified' do
+      conf[:key_files] = nil
+      cls.new(conf).connection.method(:options).call[:auth_methods].must_equal ["none", "password", "keyboard-interactive"]
+    end
+
+    it 'sets the right auth_methods when keys are specified' do
+      conf[:password] = nil
+      cls.new(conf).connection.method(:options).call[:auth_methods].must_equal ["none", "publickey"]
+    end
+
+    it 'sets the right auth_methods for agent auth' do
+      cls_agent.stubs(:ssh_known_identities).returns({:some => 'rsa_key'})
+      cls_agent.connection.method(:options).call[:auth_methods].must_equal ['none', 'publickey']
+    end
+
+    it 'works with ssh agent auth' do
+      cls_agent.stubs(:ssh_known_identities).returns({:some => 'rsa_key'})
+      cls_agent.connection
+    end
   end
 
   describe 'converting connection to string for logging' do
@@ -111,9 +132,8 @@ describe 'ssh transport' do
     end
 
     it 'does not like key and password == nil' do
-      conf.delete(:password)
-      conf.delete(:key_files)
-      proc { cls.new(conf).connection }.must_raise Train::ClientError
+      cls_agent.stubs(:ssh_known_identities).returns({})
+      proc { cls_agent.connection }.must_raise Train::ClientError
     end
 
     it 'wont connect if it is not possible' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -162,6 +162,7 @@ files:
 - lib/train/extras/os_detect_darwin.rb
 - lib/train/extras/os_detect_esx.rb
 - lib/train/extras/os_detect_linux.rb
+- lib/train/extras/os_detect_openvms.rb
 - lib/train/extras/os_detect_unix.rb
 - lib/train/extras/os_detect_windows.rb
 - lib/train/extras/stat.rb