train 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124fd4ed4c208f576481fb0b295fb8db93d9dd21
-  data.tar.gz: '0680e4d022b89b9e94abcd2f76ec830c69936ec9'
+  metadata.gz: '095b1ae4856669cbe224dffbfa09f555ce7c0d05'
+  data.tar.gz: ee6cc55a500e4466e497e853e49963a05b1f85d2
 SHA512:
-  metadata.gz: 7a82299c5aea2a11cbaf596a8aaa6bee503e7a169c86934b7af9a379ae70fc72fddbde527dcea1b717b08795d270a8092a223f72d7b582e8ded18b5c99180d56
-  data.tar.gz: db232796a60f74458d26ceff2273e72a233fcb14f794b03c6c9e45dfda7ba84e0632005a2c3c6df2ef9b2d7e816044f9589003cea87c890ea0e369fdc9f68838
+  metadata.gz: ea321b3f07afc791e16628f7d4f26277dc7caed537e29f8351dd8934741af77b8ee137ce35184d820c2aca2e02b335d6fdb538784577f11a06e9c7be1924ef07
+  data.tar.gz: d3a80455ea2819ccdb0ba1e92fdd94c7525604d6dfe49345902531e44eef9c06fd08d39b7911ac9464d44da4f762cd46fe10ab377804327237e4ba7e6405f987

data/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 
-## [1.2.0](https://github.com/chef/train/tree/1.2.0) (2018-03-15)
-[Full Changelog](https://github.com/chef/train/compare/v1.1.1...1.2.0)
+## [1.3.0](https://github.com/chef/train/tree/1.3.0) (2018-03-29)
+[Full Changelog](https://github.com/chef/train/compare/v1.2.0...1.3.0)
+
+**Implemented enhancements:**
+
+- Update errors to have a base type of Train::Error [\#273](https://github.com/chef/train/pull/273) ([marcparadise](https://github.com/marcparadise))
+
+**Closed issues:**
+
+- RFC: Generate unique uuid for platforms [\#264](https://github.com/chef/train/issues/264)
+
+**Merged pull requests:**
+
+- Add MSI connection option for azure. [\#272](https://github.com/chef/train/pull/272) ([jquick](https://github.com/jquick))
+- Add transport for Cisco IOS [\#271](https://github.com/chef/train/pull/271) ([jerryaldrichiii](https://github.com/jerryaldrichiii))
+- Add platform uuid information. [\#270](https://github.com/chef/train/pull/270) ([jquick](https://github.com/jquick))
+
+## [v1.2.0](https://github.com/chef/train/tree/v1.2.0) (2018-03-15)
+[Full Changelog](https://github.com/chef/train/compare/v1.1.1...v1.2.0)
 
 **Implemented enhancements:**
 
@@ -14,6 +31,7 @@
 
 **Merged pull requests:**
 
+- Release train 1.2.0 [\#269](https://github.com/chef/train/pull/269) ([jquick](https://github.com/jquick))
 - Force 64bit powershell for 32bit ruby running on 64bit windows [\#266](https://github.com/chef/train/pull/266) ([jquick](https://github.com/jquick))
 - support cisco ios xe [\#262](https://github.com/chef/train/pull/262) ([arlimus](https://github.com/arlimus))
 - Create a master OS family and refactor specifications [\#261](https://github.com/chef/train/pull/261) ([jquick](https://github.com/jquick))

data/lib/train/errors.rb

@@ -9,21 +9,24 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 
 module Train
+  # Base exception for any exception explicitly raised by the Train library.
+  class Error < ::StandardError; end
+
   # Base exception class for all exceptions that are caused by user input
   # errors.
-  class UserError < ::StandardError; end
+  class UserError < Error; end
 
   # Base exception class for all exceptions that are caused by incorrect use
   # of an API.
-  class ClientError < ::StandardError; end
+  class ClientError < Error; end
 
   # Base exception class for all exceptions that are caused by other failures
   # in the transport layer.
-  class TransportError < ::StandardError; end
+  class TransportError < Error; end
 
   # Exception for when no platform can be detected.
-  class PlatformDetectionFailed < ::StandardError; end
+  class PlatformDetectionFailed < Error; end
 
   # Exception for when a invalid cache type is passed.
-  class UnknownCacheType < ::StandardError; end
+  class UnknownCacheType < Error; end
 end

data/lib/train/platforms.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 
 require 'train/platforms/common'
-require 'train/platforms/family'
-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'
+require 'train/platforms/detect/uuid'
+require 'train/platforms/family'
+require 'train/platforms/platform'
 
 module Train::Platforms
   class << self

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

@@ -5,7 +5,7 @@ require 'train/platforms/detect/helpers/os_windows'
 require 'rbconfig'
 
 module Train::Platforms::Detect::Helpers
-  module OSCommon
+  module OSCommon # rubocop:disable Metrics/ModuleLength
     include Train::Platforms::Detect::Helpers::Linux
     include Train::Platforms::Detect::Helpers::Windows
 
@@ -87,5 +87,59 @@ module Train::Platforms::Detect::Helpers
 
       @cache[:cisco] = nil
     end
+
+    def unix_uuid
+      uuid = unix_uuid_from_chef
+      uuid = unix_uuid_from_machine_file if uuid.nil?
+      uuid = uuid_from_command if uuid.nil?
+      raise Train::TransportError, 'Cannot find a UUID for your node.' if uuid.nil?
+      uuid
+    end
+
+    def unix_uuid_from_chef
+      file = @backend.file('/var/chef/cache/data_collector_metadata.json')
+      if file.exist? && !file.size.zero?
+        json = ::JSON.parse(file.content)
+        return json['node_uuid'] if json['node_uuid']
+      end
+    end
+
+    def unix_uuid_from_machine_file
+      %W(
+        /etc/chef/chef_guid
+        #{ENV['HOME']}/.chef/chef_guid
+        /etc/machine-id
+        /var/lib/dbus/machine-id
+        /var/db/dbus/machine-id
+      ).each do |path|
+        file = @backend.file(path)
+        next unless file.exist? && !file.size.zero?
+        return file.content.chomp if path =~ /guid/
+        return uuid_from_string(file.content.chomp)
+      end
+      nil
+    end
+
+    # This takes a command from the platform detect block to run.
+    # We expect the command to return a unique identifier which
+    # we turn into a UUID.
+    def uuid_from_command
+      return unless @platform[:uuid_command]
+      result = @backend.run_command(@platform[:uuid_command])
+      uuid_from_string(result.stdout.chomp) if result.exit_status.zero? && !result.stdout.empty?
+    end
+
+    # This hashes the passed string into SHA1.
+    # Then it downgrades the 160bit SHA1 to a 128bit
+    # then we format it as a valid UUIDv5.
+    def uuid_from_string(string)
+      hash = Digest::SHA1.new
+      hash.update(string)
+      ary = hash.digest.unpack('NnnnnN')
+      ary[2] = (ary[2] & 0x0FFF) | (5 << 12)
+      ary[3] = (ary[3] & 0x3FFF) | 0x8000
+      # rubocop:disable Style/FormatString
+      '%08x-%04x-%04x-%04x-%04x%08x' % ary
+    end
   end
 end

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

@@ -75,5 +75,46 @@ module Train::Platforms::Detect::Helpers
       arch_number = sys_info[:Architecture].to_i
       arch_map[arch_number]
     end
+
+    # This method scans the target os for a unique uuid to use
+    def windows_uuid
+      uuid = windows_uuid_from_chef
+      uuid = windows_uuid_from_machine_file if uuid.nil?
+      uuid = windows_uuid_from_wmic if uuid.nil?
+      uuid = windows_uuid_from_registry if uuid.nil?
+      raise Train::TransportError, 'Cannot find a UUID for your node.' if uuid.nil?
+      uuid
+    end
+
+    def windows_uuid_from_machine_file
+      %W(
+        #{ENV['SYSTEMDRIVE']}\\chef\\chef_guid
+        #{ENV['HOMEDRIVE']}#{ENV['HOMEPATH']}\\.chef\\chef_guid
+      ).each do |path|
+        file = @backend.file(path)
+        return file.content.chomp if file.exist? && !file.size.zero?
+      end
+      nil
+    end
+
+    def windows_uuid_from_chef
+      file = @backend.file("#{ENV['SYSTEMDRIVE']}\\chef\\cache\\data_collector_metadata.json")
+      return if !file.exist? || file.size.zero?
+      json = JSON.parse(file.content)
+      json['node_uuid'] if json['node_uuid']
+    end
+
+    def windows_uuid_from_wmic
+      result = @backend.run_command('wmic csproduct get UUID')
+      return unless result.exit_status.zero?
+      result.stdout.split("\r\n")[-1].strip
+    end
+
+    def windows_uuid_from_registry
+      cmd = '(Get-ItemProperty "Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography" -Name "MachineGuid")."MachineGuid"'
+      result = @backend.run_command(cmd)
+      return unless result.exit_status.zero?
+      result.stdout.chomp
+    end
   end
 end

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

@@ -449,6 +449,7 @@ module Train::Platforms::Detect::Specifications
       plat.name('mac_os_x').title('macOS X').in_family('darwin')
           .detect {
             cmd = unix_file_contents('/System/Library/CoreServices/SystemVersion.plist')
+            @platform[:uuid_command] = "system_profiler SPHardwareDataType | awk '/UUID/ { print $3; }'"
             true if cmd =~ /Mac OS X/i
           }
       plat.name('darwin').title('Darwin').in_family('darwin')

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'digest/sha1'
+require 'securerandom'
+require 'json'
+
+module Train::Platforms::Detect
+  class UUID
+    include Train::Platforms::Detect::Helpers::OSCommon
+
+    def initialize(platform)
+      @platform = platform
+      @backend = @platform.backend
+    end
+
+    def find_or_create_uuid
+      # for api transports uuid is defined on the connection
+      if defined?(@backend.unique_identifier)
+        uuid_from_string(@backend.unique_identifier)
+      elsif @platform.unix?
+        unix_uuid
+      elsif @platform.windows?
+        windows_uuid
+      else
+        if @platform[:uuid_command]
+          result = @backend.run_command(@platform[:uuid_command])
+          return uuid_from_string(result.stdout.chomp) if result.exit_status.zero? && !result.stdout.empty?
+        end
+
+        raise 'Could not find platform uuid! Please set a uuid_command for your platform.'
+      end
+    end
+  end
+end

data/lib/train/platforms/platform.rb

@@ -41,6 +41,10 @@ module Train::Platforms
                         end
     end
 
+    def uuid
+      @uuid ||= Train::Platforms::Detect::UUID.new(self).find_or_create_uuid.downcase
+    end
+
     # This is for backwords compatability with
     # the current inspec os resource.
     def[](name)

data/lib/train/transports/aws.rb

@@ -59,6 +59,13 @@ module Train::Transports
       def uri
         "aws://#{@options[:region]}"
       end
+
+      def unique_identifier
+        # use aws account id
+        client = aws_client(::Aws::IAM::Client)
+        arn = client.get_user.user.arn
+        arn.split(':')[4]
+      end
     end
   end
 end

data/lib/train/transports/azure.rb

@@ -4,6 +4,8 @@ require 'train/plugins'
 require 'ms_rest_azure'
 require 'azure_mgmt_resources'
 require 'inifile'
+require 'socket'
+require 'timeout'
 
 module Train::Transports
   class Azure < Train.plugin(1)
@@ -12,6 +14,7 @@ module Train::Transports
     option :client_id, default: ENV['AZURE_CLIENT_ID']
     option :client_secret, default: ENV['AZURE_CLIENT_SECRET']
     option :subscription_id, default: ENV['AZURE_SUBSCRIPTION_ID']
+    option :msi_port, default: ENV['AZURE_MSI_PORT'] || '50342'
 
     # This can provide the client id and secret
     option :credentials_file, default: ENV['AZURE_CRED_FILE']
@@ -21,6 +24,8 @@ module Train::Transports
     end
 
     class Connection < BaseConnection
+      attr_reader :options
+
       def initialize(options)
         @apis = {}
 
@@ -36,6 +41,8 @@ module Train::Transports
           parse_credentials_file
         end
 
+        @options[:msi_port] = @options[:msi_port].to_i unless @options[:msi_port].nil?
+
         # additional platform details
         release = Gem.loaded_specs['azure_mgmt_resources'].version
         @platform_details = { release: "azure_mgmt_resources-v#{release}" }
@@ -54,19 +61,24 @@ module Train::Transports
       end
 
       def connect
-        provider = ::MsRestAzure::ApplicationTokenProvider.new(
-          @options[:tenant_id],
-          @options[:client_id],
-          @options[:client_secret],
-        )
+        if @options[:client_id].nil? && @options[:client_secret].nil? && port_open?(@options[:msi_port])
+          # try using MSI connection
+          provider = ::MsRestAzure::MSITokenProvider.new(@options[:msi_port])
+        else
+          provider = ::MsRestAzure::ApplicationTokenProvider.new(
+            @options[:tenant_id],
+            @options[:client_id],
+            @options[:client_secret],
+          )
+        end
 
         @credentials = {
           credentials: ::MsRest::TokenCredentials.new(provider),
           subscription_id: @options[:subscription_id],
           tenant_id: @options[:tenant_id],
-          client_id: @options[:client_id],
-          client_secret: @options[:client_secret],
         }
+        @credentials[:client_id] = @options[:client_id] unless @options[:client_id].nil?
+        @credentials[:client_secret] = @options[:client_secret] unless @options[:client_secret].nil?
       end
 
       def uri
@@ -118,8 +130,25 @@ module Train::Transports
         @apis[resource_type]
       end
 
+      def unique_identifier
+        options[:subscription_id] || options[:tenant_id]
+      end
+
       private
 
+      def port_open?(port, seconds = 1)
+        Timeout.timeout(seconds) do
+          begin
+            TCPSocket.new('localhost', port).close
+            true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            false
+          end
+        end
+      rescue Timeout::Error
+        false
+      end
+
       def parse_credentials_file # rubocop:disable Metrics/AbcSize
         # If an AZURE_CRED_FILE environment variable has been specified set the
         # the credentials file to that, otherwise set the one in home

data/lib/train/transports/cisco_ios.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+require 'train/plugins'
+require 'train/transports/ssh'
+
+module Train::Transports
+  class BadEnablePassword < Train::TransportError; end
+
+  class CiscoIOS < SSH
+    name 'cisco_ios'
+
+    option :host, required: true
+    option :user, required: true
+    option :port, default: 22, required: true
+
+    option :password, required: true
+
+    # Used to elevate to enable mode (similar to `sudo su` in Linux)
+    option :enable_password
+
+    def connection
+      @connection ||= Connection.new(validate_options(@options).options)
+    end
+
+    class Connection < BaseConnection
+      def initialize(options)
+        super(options)
+
+        # Delete options to avoid passing them in to `Net::SSH.start` later
+        @host = @options.delete(:host)
+        @user = @options.delete(:user)
+        @port = @options.delete(:port)
+        @enable_password = @options.delete(:enable_password)
+
+        @prompt = /^\S+[>#]\r\n.*$/
+      end
+
+      def uri
+        "ssh://#{@user}@#{@host}:#{@port}"
+      end
+
+      private
+
+      def establish_connection
+        logger.debug("[SSH] opening connection to #{self}")
+
+        Net::SSH.start(
+          @host,
+          @user,
+          @options.reject { |_key, value| value.nil? },
+        )
+      end
+
+      def session
+        return @session unless @session.nil?
+
+        @session = open_channel(establish_connection)
+
+        # Escalate privilege to enable mode if password is given
+        if @enable_password
+          run_command_via_connection("enable\r\n#{@enable_password}")
+        end
+
+        # Prevent `--MORE--` by removing terminal length limit
+        run_command_via_connection('terminal length 0')
+
+        @session
+      end
+
+      def run_command_via_connection(cmd)
+        # Ensure buffer is empty before sending data
+        @buf = ''
+
+        logger.debug("[SSH] Running `#{cmd}` on #{self}")
+        session.send_data(cmd + "\r\n")
+
+        logger.debug('[SSH] waiting for prompt')
+        until @buf =~ @prompt
+          raise BadEnablePassword if @buf =~ /Bad secrets/
+          session.connection.process(0)
+        end
+
+        # Save the buffer and clear it for the next command
+        output = @buf.dup
+        @buf = ''
+
+        format_result(format_output(output, cmd))
+      end
+
+      ERROR_MATCHERS = [
+        'Bad IP address',
+        'Incomplete command',
+        'Invalid input detected',
+        'Unrecognized host',
+      ].freeze
+
+      # IOS commands do not have an exit code so we must compare the command
+      # output with partial segments of known errors. Then, we return a
+      # `CommandResult` with arguments in the correct position based on the
+      # result.
+      def format_result(result)
+        if ERROR_MATCHERS.none? { |e| result.include?(e) }
+          CommandResult.new(result, '', 0)
+        else
+          CommandResult.new('', result, 1)
+        end
+      end
+
+      # The buffer (@buf) contains all data sent/received on the SSH channel so
+      # we need to format the data to match what we would expect from Train
+      def format_output(output, cmd)
+        leading_prompt = /(\r\n|^)\S+[>#]/
+        command_string = /#{cmd}\r\n/
+        trailing_prompt = /\S+[>#](\r\n|$)/
+        trailing_line_endings = /(\r\n)+$/
+
+        output
+          .sub(leading_prompt, '')
+          .sub(command_string, '')
+          .gsub(trailing_prompt, '')
+          .gsub(trailing_line_endings, '')
+      end
+
+      # Create an SSH channel that writes to @buf when data is received
+      def open_channel(ssh)
+        logger.debug("[SSH] opening SSH channel to #{self}")
+        ssh.open_channel do |ch|
+          ch.on_data do |_, data|
+            @buf += data
+          end
+
+          ch.send_channel_request('shell') do |_, success|
+            raise 'Failed to open SSH shell' unless success
+            logger.debug('[SSH] shell opened')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/train/transports/local.rb

@@ -4,13 +4,14 @@
 # author: Christoph Hartmann
 
 require 'train/plugins'
+require 'train/errors'
 require 'mixlib/shellout'
 
 module Train::Transports
   class Local < Train.plugin(1)
     name 'local'
 
-    class PipeError < ::StandardError; end
+    class PipeError < Train::TransportError; end
 
     def connection(_ = nil)
       @connection ||= Connection.new(@options)

data/lib/train/transports/mock.rb

@@ -57,6 +57,8 @@ end
 
 class Train::Transports::Mock
   class Connection < BaseConnection
+    attr_reader :options
+
     def initialize(conf = nil)
       super(conf)
       mock_os

data/lib/train/version.rb

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

data/test/unit/platforms/detect/uuid_test.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+require 'helper'
+require 'train/transports/mock'
+require 'securerandom'
+
+class TestFile
+  def initialize(string)
+    @string = string
+  end
+
+  def exist?
+    true
+  end
+
+  def size
+    @string.length
+  end
+
+  def content
+    @string
+  end
+end
+
+describe 'uuid' do
+  def mock_platform(name, commands = {}, files = {}, plat_options = {})
+    Train::Platforms.list[name] = nil
+    mock = Train::Transports::Mock::Connection.new
+    commands.each do |command, data|
+      mock.mock_command(command, data)
+    end
+
+    file_objects = {}
+    files.each do |path, content|
+      file_objects[path] = TestFile.new(content)
+    end
+
+    mock.files = file_objects
+    mock.direct_platform(name, plat_options)
+  end
+
+  it 'finds a linux uuid from chef entity_uuid' do
+    files = { '/var/chef/cache/data_collector_metadata.json' => '{"node_uuid":"d400073f-0920-41aa-8dd3-2ea59b18f5ce"}' }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal 'd400073f-0920-41aa-8dd3-2ea59b18f5ce'
+  end
+
+  it 'finds a windows uuid from chef entity_uuid' do
+    ENV['SYSTEMDRIVE'] = 'C:'
+    files = { 'C:\chef\cache\data_collector_metadata.json' => '{"node_uuid":"d400073f-0920-41aa-8dd3-2ea59b18f5ce"}' }
+    plat = mock_platform('windows', {}, files)
+    plat.uuid.must_equal 'd400073f-0920-41aa-8dd3-2ea59b18f5ce'
+  end
+
+  it 'finds a linux uuid from /etc/chef/chef_guid' do
+    files = { '/etc/chef/chef_guid' => '5e430326-b5aa-56f8-975f-c3ca1c21df91' }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a linux uuid from /home/testuser/.chef/chef_guid' do
+    ENV['HOME'] = '/home/testuser'
+    files = { '/home/testuser/.chef/chef_guid' => '5e430326-b5aa-56f8-975f-c3ca1c21df91' }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a linux uuid from /etc/machine-id' do
+    files = { '/etc/machine-id' => '123141dsfadf' }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a linux uuid from /var/lib/dbus/machine-id' do
+    files = {
+      '/etc/machine-id' => '',
+      '/var/lib/dbus/machine-id' => '123141dsfadf',
+    }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a linux uuid from /etc/machine-id' do
+    files = { '/etc/machine-id' => '123141dsfadf' }
+    plat = mock_platform('linux', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a windows uuid from wmic' do
+    commands = { 'wmic csproduct get UUID' => "UUID\r\nd400073f-0920-41aa-8dd3-2ea59b18f5ce\r\n" }
+    plat = mock_platform('windows', commands)
+    plat.uuid.must_equal 'd400073f-0920-41aa-8dd3-2ea59b18f5ce'
+  end
+
+  it 'finds a windows uuid from registry' do
+    commands = { '(Get-ItemProperty "Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography" -Name "MachineGuid")."MachineGuid"' => "d400073f-0920-41aa-8dd3-2ea59b18f5ce\r\n" }
+    plat = mock_platform('windows', commands)
+    plat.uuid.must_equal 'd400073f-0920-41aa-8dd3-2ea59b18f5ce'
+  end
+
+  it 'finds a windows uuid from C:\chef\chef_guid' do
+    ENV['SYSTEMDRIVE'] = 'C:'
+    files = { 'C:\chef\chef_guid' => '5e430326-b5aa-56f8-975f-c3ca1c21df91' }
+    plat = mock_platform('windows', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a windows uuid from C:\Users\test\.chef\chef_guid' do
+    ENV['HOMEDRIVE'] = 'C:\\'
+    ENV['HOMEPATH'] = 'Users\test'
+    files = { 'C:\Users\test\.chef\chef_guid' => '5e430326-b5aa-56f8-975f-c3ca1c21df91' }
+    plat = mock_platform('windows', {}, files)
+    plat.uuid.must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'generates a uuid from a string' do
+    plat = mock_platform('linux')
+    uuid = Train::Platforms::Detect::UUID.new(plat)
+    uuid.uuid_from_string('123141dsfadf').must_equal '5e430326-b5aa-56f8-975f-c3ca1c21df91'
+  end
+
+  it 'finds a aws uuid' do
+    plat = mock_platform('aws')
+    plat.backend.stubs(:unique_identifier).returns('158551926027')
+    plat.uuid.must_equal '1d74ce61-ac15-5c48-9ee3-5aa8207ac37f'
+  end
+
+  it 'finds an azure uuid' do
+    plat = mock_platform('azure')
+    plat.backend.stubs(:unique_identifier).returns('1d74ce61-ac15-5c48-9ee3-5aa8207ac37f')
+    plat.uuid.must_equal '2c2e4fa9-7287-5dee-85a3-6527face7b7b'
+  end
+end

data/test/unit/transports/aws_test.rb

@@ -96,4 +96,28 @@ describe 'aws transport' do
       ENV['AWS_REGION'].must_equal 'xyz'
     end
   end
+
+  describe 'unique_identifier' do
+    class AwsArn
+      def arn
+        'arn:aws:iam::158551926027:user/test-fixture-maker'
+      end
+    end
+
+    class AwsUser
+      def user
+        AwsArn.new
+      end
+    end
+
+    class AwsClient
+      def get_user
+        AwsUser.new
+      end
+    end
+    it 'returns an account id' do
+      connection.stubs(:aws_client).returns(AwsClient.new)
+      connection.unique_identifier.must_equal '158551926027'
+    end
+  end
 end

data/test/unit/transports/azure_test.rb

@@ -83,12 +83,44 @@ describe 'azure transport' do
   describe 'connect' do
     it 'validate credentials' do
       connection.connect
+      token = credentials[:credentials].instance_variable_get(:@token_provider)
+      token.class.must_equal MsRestAzure::ApplicationTokenProvider
+
       credentials[:credentials].class.must_equal MsRest::TokenCredentials
       credentials[:tenant_id].must_equal 'test_tenant_id'
       credentials[:client_id].must_equal 'test_client_id'
       credentials[:client_secret].must_equal 'test_client_secret'
       credentials[:subscription_id].must_equal 'test_subscription_id'
     end
+
+    it 'validate msi credentials' do
+      options[:client_id] = nil
+      options[:client_secret] = nil
+      Train::Transports::Azure::Connection.any_instance.stubs(:port_open?).returns(true)
+
+      connection.connect
+      token = credentials[:credentials].instance_variable_get(:@token_provider)
+      token.class.must_equal MsRestAzure::MSITokenProvider
+
+      credentials[:credentials].class.must_equal MsRest::TokenCredentials
+      credentials[:tenant_id].must_equal 'test_tenant_id'
+      credentials[:subscription_id].must_equal 'test_subscription_id'
+      credentials[:client_id].must_be_nil
+      credentials[:client_secret].must_be_nil
+      options[:msi_port].must_equal 50342
+    end
+  end
+
+  describe 'unique_identifier' do
+    it 'returns a subscription id' do
+      connection.unique_identifier.must_equal 'test_subscription_id'
+    end
+
+    it 'returns a tenant id' do
+      options = connection.instance_variable_get(:@options)
+      options[:subscription_id] = nil
+      connection.unique_identifier.must_equal 'test_tenant_id'
+    end
   end
 
   describe 'parse_credentials_file' do

data/test/unit/transports/cisco_ios.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+require 'helper'
+require 'train/transports/cisco_ios'
+
+describe 'Train::Transports::CiscoIOS' do
+  let(:cls) do
+    plat = Train::Platforms.name('mock').in_family('cisco_ios')
+    plat.add_platform_methods
+    Train::Platforms::Detect.stubs(:scan).returns(plat)
+    Train::Transports::CiscoIOS
+  end
+
+  let(:opts) do
+    {
+      host: 'fakehost',
+      user: 'fakeuser',
+      password: 'fakepassword',
+    }
+  end
+
+  let(:cisco_ios) do
+    cls.new(opts)
+  end
+
+  describe 'CiscoIOS::Connection' do
+    let(:connection) { cls.new(opts).connection }
+
+    describe '#initialize' do
+      it 'raises an error when user is missing' do
+        opts.delete(:user)
+        err = proc { cls.new(opts).connection }.must_raise(Train::ClientError)
+        err.message.must_match(/must provide.*user/)
+      end
+
+      it 'raises an error when host is missing' do
+        opts.delete(:host)
+        err = proc { cls.new(opts).connection }.must_raise(Train::ClientError)
+        err.message.must_match(/must provide.*host/)
+      end
+
+      it 'raises an error when password is missing' do
+        opts.delete(:password)
+        err = proc { cls.new(opts).connection }.must_raise(Train::ClientError)
+        err.message.must_match(/must provide.*password/)
+      end
+
+      it 'provides a uri' do
+        connection.uri.must_equal 'ssh://fakeuser@fakehost:22'
+      end
+    end
+
+    describe '#format_result' do
+      it 'returns correctly when result is `good`' do
+        output = 'good'
+        Train::Extras::CommandResult.expects(:new).with(output, '', 0)
+        connection.send(:format_result, 'good')
+      end
+
+      it 'returns correctly when result matches /Bad IP address/' do
+        output = "Translating \"nope\"\r\n\r\nTranslating \"nope\"\r\n\r\n% Bad IP address or host name\r\n% Unknown command or computer name, or unable to find computer address\r\n"
+        Train::Extras::CommandResult.expects(:new).with('', output, 1)
+        connection.send(:format_result, output)
+      end
+
+      it 'returns correctly when result matches /Incomplete command/' do
+        output = "% Incomplete command.\r\n\r\n"
+        Train::Extras::CommandResult.expects(:new).with('', output, 1)
+        connection.send(:format_result, output)
+      end
+
+      it 'returns correctly when result matches /Invalid input detected/' do
+        output = "             ^\r\n% Invalid input detected at '^' marker.\r\n\r\n"
+        Train::Extras::CommandResult.expects(:new).with('', output, 1)
+        connection.send(:format_result, output)
+      end
+
+      it 'returns correctly when result matches /Unrecognized host/' do
+        output = "Translating \"nope\"\r\n% Unrecognized host or address, or protocol not running.\r\n\r\n"
+        Train::Extras::CommandResult.expects(:new).with('', output, 1)
+        connection.send(:format_result, output)
+      end
+    end
+
+    describe '#format_output' do
+      it 'returns output containing only the output of the command executed' do
+        cmd = 'show calendar'
+        output = "show calendar\r\n10:35:50 UTC Fri Mar 23 2018\r\n7200_ios_12#\r\n7200_ios_12#"
+        result = connection.send(:format_output, output, cmd)
+        result.must_equal '10:35:50 UTC Fri Mar 23 2018'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -217,6 +217,7 @@ files:
 - lib/train/platforms/detect/scanner.rb
 - lib/train/platforms/detect/specifications/api.rb
 - lib/train/platforms/detect/specifications/os.rb
+- lib/train/platforms/detect/uuid.rb
 - lib/train/platforms/family.rb
 - lib/train/platforms/platform.rb
 - lib/train/plugins.rb
@@ -224,6 +225,7 @@ files:
 - lib/train/plugins/transport.rb
 - lib/train/transports/aws.rb
 - lib/train/transports/azure.rb
+- lib/train/transports/cisco_ios.rb
 - lib/train/transports/docker.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
@@ -279,6 +281,7 @@ files:
 - test/unit/platforms/detect/os_linux_test.rb
 - test/unit/platforms/detect/os_windows_test.rb
 - test/unit/platforms/detect/scanner_test.rb
+- test/unit/platforms/detect/uuid_test.rb
 - test/unit/platforms/family_test.rb
 - test/unit/platforms/os_detect_test.rb
 - test/unit/platforms/platform_test.rb
@@ -289,6 +292,7 @@ files:
 - test/unit/train_test.rb
 - test/unit/transports/aws_test.rb
 - test/unit/transports/azure_test.rb
+- test/unit/transports/cisco_ios.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
@@ -368,6 +372,7 @@ test_files:
 - test/unit/platforms/detect/os_linux_test.rb
 - test/unit/platforms/detect/os_windows_test.rb
 - test/unit/platforms/detect/scanner_test.rb
+- test/unit/platforms/detect/uuid_test.rb
 - test/unit/platforms/family_test.rb
 - test/unit/platforms/os_detect_test.rb
 - test/unit/platforms/platform_test.rb
@@ -378,6 +383,7 @@ test_files:
 - test/unit/train_test.rb
 - test/unit/transports/aws_test.rb
 - test/unit/transports/azure_test.rb
+- test/unit/transports/cisco_ios.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb