rake-compiler-dock 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c26ea0c9a2f101595eacf69df6bd46dfb781da9e
-  data.tar.gz: eba33956622fdc4ebd756cfead1f91f58f9294f2
+  metadata.gz: 6c62efef1a82d18b2fd09f02ba508c683693b306
+  data.tar.gz: c6908768b4f5af935e1080fad7f2f08d5942cfe4
 SHA512:
-  metadata.gz: 557cee7a6e0b484bb1b41f23ca4474db5383464722057cf7a33c21a8caa2e455b72782f11c61524bad843503c2274b4f0843d6ee40cb72ee9f349a11bd8cab1b
-  data.tar.gz: c0cae01e38a66d568a80fa7a11541782235bb10aca925da6ea0be4c0a071c23544c2c31b6b51fde8a5e0a1d518666cd7715e45ecd4720fef0be54a4604d99cc4
+  metadata.gz: cba0c38a91c5325e7bfc9137f7b197da46064db824cb6f425b84854993a7dfcd4b5bf7e066f427b6205e72732f69fb43ce3da0d613062df07b100cc1d251e43b
+  data.tar.gz: efed7ff1813b06cce9b396b208843146a19b4e0ed0f6a6def118655099ad378ce2bb3ceb2e64875ae21d3ee185ce99c4017420981edaaf185518c763ebe16fa5

data.tar.gz.sig

@@ -1 +1,2 @@
-m�����'���)D�1U��o��nB��}�(�ƹ|��Sˎ¢�Q"�����w���
g�X@E`�S2��
+K�cݗ`�Уw�.=_���hc�v��t�d��W:E�`�4�.�?��'_�כ3E]0���҃I������5�6��v�&����ß�Gћ�����j��Y���K���ĻO�MC���
ްR��D�˫����l��w���鄍�|�TP庅���?��{�W�bȑA��09�\V�t�
+,�m1ә���rwN)ZT0�z���*O|�U�e9�H�h��Us����r�lgcR&v������۔��

data/History.md

@@ -1,3 +1,13 @@
+0.4.0 / 2015-06-29
+------------------
+* Add support for OS-X.
+* Try boot2docker init and start, when docker is not available.
+* Add colorized terminal output.
+* Fix usage of STDIN for sending data/commands into the container.
+* Limit gemspec to ruby-1.9.3 or newer.
+* Allow spaces in user name and path on the host side.
+
+
 0.3.1 / 2015-06-24
 ------------------
 * Add :sigfw and :runas options.

data/README.md

@@ -28,19 +28,26 @@ Install rake-compiler-dock as a gem. The docker image is downloaded later on dem
 
 ## Usage
 
-Rake-compiler-dock offers the shell command `rake-compiler-dock` and a [ruby API for issuing commands within the docker image](http://www.rubydoc.info/gems/rake-compiler-dock/RakeCompilerDock).
-Both mount the current working directory into the docker environment.
-All commands are executed with the current user and group of the host.
-This is done by copying account data into the container and sudo to it.
+Rake-compiler-dock offers the shell command `rake-compiler-dock` and a [ruby API](http://www.rubydoc.info/gems/rake-compiler-dock/RakeCompilerDock) for issuing commands within the docker image, described below.
 
 `rake-compiler-dock` without arguments starts an interactive shell session.
+This is best suited to try out and debug a build.
+It mounts the current working directory into the docker environment.
 All changes below the current working directory are shared with the host.
-But note, that all other changes to the file system of the contanier are dropped at the end of the session - the docker image is stateless. `rake-compiler-dock` can also take the build command(s) from STDIN or as command arguments.
+But note, that all other changes to the file system of the container are dropped at the end of the session - the docker image is stateless. `rake-compiler-dock` can also take the build command(s) from STDIN or as command arguments.
 
-To build x86- and x64 Windows (Mingw) binary gems, it is typically called like this:
+All commands are executed with the same user and group of the host.
+This is done by copying user account data into the container and sudo to it.
 
-    $ cd your-gem-dir/
-    $ rake-compiler-dock bash -c "bundle && rake cross native gem RUBYOPT=--disable-rubygems"
+To build x86- and x64 Windows (RubyInstaller) binary gems interactively, it can be called like this:
+
+    user@host:$ cd your-gem-dir/
+    user@host:$ rake-compiler-dock   # this enters a container with an interactive shell
+    user@5b53794ada92:$ bundle
+    user@5b53794ada92:$ rake cross native gem
+    user@5b53794ada92:$ exit
+    user@host:$ ls pkg/*.gem
+    your-gem-1.0.0.gem  your-gem-1.0.0-x64-mingw32.gem  your-gem-1.0.0-x86-mingw32.gem
 
 The installed cross rubies can be listed like this:
 

data/bin/rake-compiler-dock

@@ -2,7 +2,13 @@
 
 require 'rake_compiler_dock'
 
-args = ARGV.empty? ? ['bash', {:sigfw => false}] : ARGV
+args = ARGV.empty? ? ['bash'] : ARGV.dup
+
+if $stdin.tty?
+  # An interactive session should not leave the container on Ctrl-C
+  args << {sigfw: false}
+end
+
 begin
   RakeCompilerDock.exec(*args) do |ok, res|
     exit(res.exitstatus)

data/lib/rake_compiler_dock.rb

@@ -1,9 +1,9 @@
-require "shellwords"
+require "rake_compiler_dock/colors"
+require "rake_compiler_dock/docker_check"
+require "rake_compiler_dock/starter"
 require "rake_compiler_dock/version"
 
 module RakeCompilerDock
-  class DockerIsNotAvailable < RuntimeError
-  end
 
   # Run the command cmd within a fresh rake-compiler-dock container and within a shell.
   #
@@ -25,14 +25,11 @@ module RakeCompilerDock
   #     end
   #   end
   def sh(cmd, options={}, &block)
-    if verbose_flag(options)
-      $stderr.puts "rake-compiler-dock bash -c #{ cmd.inspect }"
-    end
-    exec('bash', '-c', cmd, options, &block)
+    Starter.sh(cmd, options, &block)
   end
 
   def image_name
-    ENV['RAKE_COMPILER_DOCK_IMAGE'] || "larskanis/rake-compiler-dock:#{VERSION}"
+    Starter.image_name
   end
 
   # Run the command cmd within a fresh rake-compiler-dock container.
@@ -46,104 +43,14 @@ module RakeCompilerDock
   # * Option +:check_docker+ can be set to false to disable the docker check.
   # * Option +:sigfw+ can be set to false to not stop the container on Ctrl-C.
   # * Option +:runas+ can be set to false to execute the command as user root.
+  # * Option +:options+ can be an Array of additional options to the 'docker run' command.
   #
   # Examples:
   #
   #   RakeCompilerDock.exec 'bash', '-c', 'echo $RUBY_CC_VERSION'
-  def exec(*args)
-    options = (Hash === args.last) ? args.pop : {}
-    runargs = args.dup
-
-    check_docker if options.fetch(:check_docker){ true }
-    runargs.unshift("sigfw") if options.fetch(:sigfw){ true }
-    runargs.unshift("runas") if options.fetch(:runas){ true }
-
-    if RUBY_PLATFORM =~ /mingw|mswin/
-      # Change Path from "C:\Path" to "/c/Path" as used by boot2docker
-      pwd = Dir.pwd.gsub(/^([a-z]):/i){ "/#{$1.downcase}" }
-      uid = 1000
-      gid = 1000
-    else
-      pwd = Dir.pwd
-      uid = Process.uid
-      gid = Process.gid
-    end
-    user = `id -nu`.chomp
-    group = `id -ng`.chomp
-
-    cmd = ["docker", "run", "--rm", "-i", "-t",
-          "-v", "#{pwd}:#{pwd}",
-          "-e", "UID=#{uid}",
-          "-e", "GID=#{gid}",
-          "-e", "USER=#{user}",
-          "-e", "GROUP=#{group}",
-          "-e", "ftp_proxy=#{ENV['ftp_proxy']}",
-          "-e", "http_proxy=#{ENV['http_proxy']}",
-          "-e", "https_proxy=#{ENV['https_proxy']}",
-          "-w", pwd,
-          image_name,
-          *runargs]
-
-    cmdline = Shellwords.join(cmd)
-    if verbose_flag(options) == true
-      $stderr.puts cmdline
-    end
-
-    ok = system(*cmd)
-    if block_given?
-      yield(ok, $?)
-    elsif !ok
-      fail "Command failed with status (#{$?.exitstatus}): " +
-        "[#{cmdline}]"
-    end
-  end
-
-  def verbose_flag(options)
-    verbose = options.fetch(:verbose) do
-      Object.const_defined?(:Rake) && Rake.const_defined?(:FileUtilsExt) ? Rake::FileUtilsExt.verbose_flag : false
-    end
-  end
-
-  @@docker_checked = false
-
-  def check_docker
-    return if @@docker_checked
-
-    version_text = `docker version` rescue SystemCallError
-    if $?.exitstatus == 0 && version_text.to_s =~ /version/
-      @@docker_checked = true
-    else
-      at_exit do
-        $stderr.puts
-        case RUBY_PLATFORM
-        when /mingw|mswin/
-          $stderr.puts "Docker is not available. Please download and install boot2docker:"
-          $stderr.puts "   https://github.com/boot2docker/windows-installer/releases"
-          $stderr.puts
-          $stderr.puts "Then execute 'boot2docker start' and follow the instuctions"
-        when /linux/
-          $stderr.puts "Docker is not available."
-          $stderr.puts
-          $stderr.puts "Install on Ubuntu/Debian:"
-          $stderr.puts "   sudo apt-get install docker.io"
-          $stderr.puts
-          $stderr.puts "Install on Fedora/Centos/RHEL"
-          $stderr.puts "   sudo yum install docker"
-          $stderr.puts "   sudo systemctl start docker"
-          $stderr.puts
-          $stderr.puts "Install on SuSE"
-          $stderr.puts "   sudo zypper install docker"
-          $stderr.puts "   sudo systemctl start docker"
-        when /darwin/
-          $stderr.puts "Docker is not available. Please download and install boot2docker:"
-          $stderr.puts "   https://github.com/boot2docker/osx-installer/releases"
-        else
-          $stderr.puts "Docker is not available."
-        end
-      end
-      raise DockerIsNotAvailable, "Docker is not available"
-    end
+  def exec(*args, &block)
+    Starter.exec(*args, &block)
   end
 
-  module_function :exec, :sh, :image_name, :verbose_flag, :check_docker
+  module_function :exec, :sh, :image_name
 end

data/lib/rake_compiler_dock/colors.rb

@@ -0,0 +1,43 @@
+module RakeCompilerDock
+  module Colors
+    # Start an escape sequence
+    ESC = "\e["
+
+    # End the escape sequence
+    NND = "#{ESC}0m"
+
+    ColorMap = {
+      black: 0,
+      red: 1,
+      green: 2,
+      yellow: 3,
+      blue: 4,
+      magenta: 5,
+      cyan: 6,
+      white: 7,
+    }
+
+    ColorMap.each do |color, code|
+      define_method(color) do |string|
+        colored(code, string)
+      end
+    end
+
+    def colored(color, string)
+      if @colors_on
+        c = ColorMap[color] || color
+        "#{ESC}#{30+c}m#{string}#{NND}"
+      else
+        string.dup
+      end
+    end
+
+    def enable_colors
+      @colors_on = true
+    end
+
+    def disable_colors
+      @colors_on = false
+    end
+  end
+end

data/lib/rake_compiler_dock/docker_check.rb

@@ -0,0 +1,159 @@
+require "rake_compiler_dock/colors"
+
+module RakeCompilerDock
+  class DockerCheck
+    include Colors
+
+    attr_reader :io
+
+    def initialize(io)
+      @io = io
+      if !io.tty? || (RUBY_PLATFORM=~/mingw|mswin/ && RUBY_VERSION[/^\d+/] < '2')
+        disable_colors
+      else
+        enable_colors
+      end
+
+      docker_version
+
+      unless ok?
+        b2d_version
+
+        if b2d_avail?
+          io.puts
+          io.puts yellow("boot2docker is available, but not ready to use. Trying to start.")
+
+          b2d_init
+          if b2d_init_ok?
+            b2d_start
+
+            docker_version
+          end
+        end
+      end
+    end
+
+    def docker_version
+      @docker_version_text = `docker version 2>&1` rescue SystemCallError
+      @docker_version_status = $?.exitstatus
+    end
+
+    def ok?
+      @docker_version_status == 0 && @docker_version_text =~ /version/
+    end
+
+    def docker_client_avail?
+      @docker_version_text =~ /version/
+    end
+
+    def b2d_version
+      @b2d_version_text = `boot2docker version 2>&1` rescue SystemCallError
+      @b2d_version_status = $?.exitstatus
+    end
+
+    def b2d_avail?
+      @b2d_version_status == 0 && @b2d_version_text =~ /version/
+    end
+
+    def b2d_init
+      system("boot2docker init") rescue SystemCallError
+      @b2d_init_status = $?.exitstatus
+    end
+
+    def b2d_init_ok?
+      @b2d_init_status == 0
+    end
+
+    def b2d_start
+      @b2d_start_text = `boot2docker start` rescue SystemCallError
+      @b2d_start_status = $?.exitstatus
+
+      if @b2d_start_status == 0
+        @b2d_start_text.scan(/(unset |Remove-Item Env:\\)(?<key>.+?)$/) do |r, |
+          io.puts "    #{$&}"
+          ENV.delete(key)
+        end
+        @b2d_start_text.scan(/(export |\$Env:)(?<key>.+?)(=| = ")(?<val>.*?)(|\")$/) do |key, val|
+          io.puts "    #{$&}"
+          ENV[key] = val
+        end
+      end
+    end
+
+    def b2d_start_ok?
+      @b2d_start_status == 0
+    end
+
+    def help_text
+      help = []
+      if !ok? && docker_client_avail? && !b2d_avail?
+        help << red("Docker client tools work, but connection to the local docker server failed.")
+        case RUBY_PLATFORM
+        when /linux/
+          help << yellow("Please make sure the docker daemon is running.")
+          help << ""
+          help << yellow("On Ubuntu/Debian:")
+          help << "   sudo service docker start"
+          help << yellow("or")
+          help << "   sudo service docker.io start"
+          help << ""
+          help << yellow("On Fedora/Centos/RHEL")
+          help << "   sudo systemctl start docker"
+          help << ""
+          help << yellow("On SuSE")
+          help << "   sudo systemctl start docker"
+          help << ""
+          help << yellow("And re-check with '") + white("docker version") + yellow("'")
+        else
+          help << yellow("    Please check why '") + white("docker version") + yellow("' fails.")
+        end
+      elsif !ok? && !b2d_avail?
+        case RUBY_PLATFORM
+        when /mingw|mswin/
+          help << red("Docker is not available.")
+          help << yellow("Please download and install boot2docker:")
+          help << yellow("    https://github.com/boot2docker/windows-installer/releases")
+        when /linux/
+          help << red("Docker is not available.")
+          help << ""
+          help << yellow("Install on Ubuntu/Debian:")
+          help << "    sudo apt-get install docker.io"
+          help << ""
+          help << yellow("Install on Fedora/Centos/RHEL")
+          help << "    sudo yum install docker"
+          help << "    sudo systemctl start docker"
+          help << ""
+          help << yellow("Install on SuSE")
+          help << "    sudo zypper install docker"
+          help << "    sudo systemctl start docker"
+        when /darwin/
+          help << red("Docker is not available.")
+          help << yellow("Please download and install boot2docker:")
+          help << yellow("    https://github.com/boot2docker/osx-installer/releases")
+        else
+          help << red("Docker is not available.")
+        end
+      elsif !ok? && !b2d_init_ok?
+        help << red("boot2docker is installed but couldn't be initialized.")
+        help << ""
+        help << yellow("    Please check why '") + white("boot2docker init") + yellow("' fails.")
+      elsif !ok? && !b2d_start_ok?
+        help << red("boot2docker is installed but couldn't be started.")
+        help << ""
+        help << yellow("    Please check why '") + white("boot2docker start") + yellow("' fails.")
+        help << yellow("    You might need to re-init with '") + white("boot2docker delete") + yellow("'.")
+      elsif !ok? && b2d_start_ok?
+        help << red("boot2docker is installed and started, but 'docker version' failed.")
+        help << ""
+        help << yellow("    Please check why '") + white("docker version") + yellow("' fails.")
+        help << yellow("    You might need to re-init with '") + white("boot2docker delete") + yellow("'.")
+      end
+
+      help.join("\n")
+    end
+
+    def print_help_text
+      io.puts(help_text)
+    end
+  end
+end

data/lib/rake_compiler_dock/starter.rb

@@ -0,0 +1,121 @@
+require "shellwords"
+require "rake_compiler_dock/version"
+
+module RakeCompilerDock
+  class DockerIsNotAvailable < RuntimeError
+  end
+
+  class Starter
+    class << self
+      def sh(cmd, options={}, &block)
+        if verbose_flag(options)
+          $stderr.puts "rake-compiler-dock bash -c #{ cmd.inspect }"
+        end
+        exec('bash', '-c', cmd, options, &block)
+      end
+
+      def image_name
+        ENV['RAKE_COMPILER_DOCK_IMAGE'] || "larskanis/rake-compiler-dock:#{VERSION}"
+      end
+
+      def exec(*args)
+        options = (Hash === args.last) ? args.pop : {}
+        runargs = args.dup
+
+        check_docker if options.fetch(:check_docker){ true }
+        runargs.unshift("sigfw") if options.fetch(:sigfw){ true }
+        runargs.unshift("runas") if options.fetch(:runas){ true }
+        docker_opts = options.fetch(:options) do
+          opts = ["--rm", "-i"]
+          opts << "-t" if $stdin.tty?
+          opts
+        end
+
+        case RUBY_PLATFORM
+        when /mingw|mswin/
+          # Change Path from "C:\Path" to "/c/Path" as used by boot2docker
+          pwd = Dir.pwd.gsub(/^([a-z]):/i){ "/#{$1.downcase}" }
+          # Virtualbox shared folders don't care about file permissions, so we use generic ids.
+          uid = 1000
+          gid = 1000
+        when /darwin/
+          pwd = Dir.pwd
+          uid = 1000
+          gid = 1000
+        else
+          pwd = Dir.pwd
+          # Docker mounted volumes also share file uid/gid and permissions with the host.
+          # Therefore we use the same attributes inside and outside the container.
+          uid = Process.uid
+          gid = Process.gid
+        end
+        user = make_valid_name(`id -nu`.chomp)
+        group = make_valid_name(`id -ng`.chomp)
+
+        cmd = ["docker", "run",
+            "-v", "#{pwd}:#{make_valid_path(pwd)}",
+            "-e", "UID=#{uid}",
+            "-e", "GID=#{gid}",
+            "-e", "USER=#{user}",
+            "-e", "GROUP=#{group}",
+            "-e", "ftp_proxy=#{ENV['ftp_proxy']}",
+            "-e", "http_proxy=#{ENV['http_proxy']}",
+            "-e", "https_proxy=#{ENV['https_proxy']}",
+            "-w", make_valid_path(pwd),
+            *docker_opts,
+            image_name,
+            *runargs]
+
+        cmdline = Shellwords.join(cmd)
+        if verbose_flag(options) == true
+          $stderr.puts cmdline
+        end
+
+        ok = system(*cmd)
+        if block_given?
+          yield(ok, $?)
+        elsif !ok
+          fail "Command failed with status (#{$?.exitstatus}): " +
+          "[#{cmdline}]"
+        end
+      end
+
+      def verbose_flag(options)
+        verbose = options.fetch(:verbose) do
+          Object.const_defined?(:Rake) && Rake.const_defined?(:FileUtilsExt) ? Rake::FileUtilsExt.verbose_flag : false
+        end
+      end
+
+      def make_valid_name(name)
+        name = name.downcase
+        # Convert disallowed characters
+        name = name[0..0].gsub(/[^a-z_]/, "_") + name[1..-2].gsub(/[^a-z0-9_-]/, "_") + name[-1..-1].gsub(/[^a-z0-9_$-]/, "_")
+        # Limit to 32 characters
+        name.sub( /^(.{16}).{2,}(.{15})$/ ){ $1+"-"+$2 }
+      end
+
+      def make_valid_path(name)
+        # Convert problematic characters
+        name = name.gsub(/[ ]/i, "_")
+      end
+
+      @@docker_checked = nil
+
+      def check_docker
+        return if @@docker_checked
+
+        check = DockerCheck.new($stderr)
+        unless check.ok?
+          at_exit do
+            $stderr.puts
+            check.print_help_text
+          end
+          raise DockerIsNotAvailable, "Docker is not available"
+        end
+
+        @@docker_checked = check
+      end
+
+    end
+  end
+end

data/lib/rake_compiler_dock/version.rb

@@ -1,3 +1,3 @@
 module RakeCompilerDock
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/rake-compiler-dock.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
 Use rake-compiler-dock to enter an interactive shell session or add a task to your Rakefile to automate your cross build.}
   spec.homepage      = "https://github.com/larskanis/rake-compiler-dock"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/src/runas

@@ -1,13 +1,13 @@
 #!/bin/bash
 
-groupadd -g $GID $GROUP
+groupadd -g "$GID" "$GROUP"
 mkdir -p /tmp/home
-useradd -g $GID -u $UID -G rvm,sudo -p "" -b /tmp/home -m $USER
+useradd -g "$GID" -u "$UID" -G rvm,sudo -p "" -b /tmp/home -m "$USER"
 
 HOME=$(bash <<< "echo ~$USER")
-ln -s /usr/local/rake-compiler $HOME/.rake-compiler
+ln -s /usr/local/rake-compiler "$HOME"/.rake-compiler
 
-sudo -u $USER --set-home \
+sudo -u "$USER" --set-home \
     BASH_ENV=/etc/rubybashrc \
     RUBY_CC_VERSION=1.8.7:1.9.3:2.0.0:2.1.6:2.2.2 \
     -- "$@"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-compiler-dock
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Lars Kanis
@@ -29,7 +29,7 @@ cert_chain:
   1i6jssufMLmyDB9b1ss72d7xQQpCHH7oizgt84wKAcsV8b83kGbAhtoszY3TgGiJ
   rww=
   -----END CERTIFICATE-----
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,9 @@ files:
 - Rakefile
 - bin/rake-compiler-dock
 - lib/rake_compiler_dock.rb
+- lib/rake_compiler_dock/colors.rb
+- lib/rake_compiler_dock/docker_check.rb
+- lib/rake_compiler_dock/starter.rb
 - lib/rake_compiler_dock/version.rb
 - patches/ruby-1.8.7-p374/nop.patch
 - patches/ruby-1.9.3/no_sendfile.patch
@@ -101,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

metadata.gz.sig

@@ -1,2 +1,3 @@
-jB��ރ`���ƻ-���86ġPOu����p`P���w����}g�lWrԴK�e���URdtWV6�
-IV��OX�b��a1֏�x�1���:��#Kd����)+y^y�Y�bh�����V�d��EƜ�]��ah$DC?s0���-����=3��1�*�L�5�����ПH�:t��v��w��m�`�?Y��W�F-�M+^�Pn2��4��M)zǒ�W��r_�a2��T̀Ewc�����0�FC��L#�(���
+\
+P)m���%�����:�Y��U�����5���ɰ�o���I-Ȃ�is��	��B���xx��}n�����'��으�'�q���	-i�u��AB�;
ƆfLs�\���"��ތ$�;� M�U��17�pZ��Mx���b蹄�[��o�W�*�0	�;����� ak�L d�W<S;!.N(���
+h׀"�I�-�6
�z