headless 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+ Copyright (c) 2010 Leonid Shevtsov
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,62 @@
+# Headless
+
+Headless is a Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action.
+
+I created it so I can run Selenium tests in Cucumber without any shell scripting. Even more, you can go headless only when you run tests against Selenium.
+
+## Installation
+
+On Debian/Ubuntu:
+
+    sudo apt-get install xvfb
+    gem install headless
+
+## Usage
+
+Block mode:
+
+    require 'rubygems'
+    require 'headless'
+    require 'selenium-webdriver'
+
+    Headless.ly do
+      driver = Selenium::WebDriver.for :firefox
+      driver.navigate.to 'http://google.com'
+      puts driver.title 
+    end
+
+Object mode:
+
+    require 'rubygems'
+    require 'headless'
+    require 'selenium-webdriver'
+
+    headless = Headless.new
+    headless.start
+
+    driver = Selenium::WebDriver.for :firefox
+    driver.navigate.to 'http://google.com'
+    puts driver.title
+
+    headless.destroy
+
+## Cucumber
+
+Running cucumber headless is now as simple as adding a before and after hook in `features/support/env.rb`:
+
+
+    # change the condition to fit your setup
+    if Capybara.current_driver == :selenium
+      require 'headless'
+
+      headless = Headless.new
+      headless.start
+
+      at_exit do
+        headless.destroy
+      end
+    end
+
+---
+
+© 2010 Leonid Shevtsov, released under the MIT license

data/lib/headless.rb

@@ -0,0 +1,117 @@
+# A class incapsulating the creation and usage of a headless X server
+#
+# == Prerequisites
+#
+# * X Window System
+# * Xvfb[http://en.wikipedia.org/wiki/Xvfb]
+#
+# == Usage
+#
+# Block mode:
+#
+#   require 'rubygems'
+#   require 'headless'
+#   require 'selenium-webdriver'
+# 
+#   Headless.ly do
+#     driver = Selenium::WebDriver.for :firefox
+#     driver.navigate.to 'http://google.com'
+#     puts driver.title 
+#   end
+#
+# Object mode:
+#
+#   require 'rubygems'
+#   require 'headless'
+#   require 'selenium-webdriver'
+#
+#   headless = Headless.new
+#   headless.start
+#
+#   driver = Selenium::WebDriver.for :firefox
+#   driver.navigate.to 'http://google.com'
+#   puts driver.title 
+#
+#   headless.destroy
+#--
+# TODO test that reuse actually works with an existing xvfb session
+# TODO maybe write a command-line wrapper like
+#   headlessly firefox
+#++
+class Headless
+
+  class Exception < ::Exception
+  end
+
+  # The display number
+  attr_reader :display
+
+  # Creates a new headless server, but NOT switches to it immediately. Call #start for that
+  def initialize(options = {})
+    @xvfb = `which Xvfb`.strip
+    raise Exception.new('Xvfb not found on your system') if @xvfb == ''
+
+    # TODO more options, like display dimensions and depth; set up default dimensions and depth
+    @display = options.fetch(:display, 99).to_i
+    @reuse_display = options.fetch(:reuse, true)
+
+    #TODO more logic here, autopicking the display number
+    if @reuse_display
+      launch_xvfb unless read_pid
+    elsif read_pid
+      raise Exception.neW("Display :#{display} is already taken and reuse=false")
+    else
+      launch_xvfb
+    end
+
+    raise Exception.new("Xvfb did not launch - something's wrong") unless read_pid
+  end
+
+  # Switches to the headless server
+  def start
+    @old_display = ENV['DISPLAY']
+    ENV['DISPLAY'] = ":#{display}"
+  end
+
+  # Switches back from the headless server
+  def stop
+    ENV['DISPLAY'] = @old_display
+  end
+
+  # Switches back from the headless server and terminates the headless session
+  def destroy
+    stop
+    Process.kill('TERM', xvfb_pid) if read_pid
+  end
+
+  # Block syntax:
+  #
+  #   Headless.run do
+  #     # perform operations in headless mode
+  #   end
+  # 
+  # Alias: #ly (Headless.ly)
+  def self.run(options={}, &block)
+    headless = Headless.new(options)
+    headless.start
+    yield headless
+    headless.destroy
+  end
+
+  class <<self; alias_method :ly, :run; end
+
+private
+  attr_reader :xvfb_pid
+
+  def launch_xvfb
+    system "#{@xvfb} :#{display} -ac >/dev/null 2>&1 &"
+    sleep 1
+  end
+
+  def read_pid
+    @xvfb_pid=(File.read("/tmp/.X#{display}-lock") rescue "").strip.to_i
+    @xvfb_pid=nil if @xvfb_pid==0
+    @xvfb_pid
+    #TODO maybe check that the process still exists
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: headless
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leonid Shevtsov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-06 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+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.\n"
+email: leonid@shevtsov.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/headless.rb
+- README.md
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/leonid-shevtsov/headless
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- Xvfb
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby headless display interface
+test_files: []
+