train 2.1.7 → 2.1.13

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

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
-require 'digest/sha1'
-require 'securerandom'
-require 'json'
+require "digest/sha1"
+require "securerandom"
+require "json"
 
 module Train::Platforms::Detect
   class UUID
@@ -24,10 +22,10 @@ module Train::Platforms::Detect
       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?
+          return uuid_from_string(result.stdout.chomp) if result.exit_status == 0 && !result.stdout.empty?
         end
 
-        raise 'Could not find platform uuid! Please set a uuid_command for your platform.'
+        raise "Could not find platform uuid! Please set a uuid_command for your platform."
       end
     end
   end

data/lib/train/platforms/platform.rb

@@ -44,7 +44,7 @@ module Train::Platforms
       @cleaned_name = nil if force
       @cleaned_name ||= begin
                           name = (@platform[:name] || @name)
-                          name.downcase!.tr!(' ', '_') if name =~ /[A-Z ]/
+                          name.downcase!.tr!(" ", "_") if name =~ /[A-Z ]/
                           name
                         end
     end
@@ -59,7 +59,7 @@ module Train::Platforms
       if respond_to?(name)
         send(name)
       else
-        'unknown'
+        "unknown"
       end
     end
 
@@ -73,6 +73,10 @@ module Train::Platforms
       @platform
     end
 
+    def cisco_ios? # TODO: kinda a hack. needed to prevent tests from corrupting.
+      false
+    end
+
     # Add generic family? and platform methods to an existing platform
     #
     # This is done later to add any custom
@@ -84,8 +88,8 @@ module Train::Platforms
       # Add in family methods
       family_list = Train::Platforms.families
       family_list.each_value do |k|
-        next if respond_to?(k.name + '?')
-        define_singleton_method(k.name + '?') do
+        next if respond_to?(k.name + "?")
+        define_singleton_method(k.name + "?") do
           family_hierarchy.include?(k.name)
         end
       end
@@ -99,7 +103,7 @@ module Train::Platforms
       end
 
       # Create method for name if its not already true
-      m = name + '?'
+      m = name + "?"
       return if respond_to?(m)
       define_singleton_method(m) do
         true

data/lib/train/plugin_test_helper.rb

@@ -3,27 +3,27 @@
 
 # Load Train.  We certainly need the plugin system, and also several other parts
 # that are tightly coupled.  Train itself is fairly light, and non-invasive.
-require 'train'
+require "train"
 
 # You can select from a number of test harnesses.  Since Train is closely related
 # to InSpec, and InSpec uses Spec-style controls in profile code, you will
 # probably want to use something like minitest/spec, which provides Spec-style
 # tests.
-require 'minitest/spec'
-require 'minitest/autorun'
+require "minitest/spec"
+require "minitest/autorun"
 
 # Data formats commonly used in testing
-require 'json'
-require 'ostruct'
+require "json"
+require "ostruct"
 
 # Utilities often needed
-require 'fileutils'
-require 'tmpdir'
-require 'pathname'
+require "fileutils"
+require "tmpdir"
+require "pathname"
 
 # You might want to put some debugging tools here.  We run tests to find bugs,
 # after all.
-require 'byebug'
+require "byebug"
 
 # Configure MiniTest to expose things like `let`
 class Module
@@ -38,11 +38,11 @@ module TrainPluginBaseHelper
     plugin_test_helper_path = Pathname.new(caller_locations(4, 1).first.absolute_path)
     plugin_src_root = plugin_test_helper_path.parent.parent
     base.let(:plugin_src_path) { plugin_src_root }
-    base.let(:plugin_fixtures_path) { File.join(plugin_src_root, 'test', 'fixtures') }
+    base.let(:plugin_fixtures_path) { File.join(plugin_src_root, "test", "fixtures") }
   end
 
-  let(:train_src_path) { File.expand_path(File.join(__FILE__, '..', '..')) }
-  let(:train_fixtures_path) { File.join(train_src_path, 'test', 'fixtures') }
+  let(:train_src_path) { File.expand_path(File.join(__FILE__, "..", "..")) }
+  let(:train_fixtures_path) { File.join(train_src_path, "test", "fixtures") }
   let(:registry) { Train::Plugins.registry }
 end
 

data/lib/train/plugins.rb

@@ -3,11 +3,11 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)
 
-require 'train/errors'
+require "train/errors"
 
 module Train
   class Plugins
-    require 'train/plugins/transport'
+    require "train/plugins/transport"
 
     class << self
       # Retrieve the current plugin registry, containing all plugin names
@@ -30,10 +30,10 @@ module Train
   # @return [Transport] the versioned transport base class
   def self.plugin(version = 1)
     if version != 1
-      fail ClientError,
-           'Only understand train plugin version 1. You are trying to '\
+      raise ClientError,
+           "Only understand train plugin version 1. You are trying to "\
            "initialize a train plugin #{version}, which is not supported "\
-           'in the current release of train.'
+           "in the current release of train."
     end
     ::Train::Plugins::Transport
   end

data/lib/train/plugins/base_connection.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-require 'train/errors'
-require 'train/extras'
-require 'train/file'
-require 'logger'
+require "train/errors"
+require "train/extras"
+require "train/file"
+require "logger"
 
 class Train::Plugins::Transport
   # A Connection instance can be generated and re-generated, given new
@@ -21,7 +21,7 @@ class Train::Plugins::Transport
     # @yield [self] yields itself for block-style invocation
     def initialize(options = nil)
       @options = options || {}
-      @logger = @options.delete(:logger) || Logger.new(STDOUT)
+      @logger = @options.delete(:logger) || Logger.new($stdout, level: :fatal)
       Train::Platforms::Detect::Specifications::OS.load
       Train::Platforms::Detect::Specifications::Api.load
 
@@ -64,12 +64,12 @@ class Train::Plugins::Transport
     # Enable caching types for Train. Currently we support
     # :api_call, :file and :command types
     def enable_cache(type)
-      fail Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
+      raise Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
       @cache_enabled[type.to_sym] = true
     end
 
     def disable_cache(type)
-      fail Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
+      raise Train::UnknownCacheType, "#{type} is not a valid cache type" unless @cache_enabled.keys.include?(type.to_sym)
       @cache_enabled[type.to_sym] = false
       clear_cache(type.to_sym)
     end
@@ -81,13 +81,13 @@ class Train::Plugins::Transport
 
     def to_json
       {
-        'files' => Hash[@cache[:file].map { |x, y| [x, y.to_json] }],
+        "files" => Hash[@cache[:file].map { |x, y| [x, y.to_json] }],
       }
     end
 
     def load_json(j)
-      require 'train/transports/mock'
-      j['files'].each do |path, jf|
+      require "train/transports/mock"
+      j["files"].each do |path, jf|
         @cache[:file][path] = Train::Transports::Mock::Connection::File.from_json(jf)
       end
     end
@@ -137,7 +137,7 @@ class Train::Plugins::Transport
     #
     # @return [LoginCommand] array of command line tokens
     def login_command
-      fail NotImplementedError, "#{self.class} does not implement #login_command()"
+      raise NotImplementedError, "#{self.class} does not implement #login_command()"
     end
 
     # Block and return only when the remote host is prepared and ready to
@@ -161,7 +161,7 @@ class Train::Plugins::Transport
     #
     # @return [CommandResult] contains the result of running the command
     def run_command_via_connection(_command, &_data_handler)
-      fail NotImplementedError, "#{self.class} does not implement #run_command_via_connection()"
+      raise NotImplementedError, "#{self.class} does not implement #run_command_via_connection()"
     end
 
     # Interact with files on the target. Read, write, and get metadata
@@ -170,7 +170,7 @@ class Train::Plugins::Transport
     # @param [String] path which is being inspected
     # @return [FileCommon] file object that allows for interaction
     def file_via_connection(_path, *_args)
-      fail NotImplementedError, "#{self.class} does not implement #file_via_connection(...)"
+      raise NotImplementedError, "#{self.class} does not implement #file_via_connection(...)"
     end
 
     def clear_cache(type)

data/lib/train/plugins/transport.rb

@@ -3,17 +3,17 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)
 
-require 'logger'
-require 'train/errors'
-require 'train/extras'
-require 'train/options'
+require "logger"
+require "train/errors"
+require "train/extras"
+require "train/options"
 
 class Train::Plugins
   class Transport
     include Train::Extras
     Train::Options.attach(self)
 
-    require 'train/plugins/base_connection'
+    require "train/plugins/base_connection"
 
     # Initialize a new Transport object
     #
@@ -21,7 +21,7 @@ class Train::Plugins
     # @return [Transport] the transport object
     def initialize(options = {})
       @options = merge_options({}, options || {})
-      @logger = @options[:logger] || Logger.new(STDOUT)
+      @logger = @options[:logger] || Logger.new($stdout, level: :fatal)
     end
 
     # Create a connection to the target. Options may be provided
@@ -30,7 +30,7 @@ class Train::Plugins
     # @param [Hash] _options = nil provide optional configuration params
     # @return [Connection] the connection for this configuration
     def connection(_options = nil)
-      fail Train::ClientError, "#{self.class} does not implement #connection()"
+      raise Train::ClientError, "#{self.class} does not implement #connection()"
     end
 
     # Register the inheriting class with as a train plugin using the

data/lib/train/transports/azure.rb

@@ -1,27 +1,27 @@
 # encoding: utf-8
 
-require 'train/plugins'
-require 'ms_rest_azure'
-require 'azure_mgmt_resources'
-require 'azure_graph_rbac'
-require 'azure_mgmt_key_vault'
-require 'socket'
-require 'timeout'
-require 'train/transports/helpers/azure/file_credentials'
-require 'train/transports/clients/azure/graph_rbac'
-require 'train/transports/clients/azure/vault'
+require "train/plugins"
+require "ms_rest_azure"
+require "azure_mgmt_resources"
+require "azure_graph_rbac"
+require "azure_mgmt_key_vault"
+require "socket"
+require "timeout"
+require "train/transports/helpers/azure/file_credentials"
+require "train/transports/clients/azure/graph_rbac"
+require "train/transports/clients/azure/vault"
 
 module Train::Transports
   class Azure < Train.plugin(1)
-    name 'azure'
-    option :tenant_id, default: ENV['AZURE_TENANT_ID']
-    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'
+    name "azure"
+    option :tenant_id, default: ENV["AZURE_TENANT_ID"]
+    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']
+    option :credentials_file, default: ENV["AZURE_CRED_FILE"]
 
     def connection(_ = nil)
       @connection ||= Connection.new(@options)
@@ -30,7 +30,7 @@ module Train::Transports
     class Connection < BaseConnection
       attr_reader :options
 
-      DEFAULT_FILE = ::File.join(Dir.home, '.azure', 'credentials')
+      DEFAULT_FILE = ::File.join(Dir.home, ".azure", "credentials")
 
       def initialize(options)
         @apis = {}
@@ -51,14 +51,14 @@ module Train::Transports
         @options[:msi_port] = @options[:msi_port].to_i unless @options[:msi_port].nil?
 
         # additional platform details
-        release = Gem.loaded_specs['azure_mgmt_resources'].version
+        release = Gem.loaded_specs["azure_mgmt_resources"].version
         @platform_details = { release: "azure_mgmt_resources-v#{release}" }
 
         connect
       end
 
       def platform
-        force_platform!('azure', @platform_details)
+        force_platform!("azure", @platform_details)
       end
 
       def azure_client(klass = ::Azure::Resources::Profiles::Latest::Mgmt::Client, opts = {})
@@ -85,13 +85,13 @@ module Train::Transports
       def connect
         if msi_auth?
           # this needs set for azure cloud to authenticate
-          ENV['MSI_VM'] = 'true'
+          ENV["MSI_VM"] = "true"
           provider = ::MsRestAzure::MSITokenProvider.new(@options[:msi_port])
         else
           provider = ::MsRestAzure::ApplicationTokenProvider.new(
             @options[:tenant_id],
             @options[:client_id],
-            @options[:client_secret],
+            @options[:client_secret]
           )
         end
 
@@ -166,7 +166,7 @@ module Train::Transports
       def port_open?(port, seconds = 3)
         Timeout.timeout(seconds) do
           begin
-            TCPSocket.new('localhost', port).close
+            TCPSocket.new("localhost", port).close
             true
           rescue SystemCallError
             false

data/lib/train/transports/cisco_ios_connection.rb

@@ -24,8 +24,8 @@ class Train::Transports::SSH
     end
 
     def unique_identifier
-      result = run_command_via_connection('show version | include Processor')
-      result.stdout.split(' ')[-1]
+      result = run_command_via_connection("show version | include Processor")
+      result.stdout.split(" ")[-1]
     end
 
     private
@@ -45,26 +45,26 @@ class Train::Transports::SSH
       if @enable_password
         # This verifies we are not in privileged exec mode before running the
         # enable command. Otherwise, the password will be in history.
-        if run_command_via_connection('show privilege').stdout.split[-1] != '15'
+        if run_command_via_connection("show privilege").stdout.split[-1] != "15"
           # Extra newlines to get back to prompt if incorrect password is used
           run_command_via_connection("enable\n#{@enable_password}\n\n\n")
         end
       end
 
       # Prevent `--MORE--` by removing terminal length limit
-      run_command_via_connection('terminal length 0')
+      run_command_via_connection("terminal length 0")
 
       @session
     end
 
     def run_command_via_connection(cmd, &_data_handler)
       # Ensure buffer is empty before sending data
-      @buf = ''
+      @buf = ""
 
       logger.debug("[SSH] Running `#{cmd}` on #{self}")
       session.send_data(cmd + "\r\n")
 
-      logger.debug('[SSH] waiting for prompt')
+      logger.debug("[SSH] waiting for prompt")
       until @buf =~ @prompt
         if @buf =~ /Bad (secrets|password)|Access denied/
           raise BadEnablePassword
@@ -74,16 +74,16 @@ class Train::Transports::SSH
 
       # Save the buffer and clear it for the next command
       output = @buf.dup
-      @buf = ''
+      @buf = ""
 
       format_result(format_output(output, cmd))
     end
 
     ERROR_MATCHERS = [
-      'Bad IP address',
-      'Incomplete command',
-      'Invalid input detected',
-      'Unrecognized host',
+      "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
@@ -92,9 +92,9 @@ class Train::Transports::SSH
     # result.
     def format_result(result)
       if ERROR_MATCHERS.none? { |e| result.include?(e) }
-        CommandResult.new(result, '', 0)
+        CommandResult.new(result, "", 0)
       else
-        CommandResult.new('', result, 1)
+        CommandResult.new("", result, 1)
       end
     end
 
@@ -107,10 +107,10 @@ class Train::Transports::SSH
       trailing_line_endings = /(\r\n)+$/
 
       output
-        .sub(leading_prompt, '')
-        .sub(command_string, '')
-        .gsub(trailing_prompt, '')
-        .gsub(trailing_line_endings, '')
+        .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
@@ -121,9 +121,9 @@ class Train::Transports::SSH
           @buf += data
         end
 
-        ch.send_channel_request('shell') do |_, success|
-          raise 'Failed to open SSH shell' unless success
-          logger.debug('[SSH] shell opened')
+        ch.send_channel_request("shell") do |_, success|
+          raise "Failed to open SSH shell" unless success
+          logger.debug("[SSH] shell opened")
         end
       end
     end