webkit_remote 0.3.2 → 0.4.0

data/lib/webkit_remote/process.rb

@@ -14,22 +14,46 @@ class Process
   #     the default port is 9292
   # @option opts [Number] timeout number of seconds to wait for the browser
   #     to start; the default timeout is 10 seconds
+  # @option opts [Hash<Symbol, Number>] window set the :left, :top, :width and
+  #     :height of the browser window; by default, the browser window is
+  #     256x256 starting at 0,0.
+  # @option opts [Hash<Symbol, Number>, Boolean] xvfb use Xvfb instead of a
+  #     real screen; set the :display, :width, :height, :depth and :dpi of the
+  #     server, or use the default display number 20, at 1280x1024x32 with
+  #     72dpi
   def initialize(opts = {})
     @port = opts[:port] || 9292
     @timeout = opts[:timeout] || 10
     @running = false
     @data_dir = Dir.mktmpdir 'webkit-remote'
     @pid = nil
+    @xvfb_pid = nil
     @cli = chrome_cli opts
+    if opts[:xvfb]
+      @xvfb_cli = xvfb_cli opts
+    else
+      @xvfb_cli = nil
+    end
   end
 
   # Starts the browser process.
   #
-  # @return [WebkitRemote::Browser] self
+  # @return [WebkitRemote::Browser] master session to the started Browser
+  #     process; the session's auto_close is set to false so that it can be
+  #     safely discarded; nil if the launch fails
   def start
     return self if running?
+
+    if @xvfb_cli
+      unless @xvfb_pid = POSIX::Spawn.spawn(*@xvfb_cli)
+        # The Xvfb launch failed.
+        return nil
+      end
+    end
+
     unless @pid = POSIX::Spawn.spawn(*@cli)
       # The launch failed
+      stop
       return nil
     end
 
@@ -51,6 +75,7 @@ class Process
       end
     end
     # The browser failed, or was too slow to start.
+    stop
     nil
   end
 
@@ -65,10 +90,28 @@ class Process
   # @return [WebkitRemote::Process] self
   def stop
     return self unless running?
-    begin
-      ::Process.kill 'TERM', @pid
-      ::Process.wait @pid
+    if @pid
+      begin
+        ::Process.kill 'TERM', @pid
+        ::Process.wait @pid
+      rescue SystemCallError
+        # Process died on its own.
+      ensure
+        @pid = nil
+      end
     end
+
+    if @xvfb_pid
+      begin
+        ::Process.kill 'TERM', @xvfb_pid
+        ::Process.wait @xvfb_pid
+      rescue SystemCallError
+        # Process died on its own.
+      ensure
+        @xvfb_pid = nil
+      end
+    end
+
     FileUtils.rm_rf @data_dir if File.exists?(@data_dir)
     @running = false
     self
@@ -90,6 +133,7 @@ class Process
     # The Chromium wiki recommends this page for available flags:
     #     http://peter.sh/experiments/chromium-command-line-switches/
     [
+      chrome_env(opts),
       self.class.chrome_binary,
       '--disable-default-apps',  # no bundled apps
       '--disable-desktop-shortcuts',  # don't mess with the desktop
@@ -115,13 +159,73 @@ class Process
       "--remote-debugging-port=#{@port}",  # Webkit remote debugging
       "--user-data-dir=#{@data_dir}",  # really ensure a clean slate
       '--window-position=0,0',  # remove randomness source
-      '--window-size=128,128',  # remove randomness source
+      '--window-size=256,256',  # remove randomness source
       'about:blank',  # don't load the homepage
       {
         chdir: @data_dir,
         in: '/dev/null',
         out: File.join(@data_dir, '.stdout'),
-        err: File.join(@data_dir, '.stderr'),
+        err: File.join(@data_dir, '.stderr')
+      },
+    ]
+  end
+
+  # Environment variables set when launching Chrome.
+  #
+  # @param [Hash] opts options passed to the WebkitRemote::Process constructor
+  # @return [Hash<String, String>] variables to be added to the environment of
+  #     the Chrome process before launching
+  def chrome_env(opts)
+    if opts[:xvfb]
+      if opts[:xvfb].respond_to?(:[]) and opts[:xvfb][:display]
+        display = opts[:xvfb][:display]
+      else
+        display = 20
+      end
+      { 'DISPLAY' => ":#{display}.0" }
+    else
+      {}
+    end
+  end
+
+  # Command-line that launches Xvfb.
+  #
+  # @param [Hash] opts options passed to the WebkitRemote::Process constructor
+  # @return [Array<String>] command line for launching Xvfb
+  def xvfb_cli(opts)
+    # The OSX man page for Xvfb:
+    #     http://developer.apple.com/library/mac/documentation/darwin/reference/manpages/man1/Xvfb.1.html
+
+    xvfb_opts = opts[:xvfb]
+    unless xvfb_opts.respond_to? :[]
+      xvfb_opts = {}
+    end
+
+    display = xvfb_opts[:display] || 20
+    width = xvfb_opts[:width] || 1280
+    height = xvfb_opts[:height] || 1024
+    depth = xvfb_opts[:depth] || 32
+    dpi = xvfb_opts[:dpi] || 72
+
+    # https://bugs.freedesktop.org/show_bug.cgi?id=17453
+    if depth == 32
+      depth = '24+32'
+    end
+
+    [
+      self.class.xvfb_binary,
+      ":#{display}",
+      '-screen', '0', "#{width}x#{height}x#{depth}",
+      '-auth', File.join(@data_dir, '.Xauthority'),
+      '-c',
+      '-dpi', dpi.to_s,
+      '-terminate',
+      '-wr',
+      {
+        chdir: @data_dir,
+        in: '/dev/null',
+        out: File.join(@data_dir, '.X_stdout'),
+        err: File.join(@data_dir, '.X_stderr'),
       },
     ]
   end
@@ -161,6 +265,20 @@ class Process
     @chrome_binary ||= nil
   end
   @chrome_binary = false
+
+  # Path to the Xvfb virtual X server binary.
+  #
+  # @return [String] full-qualified path to a binary that launches Xvfb.
+  def self.xvfb_binary
+    return @xvfb_binary unless @xvfb_binary == false
+
+    path = `which Xvfb`
+    unless path.empty?
+      @xvfb_binary = path.strip
+    end
+    @xvfb_binary ||= nil
+  end
+  @xvfb_binary = false
 end  # class WebkitRemote::Browser
 
 end  # namespace WebkitRemote

data/lib/webkit_remote/top_level.rb

@@ -7,7 +7,12 @@ module WebkitRemote
   #     WebKit process; the client will automatically stop the process when
   #     closed
   def self.local(opts = {})
+    # Use Xvfb if no desktop is available.
+    if !opts.has_key?(:xvfb) && (!ENV['DISPLAY'] || ENV['DISPLAY'].empty?)
+      opts = { xvfb: true }.merge! opts
+    end
     process = WebkitRemote::Process.new opts
+
     browser = process.start
     browser.stop_process = true
     client = WebkitRemote::Client.new tab: browser.tabs.first,

data/test/fixtures/html/console.html

@@ -17,6 +17,10 @@
       })();
       // Arguments test.
       console.error("params ", 42, true, { hello: "ruby" });
+      // Repetition test.
+      for (var i = 0; i < 3; i++) {
+        console.warn("one more time");
+      }
     </script>
   </head>
   <body>

data/test/fixtures/html/dom.html

@@ -0,0 +1,23 @@
+<!doctype html>
+<html>
+  <head>
+    <title>WebkitRemote DOM test</title>
+  </head>
+  <body>
+    <article id="load-article">
+      <section id="load-confirmation-section">
+        <p id="load-confirmation" data-purpose="attr-value-test">
+          DOM test loaded
+        </p>
+      </section>
+    </article>
+    <article id="second-article">
+      <section id="second-section">
+        <p id="second-paragraph" data-purpose="query-selector-all-test">
+          Second paragraph for testing query_selector_all.
+        </p>
+      </section>
+    </article>
+  </body>
+</html>
+

data/test/helper.rb

@@ -17,6 +17,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'webkit_remote'
 
+require 'debugger'
 require 'pp'
 require 'thread'
 Thread.abort_on_exception = true

data/test/webkit_remote/browser_test.rb

@@ -2,7 +2,7 @@ require File.expand_path('../helper.rb', File.dirname(__FILE__))
 
 describe WebkitRemote::Browser do
   before :each do
-    @process = WebkitRemote::Process.new port: 9669
+    @process = WebkitRemote::Process.new port: 9669, xvfb: true
     @process.start
   end
   after :each do

data/test/webkit_remote/client/console_test.rb

@@ -40,17 +40,34 @@ describe WebkitRemote::Client::Console do
       @client.console_events = true
       @client.navigate_to fixture_url(:console)
       @events = @client.wait_for type: WebkitRemote::Event::PageLoaded
-      @messages = @events.select do |event|
+      @message_events = @events.select do |event|
         event.kind_of? WebkitRemote::Event::ConsoleMessage
       end
+      @repeat_events = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::ConsoleMessageRepeated
+      end
+      @messages = @client.console_messages
     end
 
     after :all do
       @client.clear_all
     end
 
-    it 'receives console events' do
-      @messages.wont_be :empty?
+    it 'receives ConsoleMessage events' do
+      @message_events.wont_be :empty?
+    end
+
+    it 'receives ConsoleMessageRepeated events' do
+      @repeat_events.wont_be :empty?
+    end
+
+    it 'collects messages into Client#console_messages' do
+      @message_events[0].message.must_equal @messages[0]
+      @message_events[1].message.must_equal @messages[1]
+      @message_events[2].message.must_equal @messages[2]
+      @message_events[3].message.must_equal @messages[3]
+      @repeat_events[0].message.must_equal @messages[3]
+      @repeat_events[1].message.must_equal @messages[3]
     end
 
     it 'parses text correctly' do
@@ -81,11 +98,18 @@ describe WebkitRemote::Client::Console do
       @messages[2].params[0, 3].must_equal ['params ', 42, true]
       @messages[2].params.length.must_equal 4
 
-      @messages[2].params[3].must_be_kind_of WebkitRemote::Client::RemoteObject
-      @messages[2].params[3].properties[:hello].value.must_equal 'ruby'
+      @messages[2].params[3].must_be_kind_of WebkitRemote::Client::JsObject
+      @messages[2].params[3].properties['hello'].value.must_equal 'ruby'
       @messages[2].params[3].group.name.must_equal nil
     end
 
+    it 'parses repeated messages correctly' do
+      @messages[3].text.must_equal 'one more time'
+      @messages[3].count.must_equal 3
+      @repeat_events[0].count.must_equal 2
+      @repeat_events[1].count.must_equal 3
+    end
+
     describe 'clear_console' do
       before :all do
         @client.clear_console
@@ -108,8 +132,41 @@ describe WebkitRemote::Client::Console do
       end
 
       it 'releases the objects in ConsoleMessage instances' do
-        @messages[2].params[3].released?.must_equal true
+        @message_events[2].message.params[3].released?.must_equal true
+      end
+    end
+  end
+
+  describe 'with console and network events enabled' do
+    before :all do
+      @client.console_events = true
+      @client.network_events = true
+      @client.navigate_to fixture_url(:network)
+      @events = @client.wait_for type: WebkitRemote::Event::ConsoleMessage,
+                                 level: :log
+      @message_events = @events.select do |event|
+        event.kind_of? WebkitRemote::Event::ConsoleMessage
       end
+      @messages = @client.console_messages
+    end
+
+    after :all do
+      @client.clear_all
+    end
+
+    it 'receives ConsoleMessage events' do
+      @message_events.wont_be :empty?
+    end
+
+    it 'associates messages with network requests' do
+      @messages[0].text.must_match /not found/i
+      @messages[0].network_resource.wont_equal nil
+      @messages[0].network_resource.document_url.
+          must_equal fixture_url(:network)
+      @messages[0].level.must_equal :error
+      @messages[0].count.must_equal 1
+      @messages[0].reason.must_equal :network
+      @messages[0].type.must_equal :log
     end
   end
 end

data/test/webkit_remote/client/dom_test.rb

@@ -0,0 +1,149 @@
+require File.expand_path('../../helper.rb', File.dirname(__FILE__))
+
+describe WebkitRemote::Client::Dom do
+  before :all do
+    @client = WebkitRemote.local port: 9669
+    @client.page_events = true
+    @client.navigate_to fixture_url(:dom)
+    @client.wait_for type: WebkitRemote::Event::PageLoaded
+  end
+  after :all do
+    @client.close
+  end
+
+  describe '#dom_root' do
+    before :all do
+      @root = @client.dom_root
+    end
+
+    it 'returns a WebkitRemote::Client::DomNode for a document' do
+      @root.must_be_kind_of WebkitRemote::Client::DomNode
+      @root.node_type.must_equal :document
+      @root.name.must_equal '#document'
+      @root.document_url.must_equal fixture_url(:dom)
+    end
+  end
+end
+
+describe WebkitRemote::Client::DomNode do
+  before :all do
+    @client = WebkitRemote.local port: 9669
+    @client.page_events = true
+    @client.navigate_to fixture_url(:dom)
+    @client.wait_for type: WebkitRemote::Event::PageLoaded
+    @root = @client.dom_root
+  end
+  after :all do
+    @client.close
+  end
+
+  describe 'querySelector' do
+    before :all do
+      @p = @root.query_selector 'p#load-confirmation'
+    end
+
+    it 'returns a WebkitRemote::Client::DomNode' do
+      @p.must_be_kind_of WebkitRemote::Client::DomNode
+    end
+
+    it 'returns a WebkitRemote::Client::DomNode with correct attributes' do
+      skip 'On-demand node processing not implemented'
+      @p.node_type.must_equal :element
+      @p.name.must_equal 'P'
+    end
+  end
+
+  describe 'querySelectorAll' do
+    before :all do
+      @p_array = @root.query_selector_all 'p'
+    end
+
+    it 'returns an array of WebkitRemote::Client::DomNodes' do
+      @p_array.must_respond_to :[]
+      @p_array.each { |p| p.must_be_kind_of WebkitRemote::Client::DomNode }
+    end
+
+    it 'returns the correct WebkitRemote::Client::DomNodes' do
+      @p_array.map { |p| p.attributes['id'] }.
+               must_equal ['load-confirmation', 'second-paragraph']
+    end
+  end
+
+  describe 'attributes' do
+    before :all do
+      @p = @root.query_selector 'p#load-confirmation'
+    end
+
+    it 'produces a Hash of attributes' do
+      @p.attributes.must_include 'data-purpose'
+      @p.attributes['data-purpose'].must_equal 'attr-value-test'
+    end
+  end
+
+  describe 'outer_html' do
+    before :all do
+      @p = @root.query_selector 'p#load-confirmation'
+    end
+
+    it 'returns the original HTML behind the element' do
+      @p.outer_html.strip.must_equal <<DOM_END.strip
+        <p id="load-confirmation" data-purpose="attr-value-test">
+          DOM test loaded
+        </p>
+DOM_END
+    end
+  end
+
+  describe 'remove' do
+    before :all do
+      @p = @root.query_selector 'p#load-confirmation'
+      @p.remove
+    end
+
+    it 'removes the node from the DOM tree' do
+      @root.query_selector_all('p').length.must_equal 1
+    end
+  end
+
+  describe 'remove_attribute' do
+    describe 'without cached data' do
+      before :all do
+        @p = @root.query_selector 'p#load-confirmation'
+        @p.remove_attribute 'data-purpose'
+      end
+
+      it 'strips the attribute from the element' do
+        @p.attributes!.wont_include 'data-purpose'
+      end
+    end
+
+    describe 'with cached data' do
+      before :all do
+        @p = @root.query_selector 'p#load-confirmation'
+        @p.attributes
+        @p.remove_attribute 'data-purpose'
+      end
+
+      it 'strips the attribute from the element' do
+        @p.attributes.wont_include 'data-purpose'
+      end
+    end
+  end
+
+  describe 'js_object' do
+    before :all do
+      @p = @root.query_selector 'p#load-confirmation'
+      @js_object = @p.js_object
+    end
+
+    it 'returns the corresponding WebkitRemote::Client::JsObject' do
+      @js_object.must_be_kind_of WebkitRemote::Client::JsObject
+      @js_object.properties['tagName'].value.must_equal 'P'
+      @js_object.properties['baseURI'].value.must_equal fixture_url(:dom)
+    end
+
+    it 'dom_node returns the DomNode back' do
+      @js_object.dom_node.must_equal @p
+    end
+  end
+end