train 2.1.19 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4262fbc901f2d107019887434f1aade83d2341d8bbf113296a6bd5d72b1fc4d
-  data.tar.gz: ab8130c7b17d3bb245fdad4d1e5419b1325df364bdaecdc62c34ddbba27d3b8a
+  metadata.gz: 56414a1d391e0ec6270aa9c1eb8ca6290853b29c625c3d50c470137b926f1310
+  data.tar.gz: 9d2c8c113e94437e2f1bf83aaa95f3026d7cd73730dc454bb20df119b6b62696
 SHA512:
-  metadata.gz: 95f034184039cecf0bf4d78b02b65bed306ee46d953b25f6870fbbd58e65eebd71dcb3ebfd9381c1287322bfada1fd0d8a3d44be57275e6748fb8be9e6a744f6
-  data.tar.gz: 86bddfca26a15768245310f82814fdebb80cbfa0609530bf587cbc82b9edf95857fa1d6de4bd2f89283f197a16b965692ce84ef20fd4fa54a4b3b45d61edc712
+  metadata.gz: fdbc3b04c1c952e349745b46f9ec48b59584e3d6fdc017a9f8c25803921ff1148258746028b14df37f54a17d6797f2079429ea64985081beb665aa61a8e8bf55
+  data.tar.gz: 5274d2b0c833dd4d3644eac562b89b56516e3476c74788e946c492428375ee4e26ff9e986e40cc1222972eeeca868e83a43f6886ee6c0b4292b865d371578f9e

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

@@ -12,7 +12,11 @@ module Train::Platforms::Detect::Helpers
     end
 
     def winrm?
-      @backend.class.to_s == "Train::Transports::WinRM::Connection"
+      backend_name == "TrainPlugins::WinRM::Connection"
+    end
+
+    def backend_name
+      @backend.class.name
     end
 
     def unix_file_contents(path)

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

@@ -236,7 +236,10 @@ module Train::Platforms::Detect::Specifications
       # suse family
       plat.family("suse").in_family("linux")
         .detect do
-          unless (suse = unix_file_contents("/etc/SuSE-release")).nil?
+          if linux_os_release && linux_os_release["ID_LIKE"] =~ /suse/i
+            @platform[:release] = linux_os_release["VERSION"]
+            true
+          elsif !(suse = unix_file_contents("/etc/SuSE-release")).nil?
             # https://rubular.com/r/UKaYWolCYFMfp1
             version = suse.scan(/VERSION = (\d+)\nPATCHLEVEL = (\d+)/).flatten.join(".")
             # https://rubular.com/r/b5PN3hZDxa5amV
@@ -247,11 +250,13 @@ module Train::Platforms::Detect::Specifications
         end
       plat.name("opensuse").title("OpenSUSE Linux").in_family("suse")
         .detect do
-          true if unix_file_contents("/etc/SuSE-release") =~ /^opensuse/i
+          true if (linux_os_release && linux_os_release["NAME"] =~ /^opensuse/i) ||
+            unix_file_contents("/etc/SuSE-release") =~ /^opensuse/i
         end
       plat.name("suse").title("Suse Linux").in_family("suse")
         .detect do
-          true if unix_file_contents("/etc/SuSE-release") =~ /suse/i
+          true if (linux_os_release && linux_os_release["NAME"] =~ /^sles/i) ||
+            unix_file_contents("/etc/SuSE-release") =~ /suse/i
         end
 
       # arch

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 2.1.19
+  version: 3.0.1
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -90,34 +90,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: winrm
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: winrm-fs
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
@@ -286,8 +258,6 @@ files:
 - lib/train/transports/ssh.rb
 - lib/train/transports/ssh_connection.rb
 - lib/train/transports/vmware.rb
-- lib/train/transports/winrm.rb
-- lib/train/transports/winrm_connection.rb
 - lib/train/version.rb
 homepage: https://github.com/inspec/train/
 licenses:

data/lib/train/transports/winrm.rb

@@ -1,207 +0,0 @@
-# encoding: utf-8
-#
-# Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
-# Author:: Matt Wrock (<matt@mattwrock.com>)
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-# Author:: Dominik Richter (<dominik.richter@gmail.com>)
-# Author:: Christoph Hartmann (<chris@lollyrock.com>)
-#
-# Copyright (C) 2014, Salim Afiune
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "rbconfig"
-require "uri"
-require "train/errors"
-
-module Train::Transports
-  # Wrapped exception for any internally raised WinRM-related errors.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class WinRMFailed < Train::TransportError; end
-
-  # A Transport which uses WinRM to execute commands and transfer files.
-  #
-  # @author Matt Wrock <matt@mattwrock.com>
-  # @author Salim Afiune <salim@afiunemaya.com.mx>
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class WinRM < Train.plugin(1) # rubocop:disable ClassLength
-    name "winrm"
-
-    require "train/transports/winrm_connection"
-
-    # ref: https://github.com/winrb/winrm#transports
-    SUPPORTED_WINRM_TRANSPORTS = %i{negotiate ssl plaintext kerberos}.freeze
-
-    # common target configuration
-    option :host, required: true
-    option :port
-    option :user, default: "administrator", required: true
-    option :password, nil
-    option :winrm_transport, default: :negotiate
-    option :winrm_disable_sspi, default: false
-    option :winrm_basic_auth_only, default: false
-    option :path, default: "/wsman"
-    option :ssl, default: false
-    option :self_signed, default: false
-
-    # additional winrm options
-    option :rdp_port, default: 3389
-    option :connection_retries, default: 5
-    option :connection_retry_sleep, default: 1
-    option :max_wait_until_ready, default: 600
-    option :ssl_peer_fingerprint, default: nil
-    option :kerberos_realm, default: nil
-    option :kerberos_service, default: nil
-    option :ca_trust_path, default: nil
-    # The amount of time in SECONDS for which each operation must get an ack
-    # from the winrm endpoint. Does not mean that the command has
-    # completed in this time, only that the server has ack'd the request.
-    option :operation_timeout, default: nil
-
-    def initialize(opts)
-      super(opts)
-      load_needed_dependencies!
-    end
-
-    # (see Base#connection)
-    def connection(state = nil, &block)
-      opts = merge_options(options, state || {})
-      validate_options(opts)
-      conn_opts = connection_options(opts)
-
-      if @connection && @connection_options == conn_opts
-        reuse_connection(&block)
-      else
-        create_new_connection(conn_opts, &block)
-      end
-    end
-
-    private
-
-    def validate_options(opts)
-      super(opts)
-
-      # set scheme and port based on ssl activation
-      scheme = opts[:ssl] ? "https" : "http"
-      port = opts[:port]
-      port = (opts[:ssl] ? 5986 : 5985) if port.nil?
-      winrm_transport = opts[:winrm_transport].to_sym
-      unless SUPPORTED_WINRM_TRANSPORTS.include?(winrm_transport)
-        raise Train::ClientError, "Unsupported transport type: #{winrm_transport.inspect}"
-      end
-
-      # remove leading '/'
-      path = (opts[:path] || "").sub(%r{^/+}, "")
-
-      opts[:endpoint] = "#{scheme}://#{opts[:host]}:#{port}/#{path}"
-    end
-
-    WINRM_FS_SPEC_VERSION = "~> 1.0".freeze
-
-    # Builds the hash of options needed by the Connection object on
-    # construction.
-    #
-    # @param data [Hash] merged configuration and mutable state data
-    # @return [Hash] hash of connection options
-    # @api private
-    def connection_options(opts)
-      {
-        logger: logger,
-        transport: opts[:winrm_transport].to_sym,
-        disable_sspi: opts[:winrm_disable_sspi],
-        basic_auth_only: opts[:winrm_basic_auth_only],
-        hostname: opts[:host],
-        endpoint: opts[:endpoint],
-        user: opts[:user],
-        password: opts[:password],
-        rdp_port: opts[:rdp_port],
-        connection_retries: opts[:connection_retries],
-        connection_retry_sleep: opts[:connection_retry_sleep],
-        max_wait_until_ready: opts[:max_wait_until_ready],
-        no_ssl_peer_verification: opts[:self_signed],
-        realm: opts[:kerberos_realm],
-        service: opts[:kerberos_service],
-        ca_trust_path: opts[:ca_trust_path],
-        ssl_peer_fingerprint: opts[:ssl_peer_fingerprint],
-      }
-    end
-
-    # Creates a new WinRM Connection instance and save it for potential
-    # future reuse.
-    #
-    # @param options [Hash] conneciton options
-    # @return [WinRM::Connection] a WinRM Connection instance
-    # @api private
-    def create_new_connection(options, &block)
-      if @connection
-        logger.debug("[WinRM] shutting previous connection #{@connection}")
-        @connection.close
-      end
-
-      @connection_options = options
-      @connection = Connection.new(options, &block)
-    end
-
-    # (see Base#load_needed_dependencies!)
-    def load_needed_dependencies!
-      spec_version = WINRM_FS_SPEC_VERSION.dup
-      logger.debug("winrm-fs requested," \
-        " loading WinRM::FS gem (#{spec_version})")
-      gem "winrm-fs", spec_version
-      first_load = require "winrm-fs"
-      load_winrm_transport!
-
-      if first_load
-        logger.debug("WinRM::FS library loaded")
-      else
-        logger.debug("WinRM::FS previously loaded")
-      end
-    rescue LoadError => e
-      logger.fatal(
-        "The `winrm-fs' gem is missing and must" \
-        " be installed or cannot be properly activated. Run" \
-        " `gem install winrm-fs --version '#{spec_version}'`" \
-        " or add the following to your Gemfile if you are using Bundler:" \
-        " `gem 'winrm-fs', '#{spec_version}'`."
-      )
-      raise Train::UserError,
-        "Could not load or activate WinRM::FS (#{e.message})"
-    end
-
-    # Load WinRM::Transport code.
-    #
-    # @api private
-    def load_winrm_transport!
-      silence_warnings { require "winrm-fs" }
-    end
-
-    # Return the last saved WinRM connection instance.
-    #
-    # @return [Winrm::Connection] a WinRM Connection instance
-    # @api private
-    def reuse_connection
-      logger.debug("[WinRM] reusing existing connection #{@connection}")
-      yield @connection if block_given?
-      @connection
-    end
-
-    def silence_warnings
-      old_verbose = $VERBOSE
-      $VERBOSE = nil
-      yield
-    ensure
-      $VERBOSE = old_verbose
-    end
-  end
-end

data/lib/train/transports/winrm_connection.rb

@@ -1,202 +0,0 @@
-# encoding: utf-8
-#
-# Author:: Salim Afiune (<salim@afiunemaya.com.mx>)
-# Author:: Matt Wrock (<matt@mattwrock.com>)
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-# Author:: Dominik Richter (<dominik.richter@gmail.com>)
-# Author:: Christoph Hartmann (<chris@lollyrock.com>)
-#
-# Copyright (C) 2014, Salim Afiune
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-class Train::Transports::WinRM
-  # A Connection instance can be generated and re-generated, given new
-  # connection details such as connection port, hostname, credentials, etc.
-  # This object is responsible for carrying out the actions on the remote
-  # host such as executing commands, transferring files, etc.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
-    attr_reader :hostname
-    def initialize(options)
-      super(options)
-      @hostname               = @options.delete(:hostname)
-      @rdp_port               = @options.delete(:rdp_port)
-      @connection_retries     = @options.delete(:connection_retries)
-      @connection_retry_sleep = @options.delete(:connection_retry_sleep)
-      @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
-      @operation_timeout      = @options.delete(:operation_timeout)
-    end
-
-    # (see Base::Connection#close)
-    def close
-      return if @session.nil?
-
-      session.close
-    ensure
-      @session = nil
-    end
-
-    # (see Base::Connection#login_command)
-    def login_command
-      case RbConfig::CONFIG["host_os"]
-      when /darwin/
-        login_command_for_mac
-      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-        login_command_for_windows
-      when /linux/
-        login_command_for_linux
-      else
-        raise ActionFailed,
-          "Remote login not supported in #{self.class} " \
-          "from host OS '#{RbConfig::CONFIG["host_os"]}'."
-      end
-    end
-
-    # (see Base::Connection#upload)
-    def upload(locals, remote)
-      file_manager.upload(locals, remote)
-    end
-
-    def download(remotes, local)
-      Array(remotes).each do |remote|
-        file_manager.download(remote, local)
-      end
-    end
-
-    # (see Base::Connection#wait_until_ready)
-    def wait_until_ready
-      delay = 3
-      session(
-        retry_limit: @max_wait_until_ready / delay,
-        retry_delay: delay
-      )
-      run_command_via_connection(PING_COMMAND.dup)
-    end
-
-    def uri
-      "winrm://#{options[:user]}@#{options[:endpoint]}:#{@rdp_port}"
-    end
-
-    private
-
-    PING_COMMAND = "Write-Host '[WinRM] Established\n'".freeze
-
-    def file_via_connection(path)
-      Train::File::Remote::Windows.new(self, path)
-    end
-
-    def run_command_via_connection(command, &data_handler)
-      return if command.nil?
-
-      logger.debug("[WinRM] #{self} (#{command})")
-      out = ""
-
-      response = session.run(command) do |stdout, _|
-        yield(stdout) if data_handler && stdout
-        out << stdout if stdout
-      end
-
-      CommandResult.new(out, response.stderr, response.exitcode)
-    end
-
-    # Create a local RDP document and return it
-    #
-    # @param opts [Hash] configuration options
-    # @option opts [true,false] :mac whether or not the document is for a
-    #   Mac system
-    # @api private
-    def rdp_doc(opts = {})
-      host = URI.parse(options[:endpoint]).host
-      content = [
-        "full address:s:#{host}:#{@rdp_port}",
-        "prompt for credentials:i:1",
-        "username:s:#{options[:user]}",
-      ].join("\n")
-
-      content.prepend("drivestoredirect:s:*\n") if opts[:mac]
-
-      content
-    end
-
-    # @return [Winrm::FileManager] a file transporter
-    # @api private
-    def file_manager
-      @file_manager ||= begin
-        # Ensure @service is available:
-        wait_until_ready
-        WinRM::FS::FileManager.new(@service)
-      end
-    end
-
-    # Builds a `LoginCommand` for use by Linux-based platforms.
-    #
-    # TODO: determine whether or not `desktop` exists
-    #
-    # @return [LoginCommand] a login command
-    # @api private
-    def login_command_for_linux
-      args  = %W{ -u #{options[:user]} }
-      args += %W{ -p #{options[:pass]} } if options.key?(:pass)
-      args += %W{ #{URI.parse(options[:endpoint]).host}:#{@rdp_port} }
-      LoginCommand.new("rdesktop", args)
-    end
-
-    # Builds a `LoginCommand` for use by Mac-based platforms.
-    #
-    # @return [LoginCommand] a login command
-    # @api private
-    def login_command_for_mac
-      LoginCommand.new("open", rdp_doc(mac: true))
-    end
-
-    # Builds a `LoginCommand` for use by Windows-based platforms.
-    #
-    # @return [LoginCommand] a login command
-    # @api private
-    def login_command_for_windows
-      LoginCommand.new("mstsc", rdp_doc)
-    end
-
-    # Establishes a remote shell session, or establishes one when invoked
-    # the first time.
-    #
-    # @param retry_options [Hash] retry options for the initial connection
-    # @return [Winrm::CommandExecutor] the command executor session
-    # @api private
-    def session(retry_options = {})
-      @session ||= begin
-        opts = {
-          retry_limit: @connection_retries.to_i,
-          retry_delay: @connection_retry_sleep.to_i,
-        }.merge(retry_options)
-
-        opts[:operation_timeout] = @operation_timeout unless @operation_timeout.nil?
-        @service = ::WinRM::Connection.new(options.merge(opts))
-        @service.logger = logger
-        @service.shell(:powershell)
-      end
-    end
-
-    # String representation of object, reporting its connection details and
-    # configuration.
-    #
-    # @api private
-    def to_s
-      options_to_print = @options.clone
-      options_to_print[:password] = "<hidden>" if options_to_print.key?(:password)
-      "#{@username}@#{@hostname}<#{options_to_print.inspect}>"
-    end
-  end
-end