kopflos 0.0.2

data/README.rdoc

@@ -0,0 +1,52 @@
+= Kopflos
+
+Yo dog, I heard you like testing in real browsers, so I put some virtual
+framebuffer onto your system so you can test while you have no actual display.
+
+== Installation
+
+* Add 'kopflos' to your gemfile. 
+* Install xvfb. 
+* run your cucumber / steak / etc stories as before
+* observe: no browser window popping up
+
+Do not know how to support Mac yet. But which ruby developer uses a macintosh anyway?
+
+=== Cucumber
+
+In your env.rb:
+
+    require 'kopflos/cucumber'
+
+=== RSpec
+
+In your spec_helper.rb or rails_helper.rb
+
+    require 'kopflos/rspec'
+
+== Future / TODO
+
+* Screenshot support -- already build in, may get more sophisticated later (TM).
+* disable kopflos temporarily -- to look at your browser from time to time
+
+== Contributing to kopflos
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Gotchas
+
+=== Lockfiles
+
+Xvfb may leave lockfiles behind (/tmp/.X999-lock). If they run out, Xvfb cannot be started and Selenium may fail with EOFError.
+
+== Copyright
+
+Copyright (c) 2011 Niklas Hofer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/kopflos.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+# stub: kopflos  ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "kopflos"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Niklas Hofer"]
+  s.date = "2016-08-16"
+  s.description = "Starts a virtual framebuffer XServer (Xvfb) and redirects all X clients there"
+  s.email = "niklas+dev@lanpartei.de"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "kopflos.gemspec",
+    "lib/kopflos.rb",
+    "lib/kopflos/cucumber.rb",
+    "lib/kopflos/rspec.rb",
+    "lib/kopflos/xvfb.rb",
+    "spec/kopflos/xvfb_spec.rb",
+    "spec/kopflos_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/niklas/kopflos"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "hides all your spawning X applications"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+  end
+end
+

data/lib/kopflos.rb

@@ -0,0 +1,63 @@
+require 'kopflos/xvfb'
+
+module Kopflos
+  class AlreadyRunning < Exception; end
+
+  EnvVar = 'KOPFLOS'
+
+  def self.start(opts={})
+    if disabled_by_env_variable?
+      log "disabled through environment variable #{EnvVar} (set to anything else than 'false' or '0')"
+      return
+    end
+    if disabled_by_switch_file?
+      log "disabled through switch file #{switch_file_path} (unlink to hide the frakkin browser windows again)"
+      return
+    end
+    if running?
+      unless opts[:reuse]
+        raise AlreadyRunning, "there is already a server running: #{@server}"
+      end
+    else
+      @server = Xvfb.new(opts)
+      @server.start
+      @server
+    end
+  rescue Xvfb::NotSupported => e
+    log "your platform is not supported (yet): #{RUBY_PLATFORM}"
+  end
+
+  def self.stop
+    if running?
+      @server.stop
+      @server = nil
+    end
+  end
+
+  def self.running?
+    @server && @server.running?
+  end
+
+  def self.reset!
+    stop
+    @server = nil
+  end
+
+  def self.disabled_by_env_variable?
+    %w(false disabled 0 disable no).include?(ENV[EnvVar].to_s)
+  end
+
+  def self.disabled_by_switch_file?
+    File.exists?( switch_file_path )
+  end
+
+  def self.switch_file_path
+    'kopflos_disabled'
+  end
+
+  def self.log(message)
+    if ENV['LOG']
+      STDERR.puts "#{self}: #{message}"
+    end
+  end
+end

data/lib/kopflos/cucumber.rb

@@ -0,0 +1,16 @@
+require 'kopflos'
+
+$kopflos_exit_code = 0
+
+Before '@javascript' do |scenario|
+  Kopflos.start :reuse => true
+end
+
+After do |scenario|
+  $kopflos_exit_code = 1 if scenario.failed?
+end
+
+at_exit do
+  Kopflos.stop
+  exit($kopflos_exit_code)
+end

data/lib/kopflos/rspec.rb

@@ -0,0 +1,10 @@
+require 'kopflos'
+
+RSpec.configure do |config|
+  config.before(:each, :js) do
+    Kopflos.start :reuse => true
+  end
+  config.after(:suite) do
+    Kopflos.stop
+  end
+end

data/lib/kopflos/xvfb.rb

@@ -0,0 +1,207 @@
+require 'tempfile'
+require 'open4'
+
+# heavily inspired by selenium-client
+#   https://github.com/jodell/selenium-client/blob/da0f3dfbc05a6377c0cada09a3d650daf1261415/lib/xvfb/xvfb.rb
+module Kopflos
+  class Xvfb
+    class Error < ::Exception; end
+
+    class NotInstalled < Error
+      def message
+        msg = <<-MSG
+          Could not find Xvfb in PATH.
+          Try installing xvfb via `sudo apt-get install xvfb`.
+          PATH: #{ENV['PATH']}
+        MSG
+      end
+    end
+
+    class NotSupported < Error; end
+
+    attr_accessor :font_path, :resolution, :screen, :wait
+
+    def initialize(options = {})
+      @font_path  = options[:font_path]      || self.class.determine_font_path
+      @resolution = options[:resolution]     || '1024x768x24'
+      @screen     = options[:screen]         || '1'
+      @wait       = options[:wait]           || 5
+      @manager    = options[:manager] || options[:wm]
+      raise NotSupported unless self.class.supported?
+    end
+
+    def self.start(options={})
+      xvfb = new(options)
+      xvfb.start
+      xvfb
+    end
+
+    def self.supported?
+      RUBY_PLATFORM =~ /linux/
+    end
+
+    def start
+      authorize
+      @server = start_server_in_subprocess
+      log "started => #{@server.pid}"
+      sleep @wait # FIXME is there a generic way to find out if Xvfb has started?
+      @window_manager = start_window_manager
+      log "finished"
+    end
+
+    def running?
+      !!@server && !!@server.status
+    end
+
+    def stop
+      kill_window_manager
+      kill_server
+      Process.wait
+    rescue Errno::ENOENT => e
+    rescue Errno::ECHILD => e
+    rescue Errno::EPIPE => e
+    ensure
+      if @servernum
+        File.unlink( lockfile ) if File.exist?(lockfile)
+      end
+      load_env @origin_env
+      @server = nil
+    end
+
+    def screenshot(filename='screenshot.png')
+      system 'import', '-window', 'root', filename
+    end
+
+    def command
+      [
+        executable,
+        ":#{servernum}",
+        '-br', # black background
+        "-fp", @font_path,
+        '-screen', @screen,
+        @resolution,
+      ]
+    end
+
+    def authorize
+      @origin_env = current_env
+      ENV['XAUTHORITY'] = authfile.path
+      ENV['DISPLAY'] = ":#{servernum}.#{@screen}"
+      IO.popen('xauth source -', 'w') do |xauth|
+        xauth.puts %Q~add :#{servernum} . #{mcookie}~
+      end
+    end
+
+    def to_s
+      "<#{self.class} :#{servernum}.#{@screen}>"
+    end
+
+
+    protected
+
+      def executable
+        return @executable if defined?(@executable)
+        @executable = `which Xvfb`.chomp
+        if @executable.empty?
+          raise NotInstalled
+        end
+        @executable
+      end
+
+      def self.determine_font_path
+        if RUBY_PLATFORM =~ /linux/
+          case `cat /etc/issue`
+          when /Debian|Ubuntu/
+            return '/usr/share/fonts/X11/misc'
+          else
+            return ENV['XVFB_FONT_PATH'] if ENV['XVFB_FONT_PATH']
+          end
+        end
+        raise NotSupported, "#{RUBY_PLATFORM} not supported by default, Export $XVFB_FONT_PATH with a path to your X11 fonts/misc directory"
+      end
+
+      def authfile
+        @authfile ||= Tempfile.new('kopflos_Xauthority')
+      end
+
+      def mcookie
+        @mcookie ||= `mcookie`.chomp
+      end
+
+
+      # Find a free server number by looking at .X*-lock files in /tmp.
+      def find_free_servernum
+        servernum  = 99
+        while File.exists?( lockfile( servernum ) )
+          servernum += 1
+        end
+        servernum
+      end
+
+      def servernum
+        @servernum ||= find_free_servernum
+      end
+
+      def start_window_manager
+        return unless @manager
+        Open4::background @manager
+      rescue Errno::ECHILD => e
+        log "could not start window manager: #{e}"
+      end
+
+      def log(message)
+        message = "#{self} #{message}"
+        if defined?(Rails)
+          Rails.logger.info(message)
+        else
+          STDERR.puts message
+        end
+      end
+
+      def lockfile(num=servernum)
+        "/tmp/.X#{num}-lock"
+      end
+
+      def start_server_in_subprocess
+        empty = ''
+        log "starting: #{command.join(' ')}"
+        Open4::background(command, 0 => empty, 1 => empty, 2 => empty, 'ignore_exit_failure' => true)
+      rescue Errno::ECHILD => e
+        log "could not start server: #{e}"
+      end
+
+      def kill_server
+        if @server
+          # first, kill the X server
+          Process.kill("USR1", @server.pid)
+          # then wait for the thread to finish
+          @server.join
+        else
+          log "no server found to kill"
+        end
+      end
+
+      def kill_window_manager
+        if @window_manager && @window_manager.respond_to?(:pid)
+          # first, kill the external process
+          Process.kill("USR1", @window_manager.pid)
+          # then wait for the thread to finish
+          @window_manager.join
+        else
+          log "no server found to kill"
+        end
+      end
+
+      def current_env
+        { :display => ENV['DISPLAY'], :xauthority => ENV['XAUTHORITY'] }
+      end
+
+      def load_env(env)
+        if env && env.respond_to?(:[])
+          ENV['DISPLAY'], ENV['XAUTHORITY'] = env[:display], env[:xauthority]
+        end
+      end
+
+  end
+
+end

data/spec/kopflos/xvfb_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Kopflos
+  describe Xvfb do
+    it "should be a class" do
+      Xvfb.should be_a(Class)
+    end
+
+    it "should determine font path on initialization" do
+      Xvfb.should_receive(:determine_font_path)
+      Xvfb.new :wait => 1
+    end
+
+
+    describe 'new' do
+      before :each do
+        process = mock("process running in background", :pid => 0, :status => 'sleep')
+        Xvfb.stub!(:determine_font_path).and_return('/usr/share/fonts/X11/misc')
+        @xvfb = Xvfb.new
+        Open4.stub!(:background).and_return( process )
+        @xvfb.stub!(:kill_server).and_return(true)
+      end
+
+      after :each do
+        @xvfb.stop
+      end
+
+      it "should set font path" do
+        @xvfb.font_path.should == '/usr/share/fonts/X11/misc'
+      end
+
+      it "should have default resolution" do
+        @xvfb.resolution.should == '1024x768x24'
+      end
+
+      it "should have default screen" do
+        @xvfb.screen.should == '1'
+      end
+
+      it "should have a default wait time of 5s" do
+        @xvfb.wait.should == 5
+      end
+
+      it "should authorize itself on startup" do
+        @xvfb.should_receive(:authorize).and_return(true)
+        @xvfb.start
+      end
+
+      it "should reflect its status" do
+        @xvfb.start
+        @xvfb.should be_running
+        @xvfb.stop
+        @xvfb.should_not be_running
+      end
+
+      it "should set DISPLAY and XAUTHORITY env vars" do
+        display, xauthority = ENV['DISPLAY'], ENV['XAUTHORITY']
+        @xvfb.authorize
+
+        ENV['DISPLAY'].should_not be_nil
+        ENV['DISPLAY'].should_not be_empty
+        ENV['DISPLAY'].should_not == display
+        ENV['XAUTHORITY'].should_not be_nil
+        ENV['XAUTHORITY'].should_not be_empty
+        ENV['XAUTHORITY'].should_not == xauthority
+      end
+
+      describe "in forked process" do
+        before :each do
+          @xvfb.stub!(:authorize).and_return(true)
+          @xvfb.stub!(:execute).and_return(true) # not really, should NOT return, it calles Kernel#exec
+        end
+        it "should start window manager" do
+          @xvfb.should_receive(:start_window_manager).and_return(true)
+          @xvfb.start
+        end
+      end
+    end
+
+  end
+end