train-core 3.8.7 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e3153fa7d5928d42936093a793c001b1c0988a10c320edba2b887f63a1ec4ab
-  data.tar.gz: 3da18aa2c5e772b2881a670c23074c1775d1d560a87576fdd15d885e4e954c79
+  metadata.gz: 579bb940034fbb7c1d8f6e8025b0d364e5b78f2161efd6155a0f7d65f03af7e0
+  data.tar.gz: f5ffb30dfd921debde3e54dc2f88d0f9c41644b02ec7bf3eb6d32797dcc81bc5
 SHA512:
-  metadata.gz: c64082d00fb778a8326543df95888d03c98a4223a54dfc2073087c7dcef695ca9ca9d8e2c40f5980a9d726431b431283e5a205ba2cdbe1ec2c9a38ce8966be0b
-  data.tar.gz: b10c8793c74e7ae271eaae49e94a7222c1b347ad808d3a16b68f23564c03a6fec5baea0bf8209a99330f3dfcfc76a61a5ef1b1b5df8ff403d995c1fda37f7536
+  metadata.gz: f6972393f3e6721198c850213d00e120c49668fe29fe60d50d2d465bf5839d9e0ee7281d14e98143d2bd9bb33130f6bee9e859e9c111c490dfdca02ea0d96a27
+  data.tar.gz: a68a449c540c36712f68b69ef6103955e4bb10287c98b4448a65b0b103bdb8e9cbf401a3316bdca6a347e9fa85dd55fa4c1619fcb7ff4cc379fecb33032918b0

data/lib/train/errors.rb

@@ -38,6 +38,9 @@ module Train
   # Exception for when no platform can be detected.
   class PlatformDetectionFailed < Error; end
 
+  # Exception for when no uuid for the platform can be detected.
+  class PlatformUuidDetectionFailed < Error; end
+
   # Exception for when a invalid cache type is passed.
   class UnknownCacheType < Error; end
 

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

@@ -97,6 +97,12 @@ module Train::Platforms::Detect::Helpers
         return @cache[:cisco] = { version: m[2], model: m[1], type: "ios-xe" }
       end
 
+      # CSR 1000V (for example) does not specify model
+      m = res.match(/Cisco IOS XE Software, Version (\d+\.\d+\.\d+[A-Z]*)/)
+      unless m.nil?
+        return @cache[:cisco] = { version: m[1], type: "ios-xe" }
+      end
+
       m = res.match(/Cisco Nexus Operating System \(NX-OS\) Software/)
       unless m.nil?
         v = res[/^\s*system:\s+version (\d+\.\d+)/, 1]
@@ -122,7 +128,6 @@ module Train::Platforms::Detect::Helpers
     end
 
     def unix_uuid_from_machine_file
-      # require 'pry';binding.pry
       %W{
         /etc/chef/chef_guid
         #{ENV["HOME"]}/.chef/chef_guid

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

@@ -51,7 +51,7 @@ module Train::Platforms::Detect::Helpers
 
     def local_windows?
       @backend.class.to_s == "Train::Transports::Local::Connection" &&
-        ruby_host_os(/mswin|mingw32|windows/)
+        ruby_host_os(/mswin|mingw|windows/)
     end
 
     # reads os name and version from wmic

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

@@ -20,12 +20,13 @@ module Train::Platforms::Detect
       elsif @platform.windows?
         windows_uuid
       else
-        if @platform[:uuid_command]
+        # Checking "unknown" :uuid_command which is set for mock transport.
+        if @platform[:uuid_command] && !@platform[:uuid_command] == "unknown"
           result = @backend.run_command(@platform[:uuid_command])
           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 Train::PlatformUuidDetectionFailed.new("Could not find platform uuid! Please set a uuid_command for your platform.")
       end
     end
   end

data/lib/train/transports/podman.rb

@@ -0,0 +1,157 @@
+require "docker"
+require_relative "../errors"
+
+module Train::Transports
+  class Podman < Train.plugin(1)
+
+    name "podman"
+
+    include_options Train::Extras::CommandWrapper
+    option :host, required: true
+    option :podman_url, required: false
+
+    def connection(state = {}, &block)
+      opts = merge_options(options, state || {})
+
+      validate_options(opts)
+
+      if @connection && @connection_options == opts
+        reuse_connection(&block)
+      else
+        create_new_connection(opts, &block)
+      end
+    end
+
+    private
+
+    # Creates a new Podman connection instance and save it for potential future
+    # reuse.
+    #
+    # @param options [Hash] connection options
+    # @return [Podman::Connection] a Podman connection instance
+    # @api private
+    def create_new_connection(options, &block)
+      if @connection
+        logger.debug("[Podman] shutting previous connection #{@connection}")
+        @connection.close
+      end
+
+      @connection_options = options
+      @connection = Connection.new(options, &block)
+    end
+
+    # Return the last saved Podman connection instance.
+    #
+    # @return [Podman::Connection] a Podman connection instance
+    # @api private
+    def reuse_connection
+      logger.debug("[Podman] reusing existing connection #{@connection}")
+      yield @connection if block_given?
+      @connection
+    end
+  end
+
+  class Train::Transports::Podman
+    class Connection < BaseConnection
+      def initialize(options)
+        super(options)
+
+        @id = options[:host]
+
+        if RUBY_PLATFORM =~ /windows|mswin|msys|mingw|cygwin/
+          raise "Unsupported host platform."
+        end
+
+        # Currently Podman url can be set using option and setting the environment variable.
+        uid = Process.uid
+        podman_url = options[:podman_url] || ENV["CONTAINER_HOST"]
+        podman_url ||= "unix:///run/podman/podman.sock" if uid == 0
+        podman_url ||= "unix:///run/user/#{uid}/podman/podman.sock"
+
+        Docker.url = podman_url
+
+        # Using docker-api ruby library to fetch the Podman container data.
+        @container = ::Docker::Container.get(@id) ||
+          raise("Can't find Podman container #{@id}")
+        @cmd_wrapper = nil
+        @cmd_wrapper = CommandWrapper.load(self, @options)
+        @probably_windows = nil
+      rescue Excon::Error::Socket
+        raise Train::TransportError, "Unable to connect to Podman using #{podman_url}"
+      rescue Docker::Error::NotFoundError => e
+        raise Train::TransportError, "Container Not Found: #{e.message}"
+      rescue Docker::Error::ServerError => e
+        raise Train::TransportError, "#{e.message}"
+      end
+
+      def close
+        # nothing to do at the moment
+      end
+
+      def uri
+        if @container.nil?
+          "podman://#{@id}"
+        else
+          "podman://#{@container.id}"
+        end
+      end
+
+      def unique_identifier
+        @container.nil? ? @id : @container.id # default uuid set to the podman host.
+      end
+
+      private
+
+      def file_via_connection(path)
+        if os.aix?
+          Train::File::Remote::Aix.new(self, path)
+        elsif os.solaris?
+          Train::File::Remote::Unix.new(self, path)
+        elsif os.windows?
+          Train::File::Remote::Windows.new(self, path)
+        else
+          Train::File::Remote::Linux.new(self, path)
+        end
+      end
+
+      def run_command_via_connection(cmd, &_data_handler)
+        cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
+
+        # Cannot use os.windows? here because it calls run_command_via_connection,
+        # causing infinite recursion during initial platform detection
+        if sniff_for_windows?
+          invocation = cmd_run_command(cmd)
+        else
+          invocation = sh_run_command(cmd)
+        end
+        stdout, stderr, exit_status = @container.exec(
+          invocation, user: @options[:user]
+        )
+        CommandResult.new(stdout.join, stderr.join, exit_status)
+      rescue ::Docker::Error::DockerError => _
+        raise
+      rescue => _
+        # @TODO: differentiate any other error
+        raise
+      end
+
+      def sh_run_command(cmd)
+        ["/bin/sh", "-c", cmd]
+      end
+
+      def cmd_run_command(cmd)
+        ["cmd.exe", "/s", "/c", cmd]
+      end
+
+      def sniff_for_windows?
+        return @probably_windows unless @probably_windows.nil?
+
+        # Run a command using /bin/sh, which should fail under Windows
+        stdout, _stderr, _exit_status = @container.exec(
+          sh_run_command("true"), user: @options[:user]
+        )
+        @probably_windows = !!stdout.detect { |l| l.include? "failure in a Windows system call" }
+      end
+    end
+  end
+end

data/lib/train/transports/ssh_connection.rb

@@ -326,7 +326,16 @@ class Train::Transports::SSH
         cmd = @cmd_wrapper.run(cmd) if @cmd_wrapper
 
         # Timeout the command if requested and able
-        cmd = "timeout #{timeout}s #{cmd}" if timeout && timeoutable?(cmd)
+        if timeout && timeoutable?(cmd)
+          # if cmd start with sudo then we need to make sure the timeout should be prepend with sudo else actual timeout is not working.
+          if cmd.strip.split[0] == "sudo"
+            split_cmd = cmd.strip.split
+            split_cmd[0] = "sudo timeout #{timeout}s"
+            cmd = split_cmd.join(" ")
+          else
+            cmd = "timeout #{timeout}s #{cmd}"
+          end
+        end
 
         logger.debug("[SSH] #{self} cmd = #{cmd}")
 

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.8.7
+  version: 3.10.0
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -162,6 +162,7 @@ files:
 - lib/train/transports/cisco_ios_connection.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
+- lib/train/transports/podman.rb
 - lib/train/transports/ssh.rb
 - lib/train/transports/ssh_connection.rb
 - lib/train/version.rb
@@ -181,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="