headless 0.3.1 → 1.0.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+## 1.0.0 (2013-01-28)
+
+* bugfix release
+* version number compliant to the [semantic versioning system](http://semver.org)
+
 ## 0.3.1 (2012-03-29)
 
 * added autopicking of display number, if the requested one is already taken

data/README.md

@@ -10,6 +10,8 @@ Documentation is available at [rdoc.info](http://rdoc.info/projects/leonid-shevt
 
 [Changelog](https://github.com/leonid-shevtsov/headless/blob/master/CHANGELOG)
 
+**Note: Headless will NOT hide most applications on OS X. [Here is a detailed explanation](https://github.com/leonid-shevtsov/headless/issues/31#issuecomment-8933108)**
+
 ## Installation
 
 On Debian/Ubuntu:
@@ -59,6 +61,27 @@ Running cucumber headless is now as simple as adding a before and after hook in
       headless.start
     end
 
+## Running tests in parallel
+
+If you have multiple threads running acceptance tests in parallel, you want to spawn Headless before forking, and then reuse that instance with `destroy_at_exit: false`.
+You can even spawn a Headless instance in one ruby script, and then reuse the same instance in other scripts by specifying the same display number and `reuse: true`.
+
+    # spawn_headless.rb
+    Headless.new(display: 100, destroy_at_exit: false).start
+
+
+    # test_suite_that_could_be_ran_multiple_times.rb
+    headless = Headless.new(display: 100, reuse: true, destroy_at_exit: false)
+    # Xvfb is already started by the first script
+
+    # reap_headless.rb 
+    headless = Headless.new(display: 100, reuse: true)
+    headless.destroy
+
+
+
+    
+
 ## Cucumber with wkhtmltopdf
 
 _Note: this is true for other programs which may use headless at the same time as cucumber is running_

data/headless.gemspec

@@ -3,7 +3,7 @@ spec = Gem::Specification.new do |s|
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '0.3.1'
+  s.version = '1.0.0'
   s.summary = 'Ruby headless display interface'
 
   s.description = <<-EOF
@@ -14,5 +14,6 @@ spec = Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
 
+  s.add_development_dependency 'rake'
   s.add_development_dependency "rspec", "~> 2.6"
 end

data/lib/headless.rb

@@ -15,11 +15,11 @@ require 'headless/video/video_recorder'
 #   require 'rubygems'
 #   require 'headless'
 #   require 'selenium-webdriver'
-# 
+#
 #   Headless.ly do
 #     driver = Selenium::WebDriver.for :firefox
 #     driver.navigate.to 'http://google.com'
-#     puts driver.title 
+#     puts driver.title
 #   end
 #
 # Object mode:
@@ -33,7 +33,7 @@ require 'headless/video/video_recorder'
 #
 #   driver = Selenium::WebDriver.for :firefox
 #   driver.navigate.to 'http://google.com'
-#   puts driver.title 
+#   puts driver.title
 #
 #   headless.destroy
 #--
@@ -42,6 +42,7 @@ require 'headless/video/video_recorder'
 class Headless
 
   DEFAULT_DISPLAY_NUMBER = 99
+  MAX_DISPLAY_NUMBER = 10_000
   DEFAULT_DISPLAY_DIMENSIONS = '1280x1024x24'
 
   class Exception < RuntimeError
@@ -102,6 +103,7 @@ class Headless
     headless = Headless.new(options)
     headless.start
     yield headless
+  ensure
     headless.destroy
   end
   class <<self; alias_method :ly, :run; end
@@ -119,38 +121,28 @@ class Headless
 private
 
   def attach_xvfb
-    # TODO this loop isn't elegant enough
-    success = false
-    while !success && @display<10000
-      begin
-        if !xvfb_running?
-          launch_xvfb
-          success=true
-        else
-          success = @reuse_display
-        end
-      rescue Errno::EPERM
-        # No permission to read pid file
-        success = false
-      end
+    possible_display_set = @autopick_display ? @display..MAX_DISPLAY_NUMBER : Array(@display)
+    pick_available_display(possible_display_set, @reuse_display)
+  end
 
-      # TODO this is crufty
-      if @autopick_display
-        @display += 1 unless success
-      else
-        break
+  def pick_available_display(display_set, can_reuse)
+    display_set.each do |display_number|
+      @display = display_number
+      begin
+        return true if xvfb_running? && can_reuse
+        return true if !xvfb_running? && launch_xvfb
+      rescue Errno::EPERM # display not accessible
+        next
       end
     end
-
-    unless success
-      raise Headless::Exception.new("Display :#{display} is already taken and reuse=false")
-    end
+    raise Headless::Exception.new("Could not find an available display")
   end
 
   def launch_xvfb
     #TODO error reporting
     result = system "#{CliUtil.path_to("Xvfb")} :#{display} -screen 0 #{dimensions} -ac >/dev/null 2>&1 &"
     raise Headless::Exception.new("Xvfb did not launch - something's wrong") unless result
+    return true
   end
 
   def xvfb_running?
@@ -164,7 +156,7 @@ private
   def read_xvfb_pid
     CliUtil.read_pid(pid_filename)
   end
-    
+
   def hook_at_exit
     unless @at_exit_hook_installed
       @at_exit_hook_installed = true

data/lib/headless/cli_util.rb

@@ -3,7 +3,7 @@ class Headless
     def self.application_exists?(app)
       `which #{app}`.strip != ""
     end
-    
+
     def self.ensure_application_exists!(app, error_message)
       if !self.application_exists?(app)
         raise Headless::Exception.new(error_message)
@@ -36,7 +36,6 @@ class Headless
         exec command
         exit! 127 # safeguard in case exec fails
       end
-      Process.detach(pid)
 
       File.open pid_filename, 'w' do |f|
         f.puts pid

data/lib/headless/video/video_recorder.rb

@@ -14,6 +14,7 @@ class Headless
       @tmp_file_path = options.fetch(:tmp_file_path, "/tmp/.headless_ffmpeg_#{@display}.mov")
       @log_file_path = options.fetch(:log_file_path, "/dev/null")
       @codec = options.fetch(:codec, "qtrle")
+      @frame_rate = options.fetch(:frame_rate, 30)
     end
 
     def capture_running?
@@ -21,7 +22,7 @@ class Headless
     end
 
     def start_capture
-      CliUtil.fork_process("#{CliUtil.path_to('ffmpeg')} -y -r 30 -g 600 -s #{@dimensions} -f x11grab -i :#{@display} -vcodec #{@codec} #{@tmp_file_path}", @pid_file_path, @log_file_path)
+      CliUtil.fork_process("#{CliUtil.path_to('ffmpeg')} -y -r #{@frame_rate} -g 600 -s #{@dimensions} -f x11grab -i :#{@display} -vcodec #{@codec} #{@tmp_file_path}", @pid_file_path, @log_file_path)
       at_exit do
         exit_status = $!.status if $!.is_a?(SystemExit)
         stop_and_discard

data/spec/headless_spec.rb

@@ -44,10 +44,10 @@ describe Headless do
           Headless.new(options).display.should == 99
         end
       end
-      
+
       context "and display reuse is not allowed" do
         let(:options) { {:reuse => false} }
-        
+
         it "should pick the next available display number" do
           Headless.new(options).display.should == 100
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170211681540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +37,12 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70170211681540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: ! '    Headless is a Ruby interface for Xvfb. It allows you to create
   a headless display straight from Ruby code, hiding some low-level action.
 
@@ -56,16 +77,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2986386947499728446
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2986386947499728446
 requirements:
 - Xvfb
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby headless display interface