train 0.32.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc74b66a02b98fd67a644a04eb0e5f2186a1826
-  data.tar.gz: 131969604ad1bc09e8189c341fbbcca6d27c2315
+  metadata.gz: '008089b91adad72506c6825bad3e8b4c6837af27'
+  data.tar.gz: 7d584e084f13afe3ef7a915cbc7a19ee20597be3
 SHA512:
-  metadata.gz: 291bcb6b64d9d02da399f3f99e6d7dbde34cf5049601712559e79b7d4118bf55d78201c9d70564f5f90c7e88ef516f7f59b19ac0046a21c2c1202eb144201a8c
-  data.tar.gz: e8f7a849c58abfc84bdd01e282b43bef1d6fc2766d26293c9eee414a136ad8b8875b6b0f464cd682a29df81692bfbdc7c13014622442159b51cbac94a13a2611
+  metadata.gz: 67d87897890642480be62a48e8bc7571ebf0769f3561d85931bd524317c1503c0c4e4ff4e26b3a1d72e717a4f02c5f660956f741b0663046697d0549b3dd059d
+  data.tar.gz: 8c6f4246840527633d22c5aee4947cc17349cf77a8a2f742db541d11f9a371aee4f41825428ee2e163f277aabaae62ce75a5cef8abc406220da0f6b9d01934bf

data/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Change Log
 
-## [0.32.0](https://github.com/chef/train/tree/0.32.0) (2018-01-04)
-[Full Changelog](https://github.com/chef/train/compare/v0.31.1...0.32.0)
+## [1.0.0](https://github.com/chef/train/tree/1.0.0) (2018-02-01)
+[Full Changelog](https://github.com/chef/train/compare/v0.32.0...1.0.0)
+
+**Closed issues:**
+
+- Add aws:// target [\#229](https://github.com/chef/train/issues/229)
+
+**Merged pull requests:**
+
+- cisco nexus + ios12 [\#247](https://github.com/chef/train/pull/247) ([arlimus](https://github.com/arlimus))
+- Add a CONTRIBUTING.md to Train [\#245](https://github.com/chef/train/pull/245) ([miah](https://github.com/miah))
+- catch detect failing to parse json [\#243](https://github.com/chef/train/pull/243) ([arlimus](https://github.com/arlimus))
+- if ssh closes the session force it to reset and reopen [\#242](https://github.com/chef/train/pull/242) ([arlimus](https://github.com/arlimus))
+- Add AWS transport [\#239](https://github.com/chef/train/pull/239) ([clintoncwolfe](https://github.com/clintoncwolfe))
+- Fix detection of Scientific Linux [\#237](https://github.com/chef/train/pull/237) ([schrd](https://github.com/schrd))
+
+## [v0.32.0](https://github.com/chef/train/tree/v0.32.0) (2018-01-04)
+[Full Changelog](https://github.com/chef/train/compare/v0.31.1...v0.32.0)
 
 **Fixed bugs:**
 
@@ -10,6 +26,7 @@
 
 **Merged pull requests:**
 
+- Release 0.32.0 [\#232](https://github.com/chef/train/pull/232) ([adamleff](https://github.com/adamleff))
 - Set mock transport to use the platform instance variable [\#230](https://github.com/chef/train/pull/230) ([jquick](https://github.com/jquick))
 
 ## [v0.31.1](https://github.com/chef/train/tree/v0.31.1) (2017-12-06)

data/README.md

@@ -4,13 +4,14 @@
 [![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/train?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/train/branch/master)
 [![Gem Version](https://badge.fury.io/rb/train.svg)](https://badge.fury.io/rb/train)
 
-Train lets you talk to your local or remote operating systems with a unified interface.
+Train lets you talk to your local or remote operating systems and APIs with a unified interface.
 
 It allows you to:
 
 * execute commands via `run_command`
 * interact with files via `file`
 * identify the target operating system via `os`
+* authenticate to API-based services and treat them like a platform
 
 Train supports:
 
@@ -19,6 +20,7 @@ Train supports:
 * WinRM
 * Docker
 * Mock (for testing and debugging)
+* AWS as an API
 
 # Examples
 
@@ -61,6 +63,21 @@ require 'train'
 train = Train.create('docker', host: 'container_id...')
 ```
 
+**AWS**
+
+To use AWS API authentication, setup an AWS client profile to store the Access Key ID and Secret Access Key.
+
+```ruby
+require 'train'
+train = Train.create('aws', region: 'us-east-2', profile: 'my-profile')
+```
+
+You may also use the standard AWS CLI environment variables, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`.
+```ruby
+require 'train'
+train = Train.create('aws')
+```
+
 ## Configuration
 
 To get a list of available options for a plugin:
@@ -96,6 +113,10 @@ puts conn.os[:release]
 # access files
 puts conn.file('/proc/version').content
 
+# access specific API client functionality
+ec2_client = train.connection.aws_client(Aws::EC2::Client)
+puts ec2_client.describe_instances
+
 # close the connection
 conn.close
 ```

data/lib/train/platforms.rb

@@ -6,6 +6,7 @@ require 'train/platforms/platform'
 require 'train/platforms/detect'
 require 'train/platforms/detect/scanner'
 require 'train/platforms/detect/specifications/os'
+require 'train/platforms/detect/specifications/api'
 
 module Train::Platforms
   class << self

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

@@ -52,5 +52,23 @@ module Train::Platforms::Detect::Helpers
       return @uname[:m] if @uname.key?(:m)
       @uname[:m] = command_output('uname -m')
     end
+
+    def cisco_show_version
+      return @cache[:cisco] if @cache.key?(:cisco)
+      res = command_output('show version')
+
+      m = res.match(/^Cisco IOS Software, [^,]+? \(([^,]+?)\), Version (\d+\.\d+)/)
+      unless m.nil?
+        return @cache[:cisco] = { version: m[2], model: m[1], type: 'ios' }
+      end
+
+      m = res.match(/^Cisco Nexus Operating System \(NX-OS\) Software/)
+      unless m.nil?
+        v = res[/^\s*system:\s+version (\d+\.\d+)/, 1]
+        return @cache[:cisco] = { version: v, type: 'nexus' }
+      end
+
+      @cache[:cisco] = nil
+    end
   end
 end

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

@@ -15,6 +15,7 @@ module Train::Platforms::Detect
       @files = {}
       @uname = {}
       @lsb = {}
+      @cache = {}
     end
 
     # Main detect method to scan all platforms for a match

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

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Train::Platforms::Detect::Specifications
+  class Api
+    def self.load
+      plat = Train::Platforms
+
+      plat.family('api')
+      plat.family('cloud').in_family('api')
+      plat.name('aws').in_family('cloud')
+    end
+  end
+end

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

@@ -27,12 +27,38 @@ module Train::Platforms::Detect::Specifications
       # unix master family
       plat.family('unix')
           .detect {
-            if unix_uname_s =~ /./
+            # 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 ')
               @platform[:arch] = unix_uname_m
               true
             end
           }
 
+      # cisco_ios family
+      plat.family('cisco').title('Cisco Family')
+          .detect {
+            !cisco_show_version.nil?
+          }
+
+      plat.name('cisco_ios').title('Cisco IOS').in_family('cisco')
+          .detect {
+            v = cisco_show_version
+            next unless v[:type] == 'ios'
+            @platform[:release] = v[:version]
+            @platform[:arch] = nil
+            true
+          }
+
+      plat.name('cisco_nexus').title('Cisco Nexus').in_family('cisco')
+          .detect {
+            v = cisco_show_version
+            next unless v[:type] == 'nexus'
+            @platform[:release] = v[:version]
+            @platform[:arch] = nil
+            true
+          }
+
       # arista_eos family
       # this has to be before redhat as EOS is based off fedora
       plat.family('arista_eos').title('Arista EOS Family').in_family('unix')
@@ -46,10 +72,14 @@ module Train::Platforms::Detect::Specifications
             cmd = @backend.run_command('show version | json')
             if cmd.exit_status == 0 && !cmd.stdout.empty?
               require 'json'
-              eos_ver = JSON.parse(cmd.stdout)
-              @platform[:release] = eos_ver['version']
-              @platform[:arch] = eos_ver['architecture']
-              true
+              begin
+                eos_ver = JSON.parse(cmd.stdout)
+                @platform[:release] = eos_ver['version']
+                @platform[:arch] = eos_ver['architecture']
+                true
+              rescue JSON::ParserError
+                nil
+              end
             end
           }
       plat.name('arista_eos_bash').title('Arista EOS Bash Shell').in_family('arista_eos')
@@ -58,10 +88,14 @@ module Train::Platforms::Detect::Specifications
               cmd = @backend.run_command('FastCli -p 15 -c "show version | json"')
               if cmd.exit_status == 0 && !cmd.stdout.empty?
                 require 'json'
-                eos_ver = JSON.parse(cmd.stdout)
-                @platform[:release] = eos_ver['version']
-                @platform[:arch] = eos_ver['architecture']
-                true
+                begin
+                  eos_ver = JSON.parse(cmd.stdout)
+                  @platform[:release] = eos_ver['version']
+                  @platform[:arch] = eos_ver['architecture']
+                  true
+                rescue JSON::ParserError
+                  nil
+                end
               end
             end
           }
@@ -158,7 +192,7 @@ module Train::Platforms::Detect::Specifications
       plat.name('scientific').title('Scientific Linux').in_family('redhat')
           .detect {
             lsb = read_linux_lsb
-            if lsb && lsb[:id] =~ /scientificsl/i
+            if lsb && lsb[:id] =~ /scientific/i
               @platform[:release] = lsb[:release]
               true
             end

data/lib/train/plugins/base_connection.rb

@@ -23,6 +23,7 @@ class Train::Plugins::Transport
       @options = options || {}
       @logger = @options.delete(:logger) || Logger.new(STDOUT)
       Train::Platforms::Detect::Specifications::OS.load
+      Train::Platforms::Detect::Specifications::Api.load
 
       # default caching options
       @cache_enabled = {
@@ -76,6 +77,20 @@ class Train::Plugins::Transport
       false
     end
 
+    def direct_platform(name)
+      plat = Train::Platforms.name(name)
+      plat.backend = self
+      plat.family_hierarchy = family_hierarchy(plat).flatten
+      plat
+    end
+
+    def family_hierarchy(plat)
+      plat.families.each_with_object([]) do |(k, _v), memo|
+        memo << k.name
+        memo << family_hierarchy(k) unless k.families.empty?
+      end
+    end
+
     # Get information on the operating system which this transport connects to.
     #
     # @return [Platform] system information

data/lib/train/transports/aws.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require 'train/plugins'
+require 'aws-sdk'
+
+module Train::Transports
+  class Aws < Train.plugin(1)
+    name 'aws'
+    option :region, required: true, default: ENV['AWS_REGION']
+    option :access_key_id, default: ENV['AWS_ACCESS_KEY_ID']
+    option :secret_access_key, default: ENV['AWS_SECRET_ACCESS_KEY']
+    option :session_token, default: ENV['AWS_SESSION_TOKEN']
+
+    # This can provide the access key id and secret access key
+    option :profile, default: ENV['AWS_PROFILE']
+
+    def connection(_ = nil)
+      @connection ||= Connection.new(@options)
+    end
+
+    class Connection < BaseConnection
+      def initialize(options)
+        # Override for any cli options
+        # aws://region/my-profile
+        options[:region] = options[:host] || options[:region]
+        if options[:path]
+          # string the leading / from path
+          options[:profile] = options[:path][1..-1]
+        end
+        super(options)
+
+        @cache_enabled[:api_call] = true
+        @cache[:api_call] = {}
+
+        connect
+      end
+
+      def platform
+        direct_platform('aws')
+      end
+
+      def aws_client(klass)
+        return klass.new unless cache_enabled?(:api_call)
+        @cache[:api_call][klass.to_s.to_sym] ||= klass.new
+      end
+
+      def aws_resource(klass, args)
+        klass.new(args)
+      end
+
+      def connect
+        ENV['AWS_PROFILE'] = @options[:profile] if @options[:profile]
+        ENV['AWS_REGION'] = @options[:region] if @options[:region]
+      end
+
+      def uri
+        "aws://#{@options[:region]}"
+      end
+    end
+  end
+end

data/lib/train/transports/mock.rb

@@ -75,19 +75,12 @@ class Train::Transports::Mock
       value = { name: 'mock', family: 'mock', release: 'unknown', arch: 'unknown' }.merge(value)
 
       platform = Train::Platforms.name(value[:name])
-      platform.family_hierarchy = mock_os_hierarchy(platform).flatten
+      platform.family_hierarchy = family_hierarchy(platform).flatten
       platform.platform = value
       platform.add_platform_methods
       @platform = platform
     end
 
-    def mock_os_hierarchy(plat)
-      plat.families.each_with_object([]) do |(k, _v), memo|
-        memo << k.name
-        memo << mock_os_hierarchy(k) unless k.families.empty?
-      end
-    end
-
     def commands=(commands)
       @cache[:command] = commands
     end

data/lib/train/transports/ssh_connection.rb

@@ -182,6 +182,7 @@ class Train::Transports::SSH
       cmd.dup.force_encoding('binary') if cmd.respond_to?(:force_encoding)
       logger.debug("[SSH] #{self} (#{cmd})")
 
+      reset_session if session.closed?
       session.open_channel do |channel|
         # wrap commands if that is configured
         cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
@@ -232,6 +233,10 @@ class Train::Transports::SSH
       }.merge(retry_options))
     end
 
+    def reset_session
+      @session = nil
+    end
+
     # String representation of object, reporting its connection details and
     # configuration.
     #

data/lib/train/version.rb

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

data/test/unit/platforms/os_detect_test.rb

@@ -44,6 +44,16 @@ describe 'os_detect' do
         platform[:family].must_equal('redhat')
         platform[:release].must_equal('7.2.1511')
       end
+      it 'sets the correct family, name, and release on scientific linux' do
+        files = {
+          '/etc/redhat-release' => "Scientific Linux release 7.4 (Nitrogen)\n",
+          '/etc/os-release' => "NAME=\"Scientific Linux\"\nVERSION=\"7.4 (Nitrogen)\"\nID=\"rhel\"\nID_LIKE=\"scientific centos fedora\"\nVERSION_ID=\"7.4\"\nPRETTY_NAME=\"Scientific Linux 7.4 (Nitrogen)\"\nANSI_COLOR=\"0;31\"\nCPE_NAME=\"cpe:/o:scientificlinux:scientificlinux:7.4:GA\"\nHOME_URL=\"http://www.scientificlinux.org//\"\nBUG_REPORT_URL=\"mailto:scientific-linux-devel@listserv.fnal.gov\"\n\nREDHAT_BUGZILLA_PRODUCT=\"Scientific Linux 7\"\nREDHAT_BUGZILLA_PRODUCT_VERSION=7.4\nREDHAT_SUPPORT_PRODUCT=\"Scientific Linux\"\nREDHAT_SUPPORT_PRODUCT_VERSION=\"7.4\"\n",
+        }
+        platform = scan_with_files('linux', files)
+        platform[:name].must_equal('scientific')
+        platform[:family].must_equal('redhat')
+        platform[:release].must_equal('7.4')
+      end
     end
   end
 
@@ -172,4 +182,26 @@ describe 'os_detect' do
       end
     end
   end
+
+  describe 'cisco' do
+    it 'recognizes Cisco IOS12' do
+      mock = Train::Transports::Mock::Connection.new
+      mock.mock_command('show version', "Cisco IOS Software, C3750E Software (C3750E-UNIVERSALK9-M), Version 12.2(58)SE")
+      platform = Train::Platforms::Detect.scan(mock)
+
+      platform[:name].must_equal('cisco_ios')
+      platform[:family].must_equal('cisco')
+      platform[:release].must_equal('12.2')
+    end
+
+    it 'recognizes Cisco Nexus' do
+      mock = Train::Transports::Mock::Connection.new
+      mock.mock_command('show version', "Cisco Nexus Operating System (NX-OS) Software\n  system:      version 5.2(1)N1(8b)\n")
+      platform = Train::Platforms::Detect.scan(mock)
+
+      platform[:name].must_equal('cisco_nexus')
+      platform[:family].must_equal('cisco')
+      platform[:release].must_equal('5.2')
+    end
+  end
 end

data/test/unit/plugins/connection_test.rb

@@ -43,6 +43,18 @@ describe 'v1 Connection Plugin' do
                 .must_be_instance_of(Logger)
     end
 
+    it 'provides direct platform' do
+      plat = connection.direct_platform('linux')
+      plat.name.must_equal 'linux'
+      plat.family_hierarchy.must_equal ['linux', 'unix']
+    end
+
+    it 'provides family hierarchy' do
+      plat = Train::Platforms.name('linux')
+      family = connection.family_hierarchy(plat)
+      family.flatten.must_equal ['linux', 'unix']
+    end
+
     it 'must use the user-provided logger' do
       l = rand
       cls.new({logger: l})

data/test/unit/transports/aws_test.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+require 'helper'
+
+describe 'aws transport' do
+  def transport(options = nil)
+    ENV['AWS_REGION'] = 'test_region'
+    ENV['AWS_ACCESS_KEY_ID'] = 'test_key_id'
+    ENV['AWS_SECRET_ACCESS_KEY'] = 'test_access_key'
+    ENV['AWS_SESSION_TOKEN'] = 'test_session_token'
+
+    # need to require this at here as it captures the envs on load
+    require 'train/transports/aws'
+    Train::Transports::Aws.new(options)
+  end
+  let(:connection) { transport.connection }
+  let(:options) { connection.instance_variable_get(:@options) }
+  let(:cache) { connection.instance_variable_get(:@cache) }
+
+  describe 'options' do
+    it 'defaults to env options' do
+      options[:region].must_equal 'test_region'
+      options[:access_key_id].must_equal 'test_key_id'
+      options[:secret_access_key].must_equal 'test_access_key'
+      options[:session_token].must_equal 'test_session_token'
+    end
+
+    it 'test options override' do
+      transport = transport(region: 'us-east-2', access_key_id: '8')
+      options = transport.connection.instance_variable_get(:@options)
+      options[:region].must_equal 'us-east-2'
+      options[:access_key_id].must_equal '8'
+      options[:secret_access_key].must_equal 'test_access_key'
+      options[:session_token].must_equal 'test_session_token'
+    end
+
+    it 'test url parse override' do
+      transport = transport(host: 'us-east-2')
+      options = transport.connection.instance_variable_get(:@options)
+      options[:region].must_equal 'us-east-2'
+      options[:session_token].must_equal 'test_session_token'
+    end
+  end
+
+  describe 'platform' do
+    it 'returns platform' do
+      plat = connection.platform
+      plat.name.must_equal 'aws'
+      plat.family_hierarchy.must_equal ['cloud', 'api']
+    end
+  end
+
+  describe 'aws_client' do
+    it 'test aws_client with caching' do
+      client = connection.aws_client(Object)
+      client.is_a?(Object).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test aws_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.aws_client(Object)
+      client.is_a?(Object).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  describe 'aws_resource' do
+    class AwsResource
+      attr_reader :hash
+      def initialize(hash)
+        @hash = hash
+      end
+    end
+
+    it 'test aws_resource with arguments' do
+      hash = { user: 1, name: 'test_user' }
+      resource = connection.aws_resource(AwsResource, hash)
+      resource.hash.must_equal hash
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  describe 'connect' do
+    it 'validate aws connection with profile' do
+      options[:profile] = 'xyz'
+      ENV['AWS_PROFILE'].must_be_nil
+      connection.connect
+      ENV['AWS_PROFILE'].must_equal 'xyz'
+    end
+
+    it 'validate aws connection with region' do
+      options[:region] = 'xyz'
+      ENV['AWS_REGION'].must_equal 'test_region'
+      connection.connect
+      ENV['AWS_REGION'].must_equal 'xyz'
+    end
+  end
+end

data/train.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'winrm', '~> 2.0'
   spec.add_dependency 'winrm-fs', '~> 1.0'
   spec.add_dependency 'docker-api', '~> 1.26'
+  spec.add_dependency 'aws-sdk', '~> 2'
 
   spec.add_development_dependency 'mocha', '~> 1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,6 +120,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -170,12 +184,14 @@ files:
 - lib/train/platforms/detect/helpers/os_linux.rb
 - lib/train/platforms/detect/helpers/os_windows.rb
 - lib/train/platforms/detect/scanner.rb
+- lib/train/platforms/detect/specifications/api.rb
 - lib/train/platforms/detect/specifications/os.rb
 - lib/train/platforms/family.rb
 - lib/train/platforms/platform.rb
 - lib/train/plugins.rb
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
+- lib/train/transports/aws.rb
 - lib/train/transports/docker.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
@@ -237,6 +253,7 @@ files:
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
+- test/unit/transports/aws_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
@@ -264,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Transport interface to talk to different backends.
@@ -322,6 +339,7 @@ test_files:
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
+- test/unit/transports/aws_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb