train 3.9.2 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd940edfe620167dde1a1775025870c54302942253e052a147af2667f8454719
-  data.tar.gz: f9aa498ec4e35c22298d6cb2fa9dedbdac0a3a5ec30474e7f628ce29681317e7
+  metadata.gz: e6b8e68e08bf282a4842a3d7ff2b3433ae881762c68ead8976199d7ff3c7d697
+  data.tar.gz: 2b8406599b0a5da73fce05d206de2eb9633e07603e2edb8c94a8e6669822d738
 SHA512:
-  metadata.gz: ce6627058fcf2703b93ca814b5c96808472fa50d9efa1674e25a316db629074155a0716ed63cfe95c3bbde2db3a2a37e43d444375f3aef26cb59f44a0fb8c055
-  data.tar.gz: d4ce657c8e652714633ad35bf6e05c349c373bbf4d847c33541c2566b7eaae5278093b28c78ba930a5401a14843ad2690165ad9189b26b97f54a3a3ac858f898
+  metadata.gz: b7462fd698eaa650607048b34eca28cb24515dea1e8bee54a4f10842f7bd1dd7b6a33fe2d5f53dd3272046539658536279e3d9be3c77911cfd2aaa3bbb90d54d
+  data.tar.gz: 102693e9e2ad91febec2fda858e61ff1b721a9af806518751ca4e9c70814ac7ad56ef490c0f273a7f01c55a5eac38cc24a4a7a27e72b7aeeee510d6acd637112

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 3.9.2
+  version: 3.10.0
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.9.2
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: train-winrm
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +213,7 @@ files:
 - lib/train/transports/helpers/azure/file_parser.rb
 - lib/train/transports/helpers/azure/subscription_id_file_parser.rb
 - lib/train/transports/helpers/azure/subscription_number_file_parser.rb
+- lib/train/transports/podman.rb
 - lib/train/transports/vmware.rb
 homepage: 
 licenses:
@@ -230,7 +231,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:
   - - ">="