buildbox 0.2.3 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29832c2693fb640f1003b5a010eeb170a792f9c2
-  data.tar.gz: dd13bc62a427512418a1bdaa7dabce4098c009dd
+  metadata.gz: 943e5240e1dc1d41d6086cdf88dadc990477f165
+  data.tar.gz: 7f03003bb7c71db8971a5c313325fc5461cca2dc
 SHA512:
-  metadata.gz: bc853759496d74190b5b5edf806325693bace3870809c3e78ef868a2e8bc45f33cadb3f3feab5268ec54f0d76ccbf600d682fea035fa863284b253ee1c6f1ded
-  data.tar.gz: 2d728c74a1571837bd7d3c93f85b49574bc65fb393435c8b61b69f2987012c13129de744df72415cf201e5d3520527b4eb1eeb223956305401dd3cb5ff0cbbe0
+  metadata.gz: 581a02441d7887327dd69584eb0c476b90dfcd01899e81f3da7bafe03b7d505ffbf4e3af385154d17394fe0db255eed477d098f41fe7ff3ae18ce502252fafce
+  data.tar.gz: c9fec973a2d1814c2342a719d14861cb0478ecdcabf7723c5e3085144430e1fea8fc35e42082b40071a723beadaaedc3413e28b297902920cc30bb4977621b1d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    buildbox (0.2.3)
+    buildbox (0.3)
       celluloid (~> 0.14)
       childprocess (~> 0.3)
       faraday (~> 0.8)

data/bin/buildbox-pty

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+# Disable stdout,stderr buffering
+STDERR.sync = STDOUT.sync = true
+
 require 'pty'
 
 # spawn the process in a pseudo terminal so colors out outputted

data/lib/buildbox.rb

@@ -8,6 +8,7 @@ module Buildbox
   autoload :CLI,           "buildbox/cli"
   autoload :Configuration, "buildbox/configuration"
   autoload :Monitor,       "buildbox/monitor"
+  autoload :Platform,      "buildbox/platform"
   autoload :Runner,        "buildbox/runner"
   autoload :Script,        "buildbox/script"
   autoload :Server,        "buildbox/server"
@@ -23,6 +24,10 @@ module Buildbox
     @logger ||= Logger.new(STDOUT).tap { |logger| logger.level = Logger::INFO }
   end
 
+  def self.logger=(logger)
+    @logger = logger
+  end
+
   def self.gem_root
     path = File.expand_path(File.join(__FILE__, "..", ".."))
   end

data/lib/buildbox/command.rb

@@ -1,56 +1,146 @@
 require 'childprocess'
 require 'pty'
 
+# Inspiration from:
+# https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/subprocess.rb
+
 module Buildbox
   class Command
-    class Result < Struct.new(:output, :exit_status)
-    end
+    # The chunk size for reading from subprocess IO.
+    READ_CHUNK_SIZE = 4096
 
-    def self.command(command, options = {}, &block)
-      new(command, options).start(&block)
-    end
+    # An error which occurs when the process doesn't end within
+    # the given timeout.
+    class TimeoutExceeded < StandardError; end
+
+    attr_reader :output, :exit_status
 
-    def self.script(script, options = {}, &block)
-      new(script, options).start(&block)
+    def self.run(*args, &block)
+      options   = args.last.is_a?(Hash) ? args.pop : {}
+      arguments = args.dup
+
+      # Run the command
+      command = new(arguments, options, &block)
+      command.start(&block)
+      command
     end
 
     def initialize(arguments, options = {})
-      @arguments     = arguments
-      @environment   = options[:environment] || {}
-      @directory     = options[:directory] || "."
+      @arguments = arguments
+      @options   = options
+      @logger    = Buildbox.logger
     end
 
     def start(&block)
-      read_io, write_io = IO.pipe
+      # Get the timeout, if we have one
+      timeout = @options[:timeout]
+
+      # Build the command we're going to run
+      arguments = [ *runner, *@arguments ].compact.map(&:to_s) # all arguments must be a string
+
+      # Build the ChildProcess
+      @logger.info("Starting process: #{arguments}")
 
-      arguments         = [ *runner, *@arguments ].compact.map(&:to_s) # all arguments must be a string
-      process           = ChildProcess.build(*arguments)
-      process.cwd       = expanded_directory
-      process.io.stdout = process.io.stderr = write_io
+      process     = ChildProcess.build(*arguments)
+      process.cwd = File.expand_path(@options[:directory] || Dir.pwd)
 
-      @environment.each_pair do |key, value|
-        process.environment[key] = value
+      # Create the pipes so we can read the output in real tim
+      read_pipe, write_pipe = IO.pipe
+      process.io.stdout     = write_pipe
+      process.io.stderr     = write_pipe
+      process.duplex        = true
+
+      # Set the environment on the process
+      if @options[:environment]
+        @options[:environment].each_pair do |key, value|
+          process.environment[key] = value
+        end
       end
 
+      # Start the process
       process.start
-      write_io.close
 
+      # Make sure the stdin does not buffer
+      process.io.stdin.sync = true
+
+      if RUBY_PLATFORM != "java"
+        # On Java, we have to close after. See down the method...
+        # Otherwise, we close the writer right here, since we're
+        # not on the writing side.
+        write_pipe.close
+      end
+
+      # Record the start time for timeout purposes
+      start_time = Time.now.to_i
+
+      # Track the output as it goes
       output = ""
-      begin
-        loop do
-          chunk         = read_io.readpartial(10240)
-          cleaned_chunk = UTF8.clean(chunk)
 
-          output << chunk
-          yield cleaned_chunk if block_given?
+      @logger.debug("Selecting on IO")
+      while true
+        results = IO.select([read_pipe], nil, nil, timeout || 0.1) || []
+        readers = results[0]
+
+        # Check if we have exceeded our timeout
+        raise TimeoutExceeded if timeout && (Time.now.to_i - start_time) > timeout
+        # Kill the process and wait a bit for it to disappear
+        # Process.kill('KILL', process.pid)
+        # Process.waitpid2(process.pid)
+
+        # Check the readers to see if they're ready
+        if readers && !readers.empty?
+          readers.each do |r|
+            # Read from the IO object
+            data = read_io(r)
+
+            # We don't need to do anything if the data is empty
+            next if data.empty?
+
+            output << cleaned_data = UTF8.clean(data)
+            yield cleaned_data if block_given?
+          end
         end
-      rescue EOFError
+
+        # Break out if the process exited. We have to do this before
+        # attempting to write to stdin otherwise we'll get a broken pipe
+        # error.
+        break if process.exited?
+      end
+
+      # Wait for the process to end.
+      begin
+        remaining = (timeout || 32000) - (Time.now.to_i - start_time)
+        remaining = 0 if remaining < 0
+        @logger.debug("Waiting for process to exit. Remaining to timeout: #{remaining}")
+
+        process.poll_for_exit(remaining)
+      rescue ChildProcess::TimeoutError
+        raise TimeoutExceeded
+      end
+
+      @logger.debug("Exit status: #{process.exit_code}")
+
+      # Read the final output data, since it is possible we missed a small
+      # amount of text between the time we last read data and when the
+      # process exited.
+
+      # Read the extra data
+      extra_data = read_io(read_pipe)
+
+      # If there's some that we missed
+      if extra_data != ""
+        output << cleaned_data = UTF8.clean(extra_data)
+        yield cleaned_data if block_given?
       end
 
-      process.wait
+      if RUBY_PLATFORM == "java"
+        # On JRuby, we need to close the writers after the process,
+        # for some reason. See https://github.com/mitchellh/vagrant/pull/711
+        write_pipe.close
+      end
 
-      # the final result!
-      Result.new(output.chomp, process.exit_code)
+      @output      = output.chomp
+      @exit_status = process.exit_code
     end
 
     private
@@ -67,8 +157,63 @@ module Buildbox
       [ "bash", "-c" ]
     end
 
-    def expanded_directory
-      File.expand_path(@directory)
+    # Reads data from an IO object while it can, returning the data it reads.
+    # When it encounters a case when it can't read anymore, it returns the
+    # data.
+    #
+    # @return [String]
+    def read_io(io)
+      data = ""
+
+      while true
+        begin
+          if Platform.windows?
+            # Windows doesn't support non-blocking reads on
+            # file descriptors or pipes so we have to get
+            # a bit more creative.
+
+            # Check if data is actually ready on this IO device.
+            # We have to do this since `readpartial` will actually block
+            # until data is available, which can cause blocking forever
+            # in some cases.
+            results = IO.select([io], nil, nil, 0.1)
+            break if !results || results[0].empty?
+
+            # Read!
+            data << io.readpartial(READ_CHUNK_SIZE)
+          else
+            # Do a simple non-blocking read on the IO object
+            data << io.read_nonblock(READ_CHUNK_SIZE)
+          end
+        rescue Exception => e
+          # The catch-all rescue here is to support multiple Ruby versions,
+          # since we use some Ruby 1.9 specific exceptions.
+
+          breakable = false
+          if e.is_a?(EOFError)
+            # An `EOFError` means this IO object is done!
+            breakable = true
+          elsif defined?(IO::WaitReadable) && e.is_a?(IO::WaitReadable)
+            # IO::WaitReadable is only available on Ruby 1.9+
+
+            # An IO::WaitReadable means there may be more IO but this
+            # IO object is not ready to be read from yet. No problem,
+            # we read as much as we can, so we break.
+            breakable = true
+          elsif e.is_a?(Errno::EAGAIN)
+            # Otherwise, we just look for the EAGAIN error which should be
+            # all that IO::WaitReadable does in Ruby 1.9.
+            breakable = true
+          end
+
+          # Break out if we're supposed to. Otherwise re-raise the error
+          # because it is a real problem.
+          break if breakable
+          raise
+        end
+      end
+
+      data
     end
   end
 end

data/lib/buildbox/platform.rb

@@ -0,0 +1,23 @@
+module Buildbox
+  class Platform
+    class << self
+      [:cygwin, :darwin, :bsd, :freebsd, :linux, :solaris].each do |type|
+        define_method("#{type}?") do
+          platform.include?(type.to_s)
+        end
+      end
+
+      def windows?
+        %W[mingw mswin].each do |text|
+          return true if platform.include?(text)
+        end
+
+        false
+      end
+
+      def platform
+        RbConfig::CONFIG["host_os"].downcase
+      end
+    end
+  end
+end

data/lib/buildbox/runner.rb

@@ -23,8 +23,8 @@ module Buildbox
       info "Running script: #{script_path}"
 
       build.output = ""
-      result = Command.script(script_path, :environment => @build.env,
-                                           :directory   => directory_path) do |chunk|
+      result = Command.run(script_path, :environment => @build.env,
+                                        :directory   => directory_path) do |chunk|
         build.output << chunk
       end
 

data/lib/buildbox/version.rb

@@ -1,3 +1,3 @@
 module Buildbox
-  VERSION = "0.2.3"
+  VERSION = "0.3"
 end

data/spec/buildbox/buildbox/command_spec.rb

@@ -5,34 +5,34 @@ require "spec_helper"
 describe Buildbox::Command do
   describe "#run" do
     it "is run within a tty" do
-      result = Buildbox::Command.command(%{ruby -e "puts STDOUT.tty?"})
+      result = Buildbox::Command.run(%{ruby -e "puts STDOUT.tty?"})
 
       result.output.should == "true"
     end
 
     it "successfully runs and returns the output from a simple comment" do
-      result = Buildbox::Command.command('echo hello world')
+      result = Buildbox::Command.run('echo hello world')
 
       result.exit_status.should == 0
       result.output.should == "hello world"
     end
 
     it "redirects stdout to stderr" do
-      result = Buildbox::Command.command('echo hello world 1>&2')
+      result = Buildbox::Command.run('echo hello world 1>&2')
 
       result.exit_status.should == 0
       result.output.should == "hello world"
     end
 
     it "handles commands that fail and returns the correct status" do
-      result = Buildbox::Command.command('(exit 1)')
+      result = Buildbox::Command.run('(exit 1)')
 
       result.exit_status.should_not == 0
       result.output.should == ''
     end
 
     it "handles running malformed commands" do
-      result = Buildbox::Command.command('if (')
+      result = Buildbox::Command.run('if (')
 
       result.exit_status.should_not == 0
       # bash 3.2.48 prints "syntax error" in lowercase.
@@ -45,7 +45,7 @@ describe Buildbox::Command do
 
     it "can collect output in chunks" do
       chunked_output = ''
-      result = Buildbox::Command.command('echo hello world') do |chunk|
+      result = Buildbox::Command.run('echo hello world') do |chunk|
         unless chunk.nil?
           chunked_output += chunk
         end
@@ -60,8 +60,8 @@ describe Buildbox::Command do
       result = nil
       second_result = nil
       thread = Thread.new do
-        result = Buildbox::Command.command('sillycommandlololol')
-        second_result = Buildbox::Command.command('export FOO=bar; doesntexist.rb')
+        result = Buildbox::Command.run('sillycommandlololol')
+        second_result = Buildbox::Command.run('export FOO=bar; doesntexist.rb')
       end
       thread.join
 
@@ -76,7 +76,7 @@ describe Buildbox::Command do
 
     it "captures color'd output from a command" do
       chunked_output = ''
-      result = Buildbox::Command.command("rspec #{FIXTURES_PATH.join('rspec', 'test_spec.rb')}") do |chunk|
+      result = Buildbox::Command.run("rspec #{FIXTURES_PATH.join('rspec', 'test_spec.rb')}") do |chunk|
         chunked_output += chunk unless chunk.nil?
       end
 
@@ -87,7 +87,7 @@ describe Buildbox::Command do
 
     it "runs scripts in a tty" do
       chunked_output = ''
-      result = Buildbox::Command.script(FIXTURES_PATH.join('tty_script')) do |chunk|
+      result = Buildbox::Command.run(FIXTURES_PATH.join('tty_script')) do |chunk|
         chunked_output += chunk unless chunk.nil?
       end
 
@@ -97,19 +97,29 @@ describe Buildbox::Command do
 
     it "still runs even if pty isn't available" do
       PTY.should_receive(:spawn).and_raise(RuntimeError.new)
-      result = Buildbox::Command.command('echo hello world')
+      result = Buildbox::Command.run('echo hello world')
 
       result.exit_status.should == 0
       result.output.should == "hello world"
     end
 
     it "supports utf8 characters" do
-      result = Buildbox::Command.command('echo "hello"; echo "\xE2\x98\xA0"')
+      result = Buildbox::Command.run('bash', '-c', 'echo "hello"; echo "\xE2\x98\xA0"')
 
       result.exit_status.should == 0
       # just trying to interact with the string that has utf8 in it to make sure that it
       # doesn't blow up like it doesn on osx. this is hacky - need a better test.
       added = result.output + "hello"
     end
+
+    it "can collect chunks from within a thread" do
+      chunks = []
+
+      result = Buildbox::Command.run(FIXTURES_PATH.join('sleep_script')) do |chunk|
+        chunks << chunk
+      end
+
+      chunks.should == ["0\r\n", "1\r\n", "2\r\n"]
+    end
   end
 end

data/spec/fixtures/sleep_script

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+3.times do |i|
+  puts i
+  sleep 1
+end

data/spec/support/silence_logger.rb

@@ -8,5 +8,6 @@ RSpec.configure do |config|
     logger = Logger.new(StringIO.new)
 
     Celluloid.logger = logger
+    Buildbox.logger = logger
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildbox
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.3'
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -121,6 +121,7 @@ files:
 - lib/buildbox/command.rb
 - lib/buildbox/configuration.rb
 - lib/buildbox/monitor.rb
+- lib/buildbox/platform.rb
 - lib/buildbox/runner.rb
 - lib/buildbox/server.rb
 - lib/buildbox/utf8.rb
@@ -157,6 +158,7 @@ files:
 - spec/fixtures/repo.git/objects/e9/8d8a9be514ef53609a52c9e1b820dbcc8e6603
 - spec/fixtures/repo.git/refs/heads/master
 - spec/fixtures/rspec/test_spec.rb
+- spec/fixtures/sleep_script
 - spec/fixtures/tty_script
 - spec/integration/running_a_build_spec.rb
 - spec/spec_helper.rb
@@ -219,6 +221,7 @@ test_files:
 - spec/fixtures/repo.git/objects/e9/8d8a9be514ef53609a52c9e1b820dbcc8e6603
 - spec/fixtures/repo.git/refs/heads/master
 - spec/fixtures/rspec/test_spec.rb
+- spec/fixtures/sleep_script
 - spec/fixtures/tty_script
 - spec/integration/running_a_build_spec.rb
 - spec/spec_helper.rb