train 2.1.7 → 2.1.13

data/lib/train/transports/clients/azure/graph_rbac.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'azure_graph_rbac'
+require "azure_graph_rbac"
 
 # Wrapper class for ::Azure::GraphRbac::Profiles::Latest::Client allowing custom configuration,
 # for example, defining additional settings for the ::MsRestAzure::ApplicationTokenProvider.
@@ -20,7 +20,7 @@ class GraphRbac
       credentials[:tenant_id],
       credentials[:client_id],
       credentials[:client_secret],
-      settings,
+      settings
     )
   end
 

data/lib/train/transports/clients/azure/vault.rb

@@ -1,15 +1,15 @@
 # encoding: utf-8
 
-require 'azure_mgmt_key_vault'
+require "azure_mgmt_key_vault"
 
 # Wrapper class for ::Azure::KeyVault::Profiles::Latest::Mgmt::Client allowing custom configuration,
 # for example, defining additional settings for the ::MsRestAzure::ApplicationTokenProvider.
 class Vault
   AUTH_ENDPOINT = MsRestAzure::AzureEnvironments::AzureCloud.active_directory_endpoint_url
-  RESOURCE_ENDPOINT = 'https://vault.azure.net'.freeze
+  RESOURCE_ENDPOINT = "https://vault.azure.net".freeze
 
   def self.client(vault_name, credentials)
-    raise ::Train::UserError, 'Vault Name cannot be nil' if vault_name.nil?
+    raise ::Train::UserError, "Vault Name cannot be nil" if vault_name.nil?
 
     credentials[:credentials] = ::MsRest::TokenCredentials.new(provider(credentials))
     credentials[:base_url] = api_endpoint(vault_name)
@@ -22,7 +22,7 @@ class Vault
       credentials[:tenant_id],
       credentials[:client_id],
       credentials[:client_secret],
-      settings,
+      settings
     )
   end
 

data/lib/train/transports/docker.rb

@@ -1,13 +1,8 @@
-# encoding: utf-8
-#
-# Author:: Dominik Richter
-# Author:: Christoph Hartmann
-
-require 'docker'
+require "docker"
 
 module Train::Transports
   class Docker < Train.plugin(1)
-    name 'docker'
+    name "docker"
 
     include_options Train::Extras::CommandWrapper
     option :host, required: true
@@ -59,10 +54,9 @@ class Train::Transports::Docker
       super(conf)
       @id = options[:host]
       @container = ::Docker::Container.get(@id) ||
-                   fail("Can't find Docker container #{@id}")
+        raise("Can't find Docker container #{@id}")
       @cmd_wrapper = nil
       @cmd_wrapper = CommandWrapper.load(self, @options)
-      self
     end
 
     def close
@@ -93,7 +87,7 @@ class Train::Transports::Docker
       cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
       stdout, stderr, exit_status = @container.exec(
         [
-          '/bin/sh', '-c', cmd
+          "/bin/sh", "-c", cmd
         ])
       CommandResult.new(stdout.join, stderr.join, exit_status)
     rescue ::Docker::Error::DockerError => _

data/lib/train/transports/gcp.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
 
-require 'train/plugins'
-require 'google/apis'
-require 'google/apis/cloudresourcemanager_v1'
-require 'google/apis/compute_v1'
-require 'google/apis/storage_v1'
-require 'google/apis/iam_v1'
-require 'google/apis/admin_directory_v1'
-require 'googleauth'
+require "train/plugins"
+require "google/apis"
+require "google/apis/cloudresourcemanager_v1"
+require "google/apis/compute_v1"
+require "google/apis/storage_v1"
+require "google/apis/iam_v1"
+require "google/apis/admin_directory_v1"
+require "googleauth"
 
 module Train::Transports
   class Gcp < Train.plugin(1)
-    name 'gcp'
+    name "gcp"
 
     # GCP will look automatically for the below env var for service accounts etc. :
     option :google_application_credentials, required: false do
-      ENV['GOOGLE_APPLICATION_CREDENTIALS']
+      ENV["GOOGLE_APPLICATION_CREDENTIALS"]
     end
     # see https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application
     # In the absence of this, the client is expected to have already set up local credentials via:
@@ -25,10 +25,10 @@ module Train::Transports
     # https://cloud.google.com/compute/docs/regions-zones/changing-default-zone-region
     # can also specify project via env var:
     option :google_cloud_project, required: false do
-      ENV['GOOGLE_CLOUD_PROJECT']
+      ENV["GOOGLE_CLOUD_PROJECT"]
     end
     option :google_super_admin_email, required: false do
-      ENV['GOOGLE_SUPER_ADMIN_EMAIL']
+      ENV["GOOGLE_SUPER_ADMIN_EMAIL"]
     end
 
     def connection(_ = nil)
@@ -40,7 +40,7 @@ module Train::Transports
         super(options)
 
         # additional GCP platform metadata
-        release = Gem.loaded_specs['google-api-client'].version
+        release = Gem.loaded_specs["google-api-client"].version
         @platform_details = { release: "google-api-client-v#{release}" }
 
         # Initialize the client object cache
@@ -51,7 +51,7 @@ module Train::Transports
       end
 
       def platform
-        force_platform!('gcp', @platform_details)
+        force_platform!("gcp", @platform_details)
       end
 
       # Instantiate some named classes for ease of use
@@ -72,7 +72,7 @@ module Train::Transports
       end
 
       def gcp_admin_client
-        scopes = ['https://www.googleapis.com/auth/admin.directory.user.readonly']
+        scopes = ["https://www.googleapis.com/auth/admin.directory.user.readonly"]
         authorization = Google::Auth.get_application_default(scopes).dup
         # Use of the Admin API requires delegation (impersonation). An email address of a Super Admin in
         # the G Suite account may be required.
@@ -88,13 +88,13 @@ module Train::Transports
       end
 
       def connect
-        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = @options[:google_application_credentials] if @options[:google_application_credentials]
-        ENV['GOOGLE_CLOUD_PROJECT'] = @options[:google_cloud_project] if @options[:google_cloud_project]
+        ENV["GOOGLE_APPLICATION_CREDENTIALS"] = @options[:google_application_credentials] if @options[:google_application_credentials]
+        ENV["GOOGLE_CLOUD_PROJECT"] = @options[:google_cloud_project] if @options[:google_cloud_project]
         # GCP initialization
-        scopes = ['https://www.googleapis.com/auth/cloud-platform',
-                  'https://www.googleapis.com/auth/compute']
+        scopes = ["https://www.googleapis.com/auth/cloud-platform",
+                  "https://www.googleapis.com/auth/compute"]
         authorization = Google::Auth.get_application_default(scopes)
-        Google::Apis::ClientOptions.default.application_name = 'chef-inspec-train'
+        Google::Apis::ClientOptions.default.application_name = "chef-inspec-train"
         Google::Apis::ClientOptions.default.application_version = Train::VERSION
         Google::Apis::RequestOptions.default.authorization = authorization
       end
@@ -104,11 +104,11 @@ module Train::Transports
       end
 
       def unique_identifier
-        unique_id = 'default'
+        unique_id = "default"
         # use auth client_id for users (issuer is nil)
-        unique_id=gcp_iam_client.request_options.authorization.client_id unless gcp_iam_client.request_options.authorization.client_id.nil?
+        unique_id = gcp_iam_client.request_options.authorization.client_id unless gcp_iam_client.request_options.authorization.client_id.nil?
         # for service account credentials (client_id is nil)
-        unique_id=gcp_iam_client.request_options.authorization.issuer unless gcp_iam_client.request_options.authorization.issuer.nil?
+        unique_id = gcp_iam_client.request_options.authorization.issuer unless gcp_iam_client.request_options.authorization.issuer.nil?
         unique_id
       end
     end

data/lib/train/transports/helpers/azure/file_credentials.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-require 'inifile'
-require 'train/transports/helpers/azure/file_parser'
-require 'train/transports/helpers/azure/subscription_number_file_parser'
-require 'train/transports/helpers/azure/subscription_id_file_parser'
+require "inifile"
+require "train/transports/helpers/azure/file_parser"
+require "train/transports/helpers/azure/subscription_number_file_parser"
+require "train/transports/helpers/azure/subscription_id_file_parser"
 
 module Train::Transports
   module Helpers
@@ -13,7 +13,7 @@ module Train::Transports
           return {} if credentials_file.nil?
           return {} unless ::File.readable?(credentials_file)
           credentials     = IniFile.load(::File.expand_path(credentials_file))
-          subscription_id = parser(subscription_id, ENV['AZURE_SUBSCRIPTION_NUMBER'], credentials).subscription_id
+          subscription_id = parser(subscription_id, ENV["AZURE_SUBSCRIPTION_NUMBER"], credentials).subscription_id
           creds(subscription_id, credentials)
         end
 
@@ -30,9 +30,9 @@ module Train::Transports
         def self.creds(subscription_id, credentials)
           {
             subscription_id: subscription_id,
-            tenant_id:       credentials[subscription_id]['tenant_id'],
-            client_id:       credentials[subscription_id]['client_id'],
-            client_secret:   credentials[subscription_id]['client_secret'],
+            tenant_id: credentials[subscription_id]["tenant_id"],
+            client_id: credentials[subscription_id]["client_id"],
+            client_secret: credentials[subscription_id]["client_secret"],
           }
         end
       end

data/lib/train/transports/helpers/azure/file_parser.rb

@@ -13,7 +13,7 @@ module Train::Transports
         def validate!
           return if @credentials.sections.count == 1
 
-          raise 'Credentials file must have one entry. Check your credentials file. If you have more than one entry set AZURE_SUBSCRIPTION_ID environment variable.'
+          raise "Credentials file must have one entry. Check your credentials file. If you have more than one entry set AZURE_SUBSCRIPTION_ID environment variable."
         end
 
         def subscription_id

data/lib/train/transports/helpers/azure/subscription_number_file_parser.rb

@@ -13,7 +13,7 @@ module Train::Transports
 
         def validate!
           if @index == 0
-            raise 'Index must be greater than 0.'
+            raise "Index must be greater than 0."
           end
 
           if @index > @credentials.sections.length

data/lib/train/transports/local.rb

@@ -3,13 +3,13 @@
 # author: Dominik Richter
 # author: Christoph Hartmann
 
-require 'train/plugins'
-require 'train/errors'
-require 'mixlib/shellout'
+require "train/plugins"
+require "train/errors"
+require "mixlib/shellout"
 
 module Train::Transports
   class Local < Train.plugin(1)
-    name 'local'
+    name "local"
 
     class PipeError < Train::TransportError; end
 
@@ -33,7 +33,7 @@ module Train::Transports
       end
 
       def uri
-        'local://'
+        "local://"
       end
 
       private
@@ -41,10 +41,10 @@ module Train::Transports
       def select_runner(options)
         if os.windows?
           # Force a 64 bit poweshell if needed
-          if RUBY_PLATFORM == 'i386-mingw32' && os.arch == 'x86_64'
+          if RUBY_PLATFORM == "i386-mingw32" && os.arch == "x86_64"
             powershell_cmd = "#{ENV['SystemRoot']}\\sysnative\\WindowsPowerShell\\v1.0\\powershell.exe"
           else
-            powershell_cmd = 'powershell'
+            powershell_cmd = "powershell"
           end
 
           # Attempt to use a named pipe but fallback to ShellOut if that fails
@@ -67,7 +67,7 @@ module Train::Transports
         when :windows_shell
           WindowsShellRunner.new
         else
-          fail "Runner type `#{command_runner}` not supported"
+          raise "Runner type `#{command_runner}` not supported"
         end
       end
 
@@ -82,7 +82,7 @@ module Train::Transports
         res.run_command
         Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
       rescue Errno::ENOENT => _
-        CommandResult.new('', '', 1)
+        CommandResult.new("", "", 1)
       end
 
       def file_via_connection(path)
@@ -112,10 +112,10 @@ module Train::Transports
       end
 
       class WindowsShellRunner
-        require 'json'
-        require 'base64'
+        require "json"
+        require "base64"
 
-        def initialize(powershell_cmd = 'powershell')
+        def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
         end
 
@@ -124,7 +124,7 @@ module Train::Transports
           script = "$ProgressPreference='SilentlyContinue';" + script
 
           # Encode script so PowerShell can use it
-          script = script.encode('UTF-16LE', 'UTF-8')
+          script = script.encode("UTF-16LE", "UTF-8")
           base64_script = Base64.strict_encode64(script)
 
           cmd = "#{@powershell_cmd} -NoProfile -EncodedCommand #{base64_script}"
@@ -136,14 +136,14 @@ module Train::Transports
       end
 
       class WindowsPipeRunner
-        require 'json'
-        require 'base64'
-        require 'securerandom'
+        require "json"
+        require "base64"
+        require "securerandom"
 
-        def initialize(powershell_cmd = 'powershell')
+        def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
           @pipe = acquire_pipe
-          fail PipeError if @pipe.nil?
+          raise PipeError if @pipe.nil?
         end
 
         def run_command(cmd)
@@ -167,7 +167,7 @@ module Train::Transports
           # PowerShell needs time to create pipe.
           100.times do
             begin
-              pipe = open("//./pipe/#{pipe_name}", 'r+')
+              pipe = open("//./pipe/#{pipe_name}", "r+")
               break
             rescue
               sleep 0.1
@@ -178,7 +178,7 @@ module Train::Transports
         end
 
         def start_pipe_server(pipe_name)
-          require 'win32/process'
+          require "win32/process"
 
           script = <<-EOF
             $ErrorActionPreference = 'Stop'
@@ -213,14 +213,14 @@ module Train::Transports
             }
           EOF
 
-          utf8_script = script.encode('UTF-16LE', 'UTF-8')
+          utf8_script = script.encode("UTF-16LE", "UTF-8")
           base64_script = Base64.strict_encode64(utf8_script)
           cmd = "#{@powershell_cmd} -NoProfile -ExecutionPolicy bypass -NonInteractive -EncodedCommand #{base64_script}"
 
           server_pid = Process.create(command_line: cmd).process_id
 
           # Ensure process is killed when the Train process exits
-          at_exit { Process.kill('KILL', server_pid) }
+          at_exit { Process.kill("KILL", server_pid) }
         end
       end
     end

data/lib/train/transports/mock.rb

@@ -1,11 +1,9 @@
-# encoding: utf-8
-
-require 'train/plugins'
-require 'digest'
+require "train/plugins"
+require "digest"
 
 module Train::Transports
   class Mock < Train.plugin(1)
-    name 'mock'
+    name "mock"
 
     def initialize(conf = nil)
       @conf = conf || {}
@@ -17,39 +15,39 @@ module Train::Transports
     end
 
     def to_s
-      'Mock Transport'
+      "Mock Transport"
     end
 
     private
 
     def trace_calls
       interface_methods = {
-        'Train::Transports::Mock' =>
+        "Train::Transports::Mock" =>
           Train::Transports::Mock.instance_methods(false),
-        'Train::Transports::Mock::Connection' =>
+        "Train::Transports::Mock::Connection" =>
           Connection.instance_methods(false),
-        'Train::Transports::Mock::Connection::File' =>
+        "Train::Transports::Mock::Connection::File" =>
           Connection::FileCommon.instance_methods(false),
-        'Train::Transports::Mock::Connection::OS' =>
+        "Train::Transports::Mock::Connection::OS" =>
           Train::Platform.instance_methods(false),
       }
 
       # rubocop:disable Metrics/ParameterLists
       # rubocop:disable Lint/Eval
-      set_trace_func proc { |event, _file, _line, id, binding, classname|
-        unless classname.to_s.start_with?('Train::Transports::Mock') and
-               event == 'call' and
-               interface_methods[classname.to_s].include?(id)
+      set_trace_func(proc { |event, _file, _line, id, binding, classname|
+        unless classname.to_s.start_with?("Train::Transports::Mock") &&
+            (event == "call") &&
+            interface_methods[classname.to_s].include?(id)
           next
         end
         # kindly borrowed from the wonderful simple-tracer by matugm
         arg_names = eval(
-          'method(__method__).parameters.map { |arg| arg[1].to_s }',
+          "method(__method__).parameters.map { |arg| arg[1].to_s }",
           binding)
-        args = eval("#{arg_names}.map { |arg| eval(arg) }", binding).join(', ')
-        prefix = '-' * (classname.to_s.count(':') - 2) + '> '
+        args = eval("#{arg_names}.map { |arg| eval(arg) }", binding).join(", ")
+        prefix = "-" * (classname.to_s.count(":") - 2) + "> "
         puts("#{prefix}#{id} #{args}")
-      }
+      })
       # rubocop:enable all
     end
   end
@@ -67,14 +65,14 @@ class Train::Transports::Mock
     end
 
     def uri
-      'mock://'
+      "mock://"
     end
 
     def mock_os(value = {})
       # if a user passes a nil value, set to an empty hash so the merge still succeeds
       value ||= {}
-      value.each { |k, v| value[k] = 'unknown' if v.nil? }
-      value = { name: 'mock', family: 'mock', release: 'unknown', arch: 'unknown' }.merge(value)
+      value.each { |k, v| value[k] = "unknown" if v.nil? }
+      value = { name: "mock", family: "mock", release: "unknown", arch: "unknown" }.merge(value)
 
       platform = Train::Platforms.name(value[:name])
       platform.find_family_hierarchy
@@ -100,26 +98,26 @@ class Train::Transports::Mock
     end
 
     def mock_command(cmd, stdout = nil, stderr = nil, exit_status = 0)
-      @cache[:command][cmd] = Command.new(stdout || '', stderr || '', exit_status)
+      @cache[:command][cmd] = Command.new(stdout || "", stderr || "", exit_status)
     end
 
     def command_not_found(cmd)
       if @options[:verbose]
-        STDERR.puts('Command not mocked:')
-        STDERR.puts('    '+cmd.to_s.split("\n").join("\n    "))
-        STDERR.puts('    SHA: ' + Digest::SHA256.hexdigest(cmd.to_s))
+        $stderr.puts("Command not mocked:")
+        $stderr.puts("    " + cmd.to_s.split("\n").join("\n    "))
+        $stderr.puts("    SHA: " + Digest::SHA256.hexdigest(cmd.to_s))
       end
       # return a non-zero exit code
       mock_command(cmd, nil, nil, 1)
     end
 
     def file_not_found(path)
-      STDERR.puts('File not mocked: '+path.to_s) if @options[:verbose]
+      $stderr.puts("File not mocked: " + path.to_s) if @options[:verbose]
       File.new(self, path)
     end
 
     def to_s
-      'Mock Connection'
+      "Mock Connection"
     end
 
     private
@@ -142,23 +140,23 @@ end
 class Train::Transports::Mock::Connection
   class File < Train::File
     def self.from_json(json)
-      res = new(json['backend'],
-                json['path'],
-                json['follow_symlink'])
-      res.type = json['type']
+      res = new(json["backend"],
+                json["path"],
+                json["follow_symlink"])
+      res.type = json["type"]
       Train::File::DATA_FIELDS.each do |f|
-        m = (f.tr('?', '') + '=').to_sym
+        m = (f.tr("?", "") + "=").to_sym
         res.method(m).call(json[f])
       end
       res
     end
 
     Train::File::DATA_FIELDS.each do |m|
-      attr_accessor m.tr('?', '').to_sym
-      next unless m.include?('?')
+      attr_accessor m.tr("?", "").to_sym
+      next unless m.include?("?")
 
       define_method m.to_sym do
-        method(m.tr('?', '').to_sym).call
+        method(m.tr("?", "").to_sym).call
       end
     end
     attr_accessor :type