headless 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dc1c06f85049924c12fc40b4558040fd514c01a
-  data.tar.gz: a5e904086bdccf72798574e2450ce76b64fda0a7
+  metadata.gz: d30b463017cd61d3b19e47c94a04e9aa4061acc7
+  data.tar.gz: d8b07cc50c12a80ad547a8214a530cffa55db8f0
 SHA512:
-  metadata.gz: d6ad825721817e789fde8d9786bac8fec26ef097e5fb4af74f8c685a9895dfa3b5850161f3bf8f809b5024a7827c08f35dfd131d843e2f0cc71b274b4197ddea
-  data.tar.gz: af0c4aea4a57b14f56868315a1874bf28a09e7ab8a4a91355d0b864e09e939794aa9eedcf9ced54692c79dc428ae5a30003ea43afaa097edaaf75b06ee85fd5f
+  metadata.gz: fadb8ac4e38bb5ce3dc9f2f8245d3a13055e5d384d8aafb6ef87aecfaed732505d0017054a0d7d84c58c9854456aa01015bd83e3fdfb0e047a0ef40217a13dab
+  data.tar.gz: 5574ded55ca457df6835da69994911da9be288fb1ab1f943e0ff3215d52d1618596876f042325b08c9e1ecc7d299de0f4542a001f654f1b81a1180cc86bfe098

data/CHANGELOG

@@ -1,3 +1,9 @@
+## 2.2.0 (2015-07-05)
+
+* Allow reuse of displays started by other user (from @marxarelli)
+* Add support for graphicsmagick instead of ImageMagick (from @BlakeMesdag)
+* Wait for Xvfb to finish when destroying it, to avoid creating zombie processes (from @samnissen)
+
 ## 2.1.0 (2015-05-10)
 
 * Allow path to video recorder binary to be customized (from @briandamaged)

data/README.md

@@ -83,8 +83,13 @@ Headless.new(display: 100, reuse: true, destroy_at_exit: false).start
 # reap_headless.rb 
 headless = Headless.new(display: 100, reuse: true)
 headless.destroy
+
+# kill_headless_without_waiting.rb 
+headless = Headless.new
+headless.destroy_without_sync
 ```
- 
+
+There's also a different approach that creates a new virtual display for every parallel test process - see [this implementation](https://gist.github.com/rosskevin/5937888) by @rosskevin.
 
 ## Cucumber with wkhtmltopdf
 

data/headless.gemspec

@@ -3,7 +3,7 @@ spec = Gem::Specification.new do |s|
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '2.1.0'
+  s.version = '2.2.0'
   s.summary = 'Ruby headless display interface'
 
   s.description = <<-EOF

data/lib/headless.rb

@@ -101,15 +101,24 @@ class Headless
   end
 
   # Switches back from the headless server and terminates the headless session
+  # while waiting for Xvfb process to terminate.
   def destroy
     stop
-    CliUtil.kill_process(pid_filename, preserve_pid_file: true)
+    CliUtil.kill_process(pid_filename, preserve_pid_file: true, wait: true)
   end
 
-  # Same as destroy, but waits for Xvfb process to terminate
+  # Deprecated.
+  # Same as destroy.
+  # Kept for backward compatibility in June 2015. 
   def destroy_sync
+    destroy
+  end
+
+  # Same as the old destroy function -- doesn't wait for Xvfb to die. 
+  # Can cause zombies: http://stackoverflow.com/a/31003621/1651458
+  def destroy_without_sync
     stop
-    CliUtil.kill_process(pid_filename, preserve_pid_file: true, wait: true)
+    CliUtil.kill_process(pid_filename, preserve_pid_file: true)
   end
 
   # Block syntax:
@@ -133,12 +142,16 @@ class Headless
 
   def take_screenshot(file_path, options={})
     using = options.fetch(:using, :imagemagick)
-    if using == :imagemagick
+    case using
+    when :imagemagick
       CliUtil.ensure_application_exists!('import', "imagemagick is not found on your system. Please install it using sudo apt-get install imagemagick")
       system "#{CliUtil.path_to('import')} -display localhost:#{display} -window root #{file_path}"
-    elsif using == :xwd
+    when :xwd
       CliUtil.ensure_application_exists!('xwd', "xwd is not found on your system. Please install it using sudo apt-get install X11-apps")
       system "#{CliUtil.path_to('xwd')} -display localhost:#{display} -silent -root -out #{file_path}"
+    when :graphicsmagick, :gm
+      CliUtil.ensure_application_exists!('gm', "graphicsmagick is not found on your system. Please install it.")
+      system "#{CliUtil.path_to('gm')} import -display localhost:#{display} -window root #{file_path}"
     else
       raise Headless::Exception.new('Unknown :using option value')
     end
@@ -154,12 +167,9 @@ private
   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
+
+      return true if xvfb_running? && can_reuse && (xvfb_mine? || !@autopick_display)
+      return true if !xvfb_running? && launch_xvfb
     end
     raise Headless::Exception.new("Could not find an available display")
   end
@@ -192,8 +202,12 @@ private
     end while !xvfb_running?
   end
 
+  def xvfb_mine?
+    CliUtil.process_mine?(read_xvfb_pid)
+  end
+
   def xvfb_running?
-    !!read_xvfb_pid
+    (pid = read_xvfb_pid) && CliUtil.process_running?(pid)
   end
 
   def pid_filename

data/lib/headless/cli_util.rb

@@ -14,20 +14,21 @@ class Headless
       `which #{app}`.strip
     end
 
-    def self.read_pid(pid_filename)
-      pid = (File.read(pid_filename) rescue "").strip.to_i
-      pid = nil if pid.zero?
+    def self.process_mine?(pid)
+      Process.kill(0, pid) && true
+    rescue Errno::EPERM, Errno::ESRCH
+      false
+    end
 
-      if pid
-        begin
-          Process.kill(0, pid)
-          pid
-        rescue Errno::ESRCH
-          nil
-        end
-      else
-        nil
-      end
+    def self.process_running?(pid)
+      Process.getpgid(pid) && true
+    rescue Errno::ESRCH
+      false
+    end
+
+    def self.read_pid(pid_filename)
+      pid = (File.read(pid_filename) rescue "").strip
+      pid.empty? ? nil : pid.to_i
     end
 
     def self.fork_process(command, pid_filename, log_filename='/dev/null')
@@ -43,7 +44,7 @@ class Headless
     end
 
     def self.kill_process(pid_filename, options={})
-      if pid = self.read_pid(pid_filename)
+      if pid = read_pid(pid_filename)
         begin
           Process.kill 'TERM', pid
           Process.wait pid if options[:wait]

data/spec/headless_spec.rb

@@ -38,9 +38,12 @@ describe Headless do
         end
       end
 
-      context "when Xvfb is already running" do
+      context "when Xvfb is already running and was started by this user" do
         before do
           allow(Headless::CliUtil).to receive(:read_pid).with('/tmp/.X99-lock').and_return(31337)
+          allow(Headless::CliUtil).to receive(:process_running?).with(31337).and_return(true)
+          allow(Headless::CliUtil).to receive(:process_mine?).with(31337).and_return(true)
+
           allow(Headless::CliUtil).to receive(:read_pid).with('/tmp/.X100-lock').and_return(nil)
         end
 
@@ -79,15 +82,18 @@ describe Headless do
 
       context 'when Xvfb is started, but by another user' do
         before do
-          allow(Headless::CliUtil).to receive(:read_pid).with('/tmp/.X99-lock') { raise Errno::EPERM }
+          allow(Headless::CliUtil).to receive(:read_pid).with('/tmp/.X99-lock').and_return(31337)
+          allow(Headless::CliUtil).to receive(:process_running?).with(31337).and_return(true)
+          allow(Headless::CliUtil).to receive(:process_mine?).with(31337).and_return(false)
+
           allow(Headless::CliUtil).to receive(:read_pid).with('/tmp/.X100-lock').and_return(nil)
         end
 
         context "and display autopicking is not allowed" do
           let(:options) { {:autopick => false} }
 
-          it "should fail with and exception" do
-            expect { Headless.new(options) }.to raise_error(Headless::Exception)
+          it "should reuse the display" do
+            expect(Headless.new(options).display).to eq 99
           end
         end
 
@@ -176,6 +182,18 @@ describe Headless do
         expect { headless.take_screenshot('a.png', :using => :xwd) }.to raise_error(Headless::Exception)
       end
 
+      it "raises an error if gm is not installed with using: :graphicsmagick" do
+        allow(Headless::CliUtil).to receive(:application_exists?).with('gm').and_return(false)
+
+        expect { headless.take_screenshot('a.png', :using => :graphicsmagick) }.to raise_error(Headless::Exception)
+      end
+
+      it "raises an error if gm is not installed with using: :gm" do
+        allow(Headless::CliUtil).to receive(:application_exists?).with('gm').and_return(false)
+
+        expect { headless.take_screenshot('a.png', :using => :gm) }.to raise_error(Headless::Exception)
+      end
+
       it "issues command to take screenshot, with default options" do
         allow(Headless::CliUtil).to receive(:path_to).with('import').and_return('path/import')
         expect(headless).to receive(:system).with("path/import -display localhost:99 -window root /tmp/image.png")
@@ -193,6 +211,18 @@ describe Headless do
         expect(headless).to receive(:system).with("path/xwd -display localhost:99 -silent -root -out /tmp/image.png")
         headless.take_screenshot("/tmp/image.png", :using => :xwd)
       end
+
+      it "issues command to take screenshot, with using: :graphicsmagick" do
+        allow(Headless::CliUtil).to receive(:path_to).with('gm').and_return('path/gm')
+        expect(headless).to receive(:system).with("path/gm import -display localhost:99 -window root /tmp/image.png")
+        headless.take_screenshot("/tmp/image.png", :using => :graphicsmagick)
+      end
+
+      it "issues command to take screenshot, with using: :gm" do
+        allow(Headless::CliUtil).to receive(:path_to).with('gm').and_return('path/gm')
+        expect(headless).to receive(:system).with("path/gm import -display localhost:99 -window root /tmp/image.png")
+        headless.take_screenshot("/tmp/image.png", :using => :gm)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,4 +98,3 @@ signing_key:
 specification_version: 4
 summary: Ruby headless display interface
 test_files: []
-has_rdoc: