docker_toolkit 0.1.2 → 0.1.3

data/lib/docker_toolkit/childprocess/windows/process.rb

@@ -0,0 +1,132 @@
+module DockerToolkit
+module ChildProcess
+  module Windows
+    class Process < AbstractProcess
+
+      attr_reader :pid
+
+      def io
+        @io ||= Windows::IO.new
+      end
+
+      def stop(timeout = 3)
+        assert_started
+
+        log "sending KILL"
+        @handle.send(WIN_SIGKILL)
+
+        poll_for_exit(timeout)
+      ensure
+        close_handle
+        close_job_if_necessary
+      end
+
+      def wait
+        if exited?
+          exit_code
+        else
+          @handle.wait
+          @exit_code = @handle.exit_code
+
+          close_handle
+          close_job_if_necessary
+
+          @exit_code
+        end
+      end
+
+      def exited?
+        return true if @exit_code
+        assert_started
+
+        code   = @handle.exit_code
+        exited = code != PROCESS_STILL_ACTIVE
+
+        log(:exited? => exited, :code => code)
+
+        if exited
+          @exit_code = code
+          close_handle
+          close_job_if_necessary
+        end
+
+        exited
+      end
+
+      private
+
+      def launch_process
+        builder = ProcessBuilder.new(@args)
+        builder.leader      = leader?
+        builder.detach      = detach?
+        builder.duplex      = duplex?
+        builder.environment = @environment unless @environment.empty?
+        builder.cwd         = @cwd
+
+        if @io
+          builder.stdout      = @io.stdout
+          builder.stderr      = @io.stderr
+        end
+
+        @pid = builder.start
+        @handle = Handle.open @pid
+
+        if leader?
+          @job = Job.new
+          @job << @handle
+        end
+
+        if duplex?
+          raise Error, "no stdin stream" unless builder.stdin
+          io._stdin = builder.stdin
+        end
+
+        self
+      end
+
+      def close_handle
+        @handle.close
+      end
+
+      def close_job_if_necessary
+        @job.close if leader?
+      end
+
+
+      class Job
+        def initialize
+          @pointer = Lib.create_job_object(nil, nil)
+
+          if @pointer.nil? || @pointer.null?
+            raise Error, "unable to create job object"
+          end
+
+          basic = JobObjectBasicLimitInformation.new
+          basic[:LimitFlags] = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE | JOB_OBJECT_LIMIT_BREAKAWAY_OK
+
+          extended = JobObjectExtendedLimitInformation.new
+          extended[:BasicLimitInformation] = basic
+
+          ret = Lib.set_information_job_object(
+            @pointer,
+            JOB_OBJECT_EXTENDED_LIMIT_INFORMATION,
+            extended,
+            extended.size
+          )
+
+          Lib.check_error ret
+        end
+
+        def <<(handle)
+          Lib.check_error Lib.assign_process_to_job_object(@pointer, handle.pointer)
+        end
+
+        def close
+          Lib.close_handle @pointer
+        end
+      end
+
+    end # Process
+  end # Windows
+end # ChildProcess
+end

data/lib/docker_toolkit/childprocess/windows/process_builder.rb

@@ -0,0 +1,177 @@
+module DockerToolkit
+module ChildProcess
+  module Windows
+    class ProcessBuilder
+      attr_accessor :leader, :detach, :duplex, :environment, :stdout, :stderr, :cwd
+      attr_reader :stdin
+
+      def initialize(args)
+        @args        = args
+
+        @detach      = false
+        @duplex      = false
+        @environment = nil
+        @cwd         = nil
+
+        @stdout      = nil
+        @stderr      = nil
+        @stdin       = nil
+
+        @flags       = 0
+        @job_ptr     = nil
+        @cmd_ptr     = nil
+        @env_ptr     = nil
+        @cwd_ptr     = nil
+      end
+
+      def start
+        create_command_pointer
+        create_environment_pointer
+        create_cwd_pointer
+
+        setup_flags
+        setup_io
+
+        pid = create_process
+        close_handles
+
+        pid
+      end
+
+      private
+
+      def create_command_pointer
+        string = @args.map { |arg| quote_if_necessary(arg.to_s) }.join ' '
+        @cmd_ptr = FFI::MemoryPointer.from_string string
+      end
+
+      def create_environment_pointer
+        return unless @environment.kind_of?(Hash) && @environment.any?
+
+        strings = []
+
+        ENV.to_hash.merge(@environment).each do |key, val|
+          next if val.nil?
+
+          if key.to_s =~ /=|\0/ || val.to_s.include?("\0")
+            raise InvalidEnvironmentVariable, "#{key.inspect} => #{val.inspect}"
+          end
+
+          strings << "#{key}=#{val}\0"
+        end
+
+        strings << "\0" # terminate the env block
+        env_str = strings.join
+
+        @env_ptr = FFI::MemoryPointer.new(:long, env_str.bytesize)
+        @env_ptr.put_bytes 0, env_str, 0, env_str.bytesize
+      end
+
+      def create_cwd_pointer
+        @cwd_ptr = FFI::MemoryPointer.from_string(@cwd || Dir.pwd)
+      end
+
+      def create_process
+        ok = Lib.create_process(
+          nil,          # application name
+          @cmd_ptr,     # command line
+          nil,          # process attributes
+          nil,          # thread attributes
+          true,         # inherit handles
+          @flags,       # creation flags
+          @env_ptr,     # environment
+          @cwd_ptr,     # current directory
+          startup_info, # startup info
+          process_info  # process info
+        )
+
+        ok or raise LaunchError, Lib.last_error_message
+
+        process_info[:dwProcessId]
+      end
+
+      def startup_info
+        @startup_info ||= StartupInfo.new
+      end
+
+      def process_info
+        @process_info ||= ProcessInfo.new
+      end
+
+      def setup_flags
+        @flags |= DETACHED_PROCESS if @detach
+        @flags |= CREATE_BREAKAWAY_FROM_JOB if @leader
+      end
+
+      def setup_io
+        startup_info[:dwFlags] ||= 0
+        startup_info[:dwFlags] |= STARTF_USESTDHANDLES
+
+        if @stdout
+          startup_info[:hStdOutput] = std_stream_handle_for(@stdout)
+        end
+
+        if @stderr
+          startup_info[:hStdError] = std_stream_handle_for(@stderr)
+        end
+
+        if @duplex
+          read_pipe_ptr  = FFI::MemoryPointer.new(:pointer)
+          write_pipe_ptr = FFI::MemoryPointer.new(:pointer)
+          sa             = SecurityAttributes.new(:inherit => true)
+
+          ok = Lib.create_pipe(read_pipe_ptr, write_pipe_ptr, sa, 0)
+          Lib.check_error ok
+
+          @read_pipe  = read_pipe_ptr.read_pointer
+          @write_pipe = write_pipe_ptr.read_pointer
+
+          Lib.set_handle_inheritance @read_pipe, true
+          Lib.set_handle_inheritance @write_pipe, false
+
+          startup_info[:hStdInput] = @read_pipe
+        else
+          startup_info[:hStdInput] = std_stream_handle_for(STDIN)
+        end
+      end
+
+      def std_stream_handle_for(io)
+        handle = Lib.handle_for(io)
+
+        begin
+          Lib.set_handle_inheritance handle, true
+        rescue ChildProcess::Error
+          # If the IO was set to close on exec previously, this call will fail.
+          # That's probably OK, since the user explicitly asked for it to be
+          # closed (at least I have yet to find other cases where this will
+          # happen...)
+        end
+
+        handle
+      end
+
+      def close_handles
+        Lib.close_handle process_info[:hProcess]
+        Lib.close_handle process_info[:hThread]
+
+        if @duplex
+          @stdin = Lib.io_for(Lib.duplicate_handle(@write_pipe), File::WRONLY)
+          Lib.close_handle @read_pipe
+          Lib.close_handle @write_pipe
+        end
+      end
+
+      def quote_if_necessary(str)
+        quote = str.start_with?('"') ? "'" : '"'
+
+        case str
+        when /[\s\\'"]/
+          [quote, str, quote].join
+        else
+          str
+        end
+      end
+    end # ProcessBuilder
+  end # Windows
+end # ChildProcess
+end

data/lib/docker_toolkit/childprocess/windows/structs.rb

@@ -0,0 +1,151 @@
+module DockerToolkit
+module ChildProcess
+  module Windows
+    # typedef struct _STARTUPINFO {
+    #   DWORD  cb;
+    #   LPTSTR lpReserved;
+    #   LPTSTR lpDesktop;
+    #   LPTSTR lpTitle;
+    #   DWORD  dwX;
+    #   DWORD  dwY;
+    #   DWORD  dwXSize;
+    #   DWORD  dwYSize;
+    #   DWORD  dwXCountChars;
+    #   DWORD  dwYCountChars;
+    #   DWORD  dwFillAttribute;
+    #   DWORD  dwFlags;
+    #   WORD   wShowWindow;
+    #   WORD   cbReserved2;
+    #   LPBYTE lpReserved2;
+    #   HANDLE hStdInput;
+    #   HANDLE hStdOutput;
+    #   HANDLE hStdError;
+    # } STARTUPINFO, *LPSTARTUPINFO;
+
+    class StartupInfo < FFI::Struct
+      layout :cb,               :ulong,
+             :lpReserved,       :pointer,
+             :lpDesktop,        :pointer,
+             :lpTitle,          :pointer,
+             :dwX,              :ulong,
+             :dwY,              :ulong,
+             :dwXSize,          :ulong,
+             :dwYSize,          :ulong,
+             :dwXCountChars,    :ulong,
+             :dwYCountChars,    :ulong,
+             :dwFillAttribute,  :ulong,
+             :dwFlags,          :ulong,
+             :wShowWindow,      :ushort,
+             :cbReserved2,      :ushort,
+             :lpReserved2,      :pointer,
+             :hStdInput,        :pointer, # void ptr
+             :hStdOutput,       :pointer, # void ptr
+             :hStdError,        :pointer # void ptr
+    end
+
+    #
+    # typedef struct _PROCESS_INFORMATION {
+    #   HANDLE hProcess;
+    #   HANDLE hThread;
+    #   DWORD  dwProcessId;
+    #   DWORD  dwThreadId;
+    # } PROCESS_INFORMATION, *LPPROCESS_INFORMATION;
+    #
+
+    class ProcessInfo < FFI::Struct
+      layout :hProcess,    :pointer, # void ptr
+             :hThread,     :pointer, # void ptr
+             :dwProcessId, :ulong,
+             :dwThreadId,  :ulong
+    end
+
+    #
+    # typedef struct _SECURITY_ATTRIBUTES {
+    #   DWORD  nLength;
+    #   LPVOID lpSecurityDescriptor;
+    #   BOOL   bInheritHandle;
+    # } SECURITY_ATTRIBUTES, *PSECURITY_ATTRIBUTES, *LPSECURITY_ATTRIBUTES;
+    #
+
+    class SecurityAttributes < FFI::Struct
+      layout :nLength,              :ulong,
+             :lpSecurityDescriptor, :pointer, # void ptr
+             :bInheritHandle,       :int
+
+      def initialize(opts = {})
+        super()
+
+        self[:nLength]              = self.class.size
+        self[:lpSecurityDescriptor] = nil
+        self[:bInheritHandle]       = opts[:inherit] ? 1 : 0
+      end
+    end
+
+    #
+    # typedef struct _JOBOBJECT_BASIC_LIMIT_INFORMATION {
+    #   LARGE_INTEGER PerProcessUserTimeLimit;
+    #   LARGE_INTEGER PerJobUserTimeLimit;
+    #   DWORD         LimitFlags;
+    #   SIZE_T        MinimumWorkingSetSize;
+    #   SIZE_T        MaximumWorkingSetSize;
+    #   DWORD         ActiveProcessLimit;
+    #   ULONG_PTR     Affinity;
+    #   DWORD         PriorityClass;
+    #   DWORD         SchedulingClass;
+    # } JOBOBJECT_BASIC_LIMIT_INFORMATION, *PJOBOBJECT_BASIC_LIMIT_INFORMATION;
+    #
+    class JobObjectBasicLimitInformation < FFI::Struct
+      layout :PerProcessUserTimeLimit, :int64,
+             :PerJobUserTimeLimit,     :int64,
+             :LimitFlags,              :ulong,
+             :MinimumWorkingSetSize,   :size_t,
+             :MaximumWorkingSetSize,   :size_t,
+             :ActiveProcessLimit,      :ulong,
+             :Affinity,                :pointer,
+             :PriorityClass,           :ulong,
+             :SchedulingClass,         :ulong
+    end
+
+    #
+    # typedef struct _IO_COUNTERS {
+    #   ULONGLONG ReadOperationCount;
+    #   ULONGLONG WriteOperationCount;
+    #   ULONGLONG OtherOperationCount;
+    #   ULONGLONG ReadTransferCount;
+    #   ULONGLONG WriteTransferCount;
+    #   ULONGLONG OtherTransferCount;
+    # } IO_COUNTERS, *PIO_COUNTERS;
+    #
+
+    class IoCounters < FFI::Struct
+      layout :ReadOperationCount,  :ulong_long,
+             :WriteOperationCount, :ulong_long,
+             :OtherOperationCount, :ulong_long,
+             :ReadTransferCount,   :ulong_long,
+             :WriteTransferCount,  :ulong_long,
+             :OtherTransferCount,  :ulong_long
+    end
+    #
+    # typedef struct _JOBOBJECT_EXTENDED_LIMIT_INFORMATION {
+    #   JOBOBJECT_BASIC_LIMIT_INFORMATION BasicLimitInformation;
+    #   IO_COUNTERS                       IoInfo;
+    #   SIZE_T                            ProcessMemoryLimit;
+    #   SIZE_T                            JobMemoryLimit;
+    #   SIZE_T                            PeakProcessMemoryUsed;
+    #   SIZE_T                            PeakJobMemoryUsed;
+    # } JOBOBJECT_EXTENDED_LIMIT_INFORMATION, *PJOBOBJECT_EXTENDED_LIMIT_INFORMATION;
+    #
+
+    class JobObjectExtendedLimitInformation < FFI::Struct
+      layout :BasicLimitInformation, JobObjectBasicLimitInformation,
+             :IoInfo,                IoCounters,
+             :ProcessMemoryLimit,    :size_t,
+             :JobMemoryLimit,        :size_t,
+             :PeakProcessMemoryUsed, :size_t,
+             :PeakJobMemoryUsed,     :size_t
+    end
+
+
+  end # Windows
+end # ChildProcess
+end

data/lib/docker_toolkit/childprocess/windows.rb

@@ -0,0 +1,35 @@
+require "ffi"
+require "rbconfig"
+
+module DockerToolkit
+module ChildProcess
+  module Windows
+    module Lib
+      extend FFI::Library
+
+      def self.msvcrt_name
+        host_part = RbConfig::CONFIG['host_os'].split("_")[1]
+        manifest  = File.join(RbConfig::CONFIG['bindir'], 'ruby.exe.manifest')
+
+        if host_part && host_part.to_i > 80 && File.exists?(manifest)
+          "msvcr#{host_part}"
+        else
+          "msvcrt"
+        end
+      end
+
+      ffi_lib "kernel32", msvcrt_name
+      ffi_convention :stdcall
+
+
+    end # Library
+  end # Windows
+end # ChildProcess
+end DockerToolkit
+
+require "docker_toolkit/childprocess/windows/lib"
+require "docker_toolkit/childprocess/windows/structs"
+require "docker_toolkit/childprocess/windows/handle"
+require "docker_toolkit/childprocess/windows/io"
+require "docker_toolkit/childprocess/windows/process_builder"
+require "docker_toolkit/childprocess/windows/process"

data/lib/docker_toolkit/childprocess.rb

@@ -0,0 +1,208 @@
+require 'docker_toolkit/childprocess/version'
+require 'docker_toolkit/childprocess/errors'
+require 'docker_toolkit/childprocess/abstract_process'
+require 'docker_toolkit/childprocess/abstract_io'
+require "fcntl"
+require 'logger'
+
+module DockerToolkit
+
+module ChildProcess
+
+  @posix_spawn = false
+
+  class << self
+    attr_writer :logger
+
+    def new(*args)
+      case os
+      when :macosx, :linux, :solaris, :bsd, :cygwin, :aix
+        if posix_spawn?
+          Unix::PosixSpawnProcess.new(args)
+        elsif jruby?
+          JRuby::Process.new(args)
+        else
+          Unix::ForkExecProcess.new(args)
+        end
+      when :windows
+        Windows::Process.new(args)
+      else
+        raise Error, "unsupported platform #{platform_name.inspect}"
+      end
+    end
+    alias_method :build, :new
+
+    def logger
+      return @logger if defined?(@logger) and @logger
+
+      @logger = Logger.new($stderr)
+      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+
+      @logger
+    end
+
+    def platform
+      if RUBY_PLATFORM == "java"
+        :jruby
+      elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == "ironruby"
+        :ironruby
+      else
+        os
+      end
+    end
+
+    def platform_name
+      @platform_name ||= "#{arch}-#{os}"
+    end
+
+    def unix?
+      !windows?
+    end
+
+    def linux?
+      os == :linux
+    end
+
+    def jruby?
+      platform == :jruby
+    end
+
+    def windows?
+      os == :windows
+    end
+
+    def posix_spawn?
+      enabled = @posix_spawn || %w[1 true].include?(ENV['CHILDPROCESS_POSIX_SPAWN'])
+      return false unless enabled
+
+      require 'ffi'
+      begin
+        require "childprocess/unix/platform/#{ChildProcess.platform_name}"
+      rescue LoadError
+        raise ChildProcess::MissingPlatformError
+      end
+
+      require "childprocess/unix/lib"
+      require 'childprocess/unix/posix_spawn_process'
+
+      true
+    rescue ChildProcess::MissingPlatformError => ex
+      warn_once ex.message
+      false
+    end
+
+    #
+    # Set this to true to enable experimental use of posix_spawn.
+    #
+
+    def posix_spawn=(bool)
+      @posix_spawn = bool
+    end
+
+    def os
+      @os ||= (
+        require "rbconfig"
+        host_os = RbConfig::CONFIG['host_os'].downcase
+
+        case host_os
+        when /linux/
+          :linux
+        when /darwin|mac os/
+          :macosx
+        when /mswin|msys|mingw32/
+          :windows
+        when /cygwin/
+          :cygwin
+        when /solaris|sunos/
+          :solaris
+        when /bsd|dragonfly/
+          :bsd
+        when /aix/
+          :aix
+        else
+          raise Error, "unknown os: #{host_os.inspect}"
+        end
+      )
+    end
+
+    def arch
+      @arch ||= (
+        host_cpu = RbConfig::CONFIG['host_cpu'].downcase
+        case host_cpu
+        when /i[3456]86/
+          if workaround_older_macosx_misreported_cpu?
+            # Workaround case: older 64-bit Darwin Rubies misreported as i686
+            "x86_64"
+          else
+            "i386"
+          end
+        when /amd64|x86_64/
+          "x86_64"
+        when /ppc|powerpc/
+          "powerpc"
+        else
+          host_cpu
+        end
+      )
+    end
+
+    #
+    # By default, a child process will inherit open file descriptors from the
+    # parent process. This helper provides a cross-platform way of making sure
+    # that doesn't happen for the given file/io.
+    #
+
+    def close_on_exec(file)
+      if file.respond_to?(:close_on_exec=)
+        file.close_on_exec = true
+      elsif file.respond_to?(:fcntl) && defined?(Fcntl::FD_CLOEXEC)
+        file.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+
+        if jruby? && posix_spawn?
+          # on JRuby, the fcntl call above apparently isn't enough when
+          # we're launching the process through posix_spawn.
+          fileno = JRuby.posix_fileno_for(file)
+          Unix::Lib.fcntl fileno, Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+        end
+      elsif windows?
+        Windows::Lib.dont_inherit file
+      else
+        raise Error, "not sure how to set close-on-exec for #{file.inspect} on #{platform_name.inspect}"
+      end
+    end
+
+    private
+
+    def warn_once(msg)
+      @warnings ||= {}
+
+      unless @warnings[msg]
+        @warnings[msg] = true
+        logger.warn msg
+      end
+    end
+
+    # Workaround: detect the situation that an older Darwin Ruby is actually
+    # 64-bit, but is misreporting cpu as i686, which would imply 32-bit.
+    #
+    # @return [Boolean] `true` if:
+    #   (a) on Mac OS X
+    #   (b) actually running in 64-bit mode
+    def workaround_older_macosx_misreported_cpu?
+      os == :macosx && is_64_bit?
+    end
+
+    # @return [Boolean] `true` if this Ruby represents `1` in 64 bits (8 bytes).
+    def is_64_bit?
+      1.size == 8
+    end
+
+  end # class << self
+end # ChildProcess
+end # DockerToolkit
+
+require 'jruby' if DockerToolkit::ChildProcess.jruby?
+
+require 'docker_toolkit/childprocess/unix'    if DockerToolkit::ChildProcess.unix?
+require 'docker_toolkit/childprocess/windows' if DockerToolkit::ChildProcess.windows?
+require 'docker_toolkit/childprocess/jruby'   if DockerToolkit::ChildProcess.jruby?

data/lib/docker_toolkit/version.rb

@@ -1,5 +1,5 @@
 module DockerToolkit
 
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 
 end