headless 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93e191ea69ebabc46da9431bff74b33ccbf646c9
-  data.tar.gz: 68b29362c47b8e776153638f187c62f467fdd422
+  metadata.gz: 64adcb425e2e63bfed70d55fc99365e60c87887d
+  data.tar.gz: e3eeace8449b30b55cfee239b666bef2dedbd96d
 SHA512:
-  metadata.gz: 757f8e09da108796a51bc6b823fe8b4ab67e8d4f900ff11dcdccbfe1434a0ca5bb5cda1a28c4cdc98a49664081512fbe5c57ca54ddc21e0a797b53b1b30eca40
-  data.tar.gz: cde1f7f928582f1f6c6f90a0b06a5c1389b2ca66f682ad78a141294bfbfa4df9666ee87c2df2be1283c9fdeb3d8a3fe2f0e7a6dceadb9638b206df5198c60b12
+  metadata.gz: 66c57e7f5ce63679504a43cfa9018e956a609cf1d1e6298285bfa1626397fa293779f95070d7267fb3f41418a3c9ef3b1919cd1d78a7e7fa6bfdc93beebc36b2
+  data.tar.gz: 9d86ad8c3bd3ccf27b914943ab6ffac5fc942c13fdb458cef3e9b2728c743826390fac433b882609cd98cb8800ec1e1b67237bf2ce98128992b8d27861f2f3e2

data/.travis.yml

@@ -1,10 +1,15 @@
+sudo: required
+dist: trusty
 language: ruby
+cache: bundler
 rvm:
   - 1.9.3
-  - 2.0
-  - 2.2
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 before_install:
   - "sudo apt-get update"
   - "sudo apt-get install -y firefox xvfb libav-tools"
   - "gem install bundler"
-script: "rspec"
+script: "bundle exec rspec"

data/CHANGELOG

@@ -1,3 +1,9 @@
+## 2.3.0 (2016-08-24)
+
+* Remove dependency on the `which` command (from @skateman)
+* Add `devices` options to video recorder (from @atzorvas)
+* By default, do not destroy Headless started by a different process (from @marxarelli)
+
 ## 2.2.3 (2016-03-17)
 
 * Fix race condition when starting Xvfb [#75] (from @NfNitLoop)

data/headless.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.email = 'leonid@shevtsov.me'
 
   s.name = 'headless'
-  s.version = '2.2.3'
+  s.version = '2.3.0'
   s.summary = 'Ruby headless display interface'
   s.license = 'MIT'
 

data/lib/headless.rb

@@ -63,16 +63,17 @@ class Headless
   # * +display+ (default 99) - what display number to listen to;
   # * +reuse+ (default true) - if given display server already exists,
   #   should we use it or try another?
-  # * +autopick+ (default true is display number isn't explicitly set) - if
+  # * +autopick+ (default true if display number isn't explicitly set) - if
   #   Headless should automatically pick a display, or fail if the given one is
   #   not available.
   # * +dimensions+ (default 1280x1024x24) - display dimensions and depth. Not
   #   all combinations are possible, refer to +man Xvfb+.
-  # * +destroy_at_exit+ (default true) - if a display is started but not
-  #   stopped, should it be destroyed when the script finishes?
+  # * +destroy_at_exit+  - if a display is started but not stopped, should it
+  #   be destroyed when the script finishes?
+  #   (default true unless reuse is true and a server is already running)
   # * +xvfb_launch_timeout+ - how long should we wait for Xvfb to open a
   #   display, before assuming that it is frozen (in seconds, default is 10)
-  # * +video+ - options to be passed to the ffmpeg video recorder
+  # * +video+ - options to be passed to the ffmpeg video recorder. See Headless::VideoRecorder#initialize for documentation
   def initialize(options = {})
     CliUtil.ensure_application_exists!('Xvfb', 'Xvfb not found on your system')
 
@@ -82,7 +83,10 @@ class Headless
     @reuse_display = options.fetch(:reuse, true)
     @dimensions = options.fetch(:dimensions, DEFAULT_DISPLAY_DIMENSIONS)
     @video_capture_options = options.fetch(:video, {})
-    @destroy_at_exit = options.fetch(:destroy_at_exit, true)
+
+    already_running = xvfb_running? rescue false
+    @destroy_at_exit = options.fetch(:destroy_at_exit, !(@reuse_display && already_running))
+
     @pid = nil # the pid of the running Xvfb process
 
     # FIXME Xvfb launch should not happen inside the constructor
@@ -110,18 +114,23 @@ class Headless
 
   # Deprecated.
   # Same as destroy.
-  # Kept for backward compatibility in June 2015. 
+  # 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. 
+  # 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)
   end
 
+  # Whether the headless display will be destroyed when the script finishes.
+  def destroy_at_exit?
+    @destroy_at_exit
+  end
+
   # Block syntax:
   #
   #   Headless.run do
@@ -238,7 +247,7 @@ private
       @at_exit_hook_installed = true
       at_exit do
         exit_status = $!.status if $!.is_a?(SystemExit)
-        destroy if @destroy_at_exit
+        destroy if destroy_at_exit?
         exit exit_status if exit_status
       end
     end

data/lib/headless/cli_util.rb

@@ -1,7 +1,9 @@
+require 'mkmf'
+
 class Headless
   class CliUtil
     def self.application_exists?(app)
-      `which #{app}`.strip != ""
+      !!path_to(app)
     end
 
     def self.ensure_application_exists!(app, error_message)
@@ -10,8 +12,16 @@ class Headless
       end
     end
 
+    # Credit: http://stackoverflow.com/a/5471032/6678
     def self.path_to(app)
-      `which #{app}`.strip
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{app}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        }
+      end
+      return nil
     end
 
     def self.process_mine?(pid)

data/lib/headless/video/video_recorder.rb

@@ -2,11 +2,22 @@ require 'tempfile'
 
 class Headless
   class VideoRecorder
-    attr_accessor :pid_file_path, :tmp_file_path, :log_file_path
-
-    # Allow end-users to override the path to the binary
-    attr_accessor :provider_binary_path
+    attr_accessor :pid_file_path, :tmp_file_path, :log_file_path, :provider_binary_path
 
+    # Construct a new Video Recorder instance. Typically done from inside Headless, but can be also created manually,
+    # and even used separately from Headless' Xvfb features.
+    # * display - display number to capture
+    # * dimensions - dimensions of the captured video
+    # * options - available options:
+    #   * provider - either :ffmpeg or :libav; default is :libav - switch if your system is provisioned with FFMpeg
+    #   * provider_binary_path - override path to ffmpeg / libav binary
+    #   * pid_file_path - override path to PID file, default is placed in /tmp
+    #   * tmp_file_path - override path to temp file, default is placed in /tmp
+    #   * log_file_path - set log file path, default is /dev/null
+    #   * codec - change ffmpeg codec, default is qtrle
+    #   * frame_rate - change frame rate, default is 30
+    #   * devices - array of device options - see https://www.ffmpeg.org/ffmpeg-devices.html
+    #   * extra - array of extra options to append to the FFMpeg command line
     def initialize(display, dimensions, options = {})
       @display = display
       @dimensions = dimensions[/.+(?=x)/]
@@ -23,6 +34,7 @@ class Headless
       @provider_binary_path = options.fetch(:provider_binary_path, guess_the_provider_binary_path)
 
       @extra = Array(options.fetch(:extra, []))
+      @devices = Array(options.fetch(:devices, []))
 
       CliUtil.ensure_application_exists!(provider_binary_path, "#{provider_binary_path} not found on your system. Install it or change video recorder provider")
     end
@@ -76,16 +88,19 @@ class Headless
         dimensions = @dimensions.match(/^(\d+x\d+)/)[0]
       end
 
-      ([
-        CliUtil.path_to(provider_binary_path),
-        "-y",
-        "-r #{@frame_rate}",
-        "-s #{dimensions}",
-        "-f x11grab",
-        "-i :#{@display}",
-        group_of_pic_size_option,
-        "-vcodec #{@codec}"
-      ].compact + @extra + [@tmp_file_path]).join(' ')
+      [
+         CliUtil.path_to(provider_binary_path),
+         "-y",
+         "-r #{@frame_rate}",
+         "-s #{dimensions}",
+         "-f x11grab",
+         @devices,
+         "-i :#{@display}",
+         group_of_pic_size_option,
+         "-vcodec #{@codec}",
+         @extra,
+         @tmp_file_path
+      ].flatten.compact.join(' ')
     end
   end
 end

data/spec/headless_spec.rb

@@ -53,6 +53,10 @@ describe Headless do
           it "should reuse the existing Xvfb" do
             expect(Headless.new(options).display).to eq 99
           end
+
+          it "should not be destroyed at exit by default" do
+            expect(Headless.new(options).destroy_at_exit?).to eq false
+          end
         end
 
         context "and display reuse is not allowed" do

data/spec/integration_spec.rb

@@ -16,9 +16,7 @@ describe 'Integration test' do
     expect(File.exist?("test.jpg")).to eq true
   end
 
-  # Unfortunately the libav version that ships with Ubuntu 12.04 has
-  # buggy X11 capture.
-  it 'should record video with ffmpeg', pending: ENV['TRAVIS'] do
+  it 'should record video with ffmpeg' do
     headless.video.start_capture
     work_with_browser
     headless.video.stop_and_save("test.mov")

data/spec/video_recorder_spec.rb

@@ -14,27 +14,27 @@ describe Headless::VideoRecorder do
       expect { Headless::VideoRecorder.new(99, "1024x768x32") }.to raise_error(Headless::Exception)
     end
 
-    it "allows provider_binary_path to be specified" do 
+    it "allows provider_binary_path to be specified" do
       Tempfile.open('some_provider') do |f|
         v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg, provider_binary_path: f.path)
         expect(v.provider_binary_path).to eq(f.path)
       end
     end
 
-    it "allows provider_binary_path to be specified" do 
+    it "allows provider_binary_path to be specified" do
       Tempfile.open('some_provider') do |f|
         v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg, provider_binary_path: f.path)
         expect(v.provider_binary_path).to eq(f.path)
       end
     end
 
-    context "provider_binary_path not specified" do 
-      it "assumes the provider binary is 'ffmpeg' if the provider is :ffmpeg" do 
+    context "provider_binary_path not specified" do
+      it "assumes the provider binary is 'ffmpeg' if the provider is :ffmpeg" do
         v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :ffmpeg)
         expect(v.provider_binary_path).to eq("ffmpeg")
       end
 
-      it "assumes the provider binary is 'avconv' if the provider is :libav" do 
+      it "assumes the provider binary is 'avconv' if the provider is :libav" do
         v = Headless::VideoRecorder.new(99, "1024x768x32", provider: :libav)
         expect(v.provider_binary_path).to eq("avconv")
       end
@@ -67,6 +67,13 @@ describe Headless::VideoRecorder do
       recorder = Headless::VideoRecorder.new(99, "1024x768x32", {:provider => :ffmpeg})
       recorder.start_capture
     end
+
+    it "starts ffmpeg with specified extra device options" do
+      expect(Headless::CliUtil).to receive(:fork_process).with(/^ffmpeg -y -r 30 -s 1024x768 -f x11grab -draw_mouse 0 -i :99 -g 600 -vcodec qtrle [^ ]+$/, "/tmp/.headless_ffmpeg_99.pid", '/dev/null')
+
+      recorder = Headless::VideoRecorder.new(99, "1024x768x32", {:devices => ["-draw_mouse 0"]})
+      recorder.start_capture
+    end
   end
 
   context "stopping video recording" do
@@ -100,7 +107,7 @@ describe Headless::VideoRecorder do
     end
   end
 
-private
+  private
 
   def stub_environment
     allow(Headless::CliUtil).to receive(:application_exists?).and_return(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headless
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Leonid Shevtsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -99,3 +99,4 @@ signing_key:
 specification_version: 4
 summary: Ruby headless display interface
 test_files: []
+has_rdoc: